Top | ![]() |
![]() |
![]() |
![]() |
void | closed | Run Last |
void | monitor-added | Run Last |
void | monitor-removed | Run Last |
void | opened | Run Last |
void | seat-added | Run Last |
void | seat-removed | Run Last |
GdkDisplay objects purpose are two fold:
To manage and provide information about input devices (pointers and keyboards)
To manage and provide information about the available GdkScreens
GdkDisplay objects are the GDK representation of an 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 GdkScreen objects currently instantiated by the application. It is also used to access the keyboard(s) and mouse pointer(s) of the display.
Most of the input device handling has been factored out into
the separate GdkDeviceManager object. Every display has a
device manager, which you can obtain using
gdk_display_get_device_manager()
.
GdkDisplay *
gdk_display_open (const gchar *display_name
);
Opens a display.
Since: 2.2
GdkDisplay *
gdk_display_get_default (void
);
Gets the default GdkDisplay. This is a convenience
function for:
gdk_display_manager_get_default_display (
.gdk_display_manager_get()
)
Since: 2.2
const gchar *
gdk_display_get_name (GdkDisplay *display
);
Gets the name of the display.
a string representing the display name. This string is owned by GDK and should not be modified or freed.
Since: 2.2
GdkScreen *
gdk_display_get_default_screen (GdkDisplay *display
);
Get the default GdkScreen for display
.
Since: 2.2
GdkDeviceManager *
gdk_display_get_device_manager (GdkDisplay *display
);
gdk_display_get_device_manager
has been deprecated since version 3.20. and should not be used in newly-written code.
Use gdk_display_get_default_seat()
and GdkSeat operations.
Returns the GdkDeviceManager associated to display
.
A GdkDeviceManager, or
NULL
. This memory is owned by GDK and must not be freed
or unreferenced.
[nullable][transfer none]
Since: 3.0
gboolean gdk_display_device_is_grabbed (GdkDisplay *display
,GdkDevice *device
);
Returns TRUE
if there is an ongoing grab on device
for display
.
void
gdk_display_beep (GdkDisplay *display
);
Emits a short beep on display
Since: 2.2
void
gdk_display_sync (GdkDisplay *display
);
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
gdk_display_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.
Since: 2.2
void
gdk_display_flush (GdkDisplay *display
);
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.
Since: 2.4
void
gdk_display_close (GdkDisplay *display
);
Closes the connection to the windowing system for the given display, and cleans up associated resources.
Since: 2.2
gboolean
gdk_display_is_closed (GdkDisplay *display
);
Finds out if the display has been closed.
Since: 2.22
GdkEvent *
gdk_display_get_event (GdkDisplay *display
);
Gets the next GdkEvent to be processed for display
, fetching events from the
windowing system if necessary.
the next GdkEvent to be processed, or NULL
if no events are pending. The returned GdkEvent should be freed
with gdk_event_free()
.
[nullable]
Since: 2.2
GdkEvent *
gdk_display_peek_event (GdkDisplay *display
);
Gets a copy of the first GdkEvent 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.)
a copy of the first GdkEvent on the event
queue, or NULL
if no events are in the queue. The returned
GdkEvent should be freed with gdk_event_free()
.
[nullable]
Since: 2.2
void gdk_display_put_event (GdkDisplay *display
,const GdkEvent *event
);
Appends a copy of the given event onto the front of the event
queue for display
.
Since: 2.2
gboolean
gdk_display_has_pending (GdkDisplay *display
);
Returns whether the display has events that are waiting to be processed.
Since: 3.0
void gdk_display_set_double_click_time (GdkDisplay *display
,guint msec
);
Sets the double click time (two clicks within this time interval count as a double click). Applications should not set this, it is a global user-configured setting.
Since: 2.2
void gdk_display_set_double_click_distance (GdkDisplay *display
,guint distance
);
Sets the double click distance (two clicks within this distance
count as a double click). See also gdk_display_set_double_click_time()
.
Applications should not set this, it is a global
user-configured setting.
Since: 2.4
gboolean
gdk_display_is_rgba (GdkDisplay *display
);
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 gdk_display_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
.
TRUE
if windows are created with an alpha channel or
FALSE
if the display does not support this functionality.
Since: 3.90
gboolean
gdk_display_is_composited (GdkDisplay *display
);
Returns whether windows can reasonably be expected to have
their alpha channel drawn correctly on the screen. Check
gdk_display_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
.
Whether windows with RGBA visuals can reasonably be expected to have their alpha channels drawn correctly on the screen.
Since: 3.90
gboolean
gdk_display_supports_cursor_color (GdkDisplay *display
);
Returns TRUE
if multicolored cursors are supported
on display
. Otherwise, cursors have only a forground
and a background color.
Since: 2.4
gboolean
gdk_display_supports_cursor_alpha (GdkDisplay *display
);
Returns TRUE
if cursors can use an 8bit alpha channel
on display
. Otherwise, cursors are restricted to bilevel
alpha (i.e. a mask).
Since: 2.4
guint
gdk_display_get_default_cursor_size (GdkDisplay *display
);
Returns the default size to use for cursors on display
.
Since: 2.4
void gdk_display_get_maximal_cursor_size (GdkDisplay *display
,guint *width
,guint *height
);
Gets the maximal size to use for cursors on display
.
display |
||
width |
the return location for the maximal cursor width. |
[out] |
height |
the return location for the maximal cursor height. |
[out] |
Since: 2.4
GdkWindow *
gdk_display_get_default_group (GdkDisplay *display
);
Returns the default group leader window for all toplevel windows
on display
. This window is implicitly created by GDK.
See gdk_window_set_group()
.
Since: 2.4
gboolean
gdk_display_supports_selection_notification
(GdkDisplay *display
);
Returns whether GdkEventOwnerChange events will be sent when the owner of a selection changes.
Since: 2.6
gboolean gdk_display_request_selection_notification (GdkDisplay *display
,GdkAtom selection
);
Request GdkEventOwnerChange events for ownership changes of the selection named by the given atom.
display |
||
selection |
the GdkAtom naming the selection for which ownership change notification is requested |
Since: 2.6
gboolean
gdk_display_supports_clipboard_persistence
(GdkDisplay *display
);
Returns whether the speicifed display supports clipboard persistance; i.e. if it’s possible to store the clipboard data after an application has quit. On X11 this checks if a clipboard daemon is running.
Since: 2.6
void gdk_display_store_clipboard (GdkDisplay *display
,GdkWindow *clipboard_window
,guint32 time_
,const GdkAtom *targets
,gint n_targets
);
Issues a request to the clipboard manager to store the clipboard data. On X11, this is a special program that works according to the FreeDesktop Clipboard Specification.
display |
||
clipboard_window |
a GdkWindow belonging to the clipboard owner |
|
time_ |
a timestamp |
|
targets |
an array of targets
that should be saved, or |
[array length=n_targets][nullable] |
n_targets |
length of the |
Since: 2.6
gboolean
gdk_display_supports_shapes (GdkDisplay *display
);
Returns TRUE
if gdk_window_shape_combine_mask()
can
be used to create shaped windows on display
.
Since: 2.10
gboolean
gdk_display_supports_input_shapes (GdkDisplay *display
);
Returns TRUE
if gdk_window_input_shape_combine_mask()
can
be used to modify the input shape of windows on display
.
Since: 2.10
GdkAppLaunchContext *
gdk_display_get_app_launch_context (GdkDisplay *display
);
Returns a GdkAppLaunchContext suitable for launching applications on the given display.
a new GdkAppLaunchContext for display
.
Free with g_object_unref()
when done.
[transfer full]
Since: 3.0
void gdk_display_notify_startup_complete (GdkDisplay *display
,const gchar *startup_id
);
Indicates to the GUI environment that the application has finished loading, using a given identifier.
GTK+ will call this function automatically for GtkWindow
with custom startup-notification identifier unless
gtk_window_set_auto_startup_notification()
is called to
disable that feature.
display |
||
startup_id |
a startup-notification identifier, for which notification process should be completed |
Since: 3.0
GdkSeat *
gdk_display_get_default_seat (GdkDisplay *display
);
Returns the default GdkSeat for this display.
Since: 3.20
GList *
gdk_display_list_seats (GdkDisplay *display
);
Returns the list of seats known to display
.
Since: 3.20
int
gdk_display_get_n_monitors (GdkDisplay *display
);
Gets the number of monitors that belong to display
.
The returned number is valid until the next emission of the “monitor-added” or “monitor-removed” signal.
Since: 3.22
GdkMonitor * gdk_display_get_monitor (GdkDisplay *display
,int monitor_num
);
Gets a monitor associated with this display.
the GdkMonitor, or NULL
if
monitor_num
is not a valid monitor number.
[nullable][transfer none]
Since: 3.22
GdkMonitor *
gdk_display_get_primary_monitor (GdkDisplay *display
);
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.
the primary monitor, or any monitor if no primary monitor is configured by the user.
[transfer none]
Since: 3.22
GdkMonitor * gdk_display_get_monitor_at_point (GdkDisplay *display
,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.
Since: 3.22
GdkMonitor * gdk_display_get_monitor_at_window (GdkDisplay *display
,GdkWindow *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.
Since: 3.22
“composited”
property “composited” gboolean
TRUE
if the display properly composits the alpha channel.
See gdk_display_is_composited()
for details.
Flags: Read
Default value: TRUE
Since: 3.90
“rgba”
property “rgba” gboolean
TRUE
if the display supports an alpha channel. See gdk_display_is_rgba()
for details.
Flags: Read
Default value: TRUE
Since: 3.90
“closed”
signalvoid user_function (GdkDisplay *display, gboolean is_error, gpointer user_data)
The ::closed signal is emitted when the connection to the windowing
system for display
is closed.
display |
the object on which the signal is emitted |
|
is_error |
|
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 2.2
“monitor-added”
signalvoid user_function (GdkDisplay *display, GdkMonitor *monitor, gpointer user_data)
The ::monitor-added signal is emitted whenever a monitor is added.
display |
the objedct on which the signal is emitted |
|
monitor |
the monitor that was just added |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.22
“monitor-removed”
signalvoid user_function (GdkDisplay *display, GdkMonitor *monitor, gpointer user_data)
The ::monitor-removed signal is emitted whenever a monitor is removed.
display |
the object on which the signal is emitted |
|
monitor |
the monitor that was just removed |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.22
“opened”
signalvoid user_function (GdkDisplay *display, gpointer user_data)
The ::opened signal is emitted when the connection to the windowing
system for display
is opened.
display |
the object on which the signal is emitted |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“seat-added”
signalvoid user_function (GdkDisplay *display, GdkSeat *seat, gpointer user_data)
The ::seat-added signal is emitted whenever a new seat is made known to the windowing system.
display |
the object on which the signal is emitted |
|
seat |
the seat that was just added |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.20
“seat-removed”
signalvoid user_function (GdkDisplay *display, GdkSeat *seat, gpointer user_data)
The ::seat-removed signal is emitted whenever a seat is removed by the windowing system.
display |
the object on which the signal is emitted |
|
seat |
the seat that was just removed |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.20