gtkmm 3.24.9

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Symbols | List of all members
Gdk::Seat Class Reference

A Gdk::Seat object represents a collection of input devices that belong to a user. More...

`#include <gdkmm/seat.h>`

Inheritance diagram for Gdk::Seat:
[legend]

## Public Types
typedef sigc::slot< void, const Glib::RefPtr< Window > & > | SlotGrabPrepare
| For instance, void on_grab_prepare(const Glib::RefPtr<Gdk::Window>& window);.
Public Types inherited from Glib::Object
typedef void(*)(gpointer data | DestroyNotify)
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify | func_destroy_notify

## Public Member Functions
| Seat (Seat && src) noexcept
Seat & | operator= (Seat && src) noexcept
| ~Seat () noexcept override
GdkSeat * | gobj ()
| Provides access to the underlying C GObject.
const GdkSeat * | gobj () const
| Provides access to the underlying C GObject.
GdkSeat * | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GrabStatus | grab (const Glib::RefPtr< Window > & window, SeatCapabilities capabilities, bool owner_events, const Glib::RefPtr< Cursor > & cursor=Glib::RefPtr< Cursor >(), const GdkEvent * event=nullptr, const SlotGrabPrepare & slot=SlotGrabPrepare())
| Grabs the seat so that all events corresponding to the given capabilities are passed to this application until the seat is ungrabbed with ungrab(), or the window becomes hidden.
void | ungrab ()
| Releases a grab added through grab().
Glib::RefPtr< Display > | get_display ()
| Returns the Gdk::Display this seat belongs to.
Glib::RefPtr< const Display > | get_display () const
| Returns the Gdk::Display this seat belongs to.
SeatCapabilities | get_capabilities () const
| Returns the capabilities this Gdk::Seat currently has.
std::vector< Glib::RefPtr< Device > > | get_slaves (SeatCapabilities capabilities)
| Returns the slave devices that match the given capabilities.
std::vector< Glib::RefPtr< const Device > > | get_slaves (SeatCapabilities capabilities) const
| Returns the slave devices that match the given capabilities.
Glib::RefPtr< Device > | get_pointer ()
| Returns the master device that routes pointer events.
Glib::RefPtr< const Device > | get_pointer () const
| Returns the master device that routes pointer events.
Glib::RefPtr< Device > | get_keyboard ()
| Returns the master device that routes keyboard events.
Glib::RefPtr< const Device > | get_keyboard () const
| Returns the master device that routes keyboard events.
Glib::SignalProxy< void, const Glib::RefPtr< Device > & > | signal_device_added ()
Glib::SignalProxy< void, const Glib::RefPtr< Device > & > | signal_device_removed ()
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > > | property_display () const
| Gdk::Display of this seat.
Public Member Functions inherited from Glib::Object
| Object (const Object &)=delete
Object & | operator= (const Object &)=delete
| Object (Object &&src) noexcept
Object & | operator= (Object &&src) noexcept
void * | get_data (const QueryQuark &key)
void | set_data (const Quark &key, void *data)
void | set_data (const Quark &key, void *data, DestroyNotify notify)
void | remove_data (const QueryQuark &quark)
void * | steal_data (const QueryQuark &quark)
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false)
Public Member Functions inherited from Glib::ObjectBase
| ObjectBase (const ObjectBase &)=delete
ObjectBase & | operator= (const ObjectBase &)=delete
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void | set_property (const Glib::ustring &property_name, const PropertyType &value)
void | get_property (const Glib::ustring &property_name, PropertyType &value) const
void | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot)
void | freeze_notify ()
void | thaw_notify ()
virtual void | reference () const
virtual void | unreference () const
GObject * | gobj ()
const GObject * | gobj () const
GObject * | gobj_copy () const
Public Member Functions inherited from sigc::trackable
| trackable () noexcept
| trackable (const trackable &src) noexcept
| trackable (trackable &&src)
| ~trackable ()
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const
void | notify_callbacks ()
trackable & | operator= (const trackable &src)
trackable & | operator= (trackable &&src)
void | remove_destroy_notify_callback (void *data) const

## Static Public Member Functions
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system.

