Class

SpiceClientGLibInputsChannel

Description [src]

class SpiceClientGLib.InputsChannel : SpiceClientGLib.Channel
{
  /* No available fields */
}

The SpiceInputsChannel struct is opaque and should not be accessed directly.

Hierarchy

Ancestors

Instance methods

spice_inputs_channel_button_press

Press a mouse button.

since: 0.35

spice_inputs_channel_button_release

Release a button.

since: 0.35

spice_inputs_channel_key_press

Press a key.

since: 0.35

spice_inputs_channel_key_press_and_release

Press and release a key event atomically (in the same message).

since: 0.35

spice_inputs_channel_key_release

Release a key.

since: 0.35

spice_inputs_channel_motion

Change mouse position (used in SPICE_MOUSE_MODE_SERVER).

since: 0.35

spice_inputs_channel_position

Change mouse position (used in SPICE_MOUSE_MODE_CLIENT).

since: 0.35

spice_inputs_channel_set_key_locks

Set the keyboard locks on the guest (Caps, Num, Scroll..).

since: 0.35

Methods inherited from SpiceChannel (10)

spice_channel_connect

Connect the channel, using SpiceSession connection informations.

spice_channel_destroy

Disconnect and unref the channel.

deprecated: 0.27

spice_channel_disconnect

Close the socket and reset connection specific data. Finally, emit reason SpiceChannel::channel-event on main context if not

SPICE_CHANNEL_NONE.

spice_channel_flush_async

Forces an asynchronous write of all user-space buffered data for the given channel.

since: 0.15

spice_channel_get_error

Retrieves the GError currently set on channel, if the SpiceChannel is in error state and can provide additional error details.

since: 0.24

spice_channel_set_capability

Enable specific channel-kind capability.

deprecated: 0.13

spice_channel_test_capability

Test availability of remote “channel kind capability”.

spice_channel_test_common_capability

Test availability of remote “common channel capability”.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

SpiceClientGLib.InputsChannel:key-modifiers

No description available.

Properties inherited from SpiceChannel (5)

SpiceClientGLib.Channel:channel-id

No description available.

SpiceClientGLib.Channel:channel-type

No description available.

SpiceClientGLib.Channel:socket

Get the underlying GSocket. Note that you should not read or write any data to it directly since this will likely corrupt the channel stream. This property is mainly useful to get some connections details.

since: 0.33

SpiceClientGLib.Channel:spice-session

No description available.

SpiceClientGLib.Channel:total-read-bytes

No description available.

Signals

SpiceClientGLib.InputsChannel::inputs-modifiers

The SpiceInputsChannel::inputs-modifiers signal is emitted when the guest keyboard locks are changed. You can read the current state from SpiceInputsChannel:key-modifiers property.

Signals inherited from SpiceChannel (2)

SpiceChannel::channel-event

The SpiceChannel::channel-event signal is emitted when the state of the connection is changed. In case of errors, spice_channel_get_error() may provide additional informations on the source of the error.

SpiceChannel::open-fd

The SpiceChannel::open-fd signal is emitted when a new connection is requested. This signal is emitted when the connection is made with spice_session_open_fd().

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct SpiceClientGLibInputsChannelClass {
  SpiceChannelClass parent_class;
  void (* inputs_modifiers) (
    SpiceChannel* channel
  );
  
}

Class structure for SpiceInputsChannel.

Class members

parent_class: SpiceChannelClass: Parent class.
inputs_modifiers: void (* inputs_modifiers) ( SpiceChannel* channel ): Signal class handler for the SpiceInputsChannel::inputs-modifiers signal.