libs/gtkmm2/gtk/gtkmm/cellrendereraccel.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _GTKMM_CELLRENDERERACCEL_H
   4 #define _GTKMM_CELLRENDERERACCEL_H
   5
   6
   7 #include <glibmm.h>
   8
   9 /* $Id: cellrendereraccel.hg,v 1.2 2006/05/11 11:40:24 murrayc Exp $ */
  10
  11 /* cellrendereraccel.h
  12  *
  13  * Copyright (C) 2005 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/cellrenderertext.h>
  31 #include <gtkmm/accelkey.h>
  32
  33
  34 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  35 typedef struct _GtkCellRendererAccel GtkCellRendererAccel;
  36 typedef struct _GtkCellRendererAccelClass GtkCellRendererAccelClass;
  37 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  38
  39
  40 namespace Gtk
  41 { class CellRendererAccel_Class; } // namespace Gtk
  42 namespace Gtk
  43 {
  44
  45 /**  .
  46  * TODO.
  47  *
  48  * @ingroup TreeView
  49  * @newin2p10
  50  */
  51
  52 class CellRendererAccel : public CellRendererText
  53 {
  54   public:
  55 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  56   typedef CellRendererAccel CppObjectType;
  57   typedef CellRendererAccel_Class CppClassType;
  58   typedef GtkCellRendererAccel BaseObjectType;
  59   typedef GtkCellRendererAccelClass BaseClassType;
  60 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  61
  62   virtual ~CellRendererAccel();
  63
  64 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  65
  66 private:
  67   friend class CellRendererAccel_Class;
  68   static CppClassType cellrendereraccel_class_;
  69
  70   // noncopyable
  71   CellRendererAccel(const CellRendererAccel&);
  72   CellRendererAccel& operator=(const CellRendererAccel&);
  73
  74 protected:
  75   explicit CellRendererAccel(const Glib::ConstructParams& construct_params);
  76   explicit CellRendererAccel(GtkCellRendererAccel* castitem);
  77
  78 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  79
  80 public:
  81 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  82   static GType get_type()      G_GNUC_CONST;
  83   static GType get_base_type() G_GNUC_CONST;
  84 #endif
  85
  86   ///Provides access to the underlying C GtkObject.
  87   GtkCellRendererAccel*       gobj()       { return reinterpret_cast<GtkCellRendererAccel*>(gobject_); }
  88
  89   ///Provides access to the underlying C GtkObject.
  90   const GtkCellRendererAccel* gobj() const { return reinterpret_cast<GtkCellRendererAccel*>(gobject_); }
  91
  92
  93 public:
  94   //C++ methods used to invoke GTK+ virtual functions:
  95 #ifdef GLIBMM_VFUNCS_ENABLED
  96 #endif //GLIBMM_VFUNCS_ENABLED
  97
  98 protected:
  99   //GTK+ Virtual Functions (override these to change behaviour):
 100 #ifdef GLIBMM_VFUNCS_ENABLED
 101 #endif //GLIBMM_VFUNCS_ENABLED
 102
 103   //Default Signal Handlers::
 104 #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 105   virtual void on_accel_edited(const Glib::ustring& path_string, guint accel_key, Gdk::ModifierType accel_mods, guint hardware_keycode);
 106   virtual void on_accel_cleared(const Glib::ustring& path_string);
 107 #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 108
 109
 110 private:
 111
 112 public:
 113
 114   CellRendererAccel();
 115
 116   //TODO: Wrap accel_key and accel_mods in an AccelKey?
 117
 118 /**
 119    * @par Prototype:
 120    * <tt>void %accel_edited(const Glib::ustring& path_string, guint accel_key, Gdk::ModifierType accel_mods, guint hardware_keycode)</tt>
 121    */
 122
 123   Glib::SignalProxy4< void,const Glib::ustring&,guint,Gdk::ModifierType,guint > signal_accel_edited();
 124
 125
 126 /**
 127    * @par Prototype:
 128    * <tt>void %accel_cleared(const Glib::ustring& path_string)</tt>
 129    */
 130
 131   Glib::SignalProxy1< void,const Glib::ustring& > signal_accel_cleared();
 132
 133
 134   #ifdef GLIBMM_PROPERTIES_ENABLED
 135 /** The keyval of the accelerator.
 136    *
 137    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 138    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 139    * the value of the property changes.
 140    */
 141   Glib::PropertyProxy<guint> property_accel_key() ;
 142 #endif //#GLIBMM_PROPERTIES_ENABLED
 143
 144 #ifdef GLIBMM_PROPERTIES_ENABLED
 145 /** The keyval of the accelerator.
 146    *
 147    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 148    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 149    * the value of the property changes.
 150    */
 151   Glib::PropertyProxy_ReadOnly<guint> property_accel_key() const;
 152 #endif //#GLIBMM_PROPERTIES_ENABLED
 153
 154   #ifdef GLIBMM_PROPERTIES_ENABLED
 155 /** The modifier mask of the accelerator.
 156    *
 157    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 158    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 159    * the value of the property changes.
 160    */
 161   Glib::PropertyProxy<Gdk::ModifierType> property_accel_mods() ;
 162 #endif //#GLIBMM_PROPERTIES_ENABLED
 163
 164 #ifdef GLIBMM_PROPERTIES_ENABLED
 165 /** The modifier mask of the accelerator.
 166    *
 167    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 168    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 169    * the value of the property changes.
 170    */
 171   Glib::PropertyProxy_ReadOnly<Gdk::ModifierType> property_accel_mods() const;
 172 #endif //#GLIBMM_PROPERTIES_ENABLED
 173
 174   #ifdef GLIBMM_PROPERTIES_ENABLED
 175 /** The hardware keycode of the accelerator.
 176    *
 177    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 178    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 179    * the value of the property changes.
 180    */
 181   Glib::PropertyProxy<guint> property_keycode() ;
 182 #endif //#GLIBMM_PROPERTIES_ENABLED
 183
 184 #ifdef GLIBMM_PROPERTIES_ENABLED
 185 /** The hardware keycode of the accelerator.
 186    *
 187    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 188    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 189    * the value of the property changes.
 190    */
 191   Glib::PropertyProxy_ReadOnly<guint> property_keycode() const;
 192 #endif //#GLIBMM_PROPERTIES_ENABLED
 193
 194
 195 #ifdef GLIBMM_PROPERTIES_ENABLED
 196   virtual Glib::PropertyProxy_Base _property_renderable(); //override
 197 #endif //GLIBMM_PROPERTIES_ENABLED
 198
 199
 200 };
 201
 202 } /* namespace Gtk */
 203
 204
 205 namespace Glib
 206 {
 207   /** @relates Gtk::CellRendererAccel
 208    * @param object The C instance
 209    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 210    * @result A C++ instance that wraps this C instance.
 211    */
 212   Gtk::CellRendererAccel* wrap(GtkCellRendererAccel* object, bool take_copy = false);
 213 } //namespace Glib
 214
 215
 216 #endif /* _GTKMM_CELLRENDERERACCEL_H */
 217