action.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_ACTION_H
#define _GTKMM_ACTION_H
 
#include <gtkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* Copyright (C) 2003 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/widget.h>
#include <gtkmm/accelgroup.h>
#include <gtkmm/stockid.h>
#include <giomm/icon.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkAction GtkAction;
typedef struct _GtkActionClass GtkActionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class Action_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
class ActionGroup;
class Menu;
class MenuItem;
class ToolItem;
class Image;
 
class Action : public Glib::Object
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef Action CppObjectType;
  typedef Action_Class CppClassType;
  typedef GtkAction BaseObjectType;
  typedef GtkActionClass BaseClassType;
 
private:  friend class Action_Class;
  static CppClassType action_class_;
 
private:
  // noncopyable
  Action(const Action&);
  Action& operator=(const Action&);
 
protected:
  explicit Action(const Glib::ConstructParams& construct_params);
  explicit Action(GtkAction* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~Action();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkAction*       gobj()       { return reinterpret_cast<GtkAction*>(gobject_); }
 
  const GtkAction* gobj() const { return reinterpret_cast<GtkAction*>(gobject_); }
 
  GtkAction* gobj_copy();
 
private:
 
 
protected:
  Action();
 
  explicit Action(const Glib::ustring& name, const StockID& stock_id = StockID(), const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
 
  explicit Action(const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
 
public:
  //Note that gtk_action_new() does not allow name to be NULL, which suggests that we should not have a default constructor,
  //but it's OK to set the name later:
  
  static Glib::RefPtr<Action> create();
 
 
  static Glib::RefPtr<Action> create(const Glib::ustring& name, const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
 
  static Glib::RefPtr<Action> create(const Glib::ustring& name, const Gtk::StockID& stock_id, const Glib::ustring& label = Glib::ustring(), const Glib::ustring& tooltip = Glib::ustring());
 
  static Glib::RefPtr<Action> create_with_icon_name(const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label, const Glib::ustring& tooltip);
 
  
  Glib::ustring get_name() const;
 
  
  bool is_sensitive() const;
  
  bool get_sensitive() const;
 
  
  void set_sensitive(bool sensitive =  true);
 
  
  bool is_visible() const;
  
  bool get_visible() const;
  
  void set_visible(bool visible =  true);
 
  
  void activate();
  
  Image* create_icon(IconSize icon_size);
  
  MenuItem* create_menu_item();
  
  ToolItem* create_tool_item();
  
  Menu* create_menu();
 
  //TODO: Deprecate these when we can derive the appropriate widgets from Activatable, when we can break ABI.
  
  void connect_proxy(Widget& proxy);
  
  void disconnect_proxy(Widget& proxy);
 
  
  Glib::SListHandle<Widget*> get_proxies();
  
  Glib::SListHandle<const Widget*> get_proxies() const;
 
  
  void connect_accelerator();
  
  void disconnect_accelerator();
 
  
  Glib::ustring get_accel_path() const;
 
  typedef sigc::slot<void> SlotActivate;
 
  
  Glib::SignalProxy0< void > signal_activate();
 
 
  //Used by AccelGroup:
  
  void set_accel_path(const Glib::ustring& accel_path);
  
  void set_accel_group(const Glib::RefPtr<AccelGroup>& accel_group);
 
  
  void set_label(const Glib::ustring& label);
  
  Glib::ustring get_label() const;
  
  void set_short_label(const Glib::ustring& short_label);
  
  Glib::ustring get_short_label() const;
  
  void set_tooltip(const Glib::ustring& tooltip);
  
  Glib::ustring get_tooltip() const;
  
  void set_stock_id(const StockID& stock_id);
  
  StockID get_stock_id() const;
  
  void set_gicon(const Glib::RefPtr<Gio::Icon>& icon);
  
  Glib::RefPtr<Gio::Icon> get_gicon();
  
  Glib::RefPtr<const Gio::Icon> get_gicon() const;
  
  void set_icon_name(const Glib::ustring& icon_name);
  
  Glib::ustring get_icon_name() const;
  
  void set_visible_horizontal(bool visible_horizontal =  true);
  
  bool get_visible_horizontal() const;
  
  void set_visible_vertical(bool visible_vertical =  true);
  
  bool get_visible_vertical() const;
  
  void set_is_important(bool is_important =  true);
  
  bool get_is_important() const;
 
  
  void set_always_show_image(bool always_show =  true);
  
  bool get_always_show_image() const;
 
  
  void block_activate();
  
  void unblock_activate();
 
  //gtk_action_get_accel_closure() is too C-specific:
  
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name() const;
 
 
  Glib::PropertyProxy< Glib::ustring > property_label() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_label() const;
 
  Glib::PropertyProxy< Glib::ustring > property_short_label() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_short_label() const;
 
  Glib::PropertyProxy< Glib::ustring > property_tooltip() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip() const;
 
  Glib::PropertyProxy< StockID > property_stock_id() ;
 
  Glib::PropertyProxy_ReadOnly< StockID > property_stock_id() const;
 
  Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > property_gicon() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > property_gicon() const;
 
  Glib::PropertyProxy< Glib::ustring > property_icon_name() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name() const;
 
  Glib::PropertyProxy< bool > property_visible_horizontal() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_visible_horizontal() const;
 
  Glib::PropertyProxy< bool > property_visible_vertical() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_visible_vertical() const;
 
  Glib::PropertyProxy< bool > property_visible_overflown() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_visible_overflown() const;
 
  Glib::PropertyProxy< bool > property_is_important() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_is_important() const;
 
  Glib::PropertyProxy< bool > property_hide_if_empty() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_hide_if_empty() const;
 
  Glib::PropertyProxy< bool > property_sensitive() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_sensitive() const;
 
  Glib::PropertyProxy< bool > property_visible() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_visible() const;
 
  Glib::PropertyProxy< Glib::RefPtr<ActionGroup> > property_action_group() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<ActionGroup> > property_action_group() const;
 
  Glib::PropertyProxy< bool > property_always_show_image() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_always_show_image() const;
 
 
protected:
  //For use by child actions:
  //TODO: Deprecate these when we can derive the appropriate widgets from Activatable, when we can break ABI.
  
  void block_activate_from(Widget& proxy);
  
  void unblock_activate_from(Widget& proxy);
 
protected:
  //Widget-creation routines:
    virtual Widget* create_menu_item_vfunc();
 
    virtual Widget* create_tool_item_vfunc();
 
    virtual void connect_proxy_vfunc(Widget* proxy);
 
    virtual void disconnect_proxy_vfunc(Widget* proxy);
 
 
public:
 
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();
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::Action> wrap(GtkAction* object, bool take_copy = false);
}
 
 
#endif /* _GTKMM_ACTION_H */