| Top |  |
 |
 |
 |
Functions
Description
The XAppFavorites class allows applications display frequently-used files and provide a safe mechanism for launching them.
A list of XAppFavoriteInfos can be retrieved in full, or only for specific mimetypes.
A favorites uri scheme is also available if the xapp gtk3 module is loaded and this also makes the uri available as a shortcut in file dialogs.
XAppFavorites are new for 2.0
Functions
xapp_favorites_get_default ()
XAppFavorites *
xapp_favorites_get_default (void);
Returns the XAppFavorites instance.
Since: 2.0
xapp_favorites_get_favorites ()
GList * xapp_favorites_get_favorites (XAppFavorites *favorites,const gchar * const *mimetypes);
Gets a list of all favorites. If mimetype is not NULL, the list will
contain only favorites with that mimetype.
Parameters
favorites |
The XAppFavorites |
|
mimetypes |
The mimetypes to filter by for results. |
[nullable][array zero-terminated=1] |
Returns
a list of XAppFavoriteInfos. Free the list with g_list_free, free elements with xapp_favorite_info_free.
[element-type XAppFavoriteInfo][transfer full]
Since: 2.0
xapp_favorites_get_n_favorites ()
gint
xapp_favorites_get_n_favorites (XAppFavorites *favorites);
Since: 2.0
xapp_favorites_find_by_display_name ()
XAppFavoriteInfo * xapp_favorites_find_by_display_name (XAppFavorites *favorites,const gchar *display_name);
Looks for an XAppFavoriteInfo that corresponds to display_name
.
Parameters
favorites |
The XAppFavorites |
|
display_name |
The display name to lookup info for. |
[not nullable] |
Returns
an XAppFavoriteInfo or NULL if one was not found. This is owned by the favorites manager and should not be freed.
[transfer none]
Since: 2.0
xapp_favorites_find_by_uri ()
XAppFavoriteInfo * xapp_favorites_find_by_uri (XAppFavorites *favorites,const gchar *uri);
Looks for an XAppFavoriteInfo that corresponds to uri
.
Returns
an XAppFavoriteInfo or NULL if one was not found. This is owned by the favorites manager and should not be freed.
[transfer none]
Since: 2.0
xapp_favorites_add ()
void xapp_favorites_add (XAppFavorites *favorites,const gchar *uri);
Adds a new favorite. If the uri already exists, this does nothing.
Since: 2.0
xapp_favorites_remove ()
void xapp_favorites_remove (XAppFavorites *favorites,const gchar *uri);
Removes a favorite from the list.
Since: 2.0
xapp_favorites_launch ()
void xapp_favorites_launch (XAppFavorites *favorites,const gchar *uri,guint32 timestamp);
Opens a favorite in its default app.
Parameters
favorites |
The XAppFavorites |
|
uri |
The uri for the favorite to launch |
|
timestamp |
The timestamp from an event or 0 |
Since: 2.0
xapp_favorites_rename ()
void xapp_favorites_rename (XAppFavorites *favorites,const gchar *old_uri,const gchar *new_uri);
Removes old_uri and adds new_uri. This is mainly for file managers to use as a convenience instead of add/remove, and guarantees the result, without having to worry about multiple dbus calls (gsettings).
Since: 2.0
xapp_favorite_info_copy ()
XAppFavoriteInfo *
xapp_favorite_info_copy (const XAppFavoriteInfo *info);
Makes an exact copy of an existing XAppFavoriteInfo.
xapp_favorite_info_free ()
void
xapp_favorite_info_free (XAppFavoriteInfo *info);
Destroys the XAppFavoriteInfo.
Since 2.0
XAppFavoritesItemSelectedCallback ()
void (*XAppFavoritesItemSelectedCallback) (XAppFavorites *favorites,const gchar *uri,gpointer user_data);
xapp_favorites_create_menu ()
GtkWidget * xapp_favorites_create_menu (XAppFavorites *favorites,const gchar **mimetypes,XAppFavoritesItemSelectedCallback callback,gpointer user_data,GDestroyNotify func);
Generates a GtkMenu widget populated with favorites. The callback will be called when a menu item has been activated, and will include the uri of the respective item.
Parameters
favorites |
The XAppFavorites instance. |
|
mimetypes |
The mimetypes to filter for, or NULL to include all favorites. |
[nullable] |
callback |
(closure user_data): The callback to use when a menu item has been selected. |
[scope notified] |
user_data |
The data to pass to the callback. |
[closure] |
func |
Destroy function for user_data |
Returns
a new GtkMenu populated with a list of favorites, or NULL if there are no favorites.
[transfer full]
Since: 2.0
xapp_favorites_create_actions ()
GList * xapp_favorites_create_actions (XAppFavorites *favorites,const gchar **mimetypes);
Generates a list of favorite GtkActions.
Parameters
favorites |
The XAppFavorites instance. |
|
mimetypes |
The mimetypes to filter for, or NULL to include all favorites. |
[nullable] |
Returns
a new GtkActionGroup populated with a list of favorites, or NULL if there are no favorites.
[element-type Gtk.Action][transfer full]
Since: 2.0
Types and Values
struct XAppFavoriteInfo
struct XAppFavoriteInfo {
gchar *uri;
gchar *display_name;
gchar *cached_mimetype;
};
Information related to a single favorite file.
Members
gchar * |
The uri to the favorite file. |
|
gchar * |
The name for use when displaying the item. This may not exactly match the filename if there are files with the same name but in different folders. |
|
gchar * |
The mimetype calculated for the uri when it was added to favorites. |
Signal Details
The “changed” signal
void user_function (XAppFavorites *xappfavorites, gpointer user_data)
Notifies when the favorites list has changed.
Flags: Action
| Top | |
|
|
|
XAppGtkWindowXAppGtkWindow — A subclass of |
Functions
| GtkWidget * | xapp_gtk_window_new () |
| void | xapp_gtk_window_set_icon_name () |
| void | xapp_gtk_window_set_icon_from_file () |
| void | xapp_gtk_window_set_progress () |
| void | xapp_gtk_window_set_progress_pulse () |
| void | xapp_set_window_icon_name () |
| void | xapp_set_window_icon_from_file () |
| void | xapp_set_window_progress () |
| void | xapp_set_window_progress_pulse () |
| void | xapp_set_xid_icon_name () |
| void | xapp_set_xid_icon_from_file () |
| void | xapp_set_xid_progress () |
| void | xapp_set_xid_progress_pulse () |
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkWindow ╰── XAppGtkWindow ╰── XAppIconChooserDialog
Description
This widget is a simple subclass of GtkWindow that provides the following additional capabilities:
Ability to set an icon name or icon file path for the window manager to make use of, rather than relying on a desktop file or fixed-size window- backed icon that Gtk normally generates. The window manager must support the NET_WM_XAPP_ICON_NAME hint.
Ability to send progress info to the window manager, in the form of an integer, 0-100, which can then be used to display this progress in some manner in a task manager or window list. The window manager must support the NET_WM_XAPP_PROGRESS hint.
Ability to signal a 'pulsing' progress state, of potentially indeterminate value, in the form of a boolean, which can be passed on to a window list. The window manager must support the NET_WM_XAPP_PROGRESS_PULSE hint
Wrappers:
Also provided are corresponding wrapper functions for normal GtkWindows. They are not class methods - they are called with the target widget as their first argument.
For example:
win = Gtk.Window() XApp.set_window_icon_name(win, "foobar")
These functions mirror those of the XAppGtkWindow class, but allow the properties to work with normal GtkWindows and descendants of GtkWindow.
Functions
xapp_gtk_window_new ()
GtkWidget *
xapp_gtk_window_new (GtkWindowType type);
Creates a new XAppGtkWindow of type type
. See gtk_window_new()
for more details.
xapp_gtk_window_set_icon_name ()
void xapp_gtk_window_set_icon_name (XAppGtkWindow *window,const gchar *icon_name);
Sets the icon name hint for a window manager (like muffin) to make
available when applications want to change their icons during runtime
without having to resort to the internal low-res pixbufs that GdkWindow
sets on the client side. This also chains up and calls GtkWindow.set_icon_name
for convenience and compatibility. Set to NULL to unset.
Parameters
window |
The XAppGtkWindow to set the icon name for |
|
icon_name |
The icon name or path to set, or |
[nullable] |
xapp_gtk_window_set_icon_from_file ()
void xapp_gtk_window_set_icon_from_file (XAppGtkWindow *window,const gchar *file_name,GError **error);
Sets the icon name hint for a window manager (like muffin) to make
available when applications want to change their icons during runtime
without having to resort to the internal low-res pixbufs that GdkWindow
sets on the client side. This also chains up and calls GtkWindow.set_icon_from_file
for convenience and compatibility. Set to NULL to unset.
Parameters
window |
The XAppGtkWindow to set the icon name for |
|
file_name |
The icon path to set, or |
[nullable] |
error |
An error to set if something goes wrong. |
[nullable] |
xapp_gtk_window_set_progress ()
void xapp_gtk_window_set_progress (XAppGtkWindow *window,gint progress);
Sets the progress hint for a window manager (like muffin) to make available when applications want to display the application's progress in some operation. The value sent to the WM will be clamped to between 0 and 100.
Note: If a window will stick around after progress is complete, you will probaby need to set progress to 0 to remove any progress effects on taskbars and window lists.
Setting progress will also cancel the 'pulsing' flag on the window as well, if it has been set.
xapp_gtk_window_set_progress_pulse ()
void xapp_gtk_window_set_progress_pulse (XAppGtkWindow *window,gboolean pulse);
Sets the progress pulse hint hint for a window manager (like muffin) to make available when applications want to display indeterminate or ongoing progress in a task manager.
Note: If a window will stick around after progress is complete, you will probaby need to set progress to 0 to remove any progress effects on taskbars and window lists. This will also remove the pulse state, if it is set.
Setting an explicit progress value will unset this flag.
Parameters
window |
The XAppGtkWindow to set the progress for |
|
pulse |
Whether to have pulsing set or not. |
xapp_set_window_icon_name ()
void xapp_set_window_icon_name (GtkWindow *window,const gchar *icon_name);
Sets the icon name hint for a window manager (like muffin) to make
available when applications want to change their icons during runtime
without having to resort to the internal low-res pixbufs that GdkWindow
sets on the client side. This is a function, not a method, for taking
advantage of this feature with descendants of GtkWindows, such as
GtkDialogs. Sets gtk_window_set_icon_name as well, to avoid needing
to have two calls each time. Set to NULL to unset.
xapp_set_window_icon_from_file ()
void xapp_set_window_icon_from_file (GtkWindow *window,const gchar *file_name,GError **error);
Sets the icon name hint for a window manager (like muffin) to make
available when applications want to change their icons during runtime
without having to resort to the internal low-res pixbufs that GdkWindow
sets on the client side. This also chains up and calls GtkWindow.set_icon_from_file
for convenience and compatibility. Set to NULL to unset.
xapp_set_window_progress ()
void xapp_set_window_progress (GtkWindow *window,gint progress);
Sets the progress hint for a window manager (like muffin) to make available when applications want to display the application's progress in some operation. The value sent to the WM will be clamped to between 0 and 100.
Note: If a window will stick around after progress is complete, you will probaby need to set progress to 0 to remove any progress effects on taskbars and window lists.
Setting progress will also cancel the 'pulsing' flag on the window as well, if it has been set.
xapp_set_window_progress_pulse ()
void xapp_set_window_progress_pulse (GtkWindow *window,gboolean pulse);
Sets the progress pulse hint hint for a window manager (like muffin) to make available when applications want to display indeterminate or ongoing progress in a task manager.
Note: If a window will stick around after progress is complete, you will probaby need to set progress to 0 to remove any progress effects on taskbars and window lists. This will also remove the pulse state, if it is set.
Setting an explicit progress value will unset this flag.
xapp_set_xid_icon_name ()
void xapp_set_xid_icon_name (gulong xid,const gchar *icon_name);
Sets the icon name hint for a window manager (like muffin) to make
available when applications want to change their icons during runtime
without having to resort to the internal low-res pixbufs that GdkWindow
sets on the client side. This is a function, not a method, for applying
the icon name property for a given (possibly foreign) window, by passing
the window's XID. Set to NULL to unset.
Parameters
xid |
The Window to set the icon name for |
|
icon_name |
The icon name to set, or |
[nullable] |
xapp_set_xid_icon_from_file ()
void xapp_set_xid_icon_from_file (gulong xid,const gchar *file_name);
Sets the icon name hint for a window manager (like muffin) to make
available when applications want to change their icons during runtime
without having to resort to the internal low-res pixbufs that GdkWindow
sets on the client side. This is a function, not a method, for applying
the icon name property for a given (possibly foreign) window, by passing
the window's XID. Set to NULL to unset.
Parameters
xid |
The Window to set the icon name for |
|
file_name |
The icon path to set, or |
[nullable] |
xapp_set_xid_progress ()
void xapp_set_xid_progress (gulong xid,gint progress);
Sets the progress hint for a window manager (like muffin) to make available when applications want to display the application's progress in some operation. The value sent to the WM will be clamped to between 0 and 100.
Setting progress will also cancel the 'pulsing' flag on the window as well, if it has been set.
Note: If a window will stick around after progress is complete, you will probaby need to set progress to 0 to remove any progress effects on taskbars and window lists.
This is a function, not a method, for applying the progress property for a given (possibly foreign) window, by passing the window's XID.
xapp_set_xid_progress_pulse ()
void xapp_set_xid_progress_pulse (gulong xid,gboolean pulse);
Sets the progress pulse hint hint for a window manager (like muffin) to make available when applications want to display indeterminate or ongoing progress in a task manager.
Note: If a window will stick around after progress is complete, you will probaby need to set progress to 0 to remove any progress effects on taskbars and window lists.
Setting an explicit progress value will unset this flag.
| Top | |
|
|
|
Functions
Properties
| XAppStatusIconInterface * | status-icon-interface | Read / Write |
| char * | icon-name | Read / Write |
| int | icon-size | Read / Write |
| char * | label | Read / Write |
| char * | metadata | Read / Write |
| char * | name | Read / Write |
| gboolean | primary-menu-is-open | Read / Write |
| gboolean | secondary-menu-is-open | Read / Write |
| char * | tooltip-text | Read / Write |
| gboolean | visible | Read / Write |
Object Hierarchy
GInterface ├── XAppObject ╰── XAppStatusIconInterface GObject ├── GDBusInterfaceSkeleton │ ╰── XAppStatusIconInterfaceSkeleton ├── GDBusObjectManagerClient │ ╰── XAppObjectManagerClient ├── GDBusObjectProxy │ ╰── XAppObjectProxy ├── GDBusObjectSkeleton │ ╰── XAppObjectSkeleton ╰── GDBusProxy ╰── XAppStatusIconInterfaceProxy
Functions
xapp_status_icon_interface_interface_info ()
GDBusInterfaceInfo *
xapp_status_icon_interface_interface_info
(void);
Gets a machine-readable description of the org.x.StatusIcon D-Bus interface.
xapp_status_icon_interface_override_properties ()
guint xapp_status_icon_interface_override_properties (GObjectClass *klass,guint property_id_begin);
Overrides all GObject properties in the XAppStatusIconInterface interface for a concrete class. The properties are overridden in the order they are defined.
Parameters
klass |
The class structure for a GObject derived class. |
|
property_id_begin |
The property id to assign to the first overridden property. |
xapp_status_icon_interface_complete_button_press ()
void xapp_status_icon_interface_complete_button_press (XAppStatusIconInterface *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the ButtonPress()g_dbus_method_invocation_return_error() or similar.
This method will free invocation
, you cannot use it afterwards.
xapp_status_icon_interface_complete_button_release ()
void xapp_status_icon_interface_complete_button_release (XAppStatusIconInterface *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the ButtonRelease()g_dbus_method_invocation_return_error() or similar.
This method will free invocation
, you cannot use it afterwards.
xapp_status_icon_interface_complete_scroll ()
void xapp_status_icon_interface_complete_scroll (XAppStatusIconInterface *object,GDBusMethodInvocation *invocation);
Helper function used in service implementations to finish handling invocations of the Scroll()g_dbus_method_invocation_return_error() or similar.
This method will free invocation
, you cannot use it afterwards.
xapp_status_icon_interface_call_button_press ()
void xapp_status_icon_interface_call_button_press (XAppStatusIconInterface *proxy,gint arg_x,gint arg_y,guint arg_button,guint arg_time,gint arg_panel_position,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the ButtonPress()proxy
.
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 g_main_context_push_thread_default()).
You can then call xapp_status_icon_interface_call_button_press_finish() to get the result of the operation.
See xapp_status_icon_interface_call_button_press_sync() for the synchronous, blocking version of this method.
Parameters
proxy |
||
arg_x |
Argument to pass with the method invocation. |
|
arg_y |
Argument to pass with the method invocation. |
|
arg_button |
Argument to pass with the method invocation. |
|
arg_time |
Argument to pass with the method invocation. |
|
arg_panel_position |
Argument to pass with the method invocation. |
|
cancellable |
A GCancellable or |
[nullable] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or |
|
user_data |
User data to pass to |
xapp_status_icon_interface_call_button_press_finish ()
gboolean xapp_status_icon_interface_call_button_press_finish (XAppStatusIconInterface *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with xapp_status_icon_interface_call_button_press().
Parameters
proxy |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
xapp_status_icon_interface_call_button_press_sync ()
gboolean xapp_status_icon_interface_call_button_press_sync (XAppStatusIconInterface *proxy,gint arg_x,gint arg_y,guint arg_button,guint arg_time,gint arg_panel_position,GCancellable *cancellable,GError **error);
Synchronously invokes the ButtonPress()proxy
. The calling thread is blocked until a reply is received.
See xapp_status_icon_interface_call_button_press() for the asynchronous version of this method.
Parameters
proxy |
||
arg_x |
Argument to pass with the method invocation. |
|
arg_y |
Argument to pass with the method invocation. |
|
arg_button |
Argument to pass with the method invocation. |
|
arg_time |
Argument to pass with the method invocation. |
|
arg_panel_position |
Argument to pass with the method invocation. |
|
cancellable |
A GCancellable or |
[nullable] |
error |
Return location for error or |
xapp_status_icon_interface_call_button_release ()
void xapp_status_icon_interface_call_button_release (XAppStatusIconInterface *proxy,gint arg_x,gint arg_y,guint arg_button,guint arg_time,gint arg_panel_position,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the ButtonRelease()proxy
.
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 g_main_context_push_thread_default()).
You can then call xapp_status_icon_interface_call_button_release_finish() to get the result of the operation.
See xapp_status_icon_interface_call_button_release_sync() for the synchronous, blocking version of this method.
Parameters
proxy |
||
arg_x |
Argument to pass with the method invocation. |
|
arg_y |
Argument to pass with the method invocation. |
|
arg_button |
Argument to pass with the method invocation. |
|
arg_time |
Argument to pass with the method invocation. |
|
arg_panel_position |
Argument to pass with the method invocation. |
|
cancellable |
A GCancellable or |
[nullable] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or |
|
user_data |
User data to pass to |
xapp_status_icon_interface_call_button_release_finish ()
gboolean xapp_status_icon_interface_call_button_release_finish (XAppStatusIconInterface *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with xapp_status_icon_interface_call_button_release().
Parameters
proxy |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
xapp_status_icon_interface_call_button_release_sync ()
gboolean xapp_status_icon_interface_call_button_release_sync (XAppStatusIconInterface *proxy,gint arg_x,gint arg_y,guint arg_button,guint arg_time,gint arg_panel_position,GCancellable *cancellable,GError **error);
Synchronously invokes the ButtonRelease()proxy
. The calling thread is blocked until a reply is received.
See xapp_status_icon_interface_call_button_release() for the asynchronous version of this method.
Parameters
proxy |
||
arg_x |
Argument to pass with the method invocation. |
|
arg_y |
Argument to pass with the method invocation. |
|
arg_button |
Argument to pass with the method invocation. |
|
arg_time |
Argument to pass with the method invocation. |
|
arg_panel_position |
Argument to pass with the method invocation. |
|
cancellable |
A GCancellable or |
[nullable] |
error |
Return location for error or |
xapp_status_icon_interface_call_scroll ()
void xapp_status_icon_interface_call_scroll (XAppStatusIconInterface *proxy,gint arg_delta,gint arg_orientation,guint arg_time,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously invokes the Scroll()proxy
.
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 g_main_context_push_thread_default()).
You can then call xapp_status_icon_interface_call_scroll_finish() to get the result of the operation.
See xapp_status_icon_interface_call_scroll_sync() for the synchronous, blocking version of this method.
Parameters
proxy |
||
arg_delta |
Argument to pass with the method invocation. |
|
arg_orientation |
Argument to pass with the method invocation. |
|
arg_time |
Argument to pass with the method invocation. |
|
cancellable |
A GCancellable or |
[nullable] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or |
|
user_data |
User data to pass to |
xapp_status_icon_interface_call_scroll_finish ()
gboolean xapp_status_icon_interface_call_scroll_finish (XAppStatusIconInterface *proxy,GAsyncResult *res,GError **error);
Finishes an operation started with xapp_status_icon_interface_call_scroll().
Parameters
proxy |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
xapp_status_icon_interface_call_scroll_sync ()
gboolean xapp_status_icon_interface_call_scroll_sync (XAppStatusIconInterface *proxy,gint arg_delta,gint arg_orientation,guint arg_time,GCancellable *cancellable,GError **error);
Synchronously invokes the Scroll()proxy
. The calling thread is blocked until a reply is received.
See xapp_status_icon_interface_call_scroll() for the asynchronous version of this method.
Parameters
proxy |
||
arg_delta |
Argument to pass with the method invocation. |
|
arg_orientation |
Argument to pass with the method invocation. |
|
arg_time |
Argument to pass with the method invocation. |
|
cancellable |
A GCancellable or |
[nullable] |
error |
Return location for error or |
xapp_status_icon_interface_get_name ()
const gchar *
xapp_status_icon_interface_get_name (XAppStatusIconInterface *object);
Gets the value of the "Name" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object
was constructed. Use xapp_status_icon_interface_dup_name() if on another thread.
[skip]
Returns
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object
.
[transfer none][nullable]
xapp_status_icon_interface_dup_name ()
gchar *
xapp_status_icon_interface_dup_name (XAppStatusIconInterface *object);
Gets a copy of the "Name" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_name ()
void xapp_status_icon_interface_set_name (XAppStatusIconInterface *object,const gchar *value);
Sets the "Name" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_get_icon_name ()
const gchar *
xapp_status_icon_interface_get_icon_name
(XAppStatusIconInterface *object);
Gets the value of the "IconName" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object
was constructed. Use xapp_status_icon_interface_dup_icon_name() if on another thread.
[skip]
Returns
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object
.
[transfer none][nullable]
xapp_status_icon_interface_dup_icon_name ()
gchar *
xapp_status_icon_interface_dup_icon_name
(XAppStatusIconInterface *object);
Gets a copy of the "IconName" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_icon_name ()
void xapp_status_icon_interface_set_icon_name (XAppStatusIconInterface *object,const gchar *value);
Sets the "IconName" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_get_tooltip_text ()
const gchar *
xapp_status_icon_interface_get_tooltip_text
(XAppStatusIconInterface *object);
Gets the value of the "TooltipText" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object
was constructed. Use xapp_status_icon_interface_dup_tooltip_text() if on another thread.
[skip]
Returns
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object
.
[transfer none][nullable]
xapp_status_icon_interface_dup_tooltip_text ()
gchar *
xapp_status_icon_interface_dup_tooltip_text
(XAppStatusIconInterface *object);
Gets a copy of the "TooltipText" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_tooltip_text ()
void xapp_status_icon_interface_set_tooltip_text (XAppStatusIconInterface *object,const gchar *value);
Sets the "TooltipText" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_get_label ()
const gchar *
xapp_status_icon_interface_get_label (XAppStatusIconInterface *object);
Gets the value of the "Label" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object
was constructed. Use xapp_status_icon_interface_dup_label() if on another thread.
[skip]
Returns
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object
.
[transfer none][nullable]
xapp_status_icon_interface_dup_label ()
gchar *
xapp_status_icon_interface_dup_label (XAppStatusIconInterface *object);
Gets a copy of the "Label" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_label ()
void xapp_status_icon_interface_set_label (XAppStatusIconInterface *object,const gchar *value);
Sets the "Label" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_get_visible ()
gboolean
xapp_status_icon_interface_get_visible
(XAppStatusIconInterface *object);
Gets the value of the "Visible" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_visible ()
void xapp_status_icon_interface_set_visible (XAppStatusIconInterface *object,gboolean value);
Sets the "Visible" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_get_icon_size ()
gint
xapp_status_icon_interface_get_icon_size
(XAppStatusIconInterface *object);
Gets the value of the "IconSize" D-Bus property.
Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_icon_size ()
void xapp_status_icon_interface_set_icon_size (XAppStatusIconInterface *object,gint value);
Sets the "IconSize" D-Bus property to value
.
Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_get_primary_menu_is_open ()
gboolean
xapp_status_icon_interface_get_primary_menu_is_open
(XAppStatusIconInterface *object);
Gets the value of the "PrimaryMenuIsOpen" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_primary_menu_is_open ()
void xapp_status_icon_interface_set_primary_menu_is_open (XAppStatusIconInterface *object,gboolean value);
Sets the "PrimaryMenuIsOpen" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_get_secondary_menu_is_open ()
gboolean
xapp_status_icon_interface_get_secondary_menu_is_open
(XAppStatusIconInterface *object);
Gets the value of the "SecondaryMenuIsOpen" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_secondary_menu_is_open ()
void xapp_status_icon_interface_set_secondary_menu_is_open (XAppStatusIconInterface *object,gboolean value);
Sets the "SecondaryMenuIsOpen" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_get_metadata ()
const gchar *
xapp_status_icon_interface_get_metadata
(XAppStatusIconInterface *object);
Gets the value of the "Metadata" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object
was constructed. Use xapp_status_icon_interface_dup_metadata() if on another thread.
[skip]
Returns
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object
.
[transfer none][nullable]
xapp_status_icon_interface_dup_metadata ()
gchar *
xapp_status_icon_interface_dup_metadata
(XAppStatusIconInterface *object);
Gets a copy of the "Metadata" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
[skip]
xapp_status_icon_interface_set_metadata ()
void xapp_status_icon_interface_set_metadata (XAppStatusIconInterface *object,const gchar *value);
Sets the "Metadata" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
[skip]
xapp_status_icon_interface_proxy_new ()
void xapp_status_icon_interface_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously creates a proxy for the D-Bus interface org.x.StatusIcon. See g_dbus_proxy_new() for more details.
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 g_main_context_push_thread_default()).
You can then call xapp_status_icon_interface_proxy_new_finish() to get the result of the operation.
See xapp_status_icon_interface_proxy_new_sync() for the synchronous, blocking version of this constructor.
Parameters
connection |
||
flags |
Flags from the GDBusProxyFlags enumeration. |
|
name |
A bus name (well-known or unique) or |
[nullable] |
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
callback |
A GAsyncReadyCallback to call when the request is satisfied. |
|
user_data |
User data to pass to |
xapp_status_icon_interface_proxy_new_finish ()
XAppStatusIconInterface * xapp_status_icon_interface_proxy_new_finish (GAsyncResult *res,GError **error);
Finishes an operation started with xapp_status_icon_interface_proxy_new().
Parameters
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
Returns
The constructed proxy object or NULL if error
is set.
[transfer full][type XAppStatusIconInterfaceProxy]
xapp_status_icon_interface_proxy_new_sync ()
XAppStatusIconInterface * xapp_status_icon_interface_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Synchronously creates a proxy for the D-Bus interface org.x.StatusIcon. See g_dbus_proxy_new_sync() for more details.
The calling thread is blocked until a reply is received.
See xapp_status_icon_interface_proxy_new() for the asynchronous version of this constructor.
Parameters
connection |
||
flags |
Flags from the GDBusProxyFlags enumeration. |
|
name |
A bus name (well-known or unique) or |
[nullable] |
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
error |
Return location for error or |
Returns
The constructed proxy object or NULL if error
is set.
[transfer full][type XAppStatusIconInterfaceProxy]
xapp_status_icon_interface_proxy_new_for_bus ()
void xapp_status_icon_interface_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Like xapp_status_icon_interface_proxy_new() but takes a GBusType instead of a GDBusConnection.
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 g_main_context_push_thread_default()).
You can then call xapp_status_icon_interface_proxy_new_for_bus_finish() to get the result of the operation.
See xapp_status_icon_interface_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.
Parameters
bus_type |
A GBusType. |
|
flags |
Flags from the GDBusProxyFlags enumeration. |
|
name |
A bus name (well-known or unique). |
|
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
callback |
A GAsyncReadyCallback to call when the request is satisfied. |
|
user_data |
User data to pass to |
xapp_status_icon_interface_proxy_new_for_bus_finish ()
XAppStatusIconInterface * xapp_status_icon_interface_proxy_new_for_bus_finish (GAsyncResult *res,GError **error);
Finishes an operation started with xapp_status_icon_interface_proxy_new_for_bus().
Parameters
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
Returns
The constructed proxy object or NULL if error
is set.
[transfer full][type XAppStatusIconInterfaceProxy]
xapp_status_icon_interface_proxy_new_for_bus_sync ()
XAppStatusIconInterface * xapp_status_icon_interface_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Like xapp_status_icon_interface_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See xapp_status_icon_interface_proxy_new_for_bus() for the asynchronous version of this constructor.
Parameters
bus_type |
A GBusType. |
|
flags |
Flags from the GDBusProxyFlags enumeration. |
|
name |
A bus name (well-known or unique). |
|
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
error |
Return location for error or |
Returns
The constructed proxy object or NULL if error
is set.
[transfer full][type XAppStatusIconInterfaceProxy]
xapp_status_icon_interface_skeleton_new ()
XAppStatusIconInterface *
xapp_status_icon_interface_skeleton_new
(void);
Creates a skeleton object for the D-Bus interface org.x.StatusIcon.
xapp_object_get_status_icon_interface ()
XAppStatusIconInterface *
xapp_object_get_status_icon_interface (XAppObject *object);
Gets the XAppStatusIconInterface instance for the D-Bus interface org.x.StatusIcon on object
, if any.
Returns
A XAppStatusIconInterface that must be freed with g_object_unref() or NULL if object
does not implement the interface.
[transfer full][nullable]
xapp_object_peek_status_icon_interface ()
XAppStatusIconInterface *
xapp_object_peek_status_icon_interface
(XAppObject *object);
Like xapp_object_get_status_icon_interface() but doesn't increase the reference count on the returned object.
It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object
is running.
[skip]
Returns
A XAppStatusIconInterface or NULL if object
does not implement the interface. Do not free the returned object, it is owned by object
.
[transfer none][nullable]
xapp_object_proxy_new ()
XAppObjectProxy * xapp_object_proxy_new (GDBusConnection *connection,const gchar *object_path);
Creates a new proxy object.
xapp_object_skeleton_new ()
XAppObjectSkeleton *
xapp_object_skeleton_new (const gchar *object_path);
Creates a new skeleton object.
xapp_object_skeleton_set_status_icon_interface ()
void xapp_object_skeleton_set_status_icon_interface (XAppObjectSkeleton *object,XAppStatusIconInterface *interface_);
Sets the XAppStatusIconInterface instance for the D-Bus interface org.x.StatusIcon on object
.
xapp_object_manager_client_get_proxy_type ()
GType xapp_object_manager_client_get_proxy_type (GDBusObjectManagerClient *manager,const gchar *object_path,const gchar *interface_name,gpointer user_data);
A GDBusProxyTypeFunc that maps interface_name
to the generated GDBusObjectProxy derived and GDBusProxy derived types.
Parameters
Returns
A GDBusProxy derived GType if interface_name
is not NULL, otherwise the GType for XAppObjectProxy.
xapp_object_manager_client_new ()
void xapp_object_manager_client_new (GDBusConnection *connection,GDBusObjectManagerClientFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously creates GDBusObjectManagerClient using xapp_object_manager_client_get_proxy_type() as the GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details.
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 g_main_context_push_thread_default()).
You can then call xapp_object_manager_client_new_finish() to get the result of the operation.
See xapp_object_manager_client_new_sync() for the synchronous, blocking version of this constructor.
Parameters
connection |
||
flags |
Flags from the GDBusObjectManagerClientFlags enumeration. |
|
name |
A bus name (well-known or unique) or |
[nullable] |
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
callback |
A GAsyncReadyCallback to call when the request is satisfied. |
|
user_data |
User data to pass to |
xapp_object_manager_client_new_finish ()
GDBusObjectManager * xapp_object_manager_client_new_finish (GAsyncResult *res,GError **error);
Finishes an operation started with xapp_object_manager_client_new().
Parameters
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
Returns
The constructed object manager client or NULL if error
is set.
[transfer full][type XAppObjectManagerClient]
xapp_object_manager_client_new_sync ()
GDBusObjectManager * xapp_object_manager_client_new_sync (GDBusConnection *connection,GDBusObjectManagerClientFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Synchronously creates GDBusObjectManagerClient using xapp_object_manager_client_get_proxy_type() as the GDBusProxyTypeFunc. See g_dbus_object_manager_client_new_sync() for more details.
The calling thread is blocked until a reply is received.
See xapp_object_manager_client_new() for the asynchronous version of this constructor.
Parameters
connection |
||
flags |
Flags from the GDBusObjectManagerClientFlags enumeration. |
|
name |
A bus name (well-known or unique) or |
[nullable] |
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
error |
Return location for error or |
Returns
The constructed object manager client or NULL if error
is set.
[transfer full][type XAppObjectManagerClient]
xapp_object_manager_client_new_for_bus ()
void xapp_object_manager_client_new_for_bus (GBusType bus_type,GDBusObjectManagerClientFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Like xapp_object_manager_client_new() but takes a GBusType instead of a GDBusConnection.
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 g_main_context_push_thread_default()).
You can then call xapp_object_manager_client_new_for_bus_finish() to get the result of the operation.
See xapp_object_manager_client_new_for_bus_sync() for the synchronous, blocking version of this constructor.
Parameters
bus_type |
A GBusType. |
|
flags |
Flags from the GDBusObjectManagerClientFlags enumeration. |
|
name |
A bus name (well-known or unique). |
|
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
callback |
A GAsyncReadyCallback to call when the request is satisfied. |
|
user_data |
User data to pass to |
xapp_object_manager_client_new_for_bus_finish ()
GDBusObjectManager * xapp_object_manager_client_new_for_bus_finish (GAsyncResult *res,GError **error);
Finishes an operation started with xapp_object_manager_client_new_for_bus().
Parameters
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
Returns
The constructed object manager client or NULL if error
is set.
[transfer full][type XAppObjectManagerClient]
xapp_object_manager_client_new_for_bus_sync ()
GDBusObjectManager * xapp_object_manager_client_new_for_bus_sync (GBusType bus_type,GDBusObjectManagerClientFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Like xapp_object_manager_client_new_sync() but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See xapp_object_manager_client_new_for_bus() for the asynchronous version of this constructor.
Parameters
bus_type |
A GBusType. |
|
flags |
Flags from the GDBusObjectManagerClientFlags enumeration. |
|
name |
A bus name (well-known or unique). |
|
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[nullable] |
error |
Return location for error or |
Returns
The constructed object manager client or NULL if error
is set.
[transfer full][type XAppObjectManagerClient]
Property Details
The “status-icon-interface” property
“status-icon-interface” XAppStatusIconInterface *
The XAppStatusIconInterface instance corresponding to the D-Bus interface org.x.StatusIcon, if any.
Connect to the “notify” signal to get informed of property changes.
Owner: XAppObject
Flags: Read / Write
The “icon-name” property
“icon-name” char *
Represents the D-Bus property "IconName".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: NULL
The “icon-size” property
“icon-size” int
Represents the D-Bus property "IconSize".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: 0
The “label” property
“label” char *
Represents the D-Bus property "Label".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: NULL
The “metadata” property
“metadata” char *
Represents the D-Bus property "Metadata".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: NULL
The “name” property
“name” char *
Represents the D-Bus property "Name".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: NULL
The “primary-menu-is-open” property
“primary-menu-is-open” gboolean
Represents the D-Bus property "PrimaryMenuIsOpen".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: FALSE
The “secondary-menu-is-open” property
“secondary-menu-is-open” gboolean
Represents the D-Bus property "SecondaryMenuIsOpen".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: FALSE
The “tooltip-text” property
“tooltip-text” char *
Represents the D-Bus property "TooltipText".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: NULL
The “visible” property
“visible” gboolean
Represents the D-Bus property "Visible".
Since the D-Bus property for this GObject 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.
Owner: XAppStatusIconInterface
Flags: Read / Write
Default value: FALSE
Signal Details
The “handle-button-press” signal
gboolean user_function (XAppStatusIconInterface *object, GDBusMethodInvocation *invocation, int arg_x, int arg_y, guint arg_button, guint arg_time, int arg_panel_position, gpointer user_data)
Signal emitted when a remote caller is invoking the ButtonPress()
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_status_icon_interface_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 G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
Parameters
object |
||
invocation |
||
arg_x |
Argument passed by remote caller. |
|
arg_y |
Argument passed by remote caller. |
|
arg_button |
Argument passed by remote caller. |
|
arg_time |
Argument passed by remote caller. |
|
arg_panel_position |
Argument passed by remote caller. |
|
user_data |
user data set when the signal handler was connected. |
Returns
G_DBUS_METHOD_INVOCATION_HANDLED or TRUE if the invocation was handled, G_DBUS_METHOD_INVOCATION_UNHANDLED or FALSE to let other signal handlers run.
Flags: Run Last
The “handle-button-release” signal
gboolean user_function (XAppStatusIconInterface *object, GDBusMethodInvocation *invocation, int arg_x, int arg_y, guint arg_button, guint arg_time, int arg_panel_position, gpointer user_data)
Signal emitted when a remote caller is invoking the ButtonRelease()
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_status_icon_interface_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 G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
Parameters
object |
||
invocation |
||
arg_x |
Argument passed by remote caller. |
|
arg_y |
Argument passed by remote caller. |
|
arg_button |
Argument passed by remote caller. |
|
arg_time |
Argument passed by remote caller. |
|
arg_panel_position |
Argument passed by remote caller. |
|
user_data |
user data set when the signal handler was connected. |
Returns
G_DBUS_METHOD_INVOCATION_HANDLED or TRUE if the invocation was handled, G_DBUS_METHOD_INVOCATION_UNHANDLED or FALSE to let other signal handlers run.
Flags: Run Last
The “handle-scroll” signal
gboolean user_function (XAppStatusIconInterface *object, GDBusMethodInvocation *invocation, int arg_delta, int arg_orientation, guint arg_time, gpointer user_data)
Signal emitted when a remote caller is invoking the Scroll()
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_status_icon_interface_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 G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
Parameters
object |
||
invocation |
||
arg_delta |
Argument passed by remote caller. |
|
arg_orientation |
Argument passed by remote caller. |
|
arg_time |
Argument passed by remote caller. |
|
user_data |
user data set when the signal handler was connected. |
Returns
G_DBUS_METHOD_INVOCATION_HANDLED or TRUE if the invocation was handled, G_DBUS_METHOD_INVOCATION_UNHANDLED or FALSE to let other signal handlers run.
Flags: Run Last
| Top | |
|
|
|
XAppVisibilityGroupXAppVisibilityGroup — Groups widgets to have their visibility or sensitivity controlled as a group, independent of their positions in any widget hierarchy. |
Functions
Description
You can use this to hide and show groups of widgets all at once, without having to specify each one. They do not have to have the same parents, or even have the same toplevel window.
If a widget is destroyed before the group is, it will be automatically removed from the visibility group. You only ever need to free the XAppVisibilityGroup itself.
Only the specific members of the group have their visibility and sensitivity set, not their descendants. No effort is made to track or prevent state changes made to individual widgets by outside influence.
Functions
xapp_visibility_group_new ()
XAppVisibilityGroup * xapp_visibility_group_new (gboolean visible,gboolean sensitive,GSList *widgets);
Creates a new XAppVisibilityGroup.
If widgets
is not NULL, adds these widgets to the group with the starting visibility and
sensitivity state.
Parameters
visible |
starting visibility state |
|
sensitive |
starting sensitivity state |
|
widgets |
list of GtkWidgets to add to the group. |
[element-type GtkWidget][transfer none][nullable] |
Since: 2.2.15
xapp_visibility_group_add_widget ()
void xapp_visibility_group_add_widget (XAppVisibilityGroup *group,GtkWidget *widget);
Adds widget to the visibility group.
Since: 2.2.15
xapp_visibility_group_remove_widget ()
gboolean xapp_visibility_group_remove_widget (XAppVisibilityGroup *group,GtkWidget *widget);
Since: 2.2.15
xapp_visibility_group_hide ()
void
xapp_visibility_group_hide (XAppVisibilityGroup *group);
Hide all widgets in the group.
Since: 2.2.15
xapp_visibility_group_show ()
void
xapp_visibility_group_show (XAppVisibilityGroup *group);
Show all widgets in the group.
Since: 2.2.15
xapp_visibility_group_set_visible ()
void xapp_visibility_group_set_visible (XAppVisibilityGroup *group,gboolean visible);
Set the visibility of all widgets in the group.
Since: 2.2.15
xapp_visibility_group_get_visible ()
gboolean
xapp_visibility_group_get_visible (XAppVisibilityGroup *group);
Get the visibility of the group.
There is no guarantee that all widgets in the group actually are in the returned state, if they've had their visibility individually modified since the last time the group was set.
Since: 2.2.15
xapp_visibility_group_set_sensitive ()
void xapp_visibility_group_set_sensitive (XAppVisibilityGroup *group,gboolean sensitive);
Set the sensitivity of all widgets in group.
Since: 2.2.15
xapp_visibility_group_get_sensitive ()
gboolean
xapp_visibility_group_get_sensitive (XAppVisibilityGroup *group);
Get the sensitivity of the group.
There is no guarantee that all widgets in the group actually are in the returned state, if they've had their sensitivity individually modified since the last time the group was set.
Since: 2.2.15
xapp_visibility_group_get_widgets ()
GSList *
xapp_visibility_group_get_widgets (XAppVisibilityGroup *group);
Returns the members of the group or NULL if the group is empty.
Returns
a list of members of the group.
The list is owned by XApp, do not free.
[element-type GtkWidget][transfer none]
Since: 2.2.15
xapp_visibility_group_set_widgets ()
void xapp_visibility_group_set_widgets (XAppVisibilityGroup *group,GSList *widgets);
Parameters
group |
the visibility group |
|
widgets |
The widgets to add to this group, replacing any existing ones. |
[nullable][element-type GtkWidget][transfer none] |
Since: 2.2.15
Types and Values
struct XAppVisibilityGroup
struct XAppVisibilityGroup {
GSList *widgets;
gboolean visible;
gboolean sensitive;
};
A group of widgets that can have their visibility and sensitivity controlled together.
Members
GSList * |
The GtkWidget members of this group. |
[element-type Gtk.Widget][transfer none][nullable] |
gboolean |
The current visible state of the group. There is no guarantee that all members are actually in this state. |
|
gboolean |
The current sensitive state of the group. There is no guarantee that all members are actually in this state. |
| Top | |
|
|
|
Functions
Description
XAppGpuOffloadHelper is class that provides a reliable property cache and simple return methods for getting offload_helper parameters and conditions from the Switcheroo interface.
Since 2.6
Functions
xapp_gpu_offload_helper_get ()
XAppGpuOffloadHelper *
xapp_gpu_offload_helper_get (void);
Creates a new XAppGpuOffloadHelper instance.
The “ready” signal will be emitted when the helper is initialized (successfully or not).
Since: 2.6
xapp_gpu_offload_helper_get_sync ()
XAppGpuOffloadHelper *
xapp_gpu_offload_helper_get_sync (void);
Creates a new XAppGpuOffloadHelper instance. This performs initialization synchronously, and can potentially block.
Use xapp_gpu_offload_helper_is_ready() to see if the helper was initialized successfully.
Since: 2.6
xapp_gpu_offload_helper_is_ready ()
gboolean
xapp_gpu_offload_helper_is_ready (XAppGpuOffloadHelper *helper);
Checks if the helper is ready and valid. This does not mean offload support exists.
Since: 2.6
xapp_gpu_offload_helper_is_offload_supported ()
gboolean
xapp_gpu_offload_helper_is_offload_supported
(XAppGpuOffloadHelper *helper);
Checks if there is a non-default GPU available for offloading.
Since: 2.6
xapp_gpu_offload_helper_get_n_gpus ()
gint
xapp_gpu_offload_helper_get_n_gpus (XAppGpuOffloadHelper *helper);
Gets the number of GPUs noticed by Switcheroo.
Returns
the total number of GPUs. A return value larger than 1 implies there are offloadable GPUs available.
Since: 2.6
xapp_gpu_offload_helper_get_offload_infos ()
GList *
xapp_gpu_offload_helper_get_offload_infos
(XAppGpuOffloadHelper *helper);
Generates a list of XAppGpuInfos that can be offloaded to, if there are any.
Returns
a list of XAppGpuInfos or NULL if there is only
a single GPU. The elements are owned by helper
but the container itself should be freed.
[element-type XAppGpuInfo][transfer container]
Since: 2.6
xapp_gpu_offload_helper_get_default_info ()
XAppGpuInfo *
xapp_gpu_offload_helper_get_default_info
(XAppGpuOffloadHelper *helper);
Returns an XAppGpuInfo for the default GPU.
Since: 2.6
xapp_gpu_offload_helper_get_info_by_id ()
XAppGpuInfo * xapp_gpu_offload_helper_get_info_by_id (XAppGpuOffloadHelper *helper,gint id);
Returns an XAppGpuInfo with the given ID.
Since: 2.6
xapp_gpu_info_get_shell_env_prefix ()
gchar *
xapp_gpu_info_get_shell_env_prefix (XAppGpuInfo *info);
Creates a new string in a form intended to prefix a shell command, containing the appropriate name/values for this gpu. For example:
__GLX_VENDOR_LIBRARY_NAME=nvidia __NV_PRIME_RENDER_OFFLOAD=1
Types and Values
XAPP_TYPE_GPU_OFFLOAD_HELPER
#define XAPP_TYPE_GPU_OFFLOAD_HELPER xapp_gpu_offload_helper_get_type ()
struct XAppGpuInfo
struct XAppGpuInfo {
gint id;
gboolean is_default;
gchar *display_name;
gchar **env_strv;
};
Information about a single GPU used for offloading. The length of env_strv
will always be an even number.
Members
gint |
An identifier that can be used to refer to this GPU. |
|
gboolean |
Whether this GPU is used by default. |
|
gchar * |
User-visible name of the GPU. |
|
gchar ** |
A string array containing alternating environment variables names and values to use to enable the gpu. |
[array zero-terminated=1] |
Signal Details
The “ready” signal
void user_function (XAppGpuOffloadHelper *helper, gboolean success, gpointer user_data)
This signal is emitted by the helper when it has completed gathering GPU information. It will only be sent once.
Parameters
helper |
||
success |
Whether or not the helper initialize successfully. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
XApp Reference Manual |
|---|
xapp 2.8.0
- API reference
- XAppDarkModeManager — Manages an application's dark mode preference for it.
- XAppFavorites — Keeps track of favorite files.
-
XAppGtkWindow — A subclass of
GtkWindowthat allows additional communication with the window manager. - XAppGpuOffloadHelper — Simple interface for Switcheroo.
- XAppIconChooserButton — A button for selecting an icon
- XAppIconChooserDialog — A dialog for selecting an icon
- XAppKbdLayoutController — Keyboard layout selection UI element provider.
- XAppMonitorBlanker — Blank and unblank unused monitors
- XAppPreferencesWindow — A base preferences window
- XAppStackSidebar — An automatic sidebar widget
- XAppStatusIcon — Broadcasts status information over DBUS
- XAppStatusIconMonitor — Looks for XAppStatusIcons on DBUS and communicates info to an applet to represent the icons.
- XAppObjectManagerClient
- xapp-util
- XAppVisibilityGroup — Groups widgets to have their visibility or sensitivity controlled as a group, independent of their positions in any widget hierarchy.
- Object Hierarchy
- API Index
- Annotation Glossary
|
 |
|
|
D
F
G
I
K
M
O
P
S
T
U
V
| Top | |
|
|
|
Functions
xapp_util_gpu_offload_supported ()
gboolean
xapp_util_gpu_offload_supported (void);
Performs a check to see if on-demand mode for discrete graphics is supported.
Since: 1.8
xapp_util_get_session_is_running ()
gboolean
xapp_util_get_session_is_running (void);
Check if the Session Manager is currently in the "Running" phase.
Since: 2.0
xapp_pango_font_string_to_css ()
gchar *
xapp_pango_font_string_to_css (const char *pango_font_string);
Converts a pango font description string to a string suitable for use with the css "font" tag. The font description must contain the font family and font size or conversion will fail and NULL will be returned
Since: 2.2
xapp_get_tmp_dir ()
const gchar *
xapp_get_tmp_dir (void);
Provides the path to the system's temporary files folder. This is identical to g_get_tmp_dir, but includes the /dev/shm ramdisk as the first choice for a temporary folder.
Since: 2.2.16
| Top | |
|
|
|
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── XAppStackSidebar
Description
A XAppStackSidebar allows you to quickly and easily provide a consistent "sidebar" object for your user interface
In order to use a XAppStackSidebar, you simply use a GtkStack to
organize your UI flow, and add the sidebar to your sidebar area. You
can use xapp_stack_sidebar_set_stack() to connect the XAppStackSidebar
to the GtkStack. The XAppStackSidebar is an extended version of the
the GtkStackSidebar that allows showing an icon in addition to the text.
Functions
xapp_stack_sidebar_set_stack ()
void xapp_stack_sidebar_set_stack (XAppStackSidebar *sidebar,GtkStack *stack);
Set the GtkStack associated with this XAppStackSidebar.
The sidebar widget will automatically update according to the order (packing) and items within the given GtkStack.
xapp_stack_sidebar_get_stack ()
GtkStack *
xapp_stack_sidebar_get_stack (XAppStackSidebar *sidebar);
Retrieves the stack.
See xapp_stack_sidebar_set_stack().
Property Details
The “stack” property
“stack” GtkStack *
Associated stack for this XAppStackSidebar.
Owner: XAppStackSidebar
Flags: Read / Write
| Top | |
|
|
|
Description
This class will attempt to use the XDG Desktop Settings portal to manage its 'gtk-application-prefer-dark-theme' setting. If the portal is unavailable it will resort to using xdg-desktop-portal-xapp's dconf setting.
Since 2.6
Functions
xapp_dark_mode_manager_new ()
XAppDarkModeManager *
xapp_dark_mode_manager_new (gboolean prefer_dark_mode);
Since: 2.6
| Top | |
|
|
|
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkWindow ╰── XAppPreferencesWindow
Description
The XAppPreferencesWindow sets up a simple dialog window with a GtkStack, GtkSidebarSwitcher, and GtkActionBar. The stack switcher and action bar only show when needed.
Functions
xapp_preferences_window_new ()
XAppPreferencesWindow *
xapp_preferences_window_new (void);
Creates a new XAppPreferencesWindow.
xapp_preferences_window_add_page ()
void xapp_preferences_window_add_page (XAppPreferencesWindow *window,GtkWidget *widget,const gchar *name,const gchar *title);
Adds a page to the window. The page is identified by name. The title will be used in the sidebar so should be short. The sidebar will show automatically once at least two pages are added.
Parameters
window |
||
widget |
a GtkWidget to add |
|
name |
the name for the page |
|
title |
a human-readable title for the page |
xapp_preferences_window_add_button ()
void xapp_preferences_window_add_button (XAppPreferencesWindow *window,GtkWidget *button,GtkPackType pack_type);
Adds a button to the bottom action bar of the window. Where the button is place will be determined by the GtkPackType. The action bar will show automatically once at least one button is added.
Types and Values
XAPP_TYPE_PREFERENCES_WINDOW
#define XAPP_TYPE_PREFERENCES_WINDOW (xapp_preferences_window_get_type ())
struct XAppPreferencesWindowClass
struct XAppPreferencesWindowClass {
GtkWindowClass parent_class;
/* Keybinding signals */
void (* close) (XAppPreferencesWindow *window);
};
Signal Details
The “close” signal
void user_function (XAppPreferencesWindow *xapppreferenceswindow, gpointer user_data)
Flags: Action
| Top | |
|
|
|
Functions
Properties
| int | icon-size | Read / Write |
| char * | name | Read / Write / Construct |
| GtkWidget * | primary-menu | Read / Write |
| GtkWidget * | secondary-menu | Read / Write |
Signals
| void | activate | Action |
| void | button-press-event | Action |
| void | button-release-event | Action |
| void | scroll-event | Action |
| void | state-changed | Action |
Types and Values
| #define | XAPP_TYPE_STATUS_ICON |
| enum | XAppStatusIconState |
| enum | XAppScrollDirection |
| XAppStatusIcon |
Description
The XAppStatusIcon allows applications to share status info about themselves. It replaces the obsolete and very similar Gtk.StatusIcon widget.
If used in an environment where no applet is handling XAppStatusIcons, the XAppStatusIcon delegates its calls to a Gtk.StatusIcon.
Functions
xapp_status_icon_new ()
XAppStatusIcon *
xapp_status_icon_new (void);
Creates a new XAppStatusIcon instance
Since: 1.6
xapp_status_icon_new_with_name ()
XAppStatusIcon *
xapp_status_icon_new_with_name (const gchar *name);
Creates a new XAppStatusIcon instance and sets its name to name.
Since: 1.6
xapp_status_icon_set_name ()
void xapp_status_icon_set_name (XAppStatusIcon *icon,const gchar *name);
Sets the status icon name. This is not shown to users.
Since: 1.6
xapp_status_icon_set_icon_name ()
void xapp_status_icon_set_icon_name (XAppStatusIcon *icon,const gchar *icon_name);
Sets the icon name or local path to use.
Since: 1.6
xapp_status_icon_get_icon_size ()
gint
xapp_status_icon_get_icon_size (XAppStatusIcon *icon);
Returns
The desired icon size - usually set by the host based on panel size. This is not what it's guaranteed to get, and this is really only useful when receiving absolute icon paths from the client app.
Since: 1.8
xapp_status_icon_set_tooltip_text ()
void xapp_status_icon_set_tooltip_text (XAppStatusIcon *icon,const gchar *tooltip_text);
Sets the tooltip text
Since: 1.6
xapp_status_icon_set_label ()
void xapp_status_icon_set_label (XAppStatusIcon *icon,const gchar *label);
Sets a label, shown beside the icon
Since: 1.6
xapp_status_icon_set_visible ()
void xapp_status_icon_set_visible (XAppStatusIcon *icon,const gboolean visible);
Sets the visibility of the status icon
Since: 1.6
xapp_status_icon_get_visible ()
gboolean
xapp_status_icon_get_visible (XAppStatusIcon *icon);
Returns whether or not the icon should currently be visible.
Since: 1.8.5
xapp_status_icon_popup_menu ()
void xapp_status_icon_popup_menu (XAppStatusIcon *icon,GtkMenu *menu,gint x,gint y,guint button,guint _time,gint panel_position);
Pop up menu
using the positioning arguments. These arguments should be
those provided by a “button-release-event”.
Parameters
icon |
||
menu |
A GtkMenu to display when the primary mouse button is released. |
[nullable] |
x |
The x anchor position for the menu. |
|
y |
The y anchor position for the menu. |
|
button |
The button used to initiate this action (or 0) |
|
_time |
The event time (or 0) |
|
panel_position |
The GtkPositionType for the position of the icon. |
Since: 1.8.6
xapp_status_icon_set_primary_menu ()
void xapp_status_icon_set_primary_menu (XAppStatusIcon *icon,GtkMenu *menu);
See the “primary-menu” property for details
Since: 1.6
xapp_status_icon_get_primary_menu ()
GtkWidget *
xapp_status_icon_get_primary_menu (XAppStatusIcon *icon);
Returns a pointer to a GtkMenu that was set previously for the
primary mouse button. If no menu was set, this returns NULL.
Since: 1.6
xapp_status_icon_set_secondary_menu ()
void xapp_status_icon_set_secondary_menu (XAppStatusIcon *icon,GtkMenu *menu);
See the “secondary-menu” property for details
Since: 1.6
xapp_status_icon_get_secondary_menu ()
GtkWidget *
xapp_status_icon_get_secondary_menu (XAppStatusIcon *icon);
Returns a pointer to a GtkMenu that was set previously for the
secondary mouse button. If no menu was set, this returns NULL.
Since: 1.6
xapp_status_icon_get_state ()
XAppStatusIconState
xapp_status_icon_get_state (XAppStatusIcon *icon);
Gets the current XAppStatusIconState of icon. The state is determined by whether the icon is being displayed by an XAppStatusMonitor client, a fallback tray icon, or not being displayed at all.
See XAppStatusIconState for more details.
Since: 1.6
xapp_status_icon_set_metadata ()
void xapp_status_icon_set_metadata (XAppStatusIcon *icon,const gchar *metadata);
Sets metadata to pass to the icon proxy for an applet's use. Right now this is only so xapp-sn-watcher can tell the applets when the icon is originating from appindicator so panel button 'highlighting' can behave correctly.
Since: 1.8.7
xapp_status_icon_any_monitors ()
gboolean
xapp_status_icon_any_monitors (void);
Looks for the existence of any active XAppStatusIconMonitors on the bus.
Since: 1.6
Types and Values
enum XAppStatusIconState
Members
|
The XAppStatusIcon is currently being handled by an XAppStatusIconMonitor (usually in an applet). |
||
|
The XAppStatusIcon is currently being handled by a legacy system tray implementation (using GtkStatusIcon). |
||
|
The XAppStatusIcon is not currently being handled by any kind of status icon implementation. |
Property Details
The “icon-size” property
“icon-size” int
The icon size that is preferred by icon monitor/host - this is usually a product of some calculation based on the panel size. It can be used by the client to size an icon to be saved as a file and its path sent to the host.
If this value is 0 it has not been set, and its value can be unreliable if the host has multiple XAppStatusIconMonitors active.
Owner: XAppStatusIcon
Flags: Read / Write
Allowed values: [0,96]
Default value: 0
The “name” property
“name” char *
The name of the icon for sorting purposes. If this is in the form of 'org.x.StatusIcon.foo`
and set immediately upon creation of the icon, it will also attempt to own this dbus name;
this can be useful in sandboxed environments where a well-defined name is required. If
additional icons are created, only the name given to the initial one will be used for dbus,
though different names can still affect the sort order. This is set to the value of
g_get_prgname() if no other name is provided.
Owner: XAppStatusIcon
Flags: Read / Write / Construct
Default value: NULL
The “primary-menu” property
“primary-menu” GtkWidget *
A GtkMenu to use when requested by the remote monitor via a left (or primary) click.
When this property is not NULL, the menu will be automatically positioned and
displayed during a primary button release.
When this property IS NULL, the “activate” will be sent for primary
button presses.
In both cases, the “button-press-event” and “button-release-events” will be fired like normal.
Setting this will remove any floating reference to the menu and assume ownership. As a result, it is not necessary to maintain a reference to it in the parent application (or unref it when finished with it - if you wish to replace the menu, simply call this method again with a new menu.
The same GtkMenu widget can be set as both the primary and secondary.
Owner: XAppStatusIcon
Flags: Read / Write
The “secondary-menu” property
“secondary-menu” GtkWidget *
A GtkMenu to use when requested by the remote monitor via a right (or secondary) click.
When this property is not NULL, the menu will be automatically positioned and
displayed during a secondary button release.
When this property IS NULL, the “activate” will be sent for secondary
button presses.
In both cases, the “button-press-event” and “button-release-events” will be fired like normal.
Setting this will remove any floating reference to the menu and assume ownership. As a result, it is not necessary to maintain a reference to it in the parent application (or unref it when finished with it - if you wish to replace the menu, simply call this method again with a new menu.
The same GtkMenu widget can be set as both the primary and secondary.
Owner: XAppStatusIcon
Flags: Read / Write
Signal Details
The “activate” signal
void user_function (XAppStatusIcon *icon, guint button, guint time, gpointer user_data)
Gets emitted when the user activates the status icon. If the XAppStatusIcon:primary-menu or
XAppStatusIcon:secondary-menu is not NULL, this signal is skipped for the respective button
presses. A middle button click will always send this signal when pressed.
Parameters
icon |
The XAppStatusIcon |
|
button |
The button that was pressed |
|
time |
The time supplied by the event, or 0 |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
The “button-press-event” signal
void user_function (XAppStatusIcon *icon, int x, int y, guint button, guint time, int panel_position, gpointer user_data)
Gets emitted when there is a button press received from an applet
Parameters
icon |
The XAppStatusIcon |
|
x |
The absolute x position to use for menu positioning |
|
y |
The absolute y position to use for menu positioning |
|
button |
The button that was pressed |
|
time |
The time supplied by the event, or 0 |
|
panel_position |
The GtkPositionType to use for menu positioning |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
The “button-release-event” signal
void user_function (XAppStatusIcon *icon, int x, int y, guint button, guint time, int panel_position, gpointer user_data)
Gets emitted when there is a button release received from an applet
Parameters
icon |
The XAppStatusIcon |
|
x |
The absolute x position to use for menu positioning |
|
y |
The absolute y position to use for menu positioning |
|
button |
The button that was released |
|
time |
The time supplied by the event, or 0 |
|
panel_position |
The GtkPositionType to use for menu positioning |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
The “scroll-event” signal
void user_function (XAppStatusIcon *icon, int amount, XAppScrollDirection direction, guint time, gpointer user_data)
Gets emitted when the user uses the mouse scroll wheel over the status icon. For the most part, amounts will always be 1, unless an applet supports smooth scrolling. Generally the direction value is most important.
Parameters
icon |
The XAppStatusIcon |
|
amount |
The amount of movement for the scroll event |
|
direction |
the XAppScrollDirection of the scroll event |
|
time |
The time supplied by the event, or 0 |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
The “state-changed” signal
void user_function (XAppStatusIcon *icon, XAppStatusIconState new_state, gpointer user_data)
Gets emitted when the state of the icon changes. If you wish to react to changes in how the status icon is being handled (perhaps to alter the menu or other click behavior), you should connect to this - see XAppStatusIconState for more details.
Parameters
icon |
The XAppStatusIcon |
|
new_state |
The new XAppStatusIconState of the icon |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
|
|
|
|
- XAppDarkModeManager — Manages an application's dark mode preference for it.
- XAppFavorites — Keeps track of favorite files.
-
XAppGtkWindow — A subclass of
GtkWindowthat allows additional communication with the window manager. - XAppGpuOffloadHelper — Simple interface for Switcheroo.
- XAppIconChooserButton — A button for selecting an icon
- XAppIconChooserDialog — A dialog for selecting an icon
- XAppKbdLayoutController — Keyboard layout selection UI element provider.
- XAppMonitorBlanker — Blank and unblank unused monitors
- XAppPreferencesWindow — A base preferences window
- XAppStackSidebar — An automatic sidebar widget
- XAppStatusIcon — Broadcasts status information over DBUS
- XAppStatusIconMonitor — Looks for XAppStatusIcons on DBUS and communicates info to an applet to represent the icons.
- XAppObjectManagerClient
- xapp-util
- XAppVisibilityGroup — Groups widgets to have their visibility or sensitivity controlled as a group, independent of their positions in any widget hierarchy.
|
|
|
|
GObject
├── XAppDarkModeManager
├── XAppFavorites
├── XAppGpuOffloadHelper
├── GInitiallyUnowned
│ ╰── GtkWidget
│ ╰── GtkContainer
│ ╰── GtkBin
│ ├── GtkWindow
│ │ ├── XAppGtkWindow
│ │ │ ╰── XAppIconChooserDialog
│ │ ╰── XAppPreferencesWindow
│ ├── GtkButton
│ │ ╰── XAppIconChooserButton
│ ╰── XAppStackSidebar
├── XAppKbdLayoutController
├── XAppMonitorBlanker
├── GDBusObjectManagerClient
│ ╰── XAppObjectManagerClient
├── GDBusObjectProxy
│ ╰── XAppObjectProxy
├── GDBusObjectSkeleton
│ ╰── XAppObjectSkeleton
├── XAppStatusIcon
├── GDBusProxy
│ ├── XAppStatusIconInterfaceProxy
│ ╰── XAppSwitcherooControlProxy
├── GDBusInterfaceSkeleton
│ ├── XAppStatusIconInterfaceSkeleton
│ ╰── XAppSwitcherooControlSkeleton
├── XAppStatusIconMonitor
╰── XAppStyleManager
GInterface
├── XAppObject
├── XAppStatusIconInterface
╰── XAppSwitcherooControl
GBoxed
├── XAppFavoriteInfo
├── XAppGpuInfo
╰── XAppVisibilityGroup
GEnum
├── XAppIconSize
├── XAppScrollDirection
╰── XAppStatusIconState
| Top | |
|
|
|
Functions
Description
A GObject wrapper for Gkbd that provides additional UI element support for keyboard layout flags and abbreviations, as well as Wfacilities to distinguish regional and hardware-based variants which might otherwise appear identical in a layout list.
Functions
xapp_kbd_layout_controller_new ()
XAppKbdLayoutController *
xapp_kbd_layout_controller_new (void);
Creates a new XAppKbdLayoutController instance.
xapp_kbd_layout_controller_get_enabled ()
gboolean
xapp_kbd_layout_controller_get_enabled
(XAppKbdLayoutController *controller);
Returns whether or not the layout controller is enabled
xapp_kbd_layout_controller_get_current_group ()
guint
xapp_kbd_layout_controller_get_current_group
(XAppKbdLayoutController *controller);
Selects the previous group in the group list.
xapp_kbd_layout_controller_set_current_group ()
void xapp_kbd_layout_controller_set_current_group (XAppKbdLayoutController *controller,guint group);
Selects the given group number as active.
xapp_kbd_layout_controller_next_group ()
void
xapp_kbd_layout_controller_next_group (XAppKbdLayoutController *controller);
Selects the next group in the group list.
xapp_kbd_layout_controller_previous_group ()
void
xapp_kbd_layout_controller_previous_group
(XAppKbdLayoutController *controller);
Selects the previous group in the group list.
xapp_kbd_layout_controller_get_current_name ()
gchar *
xapp_kbd_layout_controller_get_current_name
(XAppKbdLayoutController *controller);
Returns the full name of the current keyboard layout.
xapp_kbd_layout_controller_get_all_names ()
gchar **
xapp_kbd_layout_controller_get_all_names
(XAppKbdLayoutController *controller);
Returns an array of all full layout names
xapp_kbd_layout_controller_get_current_icon_name ()
gchar *
xapp_kbd_layout_controller_get_current_icon_name
(XAppKbdLayoutController *controller);
Returns the icon file name (no path or extension) to use for the current layout
xapp_kbd_layout_controller_get_icon_name_for_group ()
gchar * xapp_kbd_layout_controller_get_icon_name_for_group (XAppKbdLayoutController *controller,guint group);
Returns the icon file name (no path or extension) to use for the specified layout.
xapp_kbd_layout_controller_get_current_flag_id ()
gint
xapp_kbd_layout_controller_get_current_flag_id
(XAppKbdLayoutController *controller);
Returns the duplicate id for the current layout
xapp_kbd_layout_controller_get_flag_id_for_group ()
gint xapp_kbd_layout_controller_get_flag_id_for_group (XAppKbdLayoutController *controller,guint group);
xapp_kbd_layout_controller_get_current_short_group_label ()
gchar *
xapp_kbd_layout_controller_get_current_short_group_label
(XAppKbdLayoutController *controller);
Returns the short group label (and subscript, if any) of the current layout
xapp_kbd_layout_controller_get_short_group_label_for_group ()
gchar * xapp_kbd_layout_controller_get_short_group_label_for_group (XAppKbdLayoutController *controller,guint group);
Returns the short group label and subscript of the specified layout.
xapp_kbd_layout_controller_get_current_variant_label ()
gchar *
xapp_kbd_layout_controller_get_current_variant_label
(XAppKbdLayoutController *controller);
Returns the variant label (and subscript, if any) of the current layout
xapp_kbd_layout_controller_get_variant_label_for_group ()
gchar * xapp_kbd_layout_controller_get_variant_label_for_group (XAppKbdLayoutController *controller,guint group);
Returns the variant label and subscript of the specified layout.
xapp_kbd_layout_controller_render_cairo_subscript ()
void xapp_kbd_layout_controller_render_cairo_subscript (cairo_t *cr,gdouble x,gdouble y,gdouble width,gdouble height,gint subscript);
Renders a subscript number in the given work area. This should be called from within a "draw" or "paint" widget/actor function, where a valid cairo_t is provided to draw with.
Parameters
cr |
a cairo_t |
|
x |
the x position of the drawing area |
|
y |
the y position of the drawing area |
|
width |
the width of the drawing area |
|
height |
the height of the drawing area |
|
subscript |
the number to render |
Property Details
The “enabled” property
“enabled” gboolean
Whether we're enabled (more than one keyboard layout is installed).
Owner: XAppKbdLayoutController
Flags: Read
Default value: FALSE
Signal Details
The “config-changed” signal
void user_function (XAppKbdLayoutController *xappkbdlayoutcontroller, gpointer user_data)
Flags: Run Last
The “layout-changed” signal
void user_function (XAppKbdLayoutController *xappkbdlayoutcontroller, guint arg1, gpointer user_data)
Flags: Run Last
| Top | |
|
|
|
Description
The XAppMonitorBlanker widget that creates one or more POPUP type GtkWindows that are used to blank unused monitors in multiple monitor setups.
Functions
xapp_monitor_blanker_new ()
XAppMonitorBlanker *
xapp_monitor_blanker_new (void);
Creates a new XAppMonitorBlanker.
xapp_monitor_blanker_blank_other_monitors ()
void xapp_monitor_blanker_blank_other_monitors (XAppMonitorBlanker *self,GtkWindow *window);
Blanks monitors besides the one where the window
is.
xapp_monitor_blanker_unblank_monitors ()
void
xapp_monitor_blanker_unblank_monitors (XAppMonitorBlanker *self);
Unblanks monitors that were blanked by
xapp_monitor_blanker_blank_other_monitors();
xapp_monitor_blanker_are_monitors_blanked ()
gboolean
xapp_monitor_blanker_are_monitors_blanked
(XAppMonitorBlanker *self);
Returns whether monitors are currently blanked.
See xapp_monitor_blanker_blank_other_monitors().
| Top | |
|
|
|
XAppStatusIconMonitorXAppStatusIconMonitor — Looks for XAppStatusIcons on DBUS and communicates info to an applet to represent the icons. |
Description
The XAppStatusIconMonitor is intended to be utilized by some status applet to display info about an app.
The simplest way to use is to make a new instance of this monitor, and connect to the “icon-added” and “icon-removed” signals. The received object for both of these signals is an XAppStatusIconInterfaceProxy. It represents an application's XAppStatusIcon, and has properties available for describing the icon name, tooltip, label and visibility.
The proxy also provides methods to handle clicks, which can be called by the applet, to request that the app display its menu.
Functions
xapp_status_icon_monitor_new ()
XAppStatusIconMonitor *
xapp_status_icon_monitor_new (void);
Creates a new monitor.
Since: 1.6
xapp_status_icon_monitor_list_icons ()
GList *
xapp_status_icon_monitor_list_icons (XAppStatusIconMonitor *monitor);
List known icon proxies.
Since: 1.6
Types and Values
XAPP_TYPE_STATUS_ICON_MONITOR
#define XAPP_TYPE_STATUS_ICON_MONITOR (xapp_status_icon_monitor_get_type ())
Signal Details
The “icon-added” signal
void user_function (XAppStatusIconMonitor *monitor, XAppStatusIconInterfaceProxy *proxy, gpointer user_data)
This signal is emitted by the monitor when it has discovered a new XAppStatusIcon on the bus.
Parameters
monitor |
||
proxy |
the interface proxy for the XAppStatusIcon that has been added. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
The “icon-removed” signal
void user_function (XAppStatusIconMonitor *monitor, XAppStatusIconInterfaceProxy *proxy, gpointer user_data)
This signal is emitted by the monitor when an XAppStatusIcon has disappeared from the bus.
Parameters
monitor |
||
proxy |
the XAppStatusIcon proxy that has been removed. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
| Top | |
|
|
|
Functions
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkButton ╰── XAppIconChooserButton
Implemented Interfaces
XAppIconChooserButton implements AtkImplementorIface, GtkBuildable, GtkActionable and GtkActivatable.
Description
The XAppIconChooserButton creates a button so that the user can select an icon. When the button is clicked it will open an XAppIconChooserDialog. The currently selected icon will be displayed as the button image.
Functions
xapp_icon_chooser_button_new ()
XAppIconChooserButton *
xapp_icon_chooser_button_new (void);
Creates a new XAppIconChooserButton and sets its icon to icon
.
xapp_icon_chooser_button_new_with_size ()
XAppIconChooserButton *
xapp_icon_chooser_button_new_with_size
(GtkIconSize icon_size);
Creates a new XAppIconChooserButton, and sets the sizes of the button image and the icons in
the dialog. Note that xapp_icon_chooser_button_new_with_size (NULL, NULL) is the same as calling
xapp_icon_chooser_button_new().
xapp_icon_chooser_button_set_icon_size ()
void xapp_icon_chooser_button_set_icon_size (XAppIconChooserButton *button,GtkIconSize icon_size);
Sets the icon size used in the button.
xapp_icon_chooser_button_set_icon ()
void xapp_icon_chooser_button_set_icon (XAppIconChooserButton *button,const gchar *icon);
Sets the icon on the XAppIconChooserButton.
xapp_icon_chooser_button_set_default_category ()
void xapp_icon_chooser_button_set_default_category (XAppIconChooserButton *button,const gchar *category);
Sets the icon on the XAppIconChooserButton.
xapp_icon_chooser_button_get_icon ()
const gchar *
xapp_icon_chooser_button_get_icon (XAppIconChooserButton *button);
Gets the icon from the XAppIconChooserButton.
xapp_icon_chooser_button_get_dialog ()
XAppIconChooserDialog *
xapp_icon_chooser_button_get_dialog (XAppIconChooserButton *button);
Gets a reference to the icon chooser dialog for the XAppIconChooserButton. This is useful for setting properties on the dialog.
Types and Values
XAPP_TYPE_ICON_CHOOSER_BUTTON
#define XAPP_TYPE_ICON_CHOOSER_BUTTON (xapp_icon_chooser_button_get_type ())
Property Details
The “category” property
“category” char *
The category selected by default.
Owner: XAppIconChooserButton
Flags: Read / Write
Default value: ""
The “icon” property
“icon” char *
The preferred size to use when looking up icons. This only works with icon names. Additionally, there is no guarantee that a selected icon name will exist in a particular size.
Owner: XAppIconChooserButton
Flags: Read / Write
Default value: ""
The “icon-size” property
“icon-size” GtkIconSize
The size to use when displaying the icon.
Owner: XAppIconChooserButton
Flags: Read / Write
Default value: GTK_ICON_SIZE_DND
|
|
|
 |
A
Parameter points to an array of items.
C
This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.
E
Generics and defining elements of containers and arrays.
N
NULL must not be passed as the value in, out, in-out; or as a return value.
NULL may be passed as the value in, out, in-out; or as a return value.
S
The callback is valid until the GDestroyNotify argument is called.
Exposed in C code, not necessarily available in other languages.
T
The caller owns the data container, but not the data inside it.
The caller owns the data, and is responsible for free it.
The data is owned by the callee, which is responsible of freeing it.
Override the parsed C type with given type.
| Top | |
|
|
|
Functions
Properties
| gboolean | allow-paths | Read / Write |
| char * | default-icon | Read / Write |
| XAppIconSize | icon-size | Read / Write |
Object Hierarchy
GEnum ╰── XAppIconSize GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkWindow ╰── XAppGtkWindow ╰── XAppIconChooserDialog
Description
The XAppIconChooserDialog creates a dialog so that the user can select an icon. It provides the ability to browse by category, search by icon name, or select from a specific file.
Functions
xapp_icon_chooser_dialog_new ()
XAppIconChooserDialog *
xapp_icon_chooser_dialog_new (void);
Creates a new XAppIconChooserDialog.
xapp_icon_chooser_dialog_run ()
gint
xapp_icon_chooser_dialog_run (XAppIconChooserDialog *dialog);
Shows the dialog and enters a separate main loop until an icon is chosen or the action is canceled.
xapp_icon_chooser_dialog_run (), xapp_icon_chooser_dialog_run_with_icon(), and
xapp_icon_chooser_dialog_run_with_category() may all be called multiple times. This is useful for
applications which use this dialog multiple times, as it may improve performance for subsequent
calls.
xapp_icon_chooser_dialog_run_with_icon ()
gint xapp_icon_chooser_dialog_run_with_icon (XAppIconChooserDialog *dialog,gchar *icon);
Like xapp_icon_chooser_dialog_run but selects the icon specified by icon
. This can be either an
icon name or a path. Passing an icon string or path that doesn't exist is accepted, but it may show
multiple results, or none at all. This behavior is useful if, for example, you wish to have the
user select an image file from a particular directory.
If the property allow_paths is FALSE, setting a path will yield no results when the dialog is opened.
xapp_icon_chooser_dialog_run (), xapp_icon_chooser_dialog_run_with_icon(), and
xapp_icon_chooser_dialog_run_with_category() may all be called multiple times. This is useful for
applications which use this dialog multiple times, as it may improve performance for subsequent
calls.
xapp_icon_chooser_dialog_run_with_category ()
gint xapp_icon_chooser_dialog_run_with_category (XAppIconChooserDialog *dialog,gchar *category);
Like xapp_icon_chooser_dialog_run but selects a particular category specified by category
.
This is used when there is a particular category of icon that is more appropriate than the
others. If the category does not exist, the first category in the list will be selected. To
get a list of possible categories, use gtk_icon_theme_list_contexts().
xapp_icon_chooser_dialog_run (), xapp_icon_chooser_dialog_run_with_icon(), and
xapp_icon_chooser_dialog_run_with_category() may all be called multiple times. This is useful for
applications which use this dialog multiple times, as it may improve performance for subsequent
calls.
xapp_icon_chooser_dialog_get_icon_string ()
gchar *
xapp_icon_chooser_dialog_get_icon_string
(XAppIconChooserDialog *dialog);
Gets the currently selected icon from the dialog. If allow-paths is TRUE, this function may return either an icon name or a path depending on what the user selects. Otherwise it will only return an icon name.
xapp_icon_chooser_dialog_add_button ()
void xapp_icon_chooser_dialog_add_button (XAppIconChooserDialog *dialog,GtkWidget *button,GtkPackType packing,GtkResponseType response_id);
Allows a button to be added to the GtkActionBar of the dialog with a custom response id.
Parameters
dialog |
||
button |
a GtkButton to add |
|
packing |
the GtkPackType to specify start or end packing to the action bar |
|
response_id |
the dialog response id to return when this button is clicked. |
xapp_icon_chooser_dialog_get_default_icon ()
gchar *
xapp_icon_chooser_dialog_get_default_icon
(XAppIconChooserDialog *dialog);
Returns the default icon (if set).
xapp_icon_chooser_dialog_set_default_icon ()
void xapp_icon_chooser_dialog_set_default_icon (XAppIconChooserDialog *dialog,const gchar *icon);
Sets the default icon. If icon
is not NULL, a button will be shown that
will reset the dialog to it's default value.
xapp_icon_chooser_dialog_add_custom_category ()
void xapp_icon_chooser_dialog_add_custom_category (XAppIconChooserDialog *dialog,const gchar *name,GList *icons);
Adds a custom category to the dialog.
Types and Values
XAPP_TYPE_ICON_CHOOSER_DIALOG
#define XAPP_TYPE_ICON_CHOOSER_DIALOG (xapp_icon_chooser_dialog_get_type ())
Property Details
The “allow-paths” property
“allow-paths” gboolean
Whether to allow paths to be searched and selected or only icon names.
Owner: XAppIconChooserDialog
Flags: Read / Write
Default value: TRUE
The “default-icon” property
“default-icon” char *
The icon to use by default.
Owner: XAppIconChooserDialog
Flags: Read / Write
Default value: NULL
The “icon-size” property
“icon-size” XAppIconSize
The preferred size to use when looking up icons. This only works with icon names. Additionally, there is no guarantee that a selected icon name will exist in a particular size.
Owner: XAppIconChooserDialog
Flags: Read / Write
Default value: XAPP_ICON_SIZE_32
Signal Details
The “close” signal
void user_function (XAppIconChooserDialog *xappiconchooserdialog, gpointer user_data)
Flags: Action
The “select” signal
void user_function (XAppIconChooserDialog *xappiconchooserdialog, gpointer user_data)
Flags: Action