XApp.StatusIconInterface¶

Implementations:: XApp.StatusIconInterfaceProxy, XApp.StatusIconInterfaceSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_button_press` (arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable, callback, *user_data)
	`call_button_press_finish` (res)
	`call_button_press_sync` (arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable)
	`call_button_release` (arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable, callback, *user_data)
	`call_button_release_finish` (res)
	`call_button_release_sync` (arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable)
	`call_scroll` (arg_delta, arg_orientation, arg_time, cancellable, callback, *user_data)
	`call_scroll_finish` (res)
	`call_scroll_sync` (arg_delta, arg_orientation, arg_time, cancellable)
	`complete_button_press` (invocation)
	`complete_button_release` (invocation)
	`complete_scroll` (invocation)

Virtual Methods¶

	`do_handle_button_press` (invocation, arg_x, arg_y, arg_button, arg_time, arg_panel_position)
	`do_handle_button_release` (invocation, arg_x, arg_y, arg_button, arg_time, arg_panel_position)
	`do_handle_scroll` (invocation, arg_delta, arg_orientation, arg_time)

Properties¶

Name	Type	Flags	Short Description
`icon-name`	`str`	r/w	IconName
`icon-size`	`int`	r/w	IconSize
`label`	`str`	r/w	Label
`metadata`	`str`	r/w	Metadata
`name`	`str`	r/w	Name
`primary-menu-is-open`	`bool`	r/w	PrimaryMenuIsOpen
`secondary-menu-is-open`	`bool`	r/w	SecondaryMenuIsOpen
`tooltip-text`	`str`	r/w	TooltipText
`visible`	`bool`	r/w	Visible

Signals¶

Name	Short Description
`handle-button-press`	Signal emitted when a remote caller is invoking the ‘ButtonPress() [gdbus-method-org-x-StatusIcon.ButtonPress]’ D-Bus method.
`handle-button-release`	Signal emitted when a remote caller is invoking the ‘ButtonRelease() [gdbus-method-org-x-StatusIcon.ButtonRelease]’ D-Bus method.
`handle-scroll`	Signal emitted when a remote caller is invoking the ‘Scroll() [gdbus-method-org-x-StatusIcon.Scroll]’ D-Bus method.

Fields¶

None

Class Details¶

class XApp.StatusIconInterface¶

Bases:: GObject.GInterface
Structure:: XApp.StatusIconInterfaceIface

Abstract interface type for the D-Bus interface ‘org.x.StatusIcon [gdbus-interface-org-x-StatusIcon.top_of_page]’.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.x.StatusIcon [gdbus-interface-org-x-StatusIcon.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the XApp.StatusIconInterface interface for a concrete class. The properties are overridden in the order they are defined.

call_button_press(arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable, callback, *user_data)¶

Parameters:

arg_x (int) – Argument to pass with the method invocation.
arg_y (int) – Argument to pass with the method invocation.
arg_button (int) – Argument to pass with the method invocation.
arg_time (int) – Argument to pass with the method invocation.
arg_panel_position (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘ButtonPress() [gdbus-method-org-x-StatusIcon.ButtonPress]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call XApp.StatusIconInterface.call_button_press_finish() to get the result of the operation.

See XApp.StatusIconInterface.call_button_press_sync() for the synchronous, blocking version of this method.

call_button_press_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to XApp.StatusIconInterface.call_button_press().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with XApp.StatusIconInterface.call_button_press().

call_button_press_sync(arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable)¶

Parameters:

arg_x (int) – Argument to pass with the method invocation.
arg_y (int) – Argument to pass with the method invocation.
arg_button (int) – Argument to pass with the method invocation.
arg_time (int) – Argument to pass with the method invocation.
arg_panel_position (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘ButtonPress() [gdbus-method-org-x-StatusIcon.ButtonPress]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See XApp.StatusIconInterface.call_button_press() for the asynchronous version of this method.

call_button_release(arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable, callback, *user_data)¶

Parameters:

arg_x (int) – Argument to pass with the method invocation.
arg_y (int) – Argument to pass with the method invocation.
arg_button (int) – Argument to pass with the method invocation.
arg_time (int) – Argument to pass with the method invocation.
arg_panel_position (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘ButtonRelease() [gdbus-method-org-x-StatusIcon.ButtonRelease]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call XApp.StatusIconInterface.call_button_release_finish() to get the result of the operation.

See XApp.StatusIconInterface.call_button_release_sync() for the synchronous, blocking version of this method.

call_button_release_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to XApp.StatusIconInterface.call_button_release().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with XApp.StatusIconInterface.call_button_release().

call_button_release_sync(arg_x, arg_y, arg_button, arg_time, arg_panel_position, cancellable)¶

Parameters:

arg_x (int) – Argument to pass with the method invocation.
arg_y (int) – Argument to pass with the method invocation.
arg_button (int) – Argument to pass with the method invocation.
arg_time (int) – Argument to pass with the method invocation.
arg_panel_position (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘ButtonRelease() [gdbus-method-org-x-StatusIcon.ButtonRelease]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See XApp.StatusIconInterface.call_button_release() for the asynchronous version of this method.

call_scroll(arg_delta, arg_orientation, arg_time, cancellable, callback, *user_data)¶

Parameters:

arg_delta (int) – Argument to pass with the method invocation.
arg_orientation (int) – Argument to pass with the method invocation.
arg_time (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Scroll() [gdbus-method-org-x-StatusIcon.Scroll]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call XApp.StatusIconInterface.call_scroll_finish() to get the result of the operation.

See XApp.StatusIconInterface.call_scroll_sync() for the synchronous, blocking version of this method.

call_scroll_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to XApp.StatusIconInterface.call_scroll().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with XApp.StatusIconInterface.call_scroll().

call_scroll_sync(arg_delta, arg_orientation, arg_time, cancellable)¶

Parameters:

arg_delta (int) – Argument to pass with the method invocation.
arg_orientation (int) – Argument to pass with the method invocation.
arg_time (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘Scroll() [gdbus-method-org-x-StatusIcon.Scroll]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See XApp.StatusIconInterface.call_scroll() for the asynchronous version of this method.

complete_button_press(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘ButtonPress() [gdbus-method-org-x-StatusIcon.ButtonPress]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_button_release(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘ButtonRelease() [gdbus-method-org-x-StatusIcon.ButtonRelease]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_scroll(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Scroll() [gdbus-method-org-x-StatusIcon.Scroll]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

do_handle_button_press(invocation, arg_x, arg_y, arg_button, arg_time, arg_panel_position) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_x (int) –
arg_y (int) –
arg_button (int) –
arg_time (int) –
arg_panel_position (int) –

Return type:

bool

do_handle_button_release(invocation, arg_x, arg_y, arg_button, arg_time, arg_panel_position) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_x (int) –
arg_y (int) –
arg_button (int) –
arg_time (int) –
arg_panel_position (int) –

Return type:

bool

do_handle_scroll(invocation, arg_delta, arg_orientation, arg_time) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_delta (int) –
arg_orientation (int) –
arg_time (int) –

Return type:

bool

Signal Details¶

XApp.StatusIconInterface.signals.handle_button_press(status_icon_interface, invocation, arg_x, arg_y, arg_button, arg_time, arg_panel_position)¶

Signal Name:

handle-button-press

Flags:

RUN_LAST

Parameters:

status_icon_interface (XApp.StatusIconInterface) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_x (int) – Argument passed by remote caller.
arg_y (int) – Argument passed by remote caller.
arg_button (int) – Argument passed by remote caller.
arg_time (int) – Argument passed by remote caller.
arg_panel_position (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘ButtonPress() [gdbus-method-org-x-StatusIcon.ButtonPress]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call XApp.StatusIconInterface.complete_button_press() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

XApp.StatusIconInterface.signals.handle_button_release(status_icon_interface, invocation, arg_x, arg_y, arg_button, arg_time, arg_panel_position)¶

Signal Name:

handle-button-release

Flags:

RUN_LAST

Parameters:

status_icon_interface (XApp.StatusIconInterface) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_x (int) – Argument passed by remote caller.
arg_y (int) – Argument passed by remote caller.
arg_button (int) – Argument passed by remote caller.
arg_time (int) – Argument passed by remote caller.
arg_panel_position (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘ButtonRelease() [gdbus-method-org-x-StatusIcon.ButtonRelease]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call XApp.StatusIconInterface.complete_button_release() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

XApp.StatusIconInterface.signals.handle_scroll(status_icon_interface, invocation, arg_delta, arg_orientation, arg_time)¶

Signal Name:

handle-scroll

Flags:

RUN_LAST

Parameters:

status_icon_interface (XApp.StatusIconInterface) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_delta (int) – Argument passed by remote caller.
arg_orientation (int) – Argument passed by remote caller.
arg_time (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Scroll() [gdbus-method-org-x-StatusIcon.Scroll]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call XApp.StatusIconInterface.complete_scroll() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Property Details¶

XApp.StatusIconInterface.props.icon_name¶

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

Represents the D-Bus property ‘“IconName” [gdbus-property-org-x-StatusIcon.IconName]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

XApp.StatusIconInterface.props.icon_size¶

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

Represents the D-Bus property ‘“IconSize” [gdbus-property-org-x-StatusIcon.IconSize]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

XApp.StatusIconInterface.props.label¶

Name:: label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Label” [gdbus-property-org-x-StatusIcon.Label]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

XApp.StatusIconInterface.props.metadata¶

Name:: metadata
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Metadata” [gdbus-property-org-x-StatusIcon.Metadata]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

XApp.StatusIconInterface.props.name¶

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

Represents the D-Bus property ‘“Name” [gdbus-property-org-x-StatusIcon.Name]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

XApp.StatusIconInterface.props.primary_menu_is_open¶

Name:: primary-menu-is-open
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“PrimaryMenuIsOpen” [gdbus-property-org-x-StatusIcon.PrimaryMenuIsOpen]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

XApp.StatusIconInterface.props.secondary_menu_is_open¶

Name:: secondary-menu-is-open
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“SecondaryMenuIsOpen” [gdbus-property-org-x-StatusIcon.SecondaryMenuIsOpen]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

XApp.StatusIconInterface.props.tooltip_text¶

Name:: tooltip-text
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“TooltipText” [gdbus-property-org-x-StatusIcon.TooltipText]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

XApp.StatusIconInterface.props.visible¶

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

Represents the D-Bus property ‘“Visible” [gdbus-property-org-x-StatusIcon.Visible]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.