Libxfce4panel.PanelPlugin¶

Subclasses:: None

Methods¶

Inherited:: Gtk.EventBox (5), Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Libxfce4panel.PanelPluginProvider (18)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`position_menu` (menu, push_in, panel_plugin)
	`add_action_widget` (widget)
	`arrow_type` ()
	`block_autohide` (blocked)
	`block_menu` ()
	`focus_widget` (widget)
	`get_arguments` ()
	`get_comment` ()
	`get_display_name` ()
	`get_expand` ()
	`get_icon_size` ()
	`get_locked` ()
	`get_mode` ()
	`get_name` ()
	`get_nrows` ()
	`get_orientation` ()
	`get_property_base` ()
	`get_screen_position` ()
	`get_shrink` ()
	`get_size` ()
	`get_small` ()
	`get_unique_id` ()
	`lookup_rc_file` ()
	`menu_destroy` ()
	`menu_insert_item` (item)
	`menu_show_about` ()
	`menu_show_configure` ()
	`popup_menu` (menu, widget, trigger_event)
	`position_widget` (menu_widget, attach_widget)
	`register_menu` (menu)
	`remove` ()
	`save_location` (create)
	`set_expand` (expand)
	`set_shrink` (shrink)
	`set_small` (small)
	`take_window` (window)
	`unblock_menu` ()

Virtual Methods¶

Inherited:: Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Libxfce4panel.PanelPluginProvider (17)

	`do_about` ()
	`do_configure_plugin` ()
	`do_construct` ()
	`do_free_data` ()
	`do_mode_changed` (mode)
	`do_nrows_changed` (rows)
	`do_orientation_changed` (orientation)
	`do_remote_event` (name, value)
	`do_removed` ()
	`do_save` ()
	`do_screen_position_changed` (position)
	`do_size_changed` (size)

Properties¶

Inherited:: Gtk.EventBox (2), Gtk.Container (3), Gtk.Widget (39)

Name	Type	Flags	Short Description
`arguments`	[`str`]	r/w/co	Startup arguments for the plugin
`comment`	`str`	r/w/co	Plugin comment
`dark-mode`	`bool`	r/w	Whether or not to request the Gtk dark theme variant
`display-name`	`str`	r/w/co	Plugin display name
`icon-size`	`int`	r	Size of the plugin’s icon
`mode`	`Libxfce4panel.PanelPluginMode`	r	Disply mode of the plugin
`nrows`	`int`	r	Number of rows of the panel
`orientation`	`Gtk.Orientation`	r	Orientation of the plugin’s panel
`screen-position`	`Libxfce4panel.ScreenPosition`	r	`xlib.Screen` position of the plugin’s panel
`shrink`	`bool`	r/w	Whether this plugin can shrink
`size`	`int`	r	Size of the plugin’s panel
`small`	`bool`	r/w	Is this plugin small, e.g. a single button?
`unique-id`	`int`	r/w/co	Unique plugin ID

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1), Libxfce4panel.PanelPluginProvider (1)

Name	Short Description
`about`	This signal is emmitted when the About entry in the right-click menu is clicked.
`configure-plugin`	This signal is emmitted when the Properties entry in the right-click menu is clicked.
`free-data`	This signal is emmitted when the plugin is closing.
`mode-changed`	This signal is emmitted whenever the mode of the panel the plugin is on changes.
`nrows-changed`	This signal is emmitted whenever the nrows of the panel the plugin is on changes.
`orientation-changed`	This signal is emmitted whenever the orientation of the panel the plugin is on changes.
`remote-event`	This signal is emmitted by the user by running xfce4-panel –plugin-event=plugin-name:name:py:data::type<Libxfce4panel.PanelPlugin.props.type>`:value`.
`removed`	This signal is emmitted when the plugin is permanently removed from the panel configuration by the user.
`save`	This signal is emitted when the plugin should save it’s configuration.
`screen-position-changed`	This signal is emmitted whenever the screen position of the panel the plugin is on changes.
`size-changed`	This signal is emmitted whenever the size of the panel the plugin is on changes.

Fields¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1), Libxfce4panel.PanelPluginProvider (1)

Class Details¶

class Libxfce4panel.PanelPlugin(**kwargs)¶

Bases:: Gtk.EventBox, Libxfce4panel.PanelPluginProvider
Abstract:: No
Structure:: Libxfce4panel.PanelPluginClass

This struct contain private data only and should be accessed by the functions below.

classmethod position_menu(menu, push_in, panel_plugin)¶

Parameters:

menu (Gtk.Menu) – a Gtk.Menu.
push_in (bool) – keep inside the screen (see Gtk.MenuPositionFunc)
panel_plugin (object or None) – an Libxfce4panel.PanelPlugin.

Returns:

x:: return location for the x coordinate.
y:: return location for the y coordinate.

Return type:

(x: int, y: int)

