menuitem.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_MENUITEM_H
#define _GTKMM_MENUITEM_H
 
#include <gtkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/*
 * Copyright (C) 1998-2002 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
 
#include <gtkmm/item.h>
#include <gtkmm/accelkey.h>
#include <gtkmm/accellabel.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkMenuItem GtkMenuItem;
typedef struct _GtkMenuItemClass GtkMenuItemClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class MenuItem_Class; } // namespace Gtk
namespace Gtk
{
 
class Menu;
namespace Menu_Helpers { class Element; }
 
// TODO: Inherit/Implement Activatable when we can break ABI.
 
class MenuItem : public Item
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef MenuItem CppObjectType;
  typedef MenuItem_Class CppClassType;
  typedef GtkMenuItem BaseObjectType;
  typedef GtkMenuItemClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~MenuItem();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class MenuItem_Class;
  static CppClassType menuitem_class_;
 
  // noncopyable
  MenuItem(const MenuItem&);
  MenuItem& operator=(const MenuItem&);
 
protected:
  explicit MenuItem(const Glib::ConstructParams& construct_params);
  explicit MenuItem(GtkMenuItem* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkMenuItem*       gobj()       { return reinterpret_cast<GtkMenuItem*>(gobject_); }
 
  const GtkMenuItem* gobj() const { return reinterpret_cast<GtkMenuItem*>(gobject_); }
 
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
  virtual void on_activate();
  virtual void on_activate_item();
  virtual void on_toggle_size_request(int* requisition);
  virtual void on_toggle_size_allocate(int allocation);
 
 
private:
 
public:
  MenuItem();
 
  explicit MenuItem(Widget& widget);
 
  explicit MenuItem(const Glib::ustring& label, bool mnemonic = false);
 
  
  void set_submenu(Menu& submenu);
 
  void unset_submenu();
 
  
  Menu* get_submenu();
  
  const Menu* get_submenu() const;
  bool has_submenu() const;
 
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void remove_submenu();
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void select();
  
  void deselect();
  
  void activate();
  
  void toggle_size_request(int& requisition);
  
  void toggle_size_allocate(int allocation);
  
  void set_right_justified(bool right_justified =  true);
  
  bool get_right_justified() const;
  
  void set_accel_path(const Glib::ustring& accel_path);
  void unset_accel_path();
  
  Glib::ustring get_accel_path() const;
  
  void set_label(const Glib::ustring& label);
  
  Glib::ustring get_label() const;
  
  void set_use_underline(bool setting =  true);
  
  bool get_use_underline() const;
 
  
  Glib::SignalProxy0< void > signal_activate();
 
  
  Glib::SignalProxy0< void > signal_activate_item();
 
  
  Glib::SignalProxy1< void,int* > signal_toggle_size_request();
 
  
  Glib::SignalProxy1< void,int > signal_toggle_size_allocate();
 
 
  void accelerate(Window& window);
 
  Glib::PropertyProxy< bool > property_right_justified() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_right_justified() const;
 
  Glib::PropertyProxy< Gtk::Menu* > property_submenu() ;
 
  Glib::PropertyProxy_ReadOnly< Gtk::Menu* > property_submenu() const;
 
  Glib::PropertyProxy< Glib::ustring > property_accel_path() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_accel_path() const;
 
  Glib::PropertyProxy< Glib::ustring > property_label() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_label() const;
 
  Glib::PropertyProxy< bool > property_use_underline() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_use_underline() const;
 
 
protected:
  void add_accel_label(const Glib::ustring& label, bool mnemonic = true);
  void set_accel_key(const AccelKey& accel_key);
 
private:
  friend class Menu_Helpers::Element;
 
  //This data is set by MenuElem, and will be used in on_realize(), in the call to add_accelerator().
  AccelKey accel_key_;
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::MenuItem* wrap(GtkMenuItem* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_MENUITEM_H */