## Protected Member Functions
| Seat ()
Protected Member Functions inherited from Glib::Object
| Object ()
| Object (const Glib::ConstructParams &construct_params)
| Object (GObject *castitem)
| ~Object () noexcept override
Protected Member Functions inherited from Glib::ObjectBase
| ObjectBase ()
| ObjectBase (const char *custom_type_name)
| ObjectBase (const std::type_info &custom_type_info)
| ObjectBase (ObjectBase &&src) noexcept
ObjectBase & | operator= (ObjectBase &&src) noexcept
virtual | ~ObjectBase () noexcept=0
void | initialize (GObject *castitem)
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)

## Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gdk::Seat > | wrap (GdkSeat * object, bool take_copy=false)
| A Glib::wrap() method for this object.

## Detailed Description

A Gdk::Seat object represents a collection of input devices that belong to a user.

Since gtkmm 3.20

## Member Typedef Documentation

## ◆ SlotGrabPrepare

typedef sigc::slot<void, const Glib::RefPtr<Window>&> Gdk::Seat::SlotGrabPrepare

For instance,
void on_grab_prepare(const Glib::RefPtr<Gdk::Window>& window);.

Type of the callback used to set up window so it can be grabbed. A typical action would be ensuring the window is visible, although there's room for other initialization actions.

Parameters

  window | The Gdk::Window being grabbed.

Since gtkmm 3.20

## Constructor & Destructor Documentation

## ◆ Seat() [1/2]

Gdk::Seat::Seat | ( | Seat && | src | ) |
| noexcept

## ◆ ~Seat()

Gdk::Seat::~Seat | ( |  | ) |
| override noexcept

## ◆ Seat() [2/2]

Gdk::Seat::Seat | ( |  | ) |
| protected

## Member Function Documentation

## ◆ get_capabilities()

SeatCapabilities Gdk::Seat::get_capabilities | ( |  | ) | const

Returns the capabilities this Gdk::Seat currently has.

Since gtkmm 3.20

Returns
  The seat capabilities.

## ◆ get_display() [1/2]

Glib::RefPtr< Display > Gdk::Seat::get_display | ( |  | ) |

Returns the Gdk::Display this seat belongs to.

Returns
  A Gdk::Display. This object is owned by GTK+ and must not be freed.

## ◆ get_display() [2/2]

Glib::RefPtr< const Display > Gdk::Seat::get_display | ( |  | ) | const

Returns the Gdk::Display this seat belongs to.

Returns
  A Gdk::Display. This object is owned by GTK+ and must not be freed.

## ◆ get_keyboard() [1/2]

Glib::RefPtr< Device > Gdk::Seat::get_keyboard | ( |  | ) |

Returns the master device that routes keyboard events.

Since gtkmm 3.20

Returns
  A master Gdk::Device with keyboard capabilities. This object is owned by GTK+ and must not be freed.

## ◆ get_keyboard() [2/2]

Glib::RefPtr< const Device > Gdk::Seat::get_keyboard | ( |  | ) | const

Returns the master device that routes keyboard events.

Since gtkmm 3.20

Returns
  A master Gdk::Device with keyboard capabilities. This object is owned by GTK+ and must not be freed.

## ◆ get_pointer() [1/2]

Glib::RefPtr< Device > Gdk::Seat::get_pointer | ( |  | ) |

Returns the master device that routes pointer events.

Since gtkmm 3.20

Returns
  A master Gdk::Device with pointer capabilities. This object is owned by GTK+ and must not be freed.

## ◆ get_pointer() [2/2]

Glib::RefPtr< const Device > Gdk::Seat::get_pointer | ( |  | ) | const

Returns the master device that routes pointer events.

Since gtkmm 3.20

Returns
  A master Gdk::Device with pointer capabilities. This object is owned by GTK+ and must not be freed.

## ◆ get_slaves() [1/2]

std::vector< Glib::RefPtr< Device > > Gdk::Seat::get_slaves | ( | SeatCapabilities | capabilities | ) |

Returns the slave devices that match the given capabilities.

Since gtkmm 3.20

Parameters

  capabilities | Capabilities to get devices for.

Returns
  A list of Gdk::Devices.

## ◆ get_slaves() [2/2]

std::vector< Glib::RefPtr< const Device > > Gdk::Seat::get_slaves | ( | SeatCapabilities | capabilities | ) | const

Returns the slave devices that match the given capabilities.

Since gtkmm 3.20

Parameters

  capabilities | Capabilities to get devices for.

Returns
  A list of Gdk::Devices.

## ◆ get_type()

static GType Gdk::Seat::get_type | ( |  | ) |
| static

Get the GType for this class, for use with the underlying GObject type system.

## ◆ gobj() [1/2]

GdkSeat * Gdk::Seat::gobj | ( |  | ) |
| inline

Provides access to the underlying C GObject.

## ◆ gobj() [2/2]

const GdkSeat * Gdk::Seat::gobj | ( |  | ) | const
| inline

Provides access to the underlying C GObject.

## ◆ gobj_copy()

GdkSeat * Gdk::Seat::gobj_copy | ( |  | ) |

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

## ◆ grab()

GrabStatus Gdk::Seat::grab | ( | const Glib::RefPtr< Window > & | window,
|  | SeatCapabilities | capabilities,
|  | bool | owner_events,
|  | const Glib::RefPtr< Cursor > & | cursor = Glib::RefPtr< Cursor >(),
|  | const GdkEvent * | event = nullptr,
|  | const SlotGrabPrepare & | slot = SlotGrabPrepare() )

Grabs the seat so that all events corresponding to the given capabilities are passed to this application until the seat is ungrabbed with ungrab(), or the window becomes hidden.

This overrides any previous grab on the seat by this client.

As a rule of thumb, if a grab is desired over Gdk::SEAT_CAPABILITY_POINTER, all other "pointing" capabilities (eg. Gdk::SEAT_CAPABILITY_TOUCH) should be grabbed too, so the user is able to interact with all of those while the grab holds, you should thus use Gdk::SEAT_CAPABILITY_ALL_POINTING most commonly.

Grabs are used for operations which need complete control over the events corresponding to the given capabilities. For example in GTK+ this is used for Drag and Drop operations, popup menus and such.

Note that if the event mask of a Gdk::Window has selected both button press and button release events, or touch begin and touch end, then a press event will cause an automatic grab until the button is released, equivalent to a grab on the window with owner_events set to `true`. This is done because most applications expect to receive paired press and release events.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the Gdk::EventGrabBroken events that are emitted when the grab ends unvoluntarily.

Since gtkmm 3.20

Parameters

  window | The Gdk::Window which will own the grab.
  capabilities | Capabilities that will be grabbed.
  owner_events | If `false` then all device events are reported with respect to window and are only reported if selected by event_mask. If `true` then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to window and only if selected by event_mask. In either mode, unreported events are discarded.
  cursor | The cursor to display while the grab is active. If this is `nullptr` then the normal cursors are used for window and its descendants, and the cursor for window is used elsewhere.
  event | The event that is triggering the grab, or `nullptr` if none is available.
  slot | Function to prepare the window to be grabbed, it can be `nullptr` if window is visible before this call.

Returns
  Gdk::GRAB_SUCCESS if the grab was successful.

## ◆ operator=()

Seat & Gdk::Seat::operator= | ( | Seat && | src | ) |
| noexcept

## ◆ property_display()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > > Gdk::Seat::property_display | ( |  | ) | const

Gdk::Display of this seat.

Since gtkmm 3.20

Returns
  A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

## ◆ signal_device_added()

Glib::SignalProxy< void, const Glib::RefPtr< Device > & > Gdk::Seat::signal_device_added | ( |  | ) |

Slot Prototype:
  `void on_my_device_added(const Glib::RefPtr<Device>& device)`

Flags: Run Last

The signal_device_added() signal is emitted when a new input device is related to this seat.

Since gtkmm 3.20

Parameters

  device | The newly added Gdk::Device.

## ◆ signal_device_removed()

Glib::SignalProxy< void, const Glib::RefPtr< Device > & > Gdk::Seat::signal_device_removed | ( |  | ) |

Slot Prototype:
  `void on_my_device_removed(const Glib::RefPtr<Device>& device)`

Flags: Run Last

The signal_device_removed() signal is emitted when an input device is removed (e.g. unplugged).

Since gtkmm 3.20

Parameters

  device | The just removed Gdk::Device.

## ◆ ungrab()

void Gdk::Seat::ungrab | ( |  | ) |

Releases a grab added through grab().

Since gtkmm 3.20

## Friends And Related Symbol Documentation

## ◆ wrap()

Glib::RefPtr< Gdk::Seat > wrap | ( | GdkSeat * | object,
|  | bool | take_copy = false )
| related

A Glib::wrap() method for this object.

Parameters

  object | The C instance.
  take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns
  A C++ instance that wraps this C instance.