Function to be used as Gtk.MenuPositionFunc in a call to Gtk.Menu.popup(). As data argument it needs an Libxfce4panel.PanelPlugin.

The menu is normally positioned relative to panel_plugin. If you want the menu to be positioned relative to another widget, you can use Gtk.Menu.attach_to_widget() to explicitly set a ‘parent’ widget.

As a convenience, Libxfce4panel.PanelPlugin.position_menu() calls Libxfce4panel.PanelPlugin.register_menu() for the menu.

void myplugin_popup_menu (Libxfce4panel.PanelPlugin *plugin, Gtk.Menu *menu, Gdk.EventButton *ev) { Gtk.Menu.popup (menu, None, None, Libxfce4panel.PanelPlugin.position_menu, plugin, ev->button, ev->time ); }

For a custom widget that will be used as a popup menu, use Libxfce4panel.PanelPlugin.position_widget() instead.

Signal Details¶

Libxfce4panel.PanelPlugin.signals.about(panel_plugin)¶

Signal Name:: about
Flags:: RUN_LAST
Parameters:: panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal

This signal is emmitted when the About entry in the right-click menu is clicked. Plugin writers can use it to show information about the plugin and display credits of the developers, translators and other contributors.

Libxfce4panel.PanelPlugin.signals.configure_plugin(panel_plugin)¶

Signal Name:: configure-plugin
Flags:: RUN_LAST
Parameters:: panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal

This signal is emmitted when the Properties entry in the right-click menu is clicked. Plugin writers can use this signal to open a plugin settings dialog. It is their responsibility to block/unblock panel autohide when the dialog is shown/hidden.

See also: Libxfce4panel.PanelPlugin.menu_show_configure() and xfce_titled_dialog_new ().

Libxfce4panel.PanelPlugin.signals.free_data(panel_plugin)¶

Signal Name:: free-data
Flags:: RUN_LAST
Parameters:: panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal

This signal is emmitted when the plugin is closing. Plugin writers should use this signal to free any allocated resources.

Libxfce4panel.PanelPlugin.signals.mode_changed(panel_plugin, mode)¶

Signal Name:

mode-changed

Flags:

RUN_LAST

Parameters:

panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal
mode (Libxfce4panel.PanelPluginMode) – new Libxfce4panel.PanelPluginMode of the panel.

This signal is emmitted whenever the mode of the panel the plugin is on changes.

New in version 4.10.

Libxfce4panel.PanelPlugin.signals.nrows_changed(panel_plugin, rows)¶

Signal Name:

nrows-changed

Flags:

RUN_LAST

Parameters:

panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal
rows (int) – new number of rows of the panel

This signal is emmitted whenever the nrows of the panel the plugin is on changes.

New in version 4.10.

Libxfce4panel.PanelPlugin.signals.orientation_changed(panel_plugin, orientation)¶

Signal Name:

orientation-changed

Flags:

RUN_LAST

Parameters:

panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal
orientation (Gtk.Orientation) – new Gtk.Orientation of the panel.

This signal is emmitted whenever the orientation of the panel the plugin is on changes. Plugins writers can for example use this signal to change the order of widgets in the plugin.

Libxfce4panel.PanelPlugin.signals.remote_event(panel_plugin, name, value)¶

Signal Name:

remote-event

Flags:

RUN_LAST

Parameters:

panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal
name (str) – name of the signal.
value (GObject.Value) – value of the signal.

Returns:

True to stop signal emission to other plugins, False to send the signal also to other plugins with the same name.

Return type:

bool

This signal is emmitted by the user by running xfce4-panel –plugin-event=plugin-name:name:py:data::type<Libxfce4panel.PanelPlugin.props.type>:value. It can be used for remote communication, like for example to popup a menu.

Libxfce4panel.PanelPlugin.signals.removed(panel_plugin)¶

Signal Name:: removed
Flags:: RUN_LAST
Parameters:: panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal

This signal is emmitted when the plugin is permanently removed from the panel configuration by the user. Developers can use this signal to cleanup custom setting locations that for example store passwords.

The free-data signal is emitted after this signal!

Note that if you use the xfconf channel and base property provided by Libxfce4panel.PanelPlugin.get_property_base() or the rc file location returned by Libxfce4panel.PanelPlugin.save_location(), the panel will take care of removing those settings.

New in version 4.8.

Libxfce4panel.PanelPlugin.signals.save(panel_plugin)¶

Signal Name:: save
Flags:: RUN_LAST
Parameters:: panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal

This signal is emitted when the plugin should save it’s configuration. The signal is always emmitted before the plugin closes (before the “free-data” signal) and also once in 10 minutes or so.

Libxfce4panel.PanelPlugin.signals.screen_position_changed(panel_plugin, position)¶

Signal Name:

screen-position-changed

Flags:

RUN_LAST

