libs/gtkmm2/gtk/gtkmm/cellrendererprogress.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _GTKMM_CELLRENDERERPROGRESS_H
   4 #define _GTKMM_CELLRENDERERPROGRESS_H
   5
   6 #include <glibmm.h>
   7
   8 /* $Id$ */
   9
  10 /* Copyright (C) 2004 The gtkmm Development Team
  11  *
  12  * This library is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Library General Public
  14  * License as published by the Free Software Foundation; either
  15  * version 2 of the License, or (at your option) any later version.
  16  *
  17  * This library is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with this library; if not, write to the Free
  24  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25  */
  26
  27 #include <gtkmm/cellrenderer.h>
  28
  29
  30 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  31 typedef struct _GtkCellRendererProgress GtkCellRendererProgress;
  32 typedef struct _GtkCellRendererProgressClass GtkCellRendererProgressClass;
  33 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  34
  35
  36 namespace Gtk
  37 { class CellRendererProgress_Class; } // namespace Gtk
  38 namespace Gtk
  39 {
  40
  41 /** Renders numbers as progress bars.
  42  *
  43  * @ingroup TreeView
  44  */
  45
  46 class CellRendererProgress : public CellRenderer
  47 {
  48   public:
  49 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  50   typedef CellRendererProgress CppObjectType;
  51   typedef CellRendererProgress_Class CppClassType;
  52   typedef GtkCellRendererProgress BaseObjectType;
  53   typedef GtkCellRendererProgressClass BaseClassType;
  54 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  55
  56   virtual ~CellRendererProgress();
  57
  58 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  59
  60 private:
  61   friend class CellRendererProgress_Class;
  62   static CppClassType cellrendererprogress_class_;
  63
  64   // noncopyable
  65   CellRendererProgress(const CellRendererProgress&);
  66   CellRendererProgress& operator=(const CellRendererProgress&);
  67
  68 protected:
  69   explicit CellRendererProgress(const Glib::ConstructParams& construct_params);
  70   explicit CellRendererProgress(GtkCellRendererProgress* castitem);
  71
  72 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  73
  74 public:
  75 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  76   static GType get_type()      G_GNUC_CONST;
  77   static GType get_base_type() G_GNUC_CONST;
  78 #endif
  79
  80   ///Provides access to the underlying C GtkObject.
  81   GtkCellRendererProgress*       gobj()       { return reinterpret_cast<GtkCellRendererProgress*>(gobject_); }
  82
  83   ///Provides access to the underlying C GtkObject.
  84   const GtkCellRendererProgress* gobj() const { return reinterpret_cast<GtkCellRendererProgress*>(gobject_); }
  85
  86
  87 public:
  88   //C++ methods used to invoke GTK+ virtual functions:
  89
  90 protected:
  91   //GTK+ Virtual Functions (override these to change behaviour):
  92
  93   //Default Signal Handlers::
  94
  95
  96 private:
  97
  98 public:
  99   CellRendererProgress();
 100
 101   /** Value of the progress bar.
 102    *
 103    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 104    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 105    * the value of the property changes.
 106    */
 107   Glib::PropertyProxy<int> property_value() ;
 108
 109 /** Value of the progress bar.
 110    *
 111    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 112    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 113    * the value of the property changes.
 114    */
 115   Glib::PropertyProxy_ReadOnly<int> property_value() const;
 116
 117   /** Text on the progress bar.
 118    *
 119    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 120    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 121    * the value of the property changes.
 122    */
 123   Glib::PropertyProxy<Glib::ustring> property_text() ;
 124
 125 /** Text on the progress bar.
 126    *
 127    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 128    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 129    * the value of the property changes.
 130    */
 131   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_text() const;
 132
 133
 134   virtual Glib::PropertyProxy_Base _property_renderable(); //override
 135
 136
 137 };
 138
 139 } // namespace Gtk
 140
 141
 142 namespace Glib
 143 {
 144   /** @relates Gtk::CellRendererProgress
 145    * @param object The C instance
 146    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 147    * @result A C++ instance that wraps this C instance.
 148    */
 149   Gtk::CellRendererProgress* wrap(GtkCellRendererProgress* object, bool take_copy = false);
 150 }
 151 #endif /* _GTKMM_CELLRENDERERPROGRESS_H */
 152