gtkmm
3.97.1
|
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>
Public Member Functions | |
Display (Display&& src) noexcept | |
Display& | operator= (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 surfaces can reasonably be expected to have their alpha channel drawn correctly on the screen. More... | |
bool | is_rgba () const |
Returns wether surfaces on this display are created with an alpha channel. More... | |
Glib::RefPtr< Event > | get_event () |
Gets the next Gdk::Event to be processed for display, fetching events from the windowing system if necessary. More... | |
Glib::RefPtr< Event > | peek_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 Event > | peek_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< Surface > | get_default_group () |
Returns the default group leader surface for all toplevel surfaces on display. More... | |
Glib::RefPtr< const Surface > | get_default_group () const |
Returns the default group leader surface for all toplevel surfaces on display. More... | |
Glib::RefPtr< Clipboard > | get_clipboard () |
Gets the clipboard used for copy/paste operations. More... | |
Glib::RefPtr< const Clipboard > | get_clipboard () const |
Gets the clipboard used for copy/paste operations. More... | |
Glib::RefPtr< Clipboard > | get_primary_clipboard () |
Gets the clipboard used for the primary selection. More... | |
Glib::RefPtr< const Clipboard > | get_primary_clipboard () const |
Gets the clipboard used for the primary selection. More... | |
bool | supports_shapes () const |
Returns true if gdk_surface_shape_combine_mask() can be used to create shaped windows on display. More... | |
bool | supports_input_shapes () const |
Returns true if gdk_surface_input_shape_combine_mask() can be used to modify the input shape of surfaces 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< AppLaunchContext > | get_app_launch_context () |
Returns a Gdk::AppLaunchContext suitable for launching applications on the given display. More... | |
Glib::RefPtr< const AppLaunchContext > | get_app_launch_context () const |
Returns a Gdk::AppLaunchContext suitable for launching applications on the given display. More... | |
Glib::RefPtr< Seat > | get_default_seat () |
Returns the default Gdk::Seat for this display. More... | |
Glib::RefPtr< const Seat > | get_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< Monitor > | get_monitor (int monitor_num) |
Gets a monitor associated with this display. More... | |
Glib::RefPtr< const Monitor > | get_monitor (int monitor_num) const |
Gets a monitor associated with this display. More... | |
Glib::RefPtr< Monitor > | get_monitor_at_surface (const Glib::RefPtr< Surface >& surface) |
Gets the monitor in which the largest area of surface resides, or a monitor close to surface if it is outside of all monitors. More... | |
Glib::RefPtr< const Monitor > | get_monitor_at_surface (const Glib::RefPtr< Surface >& surface) const |
Gets the monitor in which the largest area of surface resides, or a monitor close to surface 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... | |
![]() | |
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) |
![]() | |
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 |
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 |
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< Display > | open (const Glib::ustring& display_name) |
Opens a display. More... | |
static Glib::RefPtr< Display > | get_default () |
Gets the default Gdk::Display. More... | |
Protected Member Functions | |
Display () | |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
![]() | |
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 Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gdk::Display > | wrap (GdkDisplay* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
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.
|
noexcept |
|
overridenoexcept |
|
protected |
void Gdk::Display::beep | ( | ) |
Emits a short beep on display.
void Gdk::Display::close | ( | ) |
Closes the connection to the windowing system for the given display, and cleans up associated resources.
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.
device | A Gdk::Device. |
true
if there is a grab in effect for device. 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.
Glib::RefPtr<AppLaunchContext> Gdk::Display::get_app_launch_context | ( | ) |
Returns a Gdk::AppLaunchContext suitable for launching applications on the given display.
Glib::RefPtr<const AppLaunchContext> Gdk::Display::get_app_launch_context | ( | ) | const |
Returns a Gdk::AppLaunchContext suitable for launching applications on the given display.
Glib::RefPtr<Clipboard> Gdk::Display::get_clipboard | ( | ) |
Gets the clipboard used for copy/paste operations.
Glib::RefPtr<const Clipboard> Gdk::Display::get_clipboard | ( | ) | const |
Gets the clipboard used for copy/paste operations.
|
static |
Gets the default Gdk::Display.
This is a convenience function for: gdk_display_manager_get_default_display (Gdk::DisplayManager::get())
.
nullptr
if there is no default display. Glib::RefPtr<Surface> Gdk::Display::get_default_group | ( | ) |
Returns the default group leader surface for all toplevel surfaces on display.
This surface is implicitly created by GDK. See gdk_surface_set_group().
Glib::RefPtr<const Surface> Gdk::Display::get_default_group | ( | ) | const |
Returns the default group leader surface for all toplevel surfaces on display.
This surface is implicitly created by GDK. See gdk_surface_set_group().
Glib::RefPtr<Seat> Gdk::Display::get_default_seat | ( | ) |
Returns the default Gdk::Seat for this display.
Glib::RefPtr<const Seat> Gdk::Display::get_default_seat | ( | ) | const |
Returns the default Gdk::Seat for this display.
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.
nullptr
if no events are pending. GdkKeymap* Gdk::Display::get_keymap | ( | ) |
Returns the Gdk::Keymap attached to display.
const GdkKeymap* Gdk::Display::get_keymap | ( | ) | const |
Returns the Gdk::Keymap attached to display.
Glib::RefPtr<Monitor> Gdk::Display::get_monitor | ( | int | monitor_num | ) |
Gets a monitor associated with this display.
monitor_num | Number of the monitor. |
nullptr
if monitor_num is not a valid monitor number. Glib::RefPtr<const Monitor> Gdk::Display::get_monitor | ( | int | monitor_num | ) | const |
Gets a monitor associated with this display.
monitor_num | Number of the monitor. |
nullptr
if monitor_num is not a valid monitor number. Glib::RefPtr<Monitor> Gdk::Display::get_monitor_at_surface | ( | const Glib::RefPtr< Surface >& | surface | ) |
Gets the monitor in which the largest area of surface resides, or a monitor close to surface if it is outside of all monitors.
surface | A Gdk::Surface. |
Glib::RefPtr<const Monitor> Gdk::Display::get_monitor_at_surface | ( | const Glib::RefPtr< Surface >& | surface | ) | const |
Gets the monitor in which the largest area of surface resides, or a monitor close to surface if it is outside of all monitors.
surface | A Gdk::Surface. |
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.
Glib::ustring Gdk::Display::get_name | ( | ) | const |
Gets the name of the display.
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.
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.
bool Gdk::Display::get_setting | ( | const Glib::ustring & | name, |
ValueType & | value | ||
) | const |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
bool Gdk::Display::has_pending | ( | ) | const |
Returns whether the display has events that are waiting to be processed.
true
if there are events ready to be processed. bool Gdk::Display::is_closed | ( | ) | const |
Finds out if the display has been closed.
true
if the display is closed. bool Gdk::Display::is_composited | ( | ) | const |
Returns whether surfaces 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
.
bool Gdk::Display::is_rgba | ( | ) | const |
Returns wether surfaces on this display are created with an alpha channel.
Even if a true
is returned, it is possible that the surface’s alpha channel won’t be honored when displaying the surface 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 surface, see Gdk::Surface::set_opacity().
On modern displays, this value is always true
.
true
if surfaces are created with an alpha channel or false
if the display does not support this functionality. std::vector<Glib::RefPtr<Seat> > Gdk::Display::list_seats | ( | ) |
Returns the list of seats known to display.
std::vector<Glib::RefPtr<const Seat> > Gdk::Display::list_seats | ( | ) | const |
Returns the list of seats known to display.
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.
startup_id | A startup-notification identifier, for which notification process should be completed. |
|
static |
Opens a display.
display_name | The name of the display to open. |
nullptr
if the display could not be opened. 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.)
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.)
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
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
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.
event | A Gdk::Event. |
Glib::SignalProxy<void(bool)> Gdk::Display::signal_closed | ( | ) |
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.
is_error | true if the display was closed due to an error. |
Glib::SignalProxy<void(const Glib::RefPtr<Monitor>&)> Gdk::Display::signal_monitor_added | ( | ) |
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.
monitor | The monitor that was just added. |
Glib::SignalProxy<void(const Glib::RefPtr<Monitor>&)> Gdk::Display::signal_monitor_removed | ( | ) |
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.
monitor | The monitor that was just removed. |
Glib::SignalProxy<void()> Gdk::Display::signal_opened | ( | ) |
void on_my_opened()
Flags: Run Last
The signal_opened() signal is emitted when the connection to the windowing system for display is opened.
Glib::SignalProxy<void(const Glib::RefPtr<Seat>&)> Gdk::Display::signal_seat_added | ( | ) |
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.
seat | The seat that was just added. |
Glib::SignalProxy<void(const Glib::RefPtr<Seat>&)> Gdk::Display::signal_seat_removed | ( | ) |
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.
seat | The seat that was just removed. |
Glib::SignalProxy<void(const Glib::ustring&)> Gdk::Display::signal_setting_changed | ( | ) |
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.
setting | The name of the setting that changed. |
bool Gdk::Display::supports_input_shapes | ( | ) | const |
Returns true
if gdk_surface_input_shape_combine_mask() can be used to modify the input shape of surfaces on display.
true
if surfaces with modified input shape are supported. bool Gdk::Display::supports_shapes | ( | ) | const |
Returns true
if gdk_surface_shape_combine_mask() can be used to create shaped windows on display.
true
if shaped windows are supported. 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.
|
related |
A Glib::wrap() method for this object.
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. |