1 // Generated by gmmproc 2.60.0 -- DO NOT MODIFY! 2 #ifndef _GTKMM_CELLRENDERERPROGRESS_H 3 #define _GTKMM_CELLRENDERERPROGRESS_H 4 5 6 #include <glibmm/ustring.h> 7 #include <sigc++/sigc++.h> 8 9 /* Copyright (C) 2004 The gtkmm Development Team 10 * 11 * This library is free software; you can redistribute it and/or 12 * modify it under the terms of the GNU Lesser General Public 13 * License as published by the Free Software Foundation; either 14 * version 2.1 of the License, or (at your option) any later version. 15 * 16 * This library is distributed in the hope that it will be useful, 17 * but WITHOUT ANY WARRANTY; without even the implied warranty of 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19 * Lesser General Public License for more details. 20 * 21 * You should have received a copy of the GNU Lesser General Public 22 * License along with this library; if not, write to the Free Software 23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 24 */ 25 26 #include <gtkmm/cellrenderer.h> 27 #include <gtkmm/orientable.h> 28 29 30 #ifndef DOXYGEN_SHOULD_SKIP_THIS 31 using GtkCellRendererProgress = struct _GtkCellRendererProgress; 32 using GtkCellRendererProgressClass = struct _GtkCellRendererProgressClass; 33 #endif /* DOXYGEN_SHOULD_SKIP_THIS */ 34 35 36 #ifndef DOXYGEN_SHOULD_SKIP_THIS 37 namespace Gtk 38 { class CellRendererProgress_Class; } // namespace Gtk 39 #endif //DOXYGEN_SHOULD_SKIP_THIS 40 41 namespace Gtk 42 { 43 44 /** Renders numbers as progress bars. 45 * 46 * @ingroup TreeView 47 * @newin{2,6} 48 */ 49 50 class CellRendererProgress 51 : public CellRenderer, 52 public Orientable 53 { 54 public: 55 #ifndef DOXYGEN_SHOULD_SKIP_THIS 56 typedef CellRendererProgress CppObjectType; 57 typedef CellRendererProgress_Class CppClassType; 58 typedef GtkCellRendererProgress BaseObjectType; 59 typedef GtkCellRendererProgressClass BaseClassType; 60 #endif /* DOXYGEN_SHOULD_SKIP_THIS */ 61 62 CellRendererProgress(CellRendererProgress&& src) noexcept; 63 CellRendererProgress& operator=(CellRendererProgress&& src) noexcept; 64 65 // noncopyable 66 CellRendererProgress(const CellRendererProgress&) = delete; 67 CellRendererProgress& operator=(const CellRendererProgress&) = delete; 68 69 ~CellRendererProgress() noexcept override; 70 71 #ifndef DOXYGEN_SHOULD_SKIP_THIS 72 73 private: 74 friend class CellRendererProgress_Class; 75 static CppClassType cellrendererprogress_class_; 76 77 protected: 78 explicit CellRendererProgress(const Glib::ConstructParams& construct_params); 79 explicit CellRendererProgress(GtkCellRendererProgress* castitem); 80 81 #endif /* DOXYGEN_SHOULD_SKIP_THIS */ 82 83 public: 84 85 /** Get the GType for this class, for use with the underlying GObject type system. 86 */ 87 static GType get_type() G_GNUC_CONST; 88 89 #ifndef DOXYGEN_SHOULD_SKIP_THIS 90 91 92 static GType get_base_type() G_GNUC_CONST; 93 #endif 94 95 /// Provides access to the underlying C GObject. gobj()96 GtkCellRendererProgress* gobj() { return reinterpret_cast<GtkCellRendererProgress*>(gobject_); } 97 98 /// Provides access to the underlying C GObject. gobj()99 const GtkCellRendererProgress* gobj() const { return reinterpret_cast<GtkCellRendererProgress*>(gobject_); } 100 101 102 public: 103 //C++ methods used to invoke GTK+ virtual functions: 104 105 protected: 106 //GTK+ Virtual Functions (override these to change behaviour): 107 108 //Default Signal Handlers:: 109 110 111 private: 112 113 114 public: 115 CellRendererProgress(); 116 117 /** The "value" property determines the percentage to which the 118 * progress bar will be "filled in". 119 * 120 * @newin{2,6} 121 * 122 * Default value: 0 123 * 124 * @return A PropertyProxy that allows you to get or set the value of the property, 125 * or receive notification when the value of the property changes. 126 */ 127 Glib::PropertyProxy< int > property_value() ; 128 129 /** The "value" property determines the percentage to which the 130 * progress bar will be "filled in". 131 * 132 * @newin{2,6} 133 * 134 * Default value: 0 135 * 136 * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, 137 * or receive notification when the value of the property changes. 138 */ 139 Glib::PropertyProxy_ReadOnly< int > property_value() const; 140 141 /** The "text" property determines the label which will be drawn 142 * over the progress bar. Setting this property to <tt>nullptr</tt> causes the default 143 * label to be displayed. Setting this property to an empty string causes 144 * no label to be displayed. 145 * 146 * @newin{2,6} 147 * 148 * Default value: "" 149 * 150 * @return A PropertyProxy that allows you to get or set the value of the property, 151 * or receive notification when the value of the property changes. 152 */ 153 Glib::PropertyProxy< Glib::ustring > property_text() ; 154 155 /** The "text" property determines the label which will be drawn 156 * over the progress bar. Setting this property to <tt>nullptr</tt> causes the default 157 * label to be displayed. Setting this property to an empty string causes 158 * no label to be displayed. 159 * 160 * @newin{2,6} 161 * 162 * Default value: "" 163 * 164 * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, 165 * or receive notification when the value of the property changes. 166 */ 167 Glib::PropertyProxy_ReadOnly< Glib::ustring > property_text() const; 168 169 /** Setting this to a non-negative value causes the cell renderer to 170 * enter "activity mode", where a block bounces back and forth to 171 * indicate that some progress is made, without specifying exactly how 172 * much. 173 * 174 * Each increment of the property causes the block to move by a little 175 * bit. 176 * 177 * To indicate that the activity has not started yet, set the property 178 * to zero. To indicate completion, set the property to G_MAXINT. 179 * 180 * @newin{2,12} 181 * 182 * Default value: -1 183 * 184 * @return A PropertyProxy that allows you to get or set the value of the property, 185 * or receive notification when the value of the property changes. 186 */ 187 Glib::PropertyProxy< int > property_pulse() ; 188 189 /** Setting this to a non-negative value causes the cell renderer to 190 * enter "activity mode", where a block bounces back and forth to 191 * indicate that some progress is made, without specifying exactly how 192 * much. 193 * 194 * Each increment of the property causes the block to move by a little 195 * bit. 196 * 197 * To indicate that the activity has not started yet, set the property 198 * to zero. To indicate completion, set the property to G_MAXINT. 199 * 200 * @newin{2,12} 201 * 202 * Default value: -1 203 * 204 * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, 205 * or receive notification when the value of the property changes. 206 */ 207 Glib::PropertyProxy_ReadOnly< int > property_pulse() const; 208 209 /** The "text-xalign" property controls the horizontal alignment of the 210 * text in the progress bar. Valid values range from 0 (left) to 1 211 * (right). Reserved for RTL layouts. 212 * 213 * @newin{2,12} 214 * 215 * Default value: 0.5 216 * 217 * @return A PropertyProxy that allows you to get or set the value of the property, 218 * or receive notification when the value of the property changes. 219 */ 220 Glib::PropertyProxy< float > property_text_xalign() ; 221 222 /** The "text-xalign" property controls the horizontal alignment of the 223 * text in the progress bar. Valid values range from 0 (left) to 1 224 * (right). Reserved for RTL layouts. 225 * 226 * @newin{2,12} 227 * 228 * Default value: 0.5 229 * 230 * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, 231 * or receive notification when the value of the property changes. 232 */ 233 Glib::PropertyProxy_ReadOnly< float > property_text_xalign() const; 234 235 /** The "text-yalign" property controls the vertical alignment of the 236 * text in the progress bar. Valid values range from 0 (top) to 1 237 * (bottom). 238 * 239 * @newin{2,12} 240 * 241 * Default value: 0.5 242 * 243 * @return A PropertyProxy that allows you to get or set the value of the property, 244 * or receive notification when the value of the property changes. 245 */ 246 Glib::PropertyProxy< float > property_text_yalign() ; 247 248 /** The "text-yalign" property controls the vertical alignment of the 249 * text in the progress bar. Valid values range from 0 (top) to 1 250 * (bottom). 251 * 252 * @newin{2,12} 253 * 254 * Default value: 0.5 255 * 256 * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, 257 * or receive notification when the value of the property changes. 258 */ 259 Glib::PropertyProxy_ReadOnly< float > property_text_yalign() const; 260 261 /** Invert the direction in which the progress bar grows. 262 * 263 * Default value: <tt>false</tt> 264 * 265 * @return A PropertyProxy that allows you to get or set the value of the property, 266 * or receive notification when the value of the property changes. 267 */ 268 Glib::PropertyProxy< bool > property_inverted() ; 269 270 /** Invert the direction in which the progress bar grows. 271 * 272 * Default value: <tt>false</tt> 273 * 274 * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, 275 * or receive notification when the value of the property changes. 276 */ 277 Glib::PropertyProxy_ReadOnly< bool > property_inverted() const; 278 279 280 Glib::PropertyProxy_Base _property_renderable() override; 281 282 283 }; 284 285 } // namespace Gtk 286 287 288 namespace Glib 289 { 290 /** A Glib::wrap() method for this object. 291 * 292 * @param object The C instance. 293 * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. 294 * @result A C++ instance that wraps this C instance. 295 * 296 * @relates Gtk::CellRendererProgress 297 */ 298 Gtk::CellRendererProgress* wrap(GtkCellRendererProgress* object, bool take_copy = false); 299 } //namespace Glib 300 301 302 #endif /* _GTKMM_CELLRENDERERPROGRESS_H */ 303 304