CScreensaver.Screen¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_global_scale` ()
class	`get_net_wm_name` (xwindow)
class	`new` (debug)
class	`reset_screensaver` ()
class	`set_net_wm_name` (window, name)
	`get_low_res_mode` ()
	`get_monitor_geometry` (monitor)
	`get_mouse_monitor` ()
	`get_n_monitors` ()
	`get_primary_monitor` ()
	`get_screen_geometry` ()
	`get_smallest_monitor_sizes` ()
	`place_pointer_in_primary_monitor` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`composited-changed`
`monitors-changed`
`size-changed`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
composited_changed_id	`int`	r
gdk_screen	`Gdk.Screen`	r
low_res	`bool`	r
monitor_infos	`CScreensaver.MonitorInfo`	r
monitors_changed_id	`int`	r
n_monitor_infos	`int`	r
obj	`GObject.Object`	r
primary_monitor_index	`int`	r
rect	`Gdk.Rectangle`	r
screen_size_changed_id	`int`	r
smallest_height	`int`	r
smallest_width	`int`	r

Class Details¶

class CScreensaver.Screen(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: CScreensaver.ScreenClass

classmethod get_global_scale()¶

Return type:: int

Retrieves the global scale factor from the Gdk.Screen.

classmethod get_net_wm_name(xwindow)¶

Parameters:: xwindow (int) – The Window (XID) to get the property from.
Returns:: The value of NET_WM_NAME.
Return type:: str

Gets the NET_WM_NAME of xwindow

classmethod new(debug)¶

Parameters:: debug (bool) –
Return type:: CScreensaver.Screen

classmethod reset_screensaver()¶: Resets the screensaver idle timer. If called when the screensaver is active it will stop it.

classmethod set_net_wm_name(window, name)¶

Parameters:

window (Gdk.Window) – The Gdk.Window to set the property on
name (str) – The name.

Sets _NET_WM_NAME to name on window

get_low_res_mode()¶

Returns:: Whether or not to use low res mode.
Return type:: bool

Gets whether or not one of our monitors falls below the low res threshold (1200 wide). This lets us display certain things at smaller sizes to prevent truncating of images, etc.

get_monitor_geometry(monitor)¶

Parameters:: monitor (int) – the monitor number
Returns:: location to store the monitor geometry
Return type:: geometry: Gdk.Rectangle

Stores the location and size of the indicated monitor in geometry.

get_mouse_monitor()¶

Returns:: the monitor index for the pointer
Return type:: int

Gets the index of the monitor that the mouse pointer currently occupies.

get_n_monitors()¶

Returns:: the number of monitors
Return type:: int

Gets the number of monitors that are joined together to form self.

get_primary_monitor()¶

Returns:: a monitor index
Return type:: int

Gets the index of the primary monitor on this self.

get_screen_geometry()¶

Returns:: location to store the screen geometry
Return type:: geometry: Gdk.Rectangle

Stores the location and size of the screen in geometry.

get_smallest_monitor_sizes()¶

Returns:

width:: width of the smallest monitor
height:: height of the smallest monitor

Return type:

(width: int, height: int)

Gets whether or not one of our monitors falls below the low res threshold (1200 wide). This lets us display certain things at smaller sizes to prevent truncating of images, etc.

place_pointer_in_primary_monitor()¶

Signal Details¶

CScreensaver.Screen.signals.composited_changed(screen)¶

Signal Name:: composited-changed
Flags:: RUN_LAST
Parameters:: screen (CScreensaver.Screen) – The object which received the signal

CScreensaver.Screen.signals.monitors_changed(screen)¶

Signal Name:: monitors-changed
Flags:: RUN_LAST
Parameters:: screen (CScreensaver.Screen) – The object which received the signal

CScreensaver.Screen.signals.size_changed(screen)¶

Signal Name:: size-changed
Flags:: RUN_LAST
Parameters:: screen (CScreensaver.Screen) – The object which received the signal