libs/gtkmm2/gtk/gtkmm/settings.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _GTKMM_SETTINGS_H
   4 #define _GTKMM_SETTINGS_H
   5
   6 #include <glibmm.h>
   7
   8 /* $Id$ */
   9
  10 /* settings.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
  30 #include <gtkmm/toolbar.h>
  31
  32
  33 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  34 typedef struct _GtkSettings GtkSettings;
  35 typedef struct _GtkSettingsClass GtkSettingsClass;
  36 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  37
  38
  39 namespace Gtk
  40 { class Settings_Class; } // namespace Gtk
  41 namespace Gtk
  42 {
  43
  44
  45 class Settings : public Glib::Object
  46 {
  47
  48 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  49
  50 public:
  51   typedef Settings CppObjectType;
  52   typedef Settings_Class CppClassType;
  53   typedef GtkSettings BaseObjectType;
  54   typedef GtkSettingsClass BaseClassType;
  55
  56 private:  friend class Settings_Class;
  57   static CppClassType settings_class_;
  58
  59 private:
  60   // noncopyable
  61   Settings(const Settings&);
  62   Settings& operator=(const Settings&);
  63
  64 protected:
  65   explicit Settings(const Glib::ConstructParams& construct_params);
  66   explicit Settings(GtkSettings* castitem);
  67
  68 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  69
  70 public:
  71   virtual ~Settings();
  72
  73 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  74   static GType get_type()      G_GNUC_CONST;
  75   static GType get_base_type() G_GNUC_CONST;
  76 #endif
  77
  78   ///Provides access to the underlying C GObject.
  79   GtkSettings*       gobj()       { return reinterpret_cast<GtkSettings*>(gobject_); }
  80
  81   ///Provides access to the underlying C GObject.
  82   const GtkSettings* gobj() const { return reinterpret_cast<GtkSettings*>(gobject_); }
  83
  84   ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
  85   GtkSettings* gobj_copy();
  86
  87 private:
  88
  89
  90 protected:
  91
  92
  93 public:
  94
  95   static Glib::RefPtr<Settings> get_default();
  96
  97
  98   /** Gets the Gtk::Settings object for @a screen , creating it if necessary.
  99    * @param screen A Gdk::Screen.
 100    * @return A Gtk::Settings object.
 101    *
 102    * Since: 2.2.
 103    */
 104   static Glib::RefPtr<Settings> get_for_screen(const Glib::RefPtr<Gdk::Screen>& screen);
 105
 106   /** Maximum time allowed between two clicks for them to be considered a double click (in milliseconds).
 107    *
 108    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 109    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 110    * the value of the property changes.
 111    */
 112   Glib::PropertyProxy<int> property_gtk_double_click_time() ;
 113
 114 /** Maximum time allowed between two clicks for them to be considered a double click (in milliseconds).
 115    *
 116    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 117    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 118    * the value of the property changes.
 119    */
 120   Glib::PropertyProxy_ReadOnly<int> property_gtk_double_click_time() const;
 121
 122   /** Maximum distance allowed between two clicks for them to be considered a double click (in pixels).
 123    *
 124    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 125    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 126    * the value of the property changes.
 127    */
 128   Glib::PropertyProxy<int> property_gtk_double_click_distance() ;
 129
 130 /** Maximum distance allowed between two clicks for them to be considered a double click (in pixels).
 131    *
 132    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 133    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 134    * the value of the property changes.
 135    */
 136   Glib::PropertyProxy_ReadOnly<int> property_gtk_double_click_distance() const;
 137
 138   /** Whether the cursor should blink.
 139    *
 140    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 141    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 142    * the value of the property changes.
 143    */
 144   Glib::PropertyProxy<bool> property_gtk_cursor_blink() ;
 145
 146 /** Whether the cursor should blink.
 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<bool> property_gtk_cursor_blink() const;
 153
 154   /** Length of the cursor blink cycle
 155    *
 156    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 157    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 158    * the value of the property changes.
 159    */
 160   Glib::PropertyProxy<int> property_gtk_cursor_blink_time() ;
 161
 162 /** Length of the cursor blink cycle
 163    *
 164    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 165    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 166    * the value of the property changes.
 167    */
 168   Glib::PropertyProxy_ReadOnly<int> property_gtk_cursor_blink_time() const;
 169
 170   /** Whether two cursors should be displayed for mixed left-to-right and right-to-left text.
 171    *
 172    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 173    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 174    * the value of the property changes.
 175    */
 176   Glib::PropertyProxy<bool> property_gtk_split_cursor() ;
 177
 178 /** Whether two cursors should be displayed for mixed left-to-right and right-to-left text.
 179    *
 180    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 181    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 182    * the value of the property changes.
 183    */
 184   Glib::PropertyProxy_ReadOnly<bool> property_gtk_split_cursor() const;
 185
 186   /** Name of theme RC file to load.
 187    *
 188    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 189    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 190    * the value of the property changes.
 191    */
 192   Glib::PropertyProxy<Glib::ustring> property_gtk_theme_name() ;
 193
 194 /** Name of theme RC file to load.
 195    *
 196    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 197    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 198    * the value of the property changes.
 199    */
 200   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_theme_name() const;
 201
 202   /** Name of key theme RC file to load.
 203    *
 204    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 205    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 206    * the value of the property changes.
 207    */
 208   Glib::PropertyProxy<Glib::ustring> property_gtk_key_theme_name() ;
 209
 210 /** Name of key theme RC file to load.
 211    *
 212    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 213    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 214    * the value of the property changes.
 215    */
 216   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_key_theme_name() const;
 217
 218   /** Keybinding to activate the menu bar.
 219    *
 220    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 221    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 222    * the value of the property changes.
 223    */
 224   Glib::PropertyProxy<Glib::ustring> property_gtk_menu_bar_accel() ;
 225
 226 /** Keybinding to activate the menu bar.
 227    *
 228    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 229    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 230    * the value of the property changes.
 231    */
 232   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_menu_bar_accel() const;
 233
 234   /** Number of pixels the cursor can move before dragging.
 235    *
 236    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 237    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 238    * the value of the property changes.
 239    */
 240   Glib::PropertyProxy<int> property_gtk_dnd_drag_threshold() ;
 241
 242 /** Number of pixels the cursor can move before dragging.
 243    *
 244    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 245    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 246    * the value of the property changes.
 247    */
 248   Glib::PropertyProxy_ReadOnly<int> property_gtk_dnd_drag_threshold() const;
 249
 250   /** Name of default font to use.
 251    *
 252    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 253    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 254    * the value of the property changes.
 255    */
 256   Glib::PropertyProxy<Glib::ustring> property_gtk_font_name() ;
 257
 258 /** Name of default font to use.
 259    *
 260    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 261    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 262    * the value of the property changes.
 263    */
 264   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_font_name() const;
 265
 266   /** Whether to antialias Xft fonts; 0=no
 267    *
 268    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 269    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 270    * the value of the property changes.
 271    */
 272   Glib::PropertyProxy<int> property_gtk_xft_antialias() ;
 273
 274 /** Whether to antialias Xft fonts; 0=no
 275    *
 276    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 277    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 278    * the value of the property changes.
 279    */
 280   Glib::PropertyProxy_ReadOnly<int> property_gtk_xft_antialias() const;
 281
 282   /** Whether to hint Xft fonts; 0=no
 283    *
 284    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 285    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 286    * the value of the property changes.
 287    */
 288   Glib::PropertyProxy<int> property_gtk_xft_hinting() ;
 289
 290 /** Whether to hint Xft fonts; 0=no
 291    *
 292    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 293    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 294    * the value of the property changes.
 295    */
 296   Glib::PropertyProxy_ReadOnly<int> property_gtk_xft_hinting() const;
 297
 298   /** What degree of hinting to use; none
 299    *
 300    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 301    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 302    * the value of the property changes.
 303    */
 304   Glib::PropertyProxy<Glib::ustring> property_gtk_xft_hintstyle() ;
 305
 306 /** What degree of hinting to use; none
 307    *
 308    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 309    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 310    * the value of the property changes.
 311    */
 312   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_xft_hintstyle() const;
 313
 314   /** Type of subpixel antialiasing; none
 315    *
 316    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 317    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 318    * the value of the property changes.
 319    */
 320   Glib::PropertyProxy<Glib::ustring> property_gtk_xft_rgba() ;
 321
 322 /** Type of subpixel antialiasing; none
 323    *
 324    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 325    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 326    * the value of the property changes.
 327    */
 328   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_xft_rgba() const;
 329
 330   /** Resolution for Xft
 331    *
 332    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 333    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 334    * the value of the property changes.
 335    */
 336   Glib::PropertyProxy<int> property_gtk_xft_dpi() ;
 337
 338 /** Resolution for Xft
 339    *
 340    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 341    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 342    * the value of the property changes.
 343    */
 344   Glib::PropertyProxy_ReadOnly<int> property_gtk_xft_dpi() const;
 345
 346
 347   // from GtkToolbar
 348   /**
 349    *
 350    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 351    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 352    * the value of the property changes.
 353    */
 354   Glib::PropertyProxy<ToolbarStyle> property_gtk_toolbar_style() ;
 355
 356 /**
 357    *
 358    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 359    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 360    * the value of the property changes.
 361    */
 362   Glib::PropertyProxy_ReadOnly<ToolbarStyle> property_gtk_toolbar_style() const;
 363
 364   /**
 365    *
 366    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 367    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 368    * the value of the property changes.
 369    */
 370   Glib::PropertyProxy<IconSize> property_gtk_toolbar_icon_size() ;
 371
 372 /**
 373    *
 374    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 375    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 376    * the value of the property changes.
 377    */
 378   Glib::PropertyProxy_ReadOnly<IconSize> property_gtk_toolbar_icon_size() const;
 379
 380
 381   // from GtkMenu
 382   /**
 383    *
 384    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 385    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 386    * the value of the property changes.
 387    */
 388   Glib::PropertyProxy<bool> property_gtk_can_change_accels() ;
 389
 390 /**
 391    *
 392    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 393    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 394    * the value of the property changes.
 395    */
 396   Glib::PropertyProxy_ReadOnly<bool> property_gtk_can_change_accels() const;
 397
 398
 399   // from GtkEntry
 400   /**
 401    *
 402    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 403    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 404    * the value of the property changes.
 405    */
 406   Glib::PropertyProxy<bool> property_gtk_entry_select_on_focus() ;
 407
 408 /**
 409    *
 410    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 411    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 412    * the value of the property changes.
 413    */
 414   Glib::PropertyProxy_ReadOnly<bool> property_gtk_entry_select_on_focus() const;
 415
 416
 417   // from GtkColorSelection
 418   /**
 419    *
 420    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 421    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 422    * the value of the property changes.
 423    */
 424   Glib::PropertyProxy<Glib::ustring> property_gtk_color_palette() ;
 425
 426 /**
 427    *
 428    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 429    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 430    * the value of the property changes.
 431    */
 432   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_color_palette() const;
 433
 434
 435   // from GtkButton
 436   /**
 437    *
 438    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 439    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 440    * the value of the property changes.
 441    */
 442   Glib::PropertyProxy<bool> property_gtk_button_images() ;
 443
 444 /**
 445    *
 446    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 447    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 448    * the value of the property changes.
 449    */
 450   Glib::PropertyProxy_ReadOnly<bool> property_gtk_button_images() const;
 451
 452
 453   // from GtkIconTheme
 454   /** Name of icon theme to use.
 455    *
 456    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 457    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 458    * the value of the property changes.
 459    */
 460   Glib::PropertyProxy<Glib::ustring> property_gtk_icon_theme_name() ;
 461
 462 /** Name of icon theme to use.
 463    *
 464    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 465    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 466    * the value of the property changes.
 467    */
 468   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_icon_theme_name() const;
 469
 470   /** List of icon sizes gtk-menu=16
 471    *
 472    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 473    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 474    * the value of the property changes.
 475    */
 476   Glib::PropertyProxy<Glib::ustring> property_gtk_icon_sizes() ;
 477
 478 /** List of icon sizes gtk-menu=16
 479    *
 480    * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
 481    * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
 482    * the value of the property changes.
 483    */
 484   Glib::PropertyProxy_ReadOnly<Glib::ustring> property_gtk_icon_sizes() const;
 485
 486
 487 public:
 488
 489 public:
 490   //C++ methods used to invoke GTK+ virtual functions:
 491
 492 protected:
 493   //GTK+ Virtual Functions (override these to change behaviour):
 494
 495   //Default Signal Handlers::
 496
 497
 498 };
 499
 500 } /* namespace Gtk */
 501
 502
 503 namespace Glib
 504 {
 505   /** @relates Gtk::Settings
 506    * @param object The C instance
 507    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 508    * @result A C++ instance that wraps this C instance.
 509    */
 510   Glib::RefPtr<Gtk::Settings> wrap(GtkSettings* object, bool take_copy = false);
 511 }
 512
 513
 514 #endif /* _GTKMM_SETTINGS_H */
 515