libs/gtkmm2/gtk/gtkmm/arrow.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _GTKMM_ARROW_H
   4 #define _GTKMM_ARROW_H
   5
   6
   7 #include <glibmm.h>
   8
   9 /* $Id$ */
  10
  11 /* arrow.h
  12  *
  13  * Copyright (C) 1998-2002 The gtkmm Development Team
  14  *
  15  * This library is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU Library General Public
  17  * License as published by the Free Software Foundation; either
  18  * version 2 of the License, or (at your option) any later version.
  19  *
  20  * This library is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  * Library General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU Library General Public
  26  * License along with this library; if not, write to the Free
  27  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  28  */
  29
  30 #include <gtkmm/misc.h>
  31
  32
  33 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  34 typedef struct _GtkArrow GtkArrow;
  35 typedef struct _GtkArrowClass GtkArrowClass;
  36 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  37
  38
  39 namespace Gtk
  40 { class Arrow_Class; } // namespace Gtk
  41 namespace Gtk
  42 {
  43
  44 /** Produces an arrow pointing in one of the four cardinal directions.
  45  *
  46  * This is intended for use where a directional arrow (in one of the four
  47  * cardinal directions) is desired. As such, it has very limited
  48  * functionality and basically only draws itself in a particular direction
  49  * and with a particular shadow type.
  50  *
  51  * Gtk::Arrow will fill any space alloted to it, but since it is inherited
  52  * from Gtk::Misc, it can be padded and/or aligned, to fill exactly the
  53  * space the programmer desires.
  54  *
  55  * @ingroup Widgets
  56  */
  57
  58 class Arrow : public Misc {
  59   public:
  60 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  61   typedef Arrow CppObjectType;
  62   typedef Arrow_Class CppClassType;
  63   typedef GtkArrow BaseObjectType;
  64   typedef GtkArrowClass BaseClassType;
  65 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  66
  67   virtual ~Arrow();
  68
  69 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  70
  71 private:
  72   friend class Arrow_Class;
  73   static CppClassType arrow_class_;
  74
  75   // noncopyable
  76   Arrow(const Arrow&);
  77   Arrow& operator=(const Arrow&);
  78
  79 protected:
  80   explicit Arrow(const Glib::ConstructParams& construct_params);
  81   explicit Arrow(GtkArrow* castitem);
  82
  83 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  84
  85 public:
  86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  87   static GType get_type()      G_GNUC_CONST;
  88   static GType get_base_type() G_GNUC_CONST;
  89 #endif
  90
  91   ///Provides access to the underlying C GtkObject.
  92   GtkArrow*       gobj()       { return reinterpret_cast<GtkArrow*>(gobject_); }
  93
  94   ///Provides access to the underlying C GtkObject.
  95   const GtkArrow* gobj() const { return reinterpret_cast<GtkArrow*>(gobject_); }
  96
  97
  98 public:
  99   //C++ methods used to invoke GTK+ virtual functions:
 100 #ifdef GLIBMM_VFUNCS_ENABLED
 101 #endif //GLIBMM_VFUNCS_ENABLED
 102
 103 protected:
 104   //GTK+ Virtual Functions (override these to change behaviour):
 105 #ifdef GLIBMM_VFUNCS_ENABLED
 106 #endif //GLIBMM_VFUNCS_ENABLED
 107
 108   //Default Signal Handlers::
 109 #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 110 #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 111
 112
 113 private:
 114
 115 public:
 116
 117
 118   /** Creates an arrow.
 119    *
 120    * @param arrow_type A Gtk::ArrowType enum describing the arrow direction.
 121    * @param shadow_type A Gtk::ShadowType enum describing the shadow type of
 122    * the arrow.
 123    */
 124   explicit Arrow(ArrowType arrow_type, ShadowType shadow_type);
 125
 126
 127   // Changes the direction and shadow of an arrow.
 128
 129   /** Sets the direction and shadow of this Arrow.
 130    * @param arrow_type A Gtk::ArrowType enum describing what arrow type to set this Arrow to.
 131    * @param shadow_type A Gtk::ShadowType enum describing what shadow type to set this Arrow to.
 132    */
 133   void set(ArrowType arrow_type, ShadowType shadow_type);
 134
 135   #ifdef GLIBMM_PROPERTIES_ENABLED
 136 /** The direction the arrow should point.
 137    *
 138    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 139    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 140    * the value of the property changes.
 141    */
 142   Glib::PropertyProxy<ArrowType> property_arrow_type() ;
 143 #endif //#GLIBMM_PROPERTIES_ENABLED
 144
 145 #ifdef GLIBMM_PROPERTIES_ENABLED
 146 /** The direction the arrow should point.
 147    *
 148    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 149    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 150    * the value of the property changes.
 151    */
 152   Glib::PropertyProxy_ReadOnly<ArrowType> property_arrow_type() const;
 153 #endif //#GLIBMM_PROPERTIES_ENABLED
 154
 155   #ifdef GLIBMM_PROPERTIES_ENABLED
 156 /** Appearance of the shadow surrounding the arrow.
 157    *
 158    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 159    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 160    * the value of the property changes.
 161    */
 162   Glib::PropertyProxy<ShadowType> property_shadow_type() ;
 163 #endif //#GLIBMM_PROPERTIES_ENABLED
 164
 165 #ifdef GLIBMM_PROPERTIES_ENABLED
 166 /** Appearance of the shadow surrounding the arrow.
 167    *
 168    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 169    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 170    * the value of the property changes.
 171    */
 172   Glib::PropertyProxy_ReadOnly<ShadowType> property_shadow_type() const;
 173 #endif //#GLIBMM_PROPERTIES_ENABLED
 174
 175
 176 };
 177
 178
 179 } /* namespace Gtk */
 180
 181
 182 namespace Glib
 183 {
 184   /** A Glib::wrap() method for this object.
 185    *
 186    * @param object The C instance.
 187    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 188    * @result A C++ instance that wraps this C instance.
 189    *
 190    * @relates Gtk::Arrow
 191    */
 192   Gtk::Arrow* wrap(GtkArrow* object, bool take_copy = false);
 193 } //namespace Glib
 194
 195
 196 #endif /* _GTKMM_ARROW_H */
 197