menushell.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_MENUSHELL_H
#define _GTKMM_MENUSHELL_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: menushell.hg,v 1.9 2006/06/21 20:04:25 murrayc Exp $ */
 
/* 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 <gdk/gdkkeysyms.h>
 
 
#include <gtkmm/container.h>
#include <gtkmm/menu_elems.h>
#include <glibmm/helperlist.h>
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkMenuShell GtkMenuShell;
typedef struct _GtkMenuShellClass GtkMenuShellClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class MenuShell_Class; } // namespace Gtk
namespace Gtk
{
 
class Menu;
class MenuShell;
class Window;
 
namespace Menu_Helpers
{
 
/*********************************************************************
***** List properties
*********************************************************************/
 
 
class MenuList : public Glib::HelperList< MenuItem, const Element, Glib::List_Cpp_Iterator<GtkMenuItem,MenuItem> >
{
public:
  MenuList();
  explicit MenuList(GtkMenuShell* gparent);
  MenuList(const MenuList& src);
  virtual ~MenuList() {}
 
  MenuList& operator=(const MenuList& src);
 
  typedef Glib::HelperList< MenuItem, const Element,  Glib::List_Cpp_Iterator<GtkMenuItem,MenuItem> > type_base;
 
  GtkMenuShell* gparent();
  const GtkMenuShell* gparent() const;
 
  virtual GList*& glist() const;      // front of list
 
  virtual void erase(iterator start, iterator stop);
  virtual iterator erase(iterator);  //Implented as custom or by LIST_CONTAINER_REMOVE
  virtual void remove(const_reference); //Implented as custom or by LIST_CONTAINER_REMOVE
 
  reference operator[](size_type l) const;
 
public:
  iterator insert(iterator position, element_type& e); //custom-implemented.
 
  template <class InputIterator>
  inline void insert(iterator position, InputIterator first, InputIterator last)
  {
    for(;first != last; ++first)
      position = insert(position, *first);
  }
 
 inline void push_front(element_type& e)
    { insert(begin(), e); }
  inline void push_back(element_type& e)
    { insert(end(), e); }
 
 
  virtual void remove(Widget& widget); //custom
  };
 
 
} // namespace Menu_Helpers
 
 
class MenuShell : public Container
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef MenuShell CppObjectType;
  typedef MenuShell_Class CppClassType;
  typedef GtkMenuShell BaseObjectType;
  typedef GtkMenuShellClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~MenuShell();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class MenuShell_Class;
  static CppClassType menushell_class_;
 
  // noncopyable
  MenuShell(const MenuShell&);
  MenuShell& operator=(const MenuShell&);
 
protected:
  explicit MenuShell(const Glib::ConstructParams& construct_params);
  explicit MenuShell(GtkMenuShell* 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
 
  GtkMenuShell*       gobj()       { return reinterpret_cast<GtkMenuShell*>(gobject_); }
 
  const GtkMenuShell* gobj() const { return reinterpret_cast<GtkMenuShell*>(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_deactivate();
  virtual void on_selection_done();
 
 
private:
 
 
public:
  
 
  typedef Menu_Helpers::MenuList MenuList;
  friend class Menu_Helpers::MenuList;
 
  
  void append(MenuItem& menu_item);
  
  void prepend(MenuItem& menu_item);
  
  void insert(MenuItem& menu_item, int position);
 
  
  void select_item(MenuItem& menu_item);
  
  void deselect();
 
  //TODO: Is force_deactivate = false a good default?
  
  void activate_item(MenuItem& menu_item, bool force_deactivate =  false);
  
  void select_first(bool search_sensitive =  true);
  
  void deactivate();
  
  void cancel();
 
  
  Glib::SignalProxy0< void > signal_deactivate();
 
  
  Glib::SignalProxy0< void > signal_selection_done();
 
  
  Glib::SignalProxy1< gboolean,int > signal_move_selected();
 
 
  //Keybinding signals:
  
  
  MenuList& items();
  const MenuList& items() const;
 
  void accelerate(Window& window);
 
  void accelerate(Widget& parent);
 
  
  bool get_take_focus() const;
  
  void set_take_focus(bool take_focus =  true);
 
  Glib::PropertyProxy< bool > property_take_focus() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_take_focus() const;
 
 
protected:
  MenuShell();
  
 
private:
 
 
  MenuList      items_proxy_;
  Gtk::Window*  accel_window_;
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::MenuShell* wrap(GtkMenuShell* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_MENUSHELL_H */