/usr/include/gdkmm-2.4/gdkmm/display.h is in libgtkmm-2.4-dev 1:2.24.4-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 | // -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GDKMM_DISPLAY_H
#define _GDKMM_DISPLAY_H
#include <glibmm.h>
/* $Id: display.hg,v 1.22 2006/04/12 11:11:24 murrayc Exp $ */
/* display.h
*
* Copyright (C) 1998-2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gdkmm/screen.h>
#include <gdkmm/device.h>
#include <gdkmm/types.h> //For ModifierType
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GdkDisplay GdkDisplay;
typedef struct _GdkDisplayClass GdkDisplayClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gdk
{ class Display_Class; } // namespace Gdk
namespace Gdk
{
class Drawable;
/** 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.
*/
class Display : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Display CppObjectType;
typedef Display_Class CppClassType;
typedef GdkDisplay BaseObjectType;
typedef GdkDisplayClass BaseClassType;
private: friend class Display_Class;
static CppClassType display_class_;
private:
// noncopyable
Display(const Display&);
Display& operator=(const Display&);
protected:
explicit Display(const Glib::ConstructParams& construct_params);
explicit Display(GdkDisplay* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Display();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GdkDisplay* gobj() { return reinterpret_cast<GdkDisplay*>(gobject_); }
///Provides access to the underlying C GObject.
const GdkDisplay* gobj() const { return reinterpret_cast<GdkDisplay*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GdkDisplay* gobj_copy();
private:
protected:
Display();
public:
/** Opens a display.
*
* @newin{2,2}
* @param display_name The name of the display to open.
* @return A Gdk::Display, or <tt>0</tt> if the display
* could not be opened.
*/
static Glib::RefPtr<Display> open(const Glib::ustring& display_name);
/** Gets the name of the display.
*
* @newin{2,2}
* @return A string representing the display name. This string is owned
* by GDK and should not be modified or freed.
*/
Glib::ustring get_name() const;
/** Gets the number of screen managed by the @a display.
*
* @newin{2,2}
* @return Number of screens.
*/
int get_n_screens() const;
/** Returns a screen object for one of the screens of the display.
*
* @newin{2,2}
* @param screen_num The screen number.
* @return The Gdk::Screen object.
*/
Glib::RefPtr<Screen> get_screen(int screen_num);
/** Returns a screen object for one of the screens of the display.
*
* @newin{2,2}
* @param screen_num The screen number.
* @return The Gdk::Screen object.
*/
Glib::RefPtr<const Screen> get_screen(int screen_num) const;
/** Get the default Gdk::Screen for @a display.
*
* @newin{2,2}
* @return The default Gdk::Screen object for @a display.
*/
Glib::RefPtr<Screen> get_default_screen();
/** Get the default Gdk::Screen for @a display.
*
* @newin{2,2}
* @return The default Gdk::Screen object for @a display.
*/
Glib::RefPtr<const Screen> get_default_screen() const;
/** Release any pointer grab.
*
* @newin{2,2}
* @param timestamp A timestap (e.g. GDK_CURRENT_TIME).
*/
void pointer_ungrab(guint32 timestamp);
/** Release any keyboard grab
*
* @newin{2,2}
* @param timestamp A timestap (e.g Gdk::CURRENT_TIME).
*/
void keyboard_ungrab(guint32 timestamp);
/** Test if the pointer is grabbed.
*
* @newin{2,2}
* @return <tt>true</tt> if an active X pointer grab is in effect.
*/
bool pointer_is_grabbed() const;
/** Emits a short beep on @a display
*
* @newin{2,2}
*/
void beep();
/** 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.
*
* @newin{2,2}
*/
void sync();
/** Closes the connection to the windowing system for the given display,
* and cleans up associated resources.
*
* @newin{2,2}
*/
void close();
/** Returns the list of available input devices attached to @a display.
* The list is statically allocated and should not be freed.
*
* @newin{2,2}
* @return A list of Gdk::Device.
*/
Glib::ListHandle< Glib::RefPtr<Device> > list_devices();
/** Returns the list of available input devices attached to @a display.
* The list is statically allocated and should not be freed.
*
* @newin{2,2}
* @return A list of Gdk::Device.
*/
Glib::ListHandle< Glib::RefPtr<const Device> > list_devices() const;
//TODO: Use C++ Gdk::Event:
//TODO: get_event() might remove the event - if so, then there should not be a const version:
/** Gets the next Gdk::Event to be processed for @a display, fetching events from the
* windowing system if necessary.
*
* @newin{2,2}
* @return The next Gdk::Event to be processed, or <tt>0</tt> if no events
* are pending. The returned Gdk::Event should be freed with Gdk::Event::free().
*/
GdkEvent* get_event();
/** Gets the next Gdk::Event to be processed for @a display, fetching events from the
* windowing system if necessary.
*
* @newin{2,2}
* @return The next Gdk::Event to be processed, or <tt>0</tt> if no events
* are pending. The returned Gdk::Event should be freed with Gdk::Event::free().
*/
const GdkEvent* get_event() const;
/** Gets a copy of the first Gdk::Event in the @a 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.)
*
* @newin{2,2}
* @return A copy of the first Gdk::Event on the event queue, or <tt>0</tt>
* if no events are in the queue. The returned Gdk::Event should be freed with
* Gdk::Event::free().
*/
GdkEvent* peek_event();
/** Gets a copy of the first Gdk::Event in the @a 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.)
*
* @newin{2,2}
* @return A copy of the first Gdk::Event on the event queue, or <tt>0</tt>
* if no events are in the queue. The returned Gdk::Event should be freed with
* Gdk::Event::free().
*/
GdkEvent* peek_event() const;
/** Appends a copy of the given event onto the front of the event
* queue for @a display.
*
* @newin{2,2}
* @param event A Gdk::Event.
*/
void put_event(GdkEvent* event);
//TODO: Use a slot here, though this is probably never used anyway:
//Find out whether we can use a string representation for the atom - look for examples of this function's use.
/** 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.
*
* @newin{2,2}
* @param message_type The type of ClientMessage events to receive.
* This will be checked against the @a message_type field
* of the XClientMessage event struct.
* @param func The function to call to process the event.
* @param data User data to pass to @a func.
*/
void add_client_message_filter(Glib::ustring& message_type, GdkFilterFunc func, gpointer data);
/** 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 <em>not</em> set this, it is a global
* user-configured setting.
*
* @newin{2,2}
* @param msec Double click time in milliseconds (thousandths of a second).
*/
void set_double_click_time(guint msec);
/** 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 <em>not</em> set this, it is a global
* user-configured setting.
*
* @newin{2,4}
* @param distance Distance in pixels.
*/
void set_double_click_distance(guint distance);
/** Gets the default Gdk::Display. This is a convenience
* function for
* <tt>gdk_display_manager_get_default_display (manager_get())</tt>.
*
* @newin{2,2}
* @return A Gdk::Display, or <tt>0</tt> if there is no default
* display.
*/
static Glib::RefPtr<Display> get_default();
/** Returns the core pointer device for the given display
*
* @newin{2,2}
* @return The core pointer device; this is owned by the
* display and should not be freed.
*/
Glib::RefPtr<Device> get_core_pointer();
/** Returns the core pointer device for the given display
*
* @newin{2,2}
* @return The core pointer device; this is owned by the
* display and should not be freed.
*/
Glib::RefPtr<const Device> get_core_pointer() const;
/** Gets the current location of the pointer and the current modifier
* mask for a given display.
*
* @param screen location to store the screen that the cursor is on.
* @param x location to store root window X coordinate of pointer.
* @param y location to store root window Y coordinate of pointer.
* @param mask location to store current modifier mask.
*
**/
void get_pointer(Glib::RefPtr<Screen>& screen, int& x, int& y, ModifierType& mask);
// In fact, any one of these gdk_display_get_pointer() args can be NULL, but we don't need so many overloads.
/**
* Gets the current location of the pointer and the current modifier
* mask for a given display.
*
* @param x location to store root window X coordinate of pointer.
* @param y location to store root window Y coordinate of pointer.
* @param mask location to store current modifier mask.
*
**/
void get_pointer(int& x, int& y, ModifierType& mask);
/** Obtains the window underneath the mouse pointer, returning the location
* of the pointer in that window in @a win_x, @a win_y for @a screen. Returns <tt>0</tt>
* if the window under the mouse pointer is not known to GDK (for example,
* belongs to another application).
*
* @newin{2,2}
* @param win_x Return location for x coordinate of the pointer location relative
* to the window origin, or <tt>0</tt>.
* @param win_y Return location for y coordinate of the pointer location relative
* & to the window origin, or <tt>0</tt>.
* @return The window under the mouse pointer, or <tt>0</tt>.
*/
Glib::RefPtr<Window> 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 @a win_x, @a win_y for @a screen. Returns <tt>0</tt>
* if the window under the mouse pointer is not known to GDK (for example,
* belongs to another application).
*
* @newin{2,2}
* @param win_x Return location for x coordinate of the pointer location relative
* to the window origin, or <tt>0</tt>.
* @param win_y Return location for y coordinate of the pointer location relative
* & to the window origin, or <tt>0</tt>.
* @return The window under the mouse pointer, or <tt>0</tt>.
*/
Glib::RefPtr<const Window> get_window_at_pointer(int& win_x, int& win_y) 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).
* @result The window underneath the mouse pointer.
*/
Glib::RefPtr<Window> 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).
* @result The window underneath the mouse pointer.
*/
Glib::RefPtr<const Window> get_window_at_pointer() const;
/** Warps the pointer of @a display to the point @a x, @a y on
* the screen @a 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.
*
* @newin{2,8}
* @param screen The screen of @a display to warp the pointer to.
* @param x The x coordinate of the destination.
* @param y The y coordinate of the destination.
*/
void warp_pointer(const Glib::RefPtr<Screen>& screen, int x, int y);
#ifndef GDKMM_DISABLE_DEPRECATED
/** 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.
*
* @newin{2,2}
* @param new_hooks A table of pointers to functions for getting
* quantities related to the current pointer position.
* @return The previous pointer hook table.
*/
GdkDisplayPointerHooks* set_pointer_hooks(const GdkDisplayPointerHooks* new_hooks);
#endif // GDKMM_DISABLE_DEPRECATED
#ifndef GDKMM_DISABLE_DEPRECATED
/** @deprecated This method has been removed in gtkmm-3.0 for lack of use cases.
*/
GdkDisplayPointerHooks* unset_pointer_hooks();
#endif // GDKMM_DISABLE_DEPRECATED
/** 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.
* @return The default display, if it could be opened,
* otherwise <tt>0</tt>.
*/
static Glib::RefPtr<Display> open_default_libgtk_only();
#ifdef G_OS_WIN32
#ifndef GDKMM_DISABLE_DEPRECATED
/** Finds out the DND protocol supported by a window.
*
* @newin{2,2}
* @deprecated Use the version that takes a GdkNativeWindow.
* @param xid The X id of the destination window.
* @param protocol Location where the supported DND protocol is returned.
* @return The X id of the window where the drop should happen. This
* may be @a xid or the X id of a proxy window, or None if @a xid doesn't
* support Drag and Drop.
*
* On Windows, GdkNativeWindow is not the same as guint32, so we keep the
* guint32 variant for ABI compatibility. On Linux, it is the same, and they
* can't be overloaded therefore. But the ABI stays the same anyway.
*/
guint32 get_drag_protocol(guint32 xid, GdkDragProtocol& protocol);
#endif // GDKMM_DISABLE_DEPRECATED
#endif
/** Finds out the DND protocol supported by a window.
*
* @newin{2,2}
* @param xid The windowing system id of the destination window.
* @param protocol Location where the supported DND protocol is returned.
* @return The windowing system id of the window where the drop should happen. This
* may be @a xid or the id of a proxy window, or zero if @a xid doesn't
* support Drag and Drop.
*/
GdkNativeWindow get_drag_protocol(GdkNativeWindow xid, GdkDragProtocol& protocol);
/** Returns the Gdk::Keymap attached to @a display.
*
* @newin{2,2}
* @return The Gdk::Keymap attached to @a display.
*/
GdkKeymap* get_keymap();
/** Returns the Gdk::Keymap attached to @a display.
*
* @newin{2,2}
* @return The Gdk::Keymap attached to @a display.
*/
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);
#ifdef G_OS_WIN32
/** Send a response to SelectionRequest event.
*
* @newin{2,2}
* @param requestor Window to which to deliver response.
* @param selection Selection that was requested.
* @param target Target that was selected.
* @param property Property in which the selection owner stored the data,
* or "None" to indicate that the request was rejected.
* @param time_ Timestamp.
*
* On Windows, GdkNativeWindow is not the same as guint32, so we keep the
* guint32 variant for ABI compatibility. On Linux, it is the same, and they
* can't be overloaded therefore. But the ABI stays the same anyway.
*/
void selection_send_notify(guint32 requestor, Glib::ustring& selection, Glib::ustring& target, Glib::ustring& property, guint32 time_);
#endif
/** Send a response to SelectionRequest event.
*
* @newin{2,2}
* @param requestor Window to which to deliver response.
* @param selection Selection that was requested.
* @param target Target that was selected.
* @param property Property in which the selection owner stored the data,
* or "None" to indicate that the request was rejected.
* @param time_ Timestamp.
*/
void selection_send_notify(GdkNativeWindow requestor, Glib::ustring& selection, Glib::ustring& target, Glib::ustring& property, guint32 time_);
/** 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
* <type>XID</type>.
*
* @newin{2,2}
* @param anid A native pixmap handle.
* @return The Gdk::Pixmap wrapper for the native pixmap,
* or <tt>0</tt> if there is none.
*/
Glib::RefPtr<Pixmap> 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
* <type>XID</type>.
*
* @newin{2,2}
* @param anid A native pixmap handle.
* @return The Gdk::Pixmap wrapper for the native pixmap,
* or <tt>0</tt> if there is none.
*/
Glib::RefPtr<const Pixmap> lookup_pixmap(NativeWindow anid) const;
/** 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.
*
* @newin{2,4}
*/
void flush();
/** Returns <tt>true</tt> if cursors can use an 8bit alpha channel
* on @a display. Otherwise, cursors are restricted to bilevel
* alpha (i.e. a mask).
*
* @newin{2,4}
* @return Whether cursors can have alpha channels.
*/
bool supports_cursor_alpha() const;
/** Returns <tt>true</tt> if multicolored cursors are supported
* on @a display. Otherwise, cursors have only a forground
* and a background color.
*
* @newin{2,4}
* @return Whether cursors can have multiple colors.
*/
bool supports_cursor_color() const;
/** Returns the default size to use for cursors on @a display.
*
* @newin{2,4}
* @return The default cursor size.
*/
guint get_default_cursor_size() const;
/** Gets the maximal size to use for cursors on @a display.
*
* @newin{2,4}
* @param width The return location for the maximal cursor width.
* @param height The return location for the maximal cursor height.
*/
void get_maximal_cursor_size(guint& width, guint& height);
/** Returns the default group leader window for all toplevel windows
* on @a display. This window is implicitly created by GDK.
* See Gdk::Window::set_group().
*
* @newin{2,4}
* @return The default group leader window for @a display.
*/
Glib::RefPtr<Window> get_default_group();
/** Returns the default group leader window for all toplevel windows
* on @a display. This window is implicitly created by GDK.
* See Gdk::Window::set_group().
*
* @newin{2,4}
* @return The default group leader window for @a display.
*/
Glib::RefPtr<const Window> get_default_group() const;
//TODO: wrap the vfuncs, though they are not very useful because people will not derive from this class? murrayc.
/** Returns whether Gdk::EventOwnerChange events will be
* sent when the owner of a selection changes.
*
* @newin{2,6}
* @return Whether Gdk::EventOwnerChange events will
* be sent.
*/
bool supports_selection_notification() const;
/** Request Gdk::EventOwnerChange events for ownership changes
* of the selection named by the given atom.
*
* @newin{2,6}
* @param selection The Gdk::Atom naming the selection for which
* ownership change notification is requested.
* @return Whether Gdk::EventOwnerChange events will
* be sent.
*/
bool request_selection_notification(const Glib::ustring& selection);
/** 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.
*
* @newin{2,6}
* @return <tt>true</tt> if the display supports clipboard persistance.
*/
bool supports_clipboard_persistence() const;
/** 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.
* @newin{2,6}
*
* @param clipboard_window A Gdk::Window belonging to the clipboard owner.
* @param time_ A timestamp.
*/
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);
/** Returns <tt>true</tt> if Gdk::Window::shape_combine_mask() can
* be used to create shaped windows on @a display.
*
* @newin{2,10}
* @return <tt>true</tt> if shaped windows are supported.
*/
bool supports_shapes() const;
/** Returns <tt>true</tt> if Gdk::Window::input_shape_combine_mask() can
* be used to modify the input shape of windows on @a display.
*
* @newin{2,10}
* @return <tt>true</tt> if windows with modified input shape are supported.
*/
bool supports_input_shapes() const;
/** Returns <tt>true</tt> 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.
*
* @newin{2,12}
* @return <tt>true</tt> if windows may be composited.
*/
bool supports_composite() const;
/** The closed signal is emitted when the connection to the windowing
* system for this display is closed.
*
* @param is_error true if the display was closed due to an error
*
* @par Prototype:
* <tt>void on_my_%closed(bool is_error)</tt>
*/
Glib::SignalProxy1< void,bool > signal_closed();
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
virtual void on_closed(bool is_error);
};
} /* namespace Gdk */
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gdk::Display
*/
Glib::RefPtr<Gdk::Display> wrap(GdkDisplay* object, bool take_copy = false);
}
#endif /* _GDKMM_DISPLAY_H */
|