/* Copyright (C) 2012 The giomm 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
_DEFS(giomm,gio)
_PINCLUDE(glibmm/private/interface_p.h)
_PINCLUDE(gio/gio.h)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GActionMapInterface GActionMapInterface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
class GIOMM_API Action;
/** ActionMap - Interface for action containers.
* The ActionMap interface is implemented by ActionGroup implementations that
* operate by containing a number of named Action instances, such as
* SimpleActionGroup.
*
* One useful application of this interface is to map the names of actions from
* various action groups to unique, prefixed names (e.g. by prepending "app."
* or "win."). This is the motivation for the 'Map' part of the interface name.
* @newin{2,32}
*/
class GIOMM_API ActionMap : public Glib::Interface
{
_CLASS_INTERFACE(ActionMap, GActionMap, G_ACTION_MAP, GActionMapInterface, , , GIOMM_API)
// The various add_action...() methods are our equivalent for g_action_map_add_action_entries().
_IGNORE(g_action_map_add_action_entries)
public:
_WRAP_METHOD(void add_action(const Glib::RefPtr& action), g_action_map_add_action)
_WRAP_METHOD(void remove_action(const Glib::ustring& action_name), g_action_map_remove_action)
_WRAP_METHOD(Glib::RefPtr lookup_action(const Glib::ustring& action_name), g_action_map_lookup_action, refreturn)
_WRAP_METHOD(Glib::RefPtr lookup_action(const Glib::ustring& action_name) const, g_action_map_lookup_action, constversion, refreturn)
/** A convenience method for creating a SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @return The Action.
*/
Glib::RefPtr add_action(const Glib::ustring& name);
/** A Slot to be called when an action has been activated,
* without passing a parameter to the slot.
* See add_action() and add_action_bool().
*
* For instance,
* void on_slot_activated();
*/
using ActivateSlot = sigc::slot;
/** A convenience method for creating a SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @return The Action.
*/
Glib::RefPtr add_action(const Glib::ustring& name, const ActivateSlot& slot);
/** A Slot to be called when an action has been activated,
* passing a parameter of a specified type.
* See add_action_with_parameter().
*
* For instance,
* void on_slot_activated(const Glib::VariantBase& parameter);
*/
using ActivateWithParameterSlot = sigc::slot;
/** A convenience method for creating a SimpleAction instance, which when
* activated will call a slot receiving a given type of parameter, and adding
* that SimpleAction to the ActionMap.
*
* @param name The name of the Action.
* @param parameter_type The type of parameter to be passed to the slot.
* @param slot The callback method to be called when the action is activated.
* @return The Action.
*/
Glib::RefPtr add_action_with_parameter(const Glib::ustring& name, const Glib::VariantType& parameter_type, const ActivateWithParameterSlot& slot);
/** A convenience method for creating a boolean-stateful SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr add_action_bool(const Glib::ustring& name, bool state = false);
/** A convenience method for creating a boolean-stateful (toggle) SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr add_action_bool(const Glib::ustring& name, const ActivateSlot& slot, bool state = false);
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating a string-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr add_action_radio_string(const Glib::ustring& name, const Glib::ustring& state);
/** A Slot to be called when an action has been activated.
* See add_action_radio_string().
*
* For instance,
* void on_slot_activated(const Glib::ustring& parameter);
*/
using ActivateWithStringParameterSlot = sigc::slot;
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating a string-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr add_action_radio_string(const Glib::ustring& name, const ActivateWithStringParameterSlot& slot, const Glib::ustring& state);
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating an integer-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr add_action_radio_integer(const Glib::ustring& name, gint32 state);
/** A Slot to be called when an action has been activated.
* See add_action_radio_integer().
*
* For instance,
* void on_slot_activated(int parameter);
*/
using ActivateWithIntParameterSlot = sigc::slot;
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating an integer-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr add_action_radio_integer(const Glib::ustring& name, const ActivateWithIntParameterSlot& slot, gint32 state);
protected:
#m4 _CONVERSION(`Glib::RefPtr', `GAction*', `Glib::unwrap($3)')
_WRAP_VFUNC(Glib::RefPtr lookup_action(const Glib::ustring& name) const, "lookup_action", refreturn)
#m4 _CONVERSION(`GAction*', `const Glib::RefPtr&', `Glib::wrap($3, true)')
_WRAP_VFUNC(void add_action(const Glib::RefPtr& action) const, "add_action")
_WRAP_VFUNC(void remove_action(const Glib::ustring& name), "remove_action")
};
} // namespace Gio