// Generated by gmmproc 2.66.7 -- DO NOT MODIFY! #ifndef _GTKMM_ACCELGROUP_H #define _GTKMM_ACCELGROUP_H #include #include #include /* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS using GtkAccelGroup = struct _GtkAccelGroup; using GtkAccelGroupClass = struct _GtkAccelGroupClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { class GTKMM_API AccelGroup_Class; } // namespace Gtk #endif //DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { /** A Gtk::AccelGroup represents a group of keyboard accelerators, typically * attached to a toplevel Gtk::Window (with Gtk::Window::add_accel_group()). * Usually you won't need to create a Gtk::AccelGroup directly; instead, gtkmm * automatically sets up the accelerators for your menus. Note that * accelerators are different from mnemonics. Accelerators are shortcuts for * activating a menu item; they appear alongside the menu item for which * they're a shortcut. For example "Ctrl+Q" might appear alongside the "Quit" * menu item. Mnemonics are shortcuts for GUI elements such as text entries or * buttons; they appear as underlined characters. See the Gtk::Label * constructor. Menu items can have both accelerators and mnemonics, of course. * * Key values are the codes which are sent whenever a key is pressed or released. * The complete list of key values can be found in the * gdk/gdkkeysyms.h * header file. They are prefixed with GDK_KEY_. */ class GTKMM_API AccelGroup : public Glib::Object { #ifndef DOXYGEN_SHOULD_SKIP_THIS public: using CppObjectType = AccelGroup; using CppClassType = AccelGroup_Class; using BaseObjectType = GtkAccelGroup; using BaseClassType = GtkAccelGroupClass; // noncopyable AccelGroup(const AccelGroup&) = delete; AccelGroup& operator=(const AccelGroup&) = delete; private: friend class AccelGroup_Class; static CppClassType accelgroup_class_; protected: explicit AccelGroup(const Glib::ConstructParams& construct_params); explicit AccelGroup(GtkAccelGroup* castitem); #endif /* DOXYGEN_SHOULD_SKIP_THIS */ public: AccelGroup(AccelGroup&& src) noexcept; AccelGroup& operator=(AccelGroup&& src) noexcept; ~AccelGroup() noexcept override; /** Get the GType for this class, for use with the underlying GObject type system. */ static GType get_type() G_GNUC_CONST; #ifndef DOXYGEN_SHOULD_SKIP_THIS static GType get_base_type() G_GNUC_CONST; #endif ///Provides access to the underlying C GObject. GtkAccelGroup* gobj() { return reinterpret_cast(gobject_); } ///Provides access to the underlying C GObject. const GtkAccelGroup* gobj() const { return reinterpret_cast(gobject_); } ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. GtkAccelGroup* gobj_copy(); private: protected: AccelGroup(); public: /** Creates a new Gtk::AccelGroup object. * @return A Glib::RefPtr<> to a newly created Gtk::AccelGroup object. */ static Glib::RefPtr create(); /** Locks are added and removed using lock() and * unlock(). * * @newin{2,14} * * @return true if there are 1 or more locks on the @a accel_group, * false otherwise. */ bool get_is_locked() const; /** Gets a Gdk::ModifierType representing the mask for this * @a accel_group. For example, Gdk::CONTROL_MASK, Gdk::SHIFT_MASK, etc. * * @newin{2,14} * * @return The modifier mask for this accel group. */ Gdk::ModifierType get_modifier_mask() const; /** Locks the given accelerator group. * * Locking an acelerator group prevents the accelerators contained * within it to be changed during runtime. Refer to * Gtk::AccelMap::change_entry() about runtime accelerator changes. * * If called more than once, @a accel_group remains locked until * unlock() has been called an equivalent number * of times. */ void lock(); /** Undoes the last call to lock() on this @a accel_group. */ void unlock(); /** Removes an accelerator previously installed through * connect(). * * @param accel_key Key value of the accelerator. * @param accel_mods Modifier combination of the accelerator. * @return true if there was an accelerator which could be * removed, false otherwise. */ bool disconnect_key(guint accel_key, Gdk::ModifierType accel_mods); /** Determines whether a given keyval and modifier mask constitute * a valid keyboard accelerator. For example, the 'a' keyval * plus Gdk::CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. * But you can't, for instance, use the GDK_Control_L keyval * as an accelerator. */ static bool valid(guint keyval, Gdk::ModifierType modifiers); /** Parse the accelerator string. * @param accelerator See the Gtk::AccelKey constructor for the format. * @param accelerator_key Output argument * @param accelerator_mods Output argument */ static void parse(const Glib::ustring& accelerator, guint& accelerator_key, Gdk::ModifierType& accelerator_mods); /** Converts an accelerator keyval and modifier mask * into a string parseable by parse(). * For example, if you pass in 'q' and Gdk::CONTROL_MASK, it returns "<Control>q". */ static Glib::ustring name(guint accelerator_key, Gdk::ModifierType accelerator_mods); /** Converts an accelerator keyval and modifier mask into a string * which can be used to represent the accelerator to the user. * * @newin{2,6} * * @param accelerator_key Accelerator keyval. * @param accelerator_mods Accelerator modifier mask. * @return A newly-allocated string representing the accelerator. */ static Glib::ustring get_label(guint accelerator_key, Gdk::ModifierType accelerator_mods); /** Sets the modifiers that will be considered significant for keyboard * accelerators. The default mod mask is Gdk::CONTROL_MASK | * Gdk::SHIFT_MASK | Gdk::MOD1_MASK, that is, Control, Shift, and Alt. * Other modifiers will ignored by default. * You must include at least the three default modifiers in any * value you pass to this function. * * The default mod mask should be changed on application startup, * before using any accelerator groups. */ static void set_default_mod_mask(Gdk::ModifierType default_mod_mask); /// See set_default_mod_mask(). static Gdk::ModifierType get_default_mod_mask(); //TODO: Add an overload that takes a ustring instead of a GQuark. /** Finds the first accelerator in @a accel_group that matches * @a accel_key and @a accel_mods, and activates it. * * @param accel_quark The quark for the accelerator name. * @param acceleratable The Glib::Object, usually a Gtk::Window, on which * to activate the accelerator. * @param accel_key Accelerator keyval from a key event. * @param accel_mods Keyboard state mask from a key event. * @return true if an accelerator was activated and handled * this keypress. */ bool activate(GQuark accel_quark, const Glib::RefPtr& 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); //TODO: _WRAP_METHOD(static bool activate(Object& object, guint accel_key, Gdk::ModifierType accel_mods), gtk_accel_groups_activate) #ifndef GTKMM_DISABLE_DEPRECATED /** * @par Slot Prototype: * bool on_my_%accel_activate(const Glib::RefPtr& acceleratable, guint keyval, Gdk::ModifierType modifier) * * The accel-activate signal is an implementation detail of * Gtk::AccelGroup and not meant to be used by applications. * * @deprecated This signal is not meant to be used by applications. * * @param acceleratable The object on which the accelerator was activated. * @param keyval The accelerator keyval. * @param modifier The modifier combination of the accelerator. * @return true if the accelerator was activated. */ Glib::SignalProxy< bool,const Glib::RefPtr&,guint,Gdk::ModifierType > signal_accel_activate(); #endif // GTKMM_DISABLE_DEPRECATED //TODO: The C type is unpleasant: //This has C docs, but it isn't worth mentioning them for such a useless signal. murrayc. /** * @par Slot Prototype: * void on_my_%accel_changed(guint keyval, Gdk::ModifierType modifier, GClosure* accel_closure) * * Flags: Run First * * The accel-changed signal is emitted when an entry * is added to or removed from the accel group. * * Widgets like Gtk::AccelLabel which display an associated * accelerator should connect to this signal, and rebuild * their visual representation if the @a accel_closure is theirs. * * @param keyval The accelerator keyval. * @param modifier The modifier combination of the accelerator. * @param accel_closure The GClosure of the accelerator. */ Glib::SignalProxy< void,guint,Gdk::ModifierType,GClosure* > signal_accel_changed(); /** * @par Slot Prototype: * void on_my_%accel_changed(guint keyval, Gdk::ModifierType modifier, GClosure* accel_closure) * * Flags: Run First * * The accel-changed signal is emitted when an entry * is added to or removed from the accel group. * * Widgets like Gtk::AccelLabel which display an associated * accelerator should connect to this signal, and rebuild * their visual representation if the @a accel_closure is theirs. * * @param keyval The accelerator keyval. * @param modifier The modifier combination of the accelerator. * @param accel_closure The GClosure of the accelerator. */ Glib::SignalProxyDetailedAnyType< void,guint,Gdk::ModifierType,GClosure* > signal_accel_changed(const Glib::ustring& accel_name); /** Is the accel group locked. * * Default value: false * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy_ReadOnly< bool > property_is_locked() const; /** Modifier Mask. * * Default value: Gdk::SHIFT_MASK | Gdk::CONTROL_MASK | Gdk::MOD1_MASK | Gdk::SUPER_MASK | Gdk::HYPER_MASK | Gdk::META_MASK * * @return A PropertyProxy_ReadOnly that allows you to get the value of the property, * or receive notification when the value of the property changes. */ 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:: }; } // namespace Gtk namespace Glib { /** A Glib::wrap() method for this object. * * @param object The C instance. * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. * @result A C++ instance that wraps this C instance. * * @relates Gtk::AccelGroup */ GTKMM_API Glib::RefPtr wrap(GtkAccelGroup* object, bool take_copy = false); } #endif /* _GTKMM_ACCELGROUP_H */