SpiceClientGtk.GtkSession

g GObject.Object GObject.Object SpiceClientGtk.GtkSession SpiceClientGtk.GtkSession GObject.Object->SpiceClientGtk.GtkSession

Subclasses:None

Methods

Inherited:GObject.Object (37)
Structs:GObject.ObjectClass (5)
class get (session)
  copy_to_guest ()
  paste_from_guest ()

Virtual Methods

Inherited:GObject.Object (7)

Properties

Name Type Flags Short Description
auto-clipboard bool r/w/c Automatically relay clipboard changes between host and guest.
auto-usbredir bool r/w/c Automatically redirect newly plugged in USBDevices to the guest.
pointer-grabbed bool r Whether the pointer is grabbed
session SpiceClientGLib.Session r/w/co SpiceClientGLib.Session
sync-modifiers bool r/w/c Automatically sync modifiers

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)

Class Details

class SpiceClientGtk.GtkSession(**kwargs)
Bases:GObject.Object
Abstract:No
Structure:SpiceClientGtk.GtkSessionClass

The SpiceClientGtk.GtkSession struct is opaque and should not be accessed directly.

classmethod get(session)
Parameters:session (SpiceClientGLib.Session) – SpiceClientGLib.Session for which to get the SpiceClientGtk.GtkSession
Returns:a weak reference to the SpiceClientGtk.GtkSession associated with the passed in SpiceClientGLib.Session
Return type:SpiceClientGtk.GtkSession

Gets the SpiceClientGtk.GtkSession associated with the passed in SpiceClientGLib.Session. A new SpiceClientGtk.GtkSession instance will be created the first time this function is called for a certain SpiceClientGLib.Session.

Note that this function returns a weak reference, which should not be used after the SpiceClientGLib.Session itself has been unref-ed by the caller.

copy_to_guest()

Copy client-side clipboard to guest clipboard.

New in version 0.8.

paste_from_guest()

Copy guest clipboard to client-side clipboard.

New in version 0.8.

Property Details

SpiceClientGtk.GtkSession.props.auto_clipboard
Name:auto-clipboard
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, CONSTRUCT

When this is true the clipboard gets automatically shared between host and guest.

New in version 0.8.

SpiceClientGtk.GtkSession.props.auto_usbredir
Name:auto-usbredir
Type:bool
Default Value:False
Flags:READABLE, WRITABLE, CONSTRUCT

Automatically redirect newly plugged in USB devices. Note the auto redirection only happens when a SpiceClientGtk.Display associated with the session had keyboard focus.

New in version 0.8.

SpiceClientGtk.GtkSession.props.pointer_grabbed
Name:pointer-grabbed
Type:bool
Default Value:False
Flags:READABLE

Returns True if the pointer is currently grabbed by this session.

New in version 0.27.

SpiceClientGtk.GtkSession.props.session
Name:session
Type:SpiceClientGLib.Session
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

SpiceClientGLib.Session this SpiceClientGtk.GtkSession is associated with

New in version 0.8.

SpiceClientGtk.GtkSession.props.sync_modifiers
Name:sync-modifiers
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, CONSTRUCT

Automatically sync modifiers (Caps, Num and Scroll locks) with the guest.

New in version 0.32.