libs/gtkmm2/gtk/gtkmm/separatortoolitem.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _GTKMM_SEPARATORTOOLITEM_H
   4 #define _GTKMM_SEPARATORTOOLITEM_H
   5
   6
   7 #include <glibmm.h>
   8
   9 /* $Id$ */
  10
  11 /* separatortoolitem.h
  12  *
  13  * Copyright (C) 2003 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/toolitem.h>
  31
  32
  33 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  34 typedef struct _GtkSeparatorToolItem GtkSeparatorToolItem;
  35 typedef struct _GtkSeparatorToolItemClass GtkSeparatorToolItemClass;
  36 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  37
  38
  39 namespace Gtk
  40 { class SeparatorToolItem_Class; } // namespace Gtk
  41 namespace Gtk
  42 {
  43
  44 /** A toolbar item that separates groups of other toolbar items.
  45  *
  46  * A Gtk::SeparatorToolItem is a Gtk::ToolItem that separates groups of other Gtk::ToolItems.
  47  * Depending on the theme, it will often look like a vertical line on
  48  * horizontally docked toolbars. If the property "expand" is <tt>true</tt> and the property "draw"
  49  * is <tt>false</tt>, a Gtk::SeparatorToolItem will act as a "spring" that forces other items to the
  50  * ends of the toolbar.
  51  *
  52  * @ingroup Widgets
  53  */
  54
  55 class SeparatorToolItem : public ToolItem
  56 {
  57   public:
  58 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  59   typedef SeparatorToolItem CppObjectType;
  60   typedef SeparatorToolItem_Class CppClassType;
  61   typedef GtkSeparatorToolItem BaseObjectType;
  62   typedef GtkSeparatorToolItemClass BaseClassType;
  63 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  64
  65   virtual ~SeparatorToolItem();
  66
  67 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  68
  69 private:
  70   friend class SeparatorToolItem_Class;
  71   static CppClassType separatortoolitem_class_;
  72
  73   // noncopyable
  74   SeparatorToolItem(const SeparatorToolItem&);
  75   SeparatorToolItem& operator=(const SeparatorToolItem&);
  76
  77 protected:
  78   explicit SeparatorToolItem(const Glib::ConstructParams& construct_params);
  79   explicit SeparatorToolItem(GtkSeparatorToolItem* castitem);
  80
  81 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  82
  83 public:
  84 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  85   static GType get_type()      G_GNUC_CONST;
  86   static GType get_base_type() G_GNUC_CONST;
  87 #endif
  88
  89   ///Provides access to the underlying C GtkObject.
  90   GtkSeparatorToolItem*       gobj()       { return reinterpret_cast<GtkSeparatorToolItem*>(gobject_); }
  91
  92   ///Provides access to the underlying C GtkObject.
  93   const GtkSeparatorToolItem* gobj() const { return reinterpret_cast<GtkSeparatorToolItem*>(gobject_); }
  94
  95
  96 public:
  97   //C++ methods used to invoke GTK+ virtual functions:
  98 #ifdef GLIBMM_VFUNCS_ENABLED
  99 #endif //GLIBMM_VFUNCS_ENABLED
 100
 101 protected:
 102   //GTK+ Virtual Functions (override these to change behaviour):
 103 #ifdef GLIBMM_VFUNCS_ENABLED
 104 #endif //GLIBMM_VFUNCS_ENABLED
 105
 106   //Default Signal Handlers::
 107 #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 108 #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 109
 110
 111 private:
 112
 113 public:
 114   SeparatorToolItem();
 115
 116
 117 };
 118
 119 } // namespace Gtk
 120
 121
 122 namespace Glib
 123 {
 124   /** A Glib::wrap() method for this object.
 125    *
 126    * @param object The C instance.
 127    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 128    * @result A C++ instance that wraps this C instance.
 129    *
 130    * @relates Gtk::SeparatorToolItem
 131    */
 132   Gtk::SeparatorToolItem* wrap(GtkSeparatorToolItem* object, bool take_copy = false);
 133 } //namespace Glib
 134
 135
 136 #endif /* _GTKMM_SEPARATORTOOLITEM_H */
 137