Parameters:

panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal
position (Libxfce4panel.ScreenPosition) – the new Libxfce4panel.ScreenPosition of the panel.

This signal is emmitted whenever the screen position of the panel the plugin is on changes. Plugins writers can for example use this signal to change the arrow direction of buttons.

Libxfce4panel.PanelPlugin.signals.size_changed(panel_plugin, size)¶

Signal Name:

size-changed

Flags:

RUN_LAST

Parameters:

panel_plugin (Libxfce4panel.PanelPlugin) – The object which received the signal
size (int) – the new size of the panel.

Return type:

bool

This signal is emmitted whenever the size of the panel the plugin is on changes. Plugins writers can for example use this signal to update their icon size.

If the function returns False or is not used, the panel will force a square size to the plugin. If you want non-square plugins and you don’t need this signal you can use something like this:

g_signal_connect (plugin, “size-changed”, G_CALLBACK (Gtk.true), None);

Property Details¶

Libxfce4panel.PanelPlugin.props.arguments¶

Name:: arguments
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The arguments the plugin was started with. If the plugin was not started with any arguments this value is None. Plugin writer can use it to read the arguments array, but Libxfce4panel.PanelPlugin.get_arguments() is recommended.

Libxfce4panel.PanelPlugin.props.comment¶

Name:: comment
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The translated description of the Libxfce4panel.PanelPlugin. This property is set during plugin construction and can’t be set twice. Plugin writer can use it to read the plugin description, but Libxfce4panel.PanelPlugin.get_comment() is recommended.

New in version 4.8.

Libxfce4panel.PanelPlugin.props.dark_mode¶

Name:: dark-mode
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Libxfce4panel.PanelPlugin shall request the Gtk dark theme variant (based on the panel setting).

New in version 4.14.

Libxfce4panel.PanelPlugin.props.display_name¶

Name:: display-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The translated display name of the Libxfce4panel.PanelPlugin. This property is set during plugin construction and can’t be set twice. Plugin writer can use it to read the plugin display name, but Libxfce4panel.PanelPlugin.get_display_name() is recommended.

Libxfce4panel.PanelPlugin.props.icon_size¶

Name:: icon-size
Type:: int
Default Value:: 0
Flags:: READABLE

The icon-size in pixels of the Libxfce4panel.PanelPlugin. Plugin writers can use it to read the plugin’s icon size, but Libxfce4panel.PanelPlugin.get_icon_size() is recommended.

New in version 4.14.

Libxfce4panel.PanelPlugin.props.mode¶

Name:: mode
Type:: Libxfce4panel.PanelPluginMode
Default Value:: Libxfce4panel.PanelPluginMode.HORIZONTAL
Flags:: READABLE

xlib.Display mode of the plugin.

New in version 4.10.

Libxfce4panel.PanelPlugin.props.nrows¶

Name:: nrows
Type:: int
Default Value:: 1
Flags:: READABLE

Number of rows the plugin is embedded on.

New in version 4.10.

Libxfce4panel.PanelPlugin.props.orientation¶

Name:: orientation
Type:: Gtk.Orientation
Default Value:: Gtk.Orientation.HORIZONTAL
Flags:: READABLE

The Gtk.Orientation of the Libxfce4panel.PanelPlugin. Plugin writer can use it to read the plugin orientation, but Libxfce4panel.PanelPlugin.get_orientation() is recommended.

Libxfce4panel.PanelPlugin.props.screen_position¶

Name:: screen-position
Type:: Libxfce4panel.ScreenPosition
Default Value:: Libxfce4panel.ScreenPosition.NONE
Flags:: READABLE

The Libxfce4panel.ScreenPosition of the Libxfce4panel.PanelPlugin. Plugin writer can use it to read the plugin’s screen position, but Libxfce4panel.PanelPlugin.get_screen_position() is recommended.

Libxfce4panel.PanelPlugin.props.shrink¶

Name:: shrink
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Libxfce4panel.PanelPlugin can shrink when there is no space left on the panel. Plugin writers can use it to read or set this property, but Libxfce4panel.PanelPlugin.set_shrink() is recommended.

New in version 4.10.

Libxfce4panel.PanelPlugin.props.size¶

Name:: size
Type:: int
Default Value:: 0
Flags:: READABLE

The size in pixels of the Libxfce4panel.PanelPlugin. Plugin writer can use it to read the plugin size, but Libxfce4panel.PanelPlugin.get_size() is recommended.

Libxfce4panel.PanelPlugin.props.small¶

Name:: small
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Libxfce4panel.PanelPlugin is small enough to fit a single row of a multi-row panel. Plugin writers can use it to read or set this property, but Libxfce4panel.PanelPlugin.set_small() is recommended.

New in version 4.10.

Libxfce4panel.PanelPlugin.props.unique_id¶

Name:: unique-id
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Unique plugin ID