display.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GDKMM_DISPLAY_H
#define _GDKMM_DISPLAY_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.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 */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gdk
{ class Display_Class; } // namespace Gdk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gdk
{
 
 
class Drawable;
 
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();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GdkDisplay*       gobj()       { return reinterpret_cast<GdkDisplay*>(gobject_); }
 
  const GdkDisplay* gobj() const { return reinterpret_cast<GdkDisplay*>(gobject_); }
 
  GdkDisplay* gobj_copy();
 
private:
 
protected:
  Display();
 
public:
  
  static Glib::RefPtr<Display> open(const Glib::ustring& display_name);
 
  
  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;
 
  //TODO: Use C++ Gdk::Event:
  //TODO: get_event() might remove the event - if so, then there should not be a const version:
  
  GdkEvent* get_event();
  
  const GdkEvent* get_event() const;
 
  
  GdkEvent* peek_event();
  
  GdkEvent* peek_event() const;
  
  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.
  
  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);
 
 
  static Glib::RefPtr<Display> get_default();
 
  
  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);
 
  // In fact, any one of these gdk_display_get_pointer() args can be NULL, but we don't need so many overloads.
  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);
 
  
#ifndef GDKMM_DISABLE_DEPRECATED
 
  GdkDisplayPointerHooks* set_pointer_hooks(const GdkDisplayPointerHooks* new_hooks);
#endif // GDKMM_DISABLE_DEPRECATED
 
 
  #ifndef GDKMM_DISABLE_DEPRECATED
 
  GdkDisplayPointerHooks* unset_pointer_hooks();
  #endif // GDKMM_DISABLE_DEPRECATED
 
  
  static Glib::RefPtr<Display> open_default_libgtk_only();
 
#ifdef G_OS_WIN32
#ifndef GDKMM_DISABLE_DEPRECATED
 
  guint32 get_drag_protocol(guint32 xid, GdkDragProtocol& protocol);
#endif // GDKMM_DISABLE_DEPRECATED
 
#endif
 
  
  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);
 
#ifdef G_OS_WIN32
  void selection_send_notify(guint32 requestor, Glib::ustring& selection, Glib::ustring& target, Glib::ustring& property, guint32 time_);
#endif
 
  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;
 
  //TODO: wrap the vfuncs, though they are not very useful because people will not derive from this class? murrayc.
 
 
  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();
 
 
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
{
  Glib::RefPtr<Gdk::Display> wrap(GdkDisplay* object, bool take_copy = false);
}
 
 
#endif /* _GDKMM_DISPLAY_H */