// Generated by gmmproc 2.82.0 -- DO NOT MODIFY! #ifndef _GTKMM_SHORTCUTCONTROLLER_H #define _GTKMM_SHORTCUTCONTROLLER_H #include #include /* Copyright (C) 2020 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, see . */ #include #include #include #include #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS using GtkShortcutController = struct _GtkShortcutController; using GtkShortcutControllerClass = struct _GtkShortcutControllerClass; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { class GTKMM_API ShortcutController_Class; } // namespace Gtk #endif //DOXYGEN_SHOULD_SKIP_THIS namespace Gtk { /** Event controller for shortcuts. * * %Gtk::ShortcutController is an event controller that manages shortcuts. * * Most common shortcuts are using this controller implicitly, e.g. by * adding a mnemonic underline to a Gtk::Label, or by installing a key * binding using gtk_widget_class_add_binding(), or by adding accelerators * to global actions using Gtk::Application::set_accels_for_action(). * * But it is possible to create your own shortcut controller, and add * shortcuts to it. * * %Gtk::ShortcutController implements Gio::ListModel for querying the shortcuts that * have been added to it. * * ## ShortcutController as a Buildable * * ShortcutControllers can be created in ui files to set up shortcuts * in the same place as the widgets. * * An example of a UI definition fragment with GtkShortcutController: * @code * * * * managed * * * <Control>k * activate * * * * * * @endcode * * @newin{3,98} * * @ingroup Gestures */ class GTKMM_API ShortcutController : public EventController, public Gio::ListModel, public Buildable { #ifndef DOXYGEN_SHOULD_SKIP_THIS public: using CppObjectType = ShortcutController; using CppClassType = ShortcutController_Class; using BaseObjectType = GtkShortcutController; using BaseClassType = GtkShortcutControllerClass; // noncopyable ShortcutController(const ShortcutController&) = delete; ShortcutController& operator=(const ShortcutController&) = delete; private: friend class ShortcutController_Class; static CppClassType shortcutcontroller_class_; protected: explicit ShortcutController(const Glib::ConstructParams& construct_params); explicit ShortcutController(GtkShortcutController* castitem); #endif /* DOXYGEN_SHOULD_SKIP_THIS */ public: ShortcutController(ShortcutController&& src) noexcept; ShortcutController& operator=(ShortcutController&& src) noexcept; ~ShortcutController() 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. GtkShortcutController* gobj() { return reinterpret_cast(gobject_); } ///Provides access to the underlying C GObject. const GtkShortcutController* 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. GtkShortcutController* gobj_copy(); private: protected: ShortcutController(); explicit ShortcutController(const Glib::RefPtr& model); public: static Glib::RefPtr create(); /** Creates a new shortcut controller that takes its shortcuts from * the given list model. * * A controller created by this function does not let you add or * remove individual shortcuts using the shortcut controller api, * but you can change the contents of the model. * * @param model A ListModel containing shortcuts. * @return A newly created shortcut controller. */ static Glib::RefPtr create(const Glib::RefPtr& model); /** Sets the controller to use the given modifier for mnemonics. * * The mnemonics modifiers determines which modifiers need to be pressed to allow * activation of shortcuts with mnemonics triggers. * * GTK normally uses the Alt modifier for mnemonics, except in `Gtk::PopoverMenu`s, * where mnemonics can be triggered without any modifiers. It should be very * rarely necessary to change this, and doing so is likely to interfere with * other shortcuts. * * This value is only relevant for local shortcut controllers. Global and managed * shortcut controllers will have their shortcuts activated from other places which * have their own modifiers for activating mnemonics. * * @param modifiers The new mnemonics_modifiers to use. */ void set_mnemonics_modifiers(Gdk::ModifierType modifiers); /** Gets the mnemonics modifiers for when this controller activates its shortcuts. * * @return The controller's mnemonics modifiers. */ Gdk::ModifierType get_mnemonics_modifiers() const; /** Sets the controller to have the given @a scope. * * The scope allows shortcuts to be activated outside of the normal * event propagation. In particular, it allows installing global * keyboard shortcuts that can be activated even when a widget does * not have focus. * * With Gtk::ShortcutScope::LOCAL, shortcuts will only be activated * when the widget has focus. * * @param scope The new scope to use. */ void set_scope(ShortcutScope scope); #ifndef GTKMM_DISABLE_DEPRECATED /** Gets the scope for when this controller activates its shortcuts. * * See set_scope() for details. * * @deprecated Use get_scope() instead. * * @return The controller's scope. */ ShortcutScope set_scope() const; #endif // GTKMM_DISABLE_DEPRECATED /** Gets the scope for when this controller activates its shortcuts. * * See set_scope() for details. * * @newin{4,2} * * @return The controller's scope. */ ShortcutScope get_scope() const; // gtk_shortcut_controller_add_shortcut() does not take a ref (transfer full). /** Adds @a shortcut to the list of shortcuts handled by @a self. * * If this controller uses an external shortcut list, this * function does nothing. * * @param shortcut A `Gtk::Shortcut`. */ void add_shortcut(const Glib::RefPtr& shortcut); /** Removes @a shortcut from the list of shortcuts handled by @a self. * * If @a shortcut had not been added to @a controller or this controller * uses an external shortcut list, this function does nothing. * * @param shortcut A `Gtk::Shortcut`. */ void remove_shortcut(const Glib::RefPtr& shortcut); /** The type of items. See Gio::ListModel::get_item_type(). * * @newin{4,8} * * @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< GType > property_item_type() const; /** The modifiers that need to be pressed to allow mnemonics activation. * * Default value: Gdk::ModifierType::ALT_MASK * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< Gdk::ModifierType > property_mnemonic_modifiers() ; /** The modifiers that need to be pressed to allow mnemonics activation. * * Default value: Gdk::ModifierType::ALT_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_mnemonic_modifiers() const; /** The number of items. See Gio::ListModel::get_n_items(). * * @newin{4,8} * * Default value: 0 * * @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< unsigned int > property_n_items() const; /** What scope the shortcuts will be handled in. * * Default value: Gtk::ShortcutScope::LOCAL * * @return A PropertyProxy that allows you to get or set the value of the property, * or receive notification when the value of the property changes. */ Glib::PropertyProxy< ShortcutScope > property_scope() ; /** What scope the shortcuts will be handled in. * * Default value: Gtk::ShortcutScope::LOCAL * * @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< ShortcutScope > property_scope() const; // The "model" property is write-pnly, construct-only. Can't be wrapped. 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::ShortcutController */ GTKMM_API Glib::RefPtr wrap(GtkShortcutController* object, bool take_copy = false); } #endif /* _GTKMM_SHORTCUTCONTROLLER_H */