![]() |
![]() |
![]() |
Spice-GTK Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#include <spice-client.h> struct SpiceCursorChannel; struct SpiceCursorChannelClass; struct SpiceCursorShape;
"cursor-hide" :Run First
"cursor-move" :Run First
"cursor-reset" :Run First
"cursor-set" :Run First
The Spice protocol defines a set of messages for controlling cursor shape and position on the remote display area. The cursor changes that should be reflected on the display are notified by signals. See for example "cursor-set" and "cursor-move" signals and the "cursor" property.
struct SpiceCursorChannel;
The SpiceCursorChannel struct is opaque and should not be accessed directly.
struct SpiceCursorChannelClass { SpiceChannelClass parent_class; /* signals */ void (*cursor_set)(SpiceCursorChannel *channel, gint width, gint height, gint hot_x, gint hot_y, gpointer rgba); void (*cursor_move)(SpiceCursorChannel *channel, gint x, gint y); void (*cursor_hide)(SpiceCursorChannel *channel); void (*cursor_reset)(SpiceCursorChannel *channel); };
Class structure for SpiceCursorChannel.
SpiceChannelClass |
Parent class. |
Signal class handler for the "cursor-set" signal. | |
Signal class handler for the "cursor-move" signal. | |
Signal class handler for the "cursor-hide" signal. | |
Signal class handler for the "cursor-reset" signal. |
struct SpiceCursorShape { SpiceCursorType type; guint16 width; guint16 height; guint16 hot_spot_x; guint16 hot_spot_y; gpointer data; };
The SpiceCursorShape structure defines the remote cursor's shape.
a SpiceCursorType of data
|
|
a width of the remote cursor | |
a height of the remote cursor | |
a 'x' coordinate of the remote cursor | |
a 'y' coordinate of the remote cursor | |
image data of the remote cursor |
"cursor"
property"cursor" SpiceCursorShape* : Read
The last SpiceCursorShape received.
Since 0.34
"cursor-hide"
signalvoid user_function (SpiceCursorChannel *cursor,
gpointer user_data) : Run First
The "cursor-hide" signal is emitted to hide the cursor/pointer on the display area.
|
the SpiceCursorChannel that emitted the signal |
|
user data set when the signal handler was connected. |
"cursor-move"
signalvoid user_function (SpiceCursorChannel *cursor,
gint x,
gint y,
gpointer user_data) : Run First
The "cursor-move" signal is emitted to update the cursor position on the display area.
|
the SpiceCursorChannel that emitted the signal |
|
x position |
|
y position |
|
user data set when the signal handler was connected. |
"cursor-reset"
signalvoid user_function (SpiceCursorChannel *cursor,
gpointer user_data) : Run First
The "cursor-reset" signal is emitted to reset the cursor to its default context.
|
the SpiceCursorChannel that emitted the signal |
|
user data set when the signal handler was connected. |
"cursor-set"
signalvoid user_function (SpiceCursorChannel *cursor,
gint width,
gint height,
gint hot_x,
gint hot_y,
gpointer rgba,
gpointer user_data) : Run First
SpiceCursorChannel::cursor-set
has been deprecated since version 0.34 and should not be used in newly-written code. Use "cursor" notify instead.
The "cursor-set" signal is emitted to modify cursor aspect and position on the display area.
|
the SpiceCursorChannel that emitted the signal |
|
width of the shape |
|
height of the shape |
|
horizontal offset of the 'hotspot' of the cursor |
|
vertical offset of the 'hotspot' of the cursor |
|
32bits shape data, or NULL if default cursor. It might
be freed after the signal is emitted, so make sure to copy it
if you need it later! |
|
user data set when the signal handler was connected. |