Gladeui.Catalog

Fields

None

Methods

class

add_path (path)

class

destroy_all ()

class

get_extra_paths ()

class

is_loaded (name)

class

load_all ()

class

remove_path (path)

get_adaptors ()

get_book ()

get_domain ()

get_icon_prefix ()

get_major_version ()

get_minor_version ()

get_name ()

get_prefix ()

get_targets ()

get_widget_groups ()

Details

class Gladeui.Catalog
classmethod add_path(path)
Parameters:

path (str) – the new path containing catalogs

Adds a new path to the list of path to look catalogs for.

classmethod destroy_all()

Destroy and free all resources related with every loaded catalog.

classmethod get_extra_paths()
Returns:

a list paths added by Gladeui.Catalog.add_path()

Return type:

[str]

classmethod is_loaded(name)
Parameters:

name (str) – a catalog object

Returns:

Whether name is loaded or not

Return type:

bool

classmethod load_all()
Returns:

the list of loaded Gladeui.Catalog *

Return type:

[Gladeui.Catalog]

Loads all available catalogs in the system. First loads catalogs from Gladeui.ENV_CATALOG_PATH, then from Gladeui.App.get_catalogs_dir() and finally from paths specified with Gladeui.Catalog.add_path()

classmethod remove_path(path)
Parameters:

path (str or None) – the new path containing catalogs or None to remove all of them

Remove path from the list of path to look catalogs for. None to remove all paths.

get_adaptors()
Returns:

the list of widget class adaptors

Return type:

[Gladeui.WidgetAdaptor]

get_book()
Returns:

The Devhelp search domain.

Return type:

str

get_domain()
Returns:

The domain to be used to translate strings from this catalog

Return type:

str

get_icon_prefix()
Returns:

The prefix for icons.

Return type:

str

get_major_version()
Returns:

The catalog version

Return type:

int

get_minor_version()
Returns:

The catalog minor version

Return type:

int

get_name()
Returns:

The symbolic catalog name.

Return type:

str

get_prefix()
Returns:

The catalog path prefix.

Return type:

str

get_targets()
Returns:

the list of suitable version targets.

Return type:

[Gladeui.TargetableVersion]

get_widget_groups()
Returns:

the list of widget groups (palette)

Return type:

[Gladeui.WidgetGroup]