Foundry.Documentation¶

Subclasses:: None

Methods¶

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

	`dup_deprecated_in` ()
	`dup_icon` ()
	`dup_menu_icon` ()
	`dup_menu_title` ()
	`dup_section_title` ()
	`dup_since_version` ()
	`dup_title` ()
	`dup_uri` ()
	`equal` (other)
	`find_children` ()
	`find_parent` ()
	`find_siblings` ()
	`has_children` ()
	`query_attribute` (attribute)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_dup_deprecated_in` ()
	`do_dup_icon` ()
	`do_dup_menu_icon` ()
	`do_dup_menu_title` ()
	`do_dup_section_title` ()
	`do_dup_since_version` ()
	`do_dup_title` ()
	`do_dup_uri` ()
	`do_equal` (other)
	`do_find_children` ()
	`do_find_parent` ()
	`do_find_siblings` ()
	`do_has_children` ()
	`do_query_attribute` (attribute)

Properties¶

Name	Type	Flags
`deprecated-in`	`str`	r
`icon`	`Gio.Icon`	r
`menu-icon`	`Gio.Icon`	r
`menu-title`	`str`	r
`section-title`	`str`	r
`since-version`	`str`	r
`title`	`str`	r
`uri`	`str`	r

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Foundry.Documentation(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Foundry.DocumentationClass

Abstract base class for plugins to provide a documentation endpoint.

This represents a single documentation endpoint like a class documentation or method documentation.

dup_deprecated_in()¶

Return type:: str or None

dup_icon()¶

Return type:: Gio.Icon or None

dup_menu_icon()¶

Return type:: Gio.Icon or None

dup_menu_title()¶

Return type:: str or None

dup_section_title()¶

Return type:: str or None

dup_since_version()¶

Return type:: str or None

dup_title()¶

Return type:: str or None

dup_uri()¶

Return type:: str or None

equal(other)¶

Parameters:: other (Foundry.Documentation) –
Return type:: bool

find_children()¶

Returns:: a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.Documentation] or rejects with error.
Return type:: Dex.Future

find_parent()¶

Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.Documentation] or rejects with error.
Return type:: Dex.Future

find_siblings()¶

Returns:: a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.Documentation] or rejects with error.
Return type:: Dex.Future

has_children()¶

Return type:: bool

query_attribute(attribute)¶

Parameters:: attribute (str) –
Return type:: str or None

Query various attributes which may be part of the documentation but are not required by plugins to implement.

do_dup_deprecated_in() virtual¶

Return type:: str or None

do_dup_icon() virtual¶

Return type:: Gio.Icon or None

do_dup_menu_icon() virtual¶

Return type:: Gio.Icon or None

do_dup_menu_title() virtual¶

Return type:: str or None

do_dup_section_title() virtual¶

Return type:: str or None

do_dup_since_version() virtual¶

Return type:: str or None

do_dup_title() virtual¶

Return type:: str or None

do_dup_uri() virtual¶

Return type:: str or None

do_equal(other) virtual¶

Parameters:: other (Foundry.Documentation) –
Return type:: bool

do_find_children() virtual¶

Returns:: a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.Documentation] or rejects with error.
Return type:: Dex.Future

do_find_parent() virtual¶

Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.Documentation] or rejects with error.
Return type:: Dex.Future

do_find_siblings() virtual¶

Returns:: a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.Documentation] or rejects with error.
Return type:: Dex.Future

do_has_children() virtual¶

Return type:: bool

do_query_attribute(attribute) virtual¶

Parameters:: attribute (str) –
Return type:: str or None

Query various attributes which may be part of the documentation but are not required by plugins to implement.

Property Details¶

Foundry.Documentation.props.deprecated_in¶

Name:: deprecated-in
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.Documentation.props.icon¶

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

Foundry.Documentation.props.menu_icon¶

Name:: menu-icon
Type:: Gio.Icon
Default Value:: None
Flags:: READABLE

Foundry.Documentation.props.menu_title¶

Name:: menu-title
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.Documentation.props.section_title¶

Name:: section-title
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.Documentation.props.since_version¶

Name:: since-version
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.Documentation.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.Documentation.props.uri¶

Name:: uri
Type:: str
Default Value:: None
Flags:: READABLE