Foundry.Symbol¶

Subclasses:: None

Methods¶

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

	`dup_icon` ()
	`dup_locator` ()
	`dup_name` ()
	`find_parent` ()
	`has_children` ()
	`list_children` ()
	`list_to_root` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_dup_icon` ()
	`do_dup_locator` ()
	`do_dup_name` ()
	`do_find_parent` ()
	`do_has_children` ()
	`do_list_children` ()

Properties¶

Name	Type	Flags
`icon`	`Gio.Icon`	r
`locator`	`Foundry.SymbolLocator`	r
`name`	`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.Symbol(**kwargs)¶

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

Abstract base class for representing symbols.

Foundry.Symbol provides the core interface for representing code symbols such as functions, classes, variables, and other identifiers. Concrete implementations handle specific symbol types and provide specialized functionality for symbol navigation, documentation, and manipulation.

dup_icon()¶

Returns:: a [iface`Gio`.Icon] or None
Return type:: Gio.Icon or None

Gets the icon representing the symbol.

New in version 1.1.

dup_locator()¶

Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.SymbolLocator].
Return type:: Foundry.SymbolLocator

Gets the locator to find the location of the symbol.

New in version 1.1.

dup_name()¶

Returns:: a string or None
Return type:: str or None

Gets the name of the symbol.

find_parent()¶

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

Find the parent symbol, if any.

has_children()¶

Returns:: True if children are possible from this symbol.
Return type:: bool

Gets if the symbol can have children even if it is not yet known if it does have any children.

New in version 1.1.

list_children()¶

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

List all of the children of this symbol.

list_to_root()¶

Returns:: a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.Symbol].
Return type:: Dex.Future

Asynchronously populates a [iface`Gio`.ListModel] of [class`Foundry`.Symbol] starting from this symbol to the root symbol by following [method`Foundry`.Symbol.find_parent] until there are no more parents.

The root symbol is placed at position 0 and self is placed in the last position.

do_dup_icon() virtual¶

Returns:: a [iface`Gio`.Icon] or None
Return type:: Gio.Icon or None

Gets the icon representing the symbol.

New in version 1.1.

do_dup_locator() virtual¶

Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.SymbolLocator].
Return type:: Foundry.SymbolLocator

Gets the locator to find the location of the symbol.

New in version 1.1.

do_dup_name() virtual¶

Returns:: a string or None
Return type:: str or None

Gets the name of the symbol.

do_find_parent() virtual¶

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

Find the parent symbol, if any.

do_has_children() virtual¶

Returns:: True if children are possible from this symbol.
Return type:: bool

Gets if the symbol can have children even if it is not yet known if it does have any children.

New in version 1.1.

do_list_children() virtual¶

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

List all of the children of this symbol.

Property Details¶

Foundry.Symbol.props.icon¶

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

Foundry.Symbol.props.locator¶

Name:: locator
Type:: Foundry.SymbolLocator
Default Value:: None
Flags:: READABLE

Foundry.Symbol.props.name¶

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