API docs for “elisa.plugins.pigment.pigment

Specialised elisa.core.components.frontend.Frontend for the Pigment toolkit.

It creates the canvas, the viewport, and the root controller (which keeps the root of the widgets hierarchy), using values specified in the configuration.

Instance Variables	viewport	the Pigment viewport (type: `pgm.Viewport` )
	canvas	the Pigment canvas (type: `pgm.Canvas` )
	config	data from the configuration file loaded at Elisa startup, or the default (type: `elisa.core.config.Config` )
	controller	the root controller, containing the root of widget hierarchy (type: `elisa.plugins.pigment.pigment_controller.PigmentController` )
	gtk_window	Gtk window, optionnally embedding the Pigment viewport (type: `gtk.Window` )

Line #	Kind	Name	Docs
357	Method	initialize	Initialize the component.
541	Method	reduce_window	Undocumented
545	Method	handle_input	Undocumented
577	Method	set_theme	Set a new theme for the frontend.
622	Method	get_theme	Get the current theme.
630	Method	load_from_theme	Loads an icon from the theme into a Pigment image.
688	Method	clean	Clean the component.
538	Method	_viewport_delete_event	Undocumented
549	Method	_initialize_theme	Initialize a theme for the frontend.
568	Method	_reload_theme	Undocumented
674	Method	_file_loaded	Undocumented
680	Method	_clone_removed	Undocumented
713	Method	_configure_callback	Undocumented
720	Method	_update_pass_callback	Undocumented
723	Method	_resize_canvas	Undocumented
730	Method	_motion_notify_callback	Undocumented
738	Method	_hide_cursor	Undocumented
741	Method	_initialize_dbus	Undocumented
752	Method	_clean_dbus	Undocumented
766	Method	_viewport_drag_motion_event	Undocumented
787	Method	_viewport_drag_drop_event	Undocumented
799	Method	_viewport_drag_leave_event	Undocumented

Inherited from Component (via Frontend):

Line #	Kind	Name	Docs
85	Class	PathDescriptor	Undocumented
97	Class Method	create	Create and initialize the component.

Inherited from Loggable (via Frontend, Component):

Line #	Kind	Name	Docs
81	Method	__init__	Undocumented

Inherited from PigmentFrontendExtensionMixin:

Line #	Kind	Name	Docs
58	Method	__init__	Undocumented
136	Method	add_controller	Add a new controller to the frontend. The controller is the one that
149	Method	remove_controller	Remove a controller from the frontend.
160	Method	create_controller	Create a controller for the given path.
196	Method	retrieve_controllers	Retrieve the list of controllers for a given path.
213	Method	add_decorator	Add a decorator function for controllers matching path_pattern.
230	Method	remove_decorator	Remove a decorator function from the frontend.
73	Method	_load_enabled_controller_and_decorator_mappings	Load the controller and decorator mappings from all the enabled
87	Method	_update_controller_mappings	Undocumented
100	Method	_update_decorator_mappings	Undocumented
113	Method	_plugin_status_changed_cb	Undocumented
189	Method	_store_controller	Undocumented
241	Method	_set_frontend	Undocumented
246	Method	_set_path	Undocumented
251	Method	_decorator_callback	Undocumented
256	Method	_decorator_errback	Undocumented
262	Method	_iterate_decorators_callback	Undocumented
266	Method	_iterate_decorators	Undocumented
292	Method	_decorate	Undocumented

def initialize(self):

overrides elisa.core.component.Component.initialize

Initialize the component.

This method is called by Component.create to finish the initialization of a component.

Returns a deferred called when a component is fully initialized (type: twisted.internet.defer.Deferred )

Parameters	path	icon path to load (type: str )
	image	drawable into which the icon will be loaded (type: `pgm.Image` )
Returns	triggered whenever the image is loaded and shown (type: `twisted.internet.defer.Deferred` )

Class e.p.p.p.PigmentFrontend(Frontend, PigmentFrontendExtensionMixin):