diff --git a/doc/en/Atk/Action.xml b/doc/en/Atk/Action.xml index 1ea58c208..f92edc1a0 100644 --- a/doc/en/Atk/Action.xml +++ b/doc/en/Atk/Action.xml @@ -10,8 +10,48 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + The ATK interface provided by UI components which the user can + activate/interact with, this should be implemented by instances + of classes with which the user can interact + directly, i.e. buttons, checkboxes, scrollbars, e.g. components + which are not "passive" providers of UI information. + + + + The ATK interface provided by UI components which the user can + activate/interact with, This should be implemented by + instances of 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 (insert/delete test, etc.) or (set value) then these actions should not + be exposed by as well. + + + Also note that the 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 . Where mouse and keyboard + actions are redundant in effect, should expose + only one action rather than exposing redundant actions if + possible. By convention we have been using "mouse centric" + terminology for names. + + @@ -31,10 +71,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'string' - To be added + Returns a description of the specified action of the object. + The action index corresponding to the action to be performed. + A description string, or 0 if action does not implement this interface. + @@ -48,11 +88,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'string' - To be added: an object of type 'bool' - To be added + Sets a description of the specified action of the object. + The action index corresponding to the action to be performed. + The description to be assigned to this action. + A representing if the description was successfully set. + @@ -65,10 +105,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'string' - To be added + Returns a keybinding associated with this action, if one exists. + The action index corresponding to the action to be performed. + A string representing the keybinding, or an empty string if there is no keybinding for this action. + @@ -81,10 +121,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'string' - To be added + Returns the name of the specified action of the object. + The action index corresponding to the action to be performed. + A name string, or an empty string if action does not implement this interface. + @@ -97,10 +137,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Perform the specified action on the object. + The action index corresponding to the action to be performed. + if success, otherwise. + @@ -110,9 +150,13 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Gets the number of accessible actions available on the object. + A the number of actions, or 0 if action does not implement this interface. + + 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. + @@ -125,10 +169,10 @@ - To be added - a - a - To be added + Returns the localized name of the specified action of the object. + The action index corresponding to the action to be performed. + A name string, or an empty string if action does not implement this interface. + diff --git a/doc/en/Atk/Component.xml b/doc/en/Atk/Component.xml index 828036469..9c1f53cf2 100644 --- a/doc/en/Atk/Component.xml +++ b/doc/en/Atk/Component.xml @@ -10,8 +10,27 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The ATK interface provided by UI components which occupy a physical area on the screen. + + + The ATK interface provided by UI components which occupy a + physical area on the screen. + + + This should be implemented by most if not all UI elements with + an actual on-screen presence, i.e. components which can be + said to have a screen-coordinate bounding box. Virtually all + widgets will need to have implementations + provided for their corresponding class. In short, + only UI elements which are* not* GUI elements will omit this + ATK interface. + + + A possible exception might be textual information with a + transparent background, in which case text glyph bounding box + information is provided by . + + @@ -31,9 +50,12 @@ - To be added - To be added: an object of type 'uint' - To be added + + Remove the handler from the list of functions to be executed + when this object receives focus events (in or out). + + The handler id of the focus handler to be removed from component. + @@ -48,12 +70,15 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Atk.CoordType' - To be added: an object of type 'bool' - To be added + Sets the postition of this component. + X coordinate. + Y coordinate. + + Specifies whether the coordinates are relative to the screen + or to the components top level window. + + or whether or not the position was set or not. + @@ -64,9 +89,11 @@ - To be added - To be added: an object of type 'bool' - To be added + Grabs focus for this component + + if successful, otherwise. + + @@ -83,14 +110,20 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Atk.CoordType' - To be added: an object of type 'bool' - To be added + Sets the extents of this component. + X coordinate. + Y coordinate. + Width to set for this component. + Height to set for this component. + + Specifies whether the coordinates are relative to the screen + or to the components top level window. + + + or whether the extents were + set or not. + + @@ -104,11 +137,13 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Set the size of this component in terms of width and height. + Width to set for this component. + Height to set for this component. + + or whether the size was set or not. + + @@ -121,10 +156,25 @@ - To be added - To be added: an object of type 'Atk.FocusHandler' - To be added: an object of type 'uint' - To be added + + Add the specified handler to the set of functions to be + called when this object receives focus events (in or out). + + The to be attached to this component. + + A handler id which can be used in + or zero if the handler + was already added. + + + + Add the specified handler to the set of functions to be + called when this object receives focus events (in or out). + + + If the handler is already added it is not added again. + + @@ -139,12 +189,18 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Atk.CoordType' - To be added: an object of type 'bool' - To be added + Checks whether the specified point is within the extent of this component. + X coordinate + Y coordinate + + Specifies whether the coordinates are relative to the screen + or to the components top level window. + + + or indicating whether the specified point is + within the extent of the component or not. + + @@ -174,9 +230,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Gets the Z order of the component. + The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW. + @@ -186,9 +242,9 @@ Atk.Layer - To be added - To be added: an object of type 'Atk.Layer' - To be added + Gets the layer of this component. + An which is the layer of the component. + @@ -203,11 +259,17 @@ - To be added - a - a - a - To be added + + Gets the position of component in the form of a point + specifying this component's top-left corner. + + X coordinate position + Y coordinate position + + Specifies whether the coordinates are relative to the screen + or to the components top level window. + + @@ -224,13 +286,16 @@ - To be added - a - a - a - a - a - To be added + Gets the rectangle which gives the extent of this component. + X coordinate position + Y coordinate position + Width + Height + + Specifies whether the coordinates are relative to the screen + or to the components top level window. + + @@ -244,10 +309,10 @@ - To be added - a - a - To be added + Gets the size of this component in terms of width and height. + Width + Height +