atk.Action.Action Class Reference

List of all members.

Detailed Description

Description AtkAction should be implemented by instances of AtkObject 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 AtkEditableText (insert/delete test, etc.) or AtkValue (set value) then these actions should not be exposed by AtkAction as well. Also note that the AtkAction 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 AtkActions. Where mouse and keyboard actions are redundant in effect, AtkAction should expose only one action rather than exposing redundant actions if possible. By convention we have been using "mouse centric" terminology for AtkAction names.


Public Member Functions

AtkActiongetActionStruct ()
 this (AtkAction *atkAction)
 Sets our main struct and passes it to the parent class.
int doAction (int i)
 Perform the specified action on the object.
int getNActions ()
 Gets the number of accessible actions available on the object.
char[] getDescription (int i)
 Returns a description of the specified action of the object.
char[] getName (int i)
 Returns the name of the specified action of the object.
char[] getLocalizedName (int i)
 Returns the localized name of the specified action of the object.
char[] getKeybinding (int i)
 Returns a keybinding associated with this action, if one exists.
int setDescription (int i, char[] desc)
 Sets a description of the specified action of the object.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

AtkActionatkAction
 the main Gtk struct


Constructor & Destructor Documentation

atk.Action.Action.this ( AtkAction atkAction  ) 

Sets our main struct and passes it to the parent class.


Member Function Documentation

int atk.Action.Action.doAction ( int  i  ) 

Perform the specified action on the object.

action: a GObject instance that implements AtkActionIface i: the action index corresponding to the action to be performed Returns: TRUE if success, FALSE otherwise

AtkAction* atk.Action.Action.getActionStruct (  ) 

char [] atk.Action.Action.getDescription ( int  i  ) 

Returns a description of the specified action of the object.

action: a GObject instance that implements AtkActionIface i: the action index corresponding to the action to be performed Returns: a description string, or NULL if action does not implement this interface.

char [] atk.Action.Action.getKeybinding ( int  i  ) 

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

action: a GObject instance that implements AtkActionIface i: the action index corresponding to the action to be performed Returns: a string representing the keybinding, or NULL if there is no keybinding for this action.

char [] atk.Action.Action.getLocalizedName ( int  i  ) 

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

action: a GObject instance that implements AtkActionIface i: the action index corresponding to the action to be performed Returns: a name string, or NULL if action does not implement this interface.

int atk.Action.Action.getNActions (  ) 

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. action: a GObject instance that implements AtkActionIface Returns: a the number of actions, or 0 if action does not implement this interface.

char [] atk.Action.Action.getName ( int  i  ) 

Returns the name of the specified action of the object.

action: a GObject instance that implements AtkActionIface i: the action index corresponding to the action to be performed Returns: a name string, or NULL if action does not implement this interface.

void* atk.Action.Action.getStruct (  )  [protected]

the main Gtk struct as a void*

int atk.Action.Action.setDescription ( int  i,
char[]  desc 
)

Sets a description of the specified action of the object.

action: a GObject instance that implements AtkActionIface i: the action index corresponding to the action to be performed desc: the description to be assigned to this action Returns: a gboolean representing if the description was successfully set;


Member Data Documentation

AtkAction* atk.Action.Action.atkAction [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo