libs/gtkmm2/gtk/gtkmm/invisible.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _GTKMM_INVISIBLE_H
   4 #define _GTKMM_INVISIBLE_H
   5
   6 #include <glibmm.h>
   7
   8 /* $Id$ */
   9
  10 /* invisible.h
  11  *
  12  * Copyright (C) 1998-2002 The gtkmm Development Team
  13  *
  14  * This library is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU Library General Public
  16  * License as published by the Free Software Foundation; either
  17  * version 2 of the License, or (at your option) any later version.
  18  *
  19  * This library is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22  * Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with this library; if not, write to the Free
  26  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  27  */
  28
  29 #include <gtkmm/widget.h>
  30
  31
  32 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  33 typedef struct _GtkInvisible GtkInvisible;
  34 typedef struct _GtkInvisibleClass GtkInvisibleClass;
  35 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  36
  37
  38 namespace Gtk
  39 { class Invisible_Class; } // namespace Gtk
  40 namespace Gtk
  41 {
  42
  43 /** This widget is used internally in GTK+, and is probably not useful for application developers.
  44  * It is used for reliable pointer grabs and selection handling in the code for drag-and-drop.
  45  * @ingroup Widgets
  46  */
  47
  48 class Invisible : public Widget
  49 {
  50   public:
  51 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  52   typedef Invisible CppObjectType;
  53   typedef Invisible_Class CppClassType;
  54   typedef GtkInvisible BaseObjectType;
  55   typedef GtkInvisibleClass BaseClassType;
  56 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  57
  58   virtual ~Invisible();
  59
  60 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  61
  62 private:
  63   friend class Invisible_Class;
  64   static CppClassType invisible_class_;
  65
  66   // noncopyable
  67   Invisible(const Invisible&);
  68   Invisible& operator=(const Invisible&);
  69
  70 protected:
  71   explicit Invisible(const Glib::ConstructParams& construct_params);
  72   explicit Invisible(GtkInvisible* castitem);
  73
  74 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  75
  76 public:
  77 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  78   static GType get_type()      G_GNUC_CONST;
  79   static GType get_base_type() G_GNUC_CONST;
  80 #endif
  81
  82   ///Provides access to the underlying C GtkObject.
  83   GtkInvisible*       gobj()       { return reinterpret_cast<GtkInvisible*>(gobject_); }
  84
  85   ///Provides access to the underlying C GtkObject.
  86   const GtkInvisible* gobj() const { return reinterpret_cast<GtkInvisible*>(gobject_); }
  87
  88
  89 public:
  90   //C++ methods used to invoke GTK+ virtual functions:
  91
  92 protected:
  93   //GTK+ Virtual Functions (override these to change behaviour):
  94
  95   //Default Signal Handlers::
  96
  97
  98 private:
  99
 100 public:
 101   Invisible();
 102   explicit Invisible(const Glib::RefPtr<Gdk::Screen>& screen);
 103
 104
 105   /** Returns the Gdk::Screen object associated with @a invisible
 106    * @return The associated Gdk::Screen.
 107    *
 108    * Since: 2.2.
 109    */
 110   Glib::RefPtr<Gdk::Screen> get_screen();
 111
 112   /** Returns the Gdk::Screen object associated with @a invisible
 113    * @return The associated Gdk::Screen.
 114    *
 115    * Since: 2.2.
 116    */
 117   Glib::RefPtr<const Gdk::Screen> get_screen() const;
 118
 119   /** Sets the Gdk::Screen where the Gtk::Invisible object will be displayed.
 120    *
 121    * Since: 2.2
 122    * @param screen A Gdk::Screen.
 123    */
 124   void set_screen(const Glib::RefPtr<Gdk::Screen>& screen);
 125
 126
 127 };
 128
 129 } /* namespace Gtk */
 130
 131
 132 namespace Glib
 133 {
 134   /** @relates Gtk::Invisible
 135    * @param object The C instance
 136    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 137    * @result A C++ instance that wraps this C instance.
 138    */
 139   Gtk::Invisible* wrap(GtkInvisible* object, bool take_copy = false);
 140 }
 141 #endif /* _GTKMM_INVISIBLE_H */
 142