atkmm 2.28.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Atk::Action Class Reference

The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of Atk::Object classes with which the user can interact directly, i.e. More...

#include <atkmm/action.h>

Inheritance diagram for Atk::Action:
Inheritance graph
[legend]

Public Member Functions

 Action (Action && src) noexcept
 
Actionoperator= (Action && src) noexcept
 
 ~Action () noexcept override
 
AtkAction * gobj ()
 Provides access to the underlying C GObject. More...
 
const AtkAction * gobj () const
 Provides access to the underlying C GObject. More...
 
bool do_action (int i)
 Perform the specified action on the object. More...
 
int get_n_actions () const
 Gets the number of accessible actions available on the object. More...
 
Glib::ustring get_description (int i) const
 Returns a description of the specified action of the object. More...
 
Glib::ustring get_name (int i) const
 Returns the name of the specified action of the object. More...
 
Glib::ustring get_keybinding (int i)
 Returns a keybinding associated with this action, if one exists. More...
 
bool set_description (int i, const Glib::ustring & desc)
 Sets a description of the specified action of the object. More...
 
Glib::ustring get_localized_name (int i)
 Returns the localized name of the specified action of the object. More...
 

Static Public Member Functions

static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 Action ()
 You should derive from this class to use it. More...
 
virtual bool do_action_vfunc (int i)
 
virtual int get_n_actions_vfunc () const
 
virtual const char * get_description_vfunc (int i) const
 
virtual const char * get_name_vfunc (int i) const
 
virtual const char * get_keybinding_vfunc (int i) const
 
virtual bool set_description_vfunc (int i, const Glib::ustring & desc)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Atk::Actionwrap (AtkAction * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of Atk::Object classes with which the user can interact directly, i.e.

buttons, checkboxes, scrollbars, e.g. components which are not "passive" providers of UI information.

Exceptions: when the user interaction is already covered by another appropriate interface such as Atk::EditableText (insert/delete test, etc.) or Atk::Value (set value) then these actions should not be exposed by Atk::Action as well.

Also note that the Atk::Action API is limited in that parameters may not be passed to the object being activated; thus the action must be self-contained and specifiable via only a single "verb". Concrete examples include "press", "release", "click" for buttons, "drag" (meaning initiate drag) and "drop" for drag sources and drop targets, etc.

Though most UI interactions on components should be invocable via keyboard as well as mouse, there will generally be a close mapping between "mouse actions" that are possible on a component and the Atk::Actions. Where mouse and keyboard actions are redundant in effect, Atk::Action should expose only one action rather than exposing redundant actions if possible. By convention we have been using "mouse centric" terminology for Atk::Action names.

Constructor & Destructor Documentation

◆ Action() [1/2]

Atk::Action::Action ( )
protected

You should derive from this class to use it.

◆ Action() [2/2]

Atk::Action::Action ( Action &&  src)
noexcept

◆ ~Action()

Atk::Action::~Action ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

static void Atk::Action::add_interface ( GType  gtype_implementer)
static

◆ do_action()

bool Atk::Action::do_action ( int  i)

Perform the specified action on the object.

Parameters
iThe action index corresponding to the action to be performed.
Returns
true if success, false otherwise.

◆ do_action_vfunc()

virtual bool Atk::Action::do_action_vfunc ( int  i)
protectedvirtual

◆ get_description()

Glib::ustring Atk::Action::get_description ( int  i) const

Returns a description of the specified action of the object.

Parameters
iThe action index corresponding to the action to be performed.
Returns
A description string, or nullptr if action does not implement this interface.

◆ get_description_vfunc()

virtual const char * Atk::Action::get_description_vfunc ( int  i) const
protectedvirtual

◆ get_keybinding()

Glib::ustring Atk::Action::get_keybinding ( int  i)

Returns a keybinding associated with this action, if one exists.

Parameters
iThe action index corresponding to the action to be performed.
Returns
A string representing the keybinding, or an empty string if there is no keybinding for this action.

◆ get_keybinding_vfunc()

virtual const char * Atk::Action::get_keybinding_vfunc ( int  i) const
protectedvirtual

◆ get_localized_name()

Glib::ustring Atk::Action::get_localized_name ( int  i)

Returns the localized name of the specified action of the object.

Parameters
iThe action index corresponding to the action to be performed.
Returns
A name string, or an empty string if action does not implement this interface.

◆ get_n_actions()

int Atk::Action::get_n_actions ( ) const

Gets the number of accessible actions available on the object.

If there are more than one, the first one is considered the "default" action of the object.

Returns
A the number of actions, or 0 if action does not implement this interface.

◆ get_n_actions_vfunc()

virtual int Atk::Action::get_n_actions_vfunc ( ) const
protectedvirtual

◆ get_name()

Glib::ustring Atk::Action::get_name ( int  i) const

Returns the name of the specified action of the object.

Parameters
iThe action index corresponding to the action to be performed.
Returns
A name string, or an empty string if action does not implement this interface.

◆ get_name_vfunc()

virtual const char * Atk::Action::get_name_vfunc ( int  i) const
protectedvirtual

◆ get_type()

static GType Atk::Action::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

AtkAction * Atk::Action::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const AtkAction * Atk::Action::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=()

Action & Atk::Action::operator= ( Action &&  src)
noexcept

◆ set_description()

bool Atk::Action::set_description ( int  i,
const Glib::ustring &  desc 
)

Sets a description of the specified action of the object.

Parameters
iThe action index corresponding to the action to be performed.
descThe description to be assigned to this action.
Returns
A bool representing if the description was successfully set;.

◆ set_description_vfunc()

virtual bool Atk::Action::set_description_vfunc ( int  i,
const Glib::ustring &  desc 
)
protectedvirtual

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Atk::Action > wrap ( AtkAction *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.