libs/gtkmm2/gtk/gtkmm/imagemenuitem.h

   1 // -*- c++ -*-
   2 // Generated by gtkmmproc -- DO NOT MODIFY!
   3 #ifndef _GTKMM_IMAGEMENUITEM_H
   4 #define _GTKMM_IMAGEMENUITEM_H
   5
   6
   7 #include <glibmm.h>
   8
   9 /* $Id$ */
  10
  11 /* checkmenuitem.h
  12  *
  13  * Copyright (C) 1998-2002 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/menuitem.h>
  31 #include <gtkmm/stockid.h>
  32
  33
  34 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  35 typedef struct _GtkImageMenuItem GtkImageMenuItem;
  36 typedef struct _GtkImageMenuItemClass GtkImageMenuItemClass;
  37 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  38
  39
  40 namespace Gtk
  41 { class ImageMenuItem_Class; } // namespace Gtk
  42 namespace Gtk
  43 {
  44
  45 /** A menu item with an icon.
  46  *
  47  * A GtkImageMenuItem is a menu item which has an icon next to the text label. Note that the
  48  * user can disable display of menu icons, so make sure to still fill in the text label.
  49  *
  50  * @ingroup Menus
  51  * @ingroup Widgets                                                                                                                                                S
  52  */
  53
  54 class ImageMenuItem : public MenuItem
  55 {
  56   public:
  57 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  58   typedef ImageMenuItem CppObjectType;
  59   typedef ImageMenuItem_Class CppClassType;
  60   typedef GtkImageMenuItem BaseObjectType;
  61   typedef GtkImageMenuItemClass BaseClassType;
  62 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  63
  64   virtual ~ImageMenuItem();
  65
  66 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  67
  68 private:
  69   friend class ImageMenuItem_Class;
  70   static CppClassType imagemenuitem_class_;
  71
  72   // noncopyable
  73   ImageMenuItem(const ImageMenuItem&);
  74   ImageMenuItem& operator=(const ImageMenuItem&);
  75
  76 protected:
  77   explicit ImageMenuItem(const Glib::ConstructParams& construct_params);
  78   explicit ImageMenuItem(GtkImageMenuItem* castitem);
  79
  80 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  81
  82 public:
  83 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  84   static GType get_type()      G_GNUC_CONST;
  85   static GType get_base_type() G_GNUC_CONST;
  86 #endif
  87
  88   ///Provides access to the underlying C GtkObject.
  89   GtkImageMenuItem*       gobj()       { return reinterpret_cast<GtkImageMenuItem*>(gobject_); }
  90
  91   ///Provides access to the underlying C GtkObject.
  92   const GtkImageMenuItem* gobj() const { return reinterpret_cast<GtkImageMenuItem*>(gobject_); }
  93
  94
  95 public:
  96   //C++ methods used to invoke GTK+ virtual functions:
  97 #ifdef GLIBMM_VFUNCS_ENABLED
  98 #endif //GLIBMM_VFUNCS_ENABLED
  99
 100 protected:
 101   //GTK+ Virtual Functions (override these to change behaviour):
 102 #ifdef GLIBMM_VFUNCS_ENABLED
 103 #endif //GLIBMM_VFUNCS_ENABLED
 104
 105   //Default Signal Handlers::
 106 #ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 107 #endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
 108
 109
 110 private:
 111
 112 public:
 113
 114   ImageMenuItem();
 115   explicit ImageMenuItem(Widget& image,
 116                          const Glib::ustring& label, bool mnemonic = false);
 117   explicit ImageMenuItem(const Glib::ustring& label, bool mnemonic = false);
 118   explicit ImageMenuItem(const StockID& id);
 119
 120
 121   /** Sets the image of @a image_menu_item  to the given widget.
 122    * Note that it depends on the show-menu-images setting whether
 123    * the image will be displayed or not.
 124    * @param image A widget to set as the image for the menu item.
 125    */
 126   void set_image(Widget& image);
 127
 128   /** Gets the widget that is currently set as the image of @a image_menu_item .
 129    * See set_image().
 130    * @return The widget set as image of @a image_menu_item .
 131    */
 132   Widget* get_image();
 133
 134   /** Gets the widget that is currently set as the image of @a image_menu_item .
 135    * See set_image().
 136    * @return The widget set as image of @a image_menu_item .
 137    */
 138   const Widget* get_image() const;
 139
 140
 141 };
 142
 143 } /* namespace Gtk */
 144
 145
 146 namespace Glib
 147 {
 148   /** A Glib::wrap() method for this object.
 149    *
 150    * @param object The C instance.
 151    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 152    * @result A C++ instance that wraps this C instance.
 153    *
 154    * @relates Gtk::ImageMenuItem
 155    */
 156   Gtk::ImageMenuItem* wrap(GtkImageMenuItem* object, bool take_copy = false);
 157 } //namespace Glib
 158
 159
 160 #endif /* _GTKMM_IMAGEMENUITEM_H */
 161