SpiceClientGLib.CursorChannel¶

Subclasses:: None

Methods¶

Inherited:: SpiceClientGLib.Channel (13), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

Virtual Methods¶

Inherited:: SpiceClientGLib.Channel (8), GObject.Object (7)

	`do_cursor_hide` ()
	`do_cursor_move` (x, y)
	`do_cursor_reset` ()
	`do_cursor_set` (width, height, hot_x, hot_y, rgba)

Properties¶

Inherited:: SpiceClientGLib.Channel (5)

Name	Type	Flags	Short Description
`cursor`	`SpiceClientGLib.CursorShape`	r	Last cursor shape received from the server

Signals¶

Inherited:: SpiceClientGLib.Channel (2), GObject.Object (1)

Name	Short Description
`cursor-hide`	The `SpiceClientGLib.CursorChannel` `::cursor-hide` signal is emitted to hide the cursor/pointer on the display area.
`cursor-move`	The `SpiceClientGLib.CursorChannel` `::cursor-move` signal is emitted to update the cursor position on the display area.
`cursor-reset`	The `SpiceClientGLib.CursorChannel` `::cursor-reset` signal is emitted to reset the cursor to its default context.
`cursor-set`	The `SpiceClientGLib.CursorChannel` `::cursor-set` signal is emitted to modify cursor aspect and position on the display area. `deprecated`

Fields¶

Inherited:: SpiceClientGLib.Channel (2), GObject.Object (1)

Name	Type	Access	Description
parent	`SpiceClientGLib.Channel`	r

Class Details¶

class SpiceClientGLib.CursorChannel(**kwargs)¶

Bases:: SpiceClientGLib.Channel
Abstract:: No
Structure:: SpiceClientGLib.CursorChannelClass

The SpiceClientGLib.CursorChannel struct is opaque and should not be accessed directly.

do_cursor_hide() virtual¶

do_cursor_move(x, y) virtual¶

Parameters:

x (int) –
y (int) –

do_cursor_reset() virtual¶

do_cursor_set(width, height, hot_x, hot_y, rgba) virtual¶

Parameters:

width (int) –
height (int) –
hot_x (int) –
hot_y (int) –
rgba (object or None) –

Signal Details¶

SpiceClientGLib.CursorChannel.signals.cursor_hide(cursor_channel)¶

Signal Name:: cursor-hide
Flags:: RUN_FIRST
Parameters:: cursor_channel (SpiceClientGLib.CursorChannel) – The object which received the signal

The SpiceClientGLib.CursorChannel ::cursor-hide signal is emitted to hide the cursor/pointer on the display area.

SpiceClientGLib.CursorChannel.signals.cursor_move(cursor_channel, x, y)¶

Signal Name:

cursor-move

Flags:

RUN_FIRST

Parameters:

cursor_channel (SpiceClientGLib.CursorChannel) – The object which received the signal
x (int) – x position
y (int) – y position

The SpiceClientGLib.CursorChannel ::cursor-move signal is emitted to update the cursor position on the display area.

SpiceClientGLib.CursorChannel.signals.cursor_reset(cursor_channel)¶

Signal Name:: cursor-reset
Flags:: RUN_FIRST
Parameters:: cursor_channel (SpiceClientGLib.CursorChannel) – The object which received the signal

The SpiceClientGLib.CursorChannel ::cursor-reset signal is emitted to reset the cursor to its default context.

SpiceClientGLib.CursorChannel.signals.cursor_set(cursor_channel, width, height, hot_x, hot_y, rgba)¶

Signal Name:

cursor-set

Flags:

RUN_FIRST, DEPRECATED

Parameters:

cursor_channel (SpiceClientGLib.CursorChannel) – The object which received the signal
width (int) – width of the shape
height (int) – height of the shape
hot_x (int) – horizontal offset of the ‘hotspot’ of the cursor
hot_y (int) – vertical offset of the ‘hotspot’ of the cursor
rgba (object or None) – 32bits shape data, or None if default cursor. It might be freed after the signal is emitted, so make sure to copy it if you need it later!

The SpiceClientGLib.CursorChannel ::cursor-set signal is emitted to modify cursor aspect and position on the display area.

Deprecated since version 0.34: Use SpiceClientGLib.CursorChannel :cursor notify instead.

Property Details¶

SpiceClientGLib.CursorChannel.props.cursor¶

Name:: cursor
Type:: SpiceClientGLib.CursorShape
Default Value:: None
Flags:: READABLE

The last SpiceClientGLib.CursorShape received.

New in version 0.34.