Functions

  set_window_icon_from_file (window, file_name)
  set_window_icon_name (window, icon_name)
  set_window_progress (window, progress)
  set_window_progress_pulse (window, pulse)
  set_xid_icon_from_file (xid, file_name)
  set_xid_icon_name (xid, icon_name)
  set_xid_progress (xid, progress)
  set_xid_progress_pulse (xid, pulse)

Details

XApp.set_window_icon_from_file(window, file_name)
Parameters:
Raises:

GLib.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 Gdk.Window sets on the client side. This also chains up and calls Gtk.Window.set_icon_from_file for convenience and compatibility. Set to None to unset.

XApp.set_window_icon_name(window, icon_name)
Parameters:

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 Gdk.Window 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 None to unset.

XApp.set_window_progress(window, progress)
Parameters:

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(window, pulse)
Parameters:

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_from_file(xid, file_name)
Parameters:
  • xid (int) – The Window to set the icon name for
  • file_name (str or None) – The icon path to set, or None to unset.

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 Gdk.Window 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 None to unset.

XApp.set_xid_icon_name(xid, icon_name)
Parameters:
  • xid (int) – The Window to set the icon name for
  • icon_name (str or None) – The icon name to set, or None to unset.

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 Gdk.Window 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 None to unset.

XApp.set_xid_progress(xid, progress)
Parameters:
  • xid (int) – The Window to set the progress for
  • progress (int) – The value to set for 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(xid, pulse)
Parameters:
  • xid (int) – The Window to set the progress for
  • pulse (bool) – Whether to have pulsing set or not.

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.