Gladeui.App¶

Subclasses:: None

Methods¶

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

class	`add_project` (project)
class	`config_save` ()
class	`do_event` (event)
class	`get` ()
class	`get_accel_group` ()
class	`get_bin_dir` ()
class	`get_catalog` (name)
class	`get_catalog_version` (name)
class	`get_catalogs` ()
class	`get_catalogs_dir` ()
class	`get_clipboard` ()
class	`get_config` ()
class	`get_lib_dir` ()
class	`get_locale_dir` ()
class	`get_modules_dir` ()
class	`get_pixmaps_dir` ()
class	`get_project_by_path` (project_path)
class	`get_projects` ()
class	`get_window` ()
class	`is_project_loaded` (project_path)
class	`new` ()
class	`remove_project` (project)
class	`search_docs` (book, page, search)
class	`set_accel_group` (accel_group)
class	`set_window` (window)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`doc-search`	Emitted when the glade core requests that a doc-search be performed.
`signal-editor-created`	Emitted when a new signal editor created.
`widget-adaptor-registered`	Emitted when a new widget adaptor is registered.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Gladeui.App(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gladeui.AppClass

classmethod add_project(project)¶

Parameters:: project (Gladeui.Project) – the project to add to the Gladeui.App

classmethod config_save()¶

Returns:: 0 on success.
Return type:: int

Saves the GLib.KeyFile to “GLib.get_user_config_dir()/GLADE_CONFIG_FILENAME”

classmethod do_event(event)¶

Parameters:: event (Gdk.Event) – the event to process.
Returns:: true if the event was handled.
Return type:: bool

This function has to be called in an event handler for widget selection to work. See Gdk.Event.handler_set()

classmethod get()¶

Returns:: the Gladeui.App
Return type:: Gladeui.App

classmethod get_accel_group()¶

Returns:: the Gtk.AccelGroup
Return type:: Gtk.AccelGroup

classmethod get_bin_dir()¶

Return type:: str

classmethod get_catalog(name)¶

Parameters:: name (str) – the name of the catalog
Returns:: a Gladeui.Catalog or None if none is found
Return type:: Gladeui.Catalog or None

classmethod get_catalog_version(name)¶

Parameters:

name (str) – the name of the Gladeui.Catalog

Returns:

True if the catalog has been found. It is a programming error to call this function with an unexisting catalog, returns False in this case and throws a warning.

major:: the major version
minor:: the minor version

Return type:

(bool, major: int, minor: int)

classmethod get_catalogs()¶

Returns:: a list of Gladeui.Catalog
Return type:: [Gladeui.Catalog]

classmethod get_catalogs_dir()¶

Return type:: str

classmethod get_clipboard()¶

Returns:: a Gladeui.Clipboard
Return type:: Gladeui.Clipboard

classmethod get_config()¶

Returns:: a GLib.KeyFile
Return type:: GLib.KeyFile

classmethod get_lib_dir()¶

Return type:: str

classmethod get_locale_dir()¶

Return type:: str

classmethod get_modules_dir()¶

Return type:: str

classmethod get_pixmaps_dir()¶

Return type:: str

classmethod get_project_by_path(project_path)¶

Parameters:: project_path (str) – The path of an open project
Returns:: A Gladeui.Project, or None if no such open project was found
Return type:: Gladeui.Project or None

Finds an open project with path

classmethod get_projects()¶

Returns:: a list of Gladeui.Catalog
Return type:: [Gladeui.Catalog]

classmethod get_window()¶

Returns:: a Gtk.Widget
Return type:: Gtk.Widget

classmethod is_project_loaded(project_path)¶

Parameters:: project_path (str) –
Return type:: bool

classmethod new()¶

Returns:: the Gladeui.App
Return type:: Gladeui.App

classmethod remove_project(project)¶

Parameters:: project (Gladeui.Project) – the project to remove from the Gladeui.App

classmethod search_docs(book, page, search)¶

Parameters:

book (str) – the name of a book
page (str) – the name of a page
search (str) – the search query

Searches for book, page and search in the documentation.

classmethod set_accel_group(accel_group)¶

Parameters:: accel_group (Gtk.AccelGroup) – a Gtk.AccelGroup to set

Sets accel_group to app. The acceleration group will made available for editor dialog windows from the plugin backend.

classmethod set_window(window)¶

Parameters:: window (Gtk.Widget) – a Gtk.Widget

Set the window of the application

Signal Details¶

Gladeui.App.signals.doc_search(app, arg1, arg2, arg3)¶

Signal Name:

doc-search

Flags:

RUN_LAST

Parameters:

app (Gladeui.App) – The object which received the signal
arg1 (str) – the (str *) book to search or None
arg2 (str) – the (str *) page to search or None
arg3 (str) – the (str *) search string or None

Emitted when the glade core requests that a doc-search be performed.

Gladeui.App.signals.signal_editor_created(app, signal_editor)¶

Signal Name:

signal-editor-created

Flags:

RUN_LAST

Parameters:

app (Gladeui.App) – The object which received the signal
signal_editor (GObject.Object) – the new Gladeui.SignalEditor.

Emitted when a new signal editor created. A tree view is created in the default handler. Connect your handler before the default handler for setting a custom column or renderer and after it for connecting to the tree view signals

Gladeui.App.signals.widget_adaptor_registered(app, adaptor)¶

Signal Name:

widget-adaptor-registered

Flags:

RUN_LAST

Parameters:

app (Gladeui.App) – The object which received the signal
adaptor (GObject.Object) – the newly registered Gladeui.WidgetAdaptor.

Emitted when a new widget adaptor is registered.