Ardour
9.0-pre0-384-ga76afae0e9
|
#include <display.h>
Public Member Functions | |
virtual | ~Display () |
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 |
int | get_n_screens () const |
Glib::RefPtr< Screen > | get_screen (int screen_num) |
Glib::RefPtr< const Screen > | get_screen (int screen_num) const |
Glib::RefPtr< Screen > | get_default_screen () |
Glib::RefPtr< const Screen > | get_default_screen () const |
void | pointer_ungrab (guint32 timestamp) |
void | keyboard_ungrab (guint32 timestamp) |
bool | pointer_is_grabbed () const |
void | beep () |
void | sync () |
void | close () |
Glib::ListHandle< Glib::RefPtr< Device > > | list_devices () |
Glib::ListHandle< Glib::RefPtr< const Device > > | list_devices () const |
GdkEvent * | get_event () |
const GdkEvent * | get_event () const |
GdkEvent * | peek_event () |
GdkEvent * | peek_event () const |
void | put_event (GdkEvent *event) |
void | add_client_message_filter (Glib::ustring &message_type, GdkFilterFunc func, gpointer data) |
void | set_double_click_time (guint msec) |
void | set_double_click_distance (guint distance) |
Glib::RefPtr< Device > | get_core_pointer () |
Glib::RefPtr< const Device > | get_core_pointer () const |
void | get_pointer (Glib::RefPtr< Screen > &screen, int &x, int &y, ModifierType &mask) |
void | get_pointer (int &x, int &y, ModifierType &mask) |
Glib::RefPtr< Window > | get_window_at_pointer (int &win_x, int &win_y) |
Glib::RefPtr< const Window > | get_window_at_pointer (int &win_x, int &win_y) const |
Glib::RefPtr< Window > | get_window_at_pointer () |
Glib::RefPtr< const Window > | get_window_at_pointer () const |
void | warp_pointer (const Glib::RefPtr< Screen > &screen, int x, int y) |
GdkDisplayPointerHooks * | set_pointer_hooks (const GdkDisplayPointerHooks *new_hooks) |
GdkDisplayPointerHooks * | unset_pointer_hooks () |
GdkNativeWindow | get_drag_protocol (GdkNativeWindow xid, GdkDragProtocol &protocol) |
GdkKeymap * | get_keymap () |
const GdkKeymap * | get_keymap () const |
bool | set_selection_owner (const Glib::RefPtr< Window > &owner, Glib::ustring &selection, guint32 time_, bool send_event) |
Glib::RefPtr< Window > | get_selection_owner (const Glib::ustring &selection) |
void | selection_send_notify (GdkNativeWindow requestor, Glib::ustring &selection, Glib::ustring &target, Glib::ustring &property, guint32 time_) |
Glib::RefPtr< Pixmap > | lookup_pixmap (NativeWindow anid) |
Glib::RefPtr< const Pixmap > | lookup_pixmap (NativeWindow anid) const |
void | flush () |
bool | supports_cursor_alpha () const |
bool | supports_cursor_color () const |
guint | get_default_cursor_size () const |
void | get_maximal_cursor_size (guint &width, guint &height) |
Glib::RefPtr< Window > | get_default_group () |
Glib::RefPtr< const Window > | get_default_group () const |
bool | supports_selection_notification () const |
bool | request_selection_notification (const Glib::ustring &selection) |
bool | supports_clipboard_persistence () const |
void | store_clipboard (const Glib::RefPtr< Gdk::Window > &clipboard_window, guint32 time_) |
void | store_clipboard (const Glib::RefPtr< Gdk::Window > &clipboard_window, guint32 time_, const Glib::StringArrayHandle &targets) |
bool | supports_shapes () const |
bool | supports_input_shapes () const |
bool | supports_composite () const |
Glib::SignalProxy1< void, bool > | signal_closed () |
Static Public Member Functions | |
static GType | get_type () G_GNUC_CONST |
static Glib::RefPtr< Display > | open (const Glib::ustring &display_name) |
static Glib::RefPtr< Display > | get_default () |
static Glib::RefPtr< Display > | open_default_libgtk_only () |
Protected Member Functions | |
Display () | |
virtual void | on_closed (bool is_error) |
This is a default handler for the signal signal_closed(). More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gdk::Display > | wrap (GdkDisplay *object, bool take_copy=false) |
Gdk::Display object's purpose is two fold: To grab/ungrab keyboard focus and mouse pointer To manage and provide information about the Gdk::Screen(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::Screen objects currently instantiated by the application. It is also used to grab and release the keyboard and the mouse pointer.
|
virtual |
|
protected |
void Gdk::Display::add_client_message_filter | ( | Glib::ustring & | message_type, |
GdkFilterFunc | func, | ||
gpointer | data | ||
) |
Adds a filter to be called when X ClientMessage events are received. See Gdk::Window::add_filter() if you are interested in filtering other types of events.
message_type | The type of ClientMessage events to receive. This will be checked against the message_type field of the XClientMessage event struct. |
func | The function to call to process the event. |
data | User data to pass to func. |
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.
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 explicitely. 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<Device> Gdk::Display::get_core_pointer | ( | ) |
Returns the core pointer device for the given display
Glib::RefPtr<const Device> Gdk::Display::get_core_pointer | ( | ) | const |
Returns the core pointer device for the given display
|
static |
Gets the default Gdk::Display. This is a convenience function for gdk_display_manager_get_default_display (manager_get())
.
0
if there is no default display. guint Gdk::Display::get_default_cursor_size | ( | ) | const |
Returns the default size to use for cursors on display.
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().
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().
Glib::RefPtr<Screen> Gdk::Display::get_default_screen | ( | ) |
Get the default Gdk::Screen for display.
Glib::RefPtr<const Screen> Gdk::Display::get_default_screen | ( | ) | const |
Get the default Gdk::Screen for display.
GdkNativeWindow Gdk::Display::get_drag_protocol | ( | GdkNativeWindow | xid, |
GdkDragProtocol & | protocol | ||
) |
Finds out the DND protocol supported by a window.
xid | The windowing system id of the destination window. |
protocol | Location where the supported DND protocol is returned. |
GdkEvent* Gdk::Display::get_event | ( | ) |
Gets the next Gdk::Event to be processed for display, fetching events from the windowing system if necessary.
0
if no events are pending. The returned Gdk::Event should be freed with Gdk::Event::free(). const GdkEvent* Gdk::Display::get_event | ( | ) | const |
Gets the next Gdk::Event to be processed for display, fetching events from the windowing system if necessary.
0
if no events are pending. The returned Gdk::Event should be freed with Gdk::Event::free(). 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.
void Gdk::Display::get_maximal_cursor_size | ( | guint & | width, |
guint & | height | ||
) |
Gets the maximal size to use for cursors on display.
width | The return location for the maximal cursor width. |
height | The return location for the maximal cursor height. |
int Gdk::Display::get_n_screens | ( | ) | const |
Gets the number of screen managed by the display.
Glib::ustring Gdk::Display::get_name | ( | ) | const |
Gets the name of the display.
void Gdk::Display::get_pointer | ( | Glib::RefPtr< Screen > & | screen, |
int & | x, | ||
int & | y, | ||
ModifierType & | mask | ||
) |
Gets the current location of the pointer and the current modifier mask for a given display.
screen | location to store the screen that the cursor is on. |
x | location to store root window X coordinate of pointer. |
y | location to store root window Y coordinate of pointer. |
mask | location to store current modifier mask. |
void Gdk::Display::get_pointer | ( | int & | x, |
int & | y, | ||
ModifierType & | mask | ||
) |
Gets the current location of the pointer and the current modifier mask for a given display.
x | location to store root window X coordinate of pointer. |
y | location to store root window Y coordinate of pointer. |
mask | location to store current modifier mask. |
Glib::RefPtr<Screen> Gdk::Display::get_screen | ( | int | screen_num | ) |
Returns a screen object for one of the screens of the display.
screen_num | The screen number. |
Glib::RefPtr<const Screen> Gdk::Display::get_screen | ( | int | screen_num | ) | const |
Returns a screen object for one of the screens of the display.
screen_num | The screen number. |
Glib::RefPtr<Window> Gdk::Display::get_selection_owner | ( | const Glib::ustring & | selection | ) |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
Glib::RefPtr<Window> Gdk::Display::get_window_at_pointer | ( | ) |
Obtains the window underneath the mouse pointer. Returns a null RefPtr if the window under the mouse pointer is not known to GDK (for example, belongs to another application).
Glib::RefPtr<const Window> Gdk::Display::get_window_at_pointer | ( | ) | const |
Obtains the window underneath the mouse pointer. Returns a null RefPtr if the window under the mouse pointer is not known to GDK (for example, belongs to another application).
Glib::RefPtr<Window> Gdk::Display::get_window_at_pointer | ( | int & | win_x, |
int & | win_y | ||
) |
Obtains the window underneath the mouse pointer, returning the location of the pointer in that window in win_x, win_y for screen. Returns 0
if the window under the mouse pointer is not known to GDK (for example, belongs to another application).
win_x | Return location for x coordinate of the pointer location relative to the window origin, or 0 . |
win_y | Return location for y coordinate of the pointer location relative & to the window origin, or 0 . |
0
. Glib::RefPtr<const Window> Gdk::Display::get_window_at_pointer | ( | int & | win_x, |
int & | win_y | ||
) | const |
Obtains the window underneath the mouse pointer, returning the location of the pointer in that window in win_x, win_y for screen. Returns 0
if the window under the mouse pointer is not known to GDK (for example, belongs to another application).
win_x | Return location for x coordinate of the pointer location relative to the window origin, or 0 . |
win_y | Return location for y coordinate of the pointer location relative & to the window origin, or 0 . |
0
.
|
inline |
|
inline |
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.
void Gdk::Display::keyboard_ungrab | ( | guint32 | timestamp | ) |
Release any keyboard grab
timestamp | A timestap (e.g Gdk::CURRENT_TIME). |
Glib::ListHandle< Glib::RefPtr<Device> > Gdk::Display::list_devices | ( | ) |
Returns the list of available input devices attached to display. The list is statically allocated and should not be freed.
Glib::ListHandle< Glib::RefPtr<const Device> > Gdk::Display::list_devices | ( | ) | const |
Returns the list of available input devices attached to display. The list is statically allocated and should not be freed.
Glib::RefPtr<Pixmap> Gdk::Display::lookup_pixmap | ( | NativeWindow | anid | ) |
Looks up the Gdk::Pixmap that wraps the given native pixmap handle.
For example in the X backend, a native pixmap handle is an Xlib XID
.
anid | A native pixmap handle. |
0
if there is none. Glib::RefPtr<const Pixmap> Gdk::Display::lookup_pixmap | ( | NativeWindow | anid | ) | const |
Looks up the Gdk::Pixmap that wraps the given native pixmap handle.
For example in the X backend, a native pixmap handle is an Xlib XID
.
anid | A native pixmap handle. |
0
if there is none.
|
protectedvirtual |
This is a default handler for the signal signal_closed().
|
static |
Opens a display.
display_name | The name of the display to open. |
0
if the display could not be opened.
|
static |
Opens the default display specified by command line arguments or environment variables, sets it as the default display, and returns it. gdk_parse_args must have been called first. If the default display has previously been set, simply returns that. An internal function that should not be used by applications.
0
. GdkEvent* 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.)
0
if no events are in the queue. The returned Gdk::Event should be freed with Gdk::Event::free(). GdkEvent* 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.)
0
if no events are in the queue. The returned Gdk::Event should be freed with Gdk::Event::free(). bool Gdk::Display::pointer_is_grabbed | ( | ) | const |
Test if the pointer is grabbed.
true
if an active X pointer grab is in effect. void Gdk::Display::pointer_ungrab | ( | guint32 | timestamp | ) |
Release any pointer grab.
timestamp | A timestap (e.g. GDK_CURRENT_TIME). |
void Gdk::Display::put_event | ( | GdkEvent * | event | ) |
Appends a copy of the given event onto the front of the event queue for display.
event | A Gdk::Event. |
bool Gdk::Display::request_selection_notification | ( | const Glib::ustring & | selection | ) |
Request Gdk::EventOwnerChange events for ownership changes of the selection named by the given atom.
selection | The Gdk::Atom naming the selection for which ownership change notification is requested. |
void Gdk::Display::selection_send_notify | ( | GdkNativeWindow | requestor, |
Glib::ustring & | selection, | ||
Glib::ustring & | target, | ||
Glib::ustring & | property, | ||
guint32 | time_ | ||
) |
Send a response to SelectionRequest event.
void Gdk::Display::set_double_click_distance | ( | guint | distance | ) |
Sets the double click distance (two clicks within this distance count as a double click and result in a Gdk::2BUTTON_PRESS event). See also set_double_click_time(). Applications should not set this, it is a global user-configured setting.
distance | Distance in pixels. |
void Gdk::Display::set_double_click_time | ( | guint | msec | ) |
Sets the double click time (two clicks within this time interval count as a double click and result in a Gdk::2BUTTON_PRESS event). Applications should not set this, it is a global user-configured setting.
msec | Double click time in milliseconds (thousandths of a second). |
GdkDisplayPointerHooks* Gdk::Display::set_pointer_hooks | ( | const GdkDisplayPointerHooks * | new_hooks | ) |
This function allows for hooking into the operation of getting the current location of the pointer on a particular display. This is only useful for such low-level tools as an event recorder. Applications should never have any reason to use this facility.
new_hooks | A table of pointers to functions for getting quantities related to the current pointer position. |
bool Gdk::Display::set_selection_owner | ( | const Glib::RefPtr< Window > & | owner, |
Glib::ustring & | selection, | ||
guint32 | time_, | ||
bool | send_event | ||
) |
Glib::SignalProxy1< void,bool > Gdk::Display::signal_closed | ( | ) |
The closed signal is emitted when the connection to the windowing system for this display is closed.
is_error | true if the display was closed due to an error |
void on_my_closed(bool is_error)
void Gdk::Display::store_clipboard | ( | const Glib::RefPtr< Gdk::Window > & | clipboard_window, |
guint32 | time_ | ||
) |
Issues a request to the clipboard manager to store the clipboard data, saving all available targets. On X11, this is a special program that works according to the freedesktop clipboard specification, available at http://www.freedesktop.org/Standards/clipboard-manager-spec.
clipboard_window | A Gdk::Window belonging to the clipboard owner. |
time_ | A timestamp. |
void Gdk::Display::store_clipboard | ( | const Glib::RefPtr< Gdk::Window > & | clipboard_window, |
guint32 | time_, | ||
const Glib::StringArrayHandle & | targets | ||
) |
bool Gdk::Display::supports_clipboard_persistence | ( | ) | const |
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.
true
if the display supports clipboard persistance. bool Gdk::Display::supports_composite | ( | ) | const |
Returns true
if Gdk::Window::set_composited() can be used to redirect drawing on the window using compositing.
Currently this only works on X11 with XComposite and XDamage extensions available.
true
if windows may be composited. bool Gdk::Display::supports_cursor_alpha | ( | ) | const |
Returns true
if cursors can use an 8bit alpha channel on display. Otherwise, cursors are restricted to bilevel alpha (i.e. a mask).
bool Gdk::Display::supports_cursor_color | ( | ) | const |
Returns true
if multicolored cursors are supported on display. Otherwise, cursors have only a forground and a background color.
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.
true
if windows with modified input shape are supported. bool Gdk::Display::supports_selection_notification | ( | ) | const |
Returns whether Gdk::EventOwnerChange events will be sent when the owner of a selection changes.
bool Gdk::Display::supports_shapes | ( | ) | const |
Returns true
if Gdk::Window::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.
GdkDisplayPointerHooks* Gdk::Display::unset_pointer_hooks | ( | ) |
void Gdk::Display::warp_pointer | ( | const Glib::RefPtr< Screen > & | screen, |
int | x, | ||
int | y | ||
) |
Warps the pointer of display to the point x, y on the screen screen, unless the pointer is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer creates events as if the user had moved the mouse instantaneously to the destination.
Note that the pointer should normally be under the control of the user. This function was added to cover some rare use cases like keyboard navigation support for the color picker in the Gtk::ColorSelectionDialog.
screen | The screen of display to warp the pointer to. |
x | The x coordinate of the destination. |
y | The y coordinate of the destination. |
|
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. |