toolbar.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TOOLBAR_H
#define _GTKMM_TOOLBAR_H
 
#include <ytkmm/ytkmmconfig.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.
 */
 
 // This is for including the config header before any code (such as
// the #ifndef GTKMM_DISABLE_DEPRECATED in deprecated classes) is generated:
 
 
#include <ytkmm/toolitem.h>
#include <ytkmm/toolbutton.h>
#include <ytkmm/toggletoolbutton.h>
#include <ytkmm/container.h>
#include <ytkmm/stockid.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkToolbar GtkToolbar;
typedef struct _GtkToolbarClass GtkToolbarClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class Toolbar_Class; } // namespace Gtk
namespace Gtk
{
 
//TODO: Derive from Toolshell when we can break ABI.
class Toolbar : public Container
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef Toolbar CppObjectType;
  typedef Toolbar_Class CppClassType;
  typedef GtkToolbar BaseObjectType;
  typedef GtkToolbarClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~Toolbar();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class Toolbar_Class;
  static CppClassType toolbar_class_;
 
  // noncopyable
  Toolbar(const Toolbar&);
  Toolbar& operator=(const Toolbar&);
 
protected:
  explicit Toolbar(const Glib::ConstructParams& construct_params);
  explicit Toolbar(GtkToolbar* 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
 
  GtkToolbar*       gobj()       { return reinterpret_cast<GtkToolbar*>(gobject_); }
 
  const GtkToolbar* gobj() const { return reinterpret_cast<GtkToolbar*>(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_orientation_changed(Orientation orientation);
  virtual void on_toolbar_style_changed(ToolbarStyle style);
  virtual bool on_popup_context_menu(int x, int y, int button_number);
 
 
private:
 
public:
  Toolbar();
 
  
  void insert(ToolItem& item, int pos);
  void insert(ToolButton& item, int pos, const sigc::slot<void>& clicked_slot);
  void insert(ToggleToolButton& item, int pos, const sigc::slot<void>& toggled_slot);
 
  void append(ToolItem& item);
  void append(ToolButton& item, const sigc::slot<void>& clicked_slot);
  void append(ToggleToolButton& item, const sigc::slot<void>& toggled_slot);
 
  void prepend(ToolItem& item);
  void prepend(ToolButton& item, const sigc::slot<void>& clicked_slot);
  void prepend(ToggleToolButton& item, const sigc::slot<void>& toggled_slot);
 
  
  int get_item_index(const ToolItem& item) const;
  
  int get_n_items() const;
  
  ToolItem* get_nth_item(int n);
  
  const ToolItem* get_nth_item(int n) const;
  
  bool get_show_arrow() const;
  
  void set_show_arrow(bool show_arrow =  true);
 
/* Style methods */
 
  // TODO: Remove these when we derive from ToolShell, which has the same methods:
  
  void set_orientation(Orientation orientation);
  
  Orientation get_orientation() const;
 
  
  void set_toolbar_style(ToolbarStyle style);
  
  ToolbarStyle get_toolbar_style() const;
 
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void set_tooltips(bool enable =  true);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  bool get_tooltips() const;
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  void unset_toolbar_style();
 
  //Note that gtk_toolbar_set_icon_size() and gtk_toolbar_unset_icon_size() were
  //deprecated sometime before GTK+ 2.4, but were undeprecated in GTK+ 2.12.
  
  void set_icon_size(IconSize icon_size);
  
  void unset_icon_size();
 
  
  IconSize get_icon_size() const;
 
  
  ReliefStyle get_relief_style() const;
  
  int get_drop_index(int x, int y) const;
  
  void set_drop_highlight_item(ToolItem& tool_item, int index);
  void unset_drop_highlight_item();
 
  
  Glib::SignalProxy1< void,Orientation > signal_orientation_changed();
 
 
  Glib::SignalProxy1< void,ToolbarStyle > signal_toolbar_style_changed();
 
 
  Glib::SignalProxy3< bool,int,int,int > signal_popup_context_menu();
 
 
  //gtkmmproc error: move_focus : ignored signal defs lookup failed
  
 
  #ifndef GTKMM_DISABLE_DEPRECATED
  //This was called get_tooltips_object() to avoid a clash with get_tooltips(), which just says whether they are enabled.
  Tooltips* get_tooltips_object() const;
  #endif //GTKMM_DISABLE_DEPRECATED
 
  //Ignore deprecated GtkToolbarAPI:
  //Normally we just deprecate it in gtkmm too,
  //but the GtkToolbar compatibility system is particularly unpleasant, so we just removed it in gtkmm 2.4. murrayc.
  
 
  Glib::PropertyProxy< Orientation > property_orientation() ;
 
  Glib::PropertyProxy_ReadOnly< Orientation > property_orientation() const;
 
  Glib::PropertyProxy< ToolbarStyle > property_toolbar_style() ;
 
  Glib::PropertyProxy_ReadOnly< ToolbarStyle > property_toolbar_style() const;
 
  Glib::PropertyProxy< bool > property_show_arrow() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_show_arrow() const;
 
  Glib::PropertyProxy< bool > property_tooltips() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_tooltips() const;
 
  Glib::PropertyProxy< IconSize > property_icon_size() ;
 
  Glib::PropertyProxy_ReadOnly< IconSize > property_icon_size() const;
 
  Glib::PropertyProxy< bool > property_icon_size_set() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_icon_size_set() const;
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::Toolbar* wrap(GtkToolbar* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_TOOLBAR_H */