Foundry.DocumentationRoot¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (identifier, title, version, icon, directories)
	`dup_icon` ()
	`dup_identifier` ()
	`dup_title` ()
	`dup_version` ()
	`list_directories` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`directories`	`Gio.ListModel`	r/w/co
`icon`	`Gio.Icon`	r/w/co
`identifier`	`str`	r/w/co
`title`	`str`	r/w/co
`version`	`str`	r/w/co

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Foundry.DocumentationRoot(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Foundry.DocumentationRootClass

An area where documentation may be ingested from.

Plugins may use this information to scan for documentation that matches their particular format.

classmethod new(identifier, title, version, icon, directories)¶

Parameters:

identifier (str) –
title (str) –
version (str) –
icon (Gio.Icon) –
directories (Gio.ListModel) –

Return type:

Foundry.DocumentationRoot

dup_icon()¶

Return type:: Gio.Icon or None

dup_identifier()¶

Return type:: str

dup_title()¶

Return type:: str

dup_version()¶

Return type:: str

list_directories()¶

Returns:: a [iface`Gio`.ListModel] of [iface`Gio`.File].
Return type:: Gio.ListModel

Property Details¶

Foundry.DocumentationRoot.props.directories¶

Name:: directories
Type:: Gio.ListModel
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.DocumentationRoot.props.icon¶

Name:: icon
Type:: Gio.Icon
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.DocumentationRoot.props.identifier¶

Name:: identifier
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.DocumentationRoot.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.DocumentationRoot.props.version¶

Name:: version
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY