gtkmm  3.93.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gdk::Display Class Reference

Gdk::Display object's purpose is two fold: To grab/ungrab keyboard focus and mouse pointer To manage and provide information about the Gdk::Monitor(s) available for this Gdk::Display. More...

#include <gdkmm/display.h>

Inheritance diagram for Gdk::Display:
Inheritance graph
[legend]

Public Member Functions

 Display (Display&& src) noexcept
 
Displayoperator= (Display&& src) noexcept
 
 ~Display () noexcept override
 
GdkDisplay* gobj ()
 Provides access to the underlying C GObject. More...
 
const GdkDisplay* gobj () const
 Provides access to the underlying C GObject. More...
 
GdkDisplay* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring get_name () const
 Gets the name of the display. More...
 
bool device_is_grabbed (const Glib::RefPtr< const Gdk::Device >& device) const
 Returns true if there is an ongoing grab on device for display. More...
 
void beep ()
 Emits a short beep on display. More...
 
void sync ()
 Flushes any requests queued for the windowing system and waits until all requests have been handled. More...
 
void close ()
 Closes the connection to the windowing system for the given display, and cleans up associated resources. More...
 
bool is_closed () const
 Finds out if the display has been closed. More...
 
bool is_composited () const
 Returns whether windows can reasonably be expected to have their alpha channel drawn correctly on the screen. More...
 
bool is_rgba () const
 Returns wether windows on this display are created with an alpha channel. More...
 
Glib::RefPtr< Eventget_event ()
 Gets the next Gdk::Event to be processed for display, fetching events from the windowing system if necessary. More...
 
Glib::RefPtr< Eventpeek_event ()
 Gets a copy of the first Gdk::Event in the display’s event queue, without removing the event from the queue. More...
 
Glib::RefPtr< const Eventpeek_event () const
 Gets a copy of the first Gdk::Event in the display’s event queue, without removing the event from the queue. More...
 
void put_event (const Glib::RefPtr< const Event >& event)
 Appends a copy of the given event onto the front of the event queue for display. More...
 
bool has_pending () const
 Returns whether the display has events that are waiting to be processed. More...
 
GdkKeymap* get_keymap ()
 Returns the Gdk::Keymap attached to display. More...
 
const GdkKeymap* get_keymap () const
 Returns the Gdk::Keymap attached to display. More...
 
void flush ()
 Flushes any requests queued for the windowing system; this happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitly. More...
 
Glib::RefPtr< Windowget_default_group ()
 Returns the default group leader window for all toplevel windows on display. More...
 
Glib::RefPtr< const Windowget_default_group () const
 Returns the default group leader window for all toplevel windows on display. More...
 
Glib::RefPtr< Clipboardget_clipboard ()
 Gets the clipboard used for copy/paste operations. More...
 
Glib::RefPtr< const Clipboardget_clipboard () const
 Gets the clipboard used for copy/paste operations. More...
 
Glib::RefPtr< Clipboardget_primary_clipboard ()
 Gets the clipboard used for the primary selection. More...
 
Glib::RefPtr< const Clipboardget_primary_clipboard () const
 Gets the clipboard used for the primary selection. More...
 
bool supports_shapes () const
 Returns true if gdk_window_shape_combine_mask() can be used to create shaped windows on display. More...
 
bool supports_input_shapes () const
 Returns true if gdk_window_input_shape_combine_mask() can be used to modify the input shape of windows on display. More...
 
void notify_startup_complete (const Glib::ustring& startup_id)
 Indicates to the GUI environment that the application has finished loading, using a given identifier. More...
 
Glib::RefPtr< AppLaunchContextget_app_launch_context ()
 Returns a Gdk::AppLaunchContext suitable for launching applications on the given display. More...
 
Glib::RefPtr< const AppLaunchContextget_app_launch_context () const
 Returns a Gdk::AppLaunchContext suitable for launching applications on the given display. More...
 
Glib::RefPtr< Seatget_default_seat ()
 Returns the default Gdk::Seat for this display. More...
 
Glib::RefPtr< const Seatget_default_seat () const
 Returns the default Gdk::Seat for this display. More...
 
std::vector< Glib::RefPtr< Seat > > list_seats ()
 Returns the list of seats known to display. More...
 
std::vector< Glib::RefPtr< const Seat > > list_seats () const
 Returns the list of seats known to display. More...
 
int get_n_monitors () const
 Gets the number of monitors that belong to display. More...
 
Glib::RefPtr< Monitorget_monitor (int monitor_num)
 Gets a monitor associated with this display. More...
 
Glib::RefPtr< const Monitorget_monitor (int monitor_num) const
 Gets a monitor associated with this display. More...
 
Glib::RefPtr< Monitorget_primary_monitor ()
 Gets the primary monitor for the display. More...
 
Glib::RefPtr< const Monitorget_primary_monitor () const
 Gets the primary monitor for the display. More...
 
Glib::RefPtr< Monitorget_monitor_at_point (int x, int y)
 Gets the monitor in which the point ( x, y) is located, or a nearby monitor if the point is not in any monitor. More...
 
Glib::RefPtr< const Monitorget_monitor_at_point (int x, int y) const
 Gets the monitor in which the point ( x, y) is located, or a nearby monitor if the point is not in any monitor. More...
 
Glib::RefPtr< Monitorget_monitor_at_window (const Glib::RefPtr< Window >& window)
 Gets the monitor in which the largest area of window resides, or a monitor close to window if it is outside of all monitors. More...
 
Glib::RefPtr< const Monitorget_monitor_at_window (const Glib::RefPtr< Window >& window) const
 Gets the monitor in which the largest area of window resides, or a monitor close to window if it is outside of all monitors. More...
 
template<class ValueType >
bool get_setting (const Glib::ustring& name, ValueType& value) const
 
Glib::SignalProxy< void(bool)> signal_closed ()
 
Glib::SignalProxy< void()> signal_opened ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Seat >&)> signal_seat_added ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Seat >&)> signal_seat_removed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Monitor >&)> signal_monitor_added ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Monitor >&)> signal_monitor_removed ()
 
Glib::SignalProxy< void(const Glib::ustring&)> signal_setting_changed ()
 
Glib::PropertyProxy_ReadOnly< bool > property_composited () const
 true if the display properly composits the alpha channel. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_rgba () const
 true if the display supports an alpha channel. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (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::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (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
 
PropertyType get_property (const Glib::ustring &property_name) const
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
 
sigc::connection connect_property_changed (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 ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (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. More...
 
static Glib::RefPtr< Displayopen (const Glib::ustring& display_name)
 Opens a display. More...
 
static Glib::RefPtr< Displayget_default ()
 Gets the default Gdk::Display. More...
 

Protected Member Functions

 Display ()
 
- 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
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gdk::Displaywrap (GdkDisplay* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- 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
 

Detailed Description

Gdk::Display object's purpose is two fold: To grab/ungrab keyboard focus and mouse pointer To manage and provide information about the Gdk::Monitor(s) available for this Gdk::Display.

Gdk::Display objects are the GDK representation of the X Display which can be described as a workstation consisting of a keyboard a pointing device (such as a mouse) and one or more screens. It is used to open and keep track of various Gdk::Monitor objects currently instantiated by the application. It is also used to grab and release the keyboard and the mouse pointer.

Constructor & Destructor Documentation

◆ Display() [1/2]

Gdk::Display::Display ( Display&&  src)
noexcept

◆ ~Display()

Gdk::Display::~Display ( )
overridenoexcept

◆ Display() [2/2]

Gdk::Display::Display ( )
protected

Member Function Documentation

◆ beep()

void Gdk::Display::beep ( )

Emits a short beep on display.

◆ close()

void Gdk::Display::close ( )

Closes the connection to the windowing system for the given display, and cleans up associated resources.

◆ device_is_grabbed()

bool Gdk::Display::device_is_grabbed ( const Glib::RefPtr< const Gdk::Device >&  device) const

Returns true if there is an ongoing grab on device for display.

Parameters
deviceA Gdk::Device.
Returns
true if there is a grab in effect for device.

◆ flush()

void Gdk::Display::flush ( )

Flushes any requests queued for the windowing system; this happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitly.

A common case where this function needs to be called is when an application is executing drawing commands from a thread other than the thread where the main loop is running.

This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing.

◆ get_app_launch_context() [1/2]

Glib::RefPtr<AppLaunchContext> Gdk::Display::get_app_launch_context ( )

Returns a Gdk::AppLaunchContext suitable for launching applications on the given display.

Returns
A new Gdk::AppLaunchContext for display. Free with Glib::object_unref() when done.

◆ get_app_launch_context() [2/2]

Glib::RefPtr<const AppLaunchContext> Gdk::Display::get_app_launch_context ( ) const

Returns a Gdk::AppLaunchContext suitable for launching applications on the given display.

Returns
A new Gdk::AppLaunchContext for display. Free with Glib::object_unref() when done.

◆ get_clipboard() [1/2]

Glib::RefPtr<Clipboard> Gdk::Display::get_clipboard ( )

Gets the clipboard used for copy/paste operations.

Returns
The display's clipboard.

◆ get_clipboard() [2/2]

Glib::RefPtr<const Clipboard> Gdk::Display::get_clipboard ( ) const

Gets the clipboard used for copy/paste operations.

Returns
The display's clipboard.

◆ get_default()

static Glib::RefPtr<Display> Gdk::Display::get_default ( )
static

Gets the default Gdk::Display.

This is a convenience function for: gdk_display_manager_get_default_display (Gdk::DisplayManager::get()).

Returns
A Gdk::Display, or nullptr if there is no default display.

◆ get_default_group() [1/2]

Glib::RefPtr<Window> Gdk::Display::get_default_group ( )

Returns the default group leader window for all toplevel windows on display.

This window is implicitly created by GDK. See Gdk::Window::set_group().

Returns
The default group leader window for display.

◆ get_default_group() [2/2]

Glib::RefPtr<const Window> Gdk::Display::get_default_group ( ) const

Returns the default group leader window for all toplevel windows on display.

This window is implicitly created by GDK. See Gdk::Window::set_group().

Returns
The default group leader window for display.

◆ get_default_seat() [1/2]

Glib::RefPtr<Seat> Gdk::Display::get_default_seat ( )

Returns the default Gdk::Seat for this display.

Returns
The default seat.

◆ get_default_seat() [2/2]

Glib::RefPtr<const Seat> Gdk::Display::get_default_seat ( ) const

Returns the default Gdk::Seat for this display.

Returns
The default seat.

◆ get_event()

Glib::RefPtr<Event> Gdk::Display::get_event ( )

Gets the next Gdk::Event to be processed for display, fetching events from the windowing system if necessary.

Returns
The next Gdk::Event to be processed, or nullptr if no events are pending.

◆ get_keymap() [1/2]

GdkKeymap* Gdk::Display::get_keymap ( )

Returns the Gdk::Keymap attached to display.

Returns
The Gdk::Keymap attached to display.

◆ get_keymap() [2/2]

const GdkKeymap* Gdk::Display::get_keymap ( ) const

Returns the Gdk::Keymap attached to display.

Returns
The Gdk::Keymap attached to display.

◆ get_monitor() [1/2]

Glib::RefPtr<Monitor> Gdk::Display::get_monitor ( int  monitor_num)

Gets a monitor associated with this display.

Parameters
monitor_numNumber of the monitor.
Returns
The Gdk::Monitor, or nullptr if monitor_num is not a valid monitor number.

◆ get_monitor() [2/2]

Glib::RefPtr<const Monitor> Gdk::Display::get_monitor ( int  monitor_num) const

Gets a monitor associated with this display.

Parameters
monitor_numNumber of the monitor.
Returns
The Gdk::Monitor, or nullptr if monitor_num is not a valid monitor number.

◆ get_monitor_at_point() [1/2]

Glib::RefPtr<Monitor> Gdk::Display::get_monitor_at_point ( int  x,
int  y 
)

Gets the monitor in which the point ( x, y) is located, or a nearby monitor if the point is not in any monitor.

Parameters
xThe x coordinate of the point.
yThe y coordinate of the point.
Returns
The monitor containing the point.

◆ get_monitor_at_point() [2/2]

Glib::RefPtr<const Monitor> Gdk::Display::get_monitor_at_point ( int  x,
int  y 
) const

Gets the monitor in which the point ( x, y) is located, or a nearby monitor if the point is not in any monitor.

Parameters
xThe x coordinate of the point.
yThe y coordinate of the point.
Returns
The monitor containing the point.

◆ get_monitor_at_window() [1/2]

Glib::RefPtr<Monitor> Gdk::Display::get_monitor_at_window ( const Glib::RefPtr< Window >&  window)

Gets the monitor in which the largest area of window resides, or a monitor close to window if it is outside of all monitors.

Parameters
windowA Gdk::Window.
Returns
The monitor with the largest overlap with window.

◆ get_monitor_at_window() [2/2]

Glib::RefPtr<const Monitor> Gdk::Display::get_monitor_at_window ( const Glib::RefPtr< Window >&  window) const

Gets the monitor in which the largest area of window resides, or a monitor close to window if it is outside of all monitors.

Parameters
windowA Gdk::Window.
Returns
The monitor with the largest overlap with window.

◆ get_n_monitors()

int Gdk::Display::get_n_monitors ( ) const

Gets the number of monitors that belong to display.

The returned number is valid until the next emission of the Gdk::Display::signal_monitor_added() or Gdk::Display::signal_monitor_removed() signal.

Returns
The number of monitors.

◆ get_name()

Glib::ustring Gdk::Display::get_name ( ) const

Gets the name of the display.

Returns
A string representing the display name. This string is owned by GDK and should not be modified or freed.

◆ get_primary_clipboard() [1/2]

Glib::RefPtr<Clipboard> Gdk::Display::get_primary_clipboard ( )

Gets the clipboard used for the primary selection.

On backends where the primary clipboard is not supported natively, GDK emulates this clipboard locally.

Returns
The primary clipboard.

◆ get_primary_clipboard() [2/2]

Glib::RefPtr<const Clipboard> Gdk::Display::get_primary_clipboard ( ) const

Gets the clipboard used for the primary selection.

On backends where the primary clipboard is not supported natively, GDK emulates this clipboard locally.

Returns
The primary clipboard.

◆ get_primary_monitor() [1/2]

Glib::RefPtr<Monitor> Gdk::Display::get_primary_monitor ( )

Gets the primary monitor for the display.

The primary monitor is considered the monitor where the “main desktop” lives. While normal application windows typically allow the window manager to place the windows, specialized desktop applications such as panels should place themselves on the primary monitor.

If no monitor is the designated primary monitor, any monitor (usually the first) may be returned. To make sure there is a dedicated primary monitor, use Gdk::Monitor::is_primary() on the returned monitor.

Returns
The primary monitor, or any monitor if no primary monitor is configured by the user.

◆ get_primary_monitor() [2/2]

Glib::RefPtr<const Monitor> Gdk::Display::get_primary_monitor ( ) const

Gets the primary monitor for the display.

The primary monitor is considered the monitor where the “main desktop” lives. While normal application windows typically allow the window manager to place the windows, specialized desktop applications such as panels should place themselves on the primary monitor.

If no monitor is the designated primary monitor, any monitor (usually the first) may be returned. To make sure there is a dedicated primary monitor, use Gdk::Monitor::is_primary() on the returned monitor.

Returns
The primary monitor, or any monitor if no primary monitor is configured by the user.

◆ get_setting()

template <class ValueType >
bool Gdk::Display::get_setting ( const Glib::ustring name,
ValueType &  value 
) const

◆ get_type()

static GType Gdk::Display::get_type ( )
static

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

◆ gobj() [1/2]

GdkDisplay* Gdk::Display::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GdkDisplay* Gdk::Display::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GdkDisplay* Gdk::Display::gobj_copy ( )

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

◆ has_pending()

bool Gdk::Display::has_pending ( ) const

Returns whether the display has events that are waiting to be processed.

Returns
true if there are events ready to be processed.

◆ is_closed()

bool Gdk::Display::is_closed ( ) const

Finds out if the display has been closed.

Returns
true if the display is closed.

◆ is_composited()

bool Gdk::Display::is_composited ( ) const

Returns whether windows can reasonably be expected to have their alpha channel drawn correctly on the screen.

Check is_rgba() for wether the display supports an alpha channel.

On X11 this function returns whether a compositing manager is compositing on display.

On modern displays, this value is always true.

Returns
Whether windows with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen.

◆ is_rgba()

bool Gdk::Display::is_rgba ( ) const

Returns wether windows on this display are created with an alpha channel.

Even if a true is returned, it is possible that the window’s alpha channel won’t be honored when displaying the window on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display. Use is_composited() to check if that is the case.

For setting an overall opacity for a top-level window, see Gdk::Window::set_opacity().

On modern displays, this value is always true.

Returns
true if windows are created with an alpha channel or false if the display does not support this functionality.

◆ list_seats() [1/2]

std::vector<Glib::RefPtr<Seat> > Gdk::Display::list_seats ( )

Returns the list of seats known to display.

Returns
The list of seats known to the Gdk::Display.

◆ list_seats() [2/2]

std::vector<Glib::RefPtr<const Seat> > Gdk::Display::list_seats ( ) const

Returns the list of seats known to display.

Returns
The list of seats known to the Gdk::Display.

◆ notify_startup_complete()

void Gdk::Display::notify_startup_complete ( const Glib::ustring startup_id)

Indicates to the GUI environment that the application has finished loading, using a given identifier.

GTK+ will call this function automatically for Gtk::Window with custom startup-notification identifier unless gtk_window_set_auto_startup_notification() is called to disable that feature.

Parameters
startup_idA startup-notification identifier, for which notification process should be completed.

◆ open()

static Glib::RefPtr<Display> Gdk::Display::open ( const Glib::ustring display_name)
static

Opens a display.

Parameters
display_nameThe name of the display to open.
Returns
A Gdk::Display, or nullptr if the display could not be opened.

◆ operator=()

Display& Gdk::Display::operator= ( Display&&  src)
noexcept

◆ peek_event() [1/2]

Glib::RefPtr<Event> Gdk::Display::peek_event ( )

Gets a copy of the first Gdk::Event in the display’s event queue, without removing the event from the queue.

(Note that this function will not get more events from the windowing system. It only checks the events that have already been moved to the GDK event queue.)

Returns
The first Gdk::Event on the event queue.

◆ peek_event() [2/2]

Glib::RefPtr<const Event> Gdk::Display::peek_event ( ) const

Gets a copy of the first Gdk::Event in the display’s event queue, without removing the event from the queue.

(Note that this function will not get more events from the windowing system. It only checks the events that have already been moved to the GDK event queue.)

Returns
The first Gdk::Event on the event queue.

◆ property_composited()

Glib::PropertyProxy_ReadOnly< bool > Gdk::Display::property_composited ( ) const

true if the display properly composits the alpha channel.

See Gdk::Display::is_composited() for details.

Default value: true

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

◆ property_rgba()

Glib::PropertyProxy_ReadOnly< bool > Gdk::Display::property_rgba ( ) const

true if the display supports an alpha channel.

See Gdk::Display::is_rgba() for details.

Default value: true

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

◆ put_event()

void Gdk::Display::put_event ( const Glib::RefPtr< const Event >&  event)

Appends a copy of the given event onto the front of the event queue for display.

Parameters
eventA Gdk::Event.

◆ signal_closed()

Glib::SignalProxy<void(bool)> Gdk::Display::signal_closed ( )
Slot Prototype:
void on_my_closed(bool is_error)

Flags: Run Last

The signal_closed() signal is emitted when the connection to the windowing system for display is closed.

Parameters
is_errortrue if the display was closed due to an error.

◆ signal_monitor_added()

Glib::SignalProxy<void(const Glib::RefPtr<Monitor>&)> Gdk::Display::signal_monitor_added ( )
Slot Prototype:
void on_my_monitor_added(const Glib::RefPtr<Monitor>& monitor)

Flags: Run Last

The signal_monitor_added() signal is emitted whenever a monitor is added.

Parameters
monitorThe monitor that was just added.

◆ signal_monitor_removed()

Glib::SignalProxy<void(const Glib::RefPtr<Monitor>&)> Gdk::Display::signal_monitor_removed ( )
Slot Prototype:
void on_my_monitor_removed(const Glib::RefPtr<Monitor>& monitor)

Flags: Run Last

The signal_monitor_removed() signal is emitted whenever a monitor is removed.

Parameters
monitorThe monitor that was just removed.

◆ signal_opened()

Glib::SignalProxy<void()> Gdk::Display::signal_opened ( )
Slot Prototype:
void on_my_opened()

Flags: Run Last

The signal_opened() signal is emitted when the connection to the windowing system for display is opened.

◆ signal_seat_added()

Glib::SignalProxy<void(const Glib::RefPtr<Seat>&)> Gdk::Display::signal_seat_added ( )
Slot Prototype:
void on_my_seat_added(const Glib::RefPtr<Seat>& seat)

Flags: Run Last

The signal_seat_added() signal is emitted whenever a new seat is made known to the windowing system.

Parameters
seatThe seat that was just added.

◆ signal_seat_removed()

Glib::SignalProxy<void(const Glib::RefPtr<Seat>&)> Gdk::Display::signal_seat_removed ( )
Slot Prototype:
void on_my_seat_removed(const Glib::RefPtr<Seat>& seat)

Flags: Run Last

The signal_seat_removed() signal is emitted whenever a seat is removed by the windowing system.

Parameters
seatThe seat that was just removed.

◆ signal_setting_changed()

Glib::SignalProxy<void(const Glib::ustring&)> Gdk::Display::signal_setting_changed ( )
Slot Prototype:
void on_my_setting_changed(const Glib::ustring& setting)

Flags: Run Last

The signal_setting_changed() signal is emitted whenever a setting changes its value.

Parameters
settingThe name of the setting that changed.

◆ supports_input_shapes()

bool Gdk::Display::supports_input_shapes ( ) const

Returns true if gdk_window_input_shape_combine_mask() can be used to modify the input shape of windows on display.

Returns
true if windows with modified input shape are supported.

◆ supports_shapes()

bool Gdk::Display::supports_shapes ( ) const

Returns true if gdk_window_shape_combine_mask() can be used to create shaped windows on display.

Returns
true if shaped windows are supported.

◆ sync()

void Gdk::Display::sync ( )

Flushes any requests queued for the windowing system and waits until all requests have been handled.

This is often used for making sure that the display is synchronized with the current state of the program. Calling sync() before gdk_error_trap_pop() makes sure that any errors generated from earlier requests are handled before the error trap is removed.

This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gdk::Display > wrap ( GdkDisplay *  object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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.