accelgroup.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_ACCELGROUP_H
#define _GTKMM_ACCELGROUP_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: accelgroup.hg,v 1.8 2005/04/07 08:46:44 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 <gdkmm/types.h>
#include <gtkmm/object.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkAccelGroup GtkAccelGroup;
typedef struct _GtkAccelGroupClass GtkAccelGroupClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class AccelGroup_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
class AccelGroup : public Glib::Object
{
   
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef AccelGroup CppObjectType;
  typedef AccelGroup_Class CppClassType;
  typedef GtkAccelGroup BaseObjectType;
  typedef GtkAccelGroupClass BaseClassType;
 
private:  friend class AccelGroup_Class;
  static CppClassType accelgroup_class_;
 
private:
  // noncopyable
  AccelGroup(const AccelGroup&);
  AccelGroup& operator=(const AccelGroup&);
 
protected:
  explicit AccelGroup(const Glib::ConstructParams& construct_params);
  explicit AccelGroup(GtkAccelGroup* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~AccelGroup();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkAccelGroup*       gobj()       { return reinterpret_cast<GtkAccelGroup*>(gobject_); }
 
  const GtkAccelGroup* gobj() const { return reinterpret_cast<GtkAccelGroup*>(gobject_); }
 
  GtkAccelGroup* gobj_copy();
 
private:
 
   //gtkmmproc error: _gtk_accel_group_reconnect : ignored method defs lookup failed
   
protected:
  AccelGroup();
 
public:
  static Glib::RefPtr<AccelGroup> create();
 
 
  bool get_is_locked() const;
  
  Gdk::ModifierType get_modifier_mask() const;
 
  
  void lock();
  
  void unlock();
  
  bool disconnect_key(guint accel_key, Gdk::ModifierType accel_mods);
 
  static bool valid(guint keyval, Gdk::ModifierType modifiers);
 
  static void parse(const Glib::ustring& accelerator, guint& accelerator_key, Gdk::ModifierType& accelerator_mods);
 
  static Glib::ustring name(guint accelerator_key, Gdk::ModifierType accelerator_mods);
 
  
  static Glib::ustring get_label(guint accelerator_key, Gdk::ModifierType accelerator_mods);
 
  static void set_default_mod_mask(Gdk::ModifierType default_mod_mask);
 
  static Gdk::ModifierType get_default_mod_mask();
 
  //TODO: Add an overload that takes a ustring instead of a GQuark.
  
  bool activate(GQuark accel_quark, const Glib::RefPtr<Glib::Object>& acceleratable, guint accel_key, Gdk::ModifierType accel_mods);
 
  
  //Let's not wrap this, because the GtkAccelGroupFindFunc callback uses GClosures, and it's not clear that this is useful.
  //AccelKey find(const SlotFind& slot);
  //GtkAccelKey*        gtk_accel_group_find(GtkAccelGroup* accel_group, GtkAccelGroupFindFunc find_func, gpointer data);
                            
  
  static bool activate(Gtk::Object& object, guint accel_key, Gdk::ModifierType accel_mods);
 
 
  Glib::SignalProxy3< bool,const Glib::RefPtr<Glib::Object>&,guint,Gdk::ModifierType > signal_accel_activate();
   
 
  //TODO: The C type is unpleasant:
  //This has C docs, but it isn't worth mentioning them for such a useless signal. murrayc.
  
  Glib::SignalProxy3< void,guint,Gdk::ModifierType,GClosure* > signal_accel_changed();
 
  
  Glib::PropertyProxy_ReadOnly< bool > property_is_locked() const;
 
 
  Glib::PropertyProxy_ReadOnly< Gdk::ModifierType > property_modifier_mask() const;
 
 
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_accel_changed(guint keyval, Gdk::ModifierType modifier, GClosure* accel_closure);
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::AccelGroup> wrap(GtkAccelGroup* object, bool take_copy = false);
}
 
 
#endif /* _GTKMM_ACCELGROUP_H */