Perform the specified action on the object.
%TRUE if success, %FALSE otherwise
the action index corresponding to the action to be performed
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.
implement this interface.
a the number of actions, or 0 if @action does not
Returns a description of the specified action of the object.
Returns a description string, or %NULL
if @action does not implement this interface.
the action index corresponding to the action to be performed
Returns a non-localized string naming the specified action of the
object. This name is generally not descriptive of the end result
of the action, but instead names the 'interaction type' which the
object supports. By convention, the above strings should be used to
represent the actions which correspond to the common point-and-click
"click", "press", "release", "drag", "drop", "popup", etc.
The "popup" action should be used to pop up a context menu for the
object, if one exists.
For technical reasons, some toolkits cannot guarantee that the
reported action is actually 'bound' to a nontrivial user event;
i.e. the result of some actions via atk_action_do_action() may be
NIL.
Returns a name string, or %NULL
if @action does not implement this interface.
the action index corresponding to the action to be performed
Returns a keybinding associated with this action, if one exists.
The returned string is in the format "<a>;<b>;<c>"
(i.e. semicolon-delimited), where <a> is the keybinding which
activates the object if it is presently enabled onscreen,
<b> corresponds to the keybinding or sequence of keys
which invokes the action even if the relevant element is not
currently posted on screen (for instance, for a menu item it
posts the parent menus before invoking). The last token in the
above string, if non-empty, represents a keyboard shortcut which
invokes the same action without posting the component or its
enclosing menus or dialogs.
Returns a string representing the available keybindings, or %NULL
if there is no keybinding for this action.
the action index corresponding to the action to be performed
Sets a description of the specified action of the object.
a gboolean representing if the description was successfully set;
the action index corresponding to the action to be performed
the description to be assigned to this action
Returns the localized name of the specified action of the object.
Returns a name string, or %NULL
if @action does not implement this interface.
the action index corresponding to the action to be performed
Perform the specified action on the object.
%TRUE if success, %FALSE otherwise
the action index corresponding to the action to be performed
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.
implement this interface.
a the number of actions, or 0 if @action does not
Returns a description of the specified action of the object.
Returns a description string, or %NULL
if @action does not implement this interface.
the action index corresponding to the action to be performed
Returns a non-localized string naming the specified action of the
object. This name is generally not descriptive of the end result
of the action, but instead names the 'interaction type' which the
object supports. By convention, the above strings should be used to
represent the actions which correspond to the common point-and-click
"click", "press", "release", "drag", "drop", "popup", etc.
The "popup" action should be used to pop up a context menu for the
object, if one exists.
For technical reasons, some toolkits cannot guarantee that the
reported action is actually 'bound' to a nontrivial user event;
i.e. the result of some actions via atk_action_do_action() may be
NIL.
Returns a name string, or %NULL
if @action does not implement this interface.
the action index corresponding to the action to be performed
Returns a keybinding associated with this action, if one exists.
The returned string is in the format "<a>;<b>;<c>"
(i.e. semicolon-delimited), where <a> is the keybinding which
activates the object if it is presently enabled onscreen,
<b> corresponds to the keybinding or sequence of keys
which invokes the action even if the relevant element is not
currently posted on screen (for instance, for a menu item it
posts the parent menus before invoking). The last token in the
above string, if non-empty, represents a keyboard shortcut which
invokes the same action without posting the component or its
enclosing menus or dialogs.
Returns a string representing the available keybindings, or %NULL
if there is no keybinding for this action.
the action index corresponding to the action to be performed
Sets a description of the specified action of the object.
a gboolean representing if the description was successfully set;
the action index corresponding to the action to be performed
the description to be assigned to this action
Returns the localized name of the specified action of the object.
Returns a name string, or %NULL
if @action does not implement this interface.
the action index corresponding to the action to be performed
%TRUE if success, %FALSE otherwise
the action index corresponding to the action to be performed
a the number of actions, or 0 if @action does not
the action index corresponding to the action to be performed
the action index corresponding to the action to be performed
the action index corresponding to the action to be performed
a gboolean representing if the description was successfully set;
the action index corresponding to the action to be performed
the description to be assigned to this action
the action index corresponding to the action to be performed
A string name/value pair representing a text attribute.
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
or zero if the handler was already added.
a handler id which can be used in atk_component_remove_focus_handler
The #AtkFocusHandler to be attached to @component
Checks whether the specified point is within the extent of the @component.
the extent of the @component or not
%TRUE or %FALSE indicating whether the specified point is within
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Gets a reference to the accessible child, if one exists, at the
coordinate point specified by @x and @y.
a reference to the accessible child, if one exists
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the rectangle which gives the extent of the @component.
address of #gint to put x coordinate
address of #gint to put y coordinate
address of #gint to put width
address of #gint to put height
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the position of @component in the form of
a point specifying @component's top-left corner.
address of #gint to put x coordinate position
address of #gint to put y coordinate position
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the size of the @component in terms of width and height.
address of #gint to put width of @component
address of #gint to put height of @component
Grabs focus for this @component.
%TRUE if successful, %FALSE otherwise.
Remove the handler specified by @handler_id 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
Sets the extents of @component.
%TRUE or %FALSE whether the extents were set or not
x coordinate
y coordinate
width to set for @component
height to set for @component
specifies whether the coordinates are relative to the screen or to the components top level window
Sets the postition of @component.
%TRUE or %FALSE whether or not the position was set or not
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Set the size of the @component in terms of width and height.
%TRUE or %FALSE whether the size was set or not
width to set for @component
height to set for @component
Gets the layer of the component.
an #AtkLayer which is the layer of the component
Gets the zorder 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.
which the component is shown in relation to other components in the same
container.
a gint which is the zorder of the component, i.e. the depth at
Returns the alpha value (i.e. the opacity) for this
(fully opaque).
An alpha value from 0 to 1.0, inclusive.
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
or zero if the handler was already added.
a handler id which can be used in atk_component_remove_focus_handler
The #AtkFocusHandler to be attached to @component
Checks whether the specified point is within the extent of the @component.
the extent of the @component or not
%TRUE or %FALSE indicating whether the specified point is within
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Gets a reference to the accessible child, if one exists, at the
coordinate point specified by @x and @y.
a reference to the accessible child, if one exists
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the rectangle which gives the extent of the @component.
address of #gint to put x coordinate
address of #gint to put y coordinate
address of #gint to put width
address of #gint to put height
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the position of @component in the form of
a point specifying @component's top-left corner.
address of #gint to put x coordinate position
address of #gint to put y coordinate position
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the size of the @component in terms of width and height.
address of #gint to put width of @component
address of #gint to put height of @component
Gets the layer of the component.
an #AtkLayer which is the layer of the component
Gets the zorder 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.
which the component is shown in relation to other components in the same
container.
a gint which is the zorder of the component, i.e. the depth at
Grabs focus for this @component.
%TRUE if successful, %FALSE otherwise.
Remove the handler specified by @handler_id 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
Sets the extents of @component.
%TRUE or %FALSE whether the extents were set or not
x coordinate
y coordinate
width to set for @component
height to set for @component
specifies whether the coordinates are relative to the screen or to the components top level window
Sets the postition of @component.
%TRUE or %FALSE whether or not the position was set or not
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Set the size of the @component in terms of width and height.
%TRUE or %FALSE whether the size was set or not
width to set for @component
height to set for @component
Returns the alpha value (i.e. the opacity) for this
(fully opaque).
An alpha value from 0 to 1.0, inclusive.
a handler id which can be used in atk_component_remove_focus_handler
The #AtkFocusHandler to be attached to @component
%TRUE or %FALSE indicating whether the specified point is within
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
a reference to the accessible child, if one exists
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
address of #gint to put x coordinate
address of #gint to put y coordinate
address of #gint to put width
address of #gint to put height
specifies whether the coordinates are relative to the screen or to the components top level window
address of #gint to put x coordinate position
address of #gint to put y coordinate position
specifies whether the coordinates are relative to the screen or to the components top level window
address of #gint to put width of @component
address of #gint to put height of @component
%TRUE if successful, %FALSE otherwise.
the handler id of the focus handler to be removed from @component
%TRUE or %FALSE whether the extents were set or not
x coordinate
y coordinate
width to set for @component
height to set for @component
specifies whether the coordinates are relative to the screen or to the components top level window
%TRUE or %FALSE whether or not the position was set or not
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
%TRUE or %FALSE whether the size was set or not
width to set for @component
height to set for @component
an #AtkLayer which is the layer of the component
a gint which is the zorder of the component, i.e. the depth at
An alpha value from 0 to 1.0, inclusive.
Gets a string indicating the document type.
a string indicating the document type
Gets a %gpointer that points to an instance of the DOM. It is
up to the caller to check atk_document_get_type to determine
how to cast this pointer.
a %gpointer that points to an instance of the DOM.
Gets a string indicating the document type.
a string indicating the document type
Gets a %gpointer that points to an instance of the DOM. It is
up to the caller to check atk_document_get_type to determine
how to cast this pointer.
a %gpointer that points to an instance of the DOM.
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of the content of this document instance. Individual
text substrings or images within this document may have
a different locale, see atk_text_get_attributes and
atk_image_get_image_locale.
locale of the document content as a whole, or NULL if
the document content does not specify a locale.
a UTF-8 string indicating the POSIX-style LC_MESSAGES
Gets an AtkAttributeSet which describes document-wide
attributes as name-value pairs.
set name-value-pair attributes associated with this document
as a whole.
An AtkAttributeSet containing the explicitly
document, or NULL if a value for #attribute_name has not been specified
for this document.
a string value associated with the named attribute for this
a character string representing the name of the attribute whose value is being queried.
for this document, FALSE otherwise (e.g. if the document does not
allow the attribute to be modified).
TRUE if #value is successfully associated with #attribute_name
a character string representing the name of the attribute whose value is being set.
a string value to be associated with #attribute_name.
a string indicating the document type
a %gpointer that points to an instance of the DOM.
Set text contents of @text.
string to set for text contents of @text
Insert text at a given position.
the text to insert
the length of text to insert, in bytes
The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.
Copy text from @start_pos up to, but not including @end_pos
to the clipboard.
start position
end position
Copy text from @start_pos up to, but not including @end_pos
to the clipboard and then delete from the widget.
start position
end position
Delete text @start_pos up to, but not including @end_pos.
start position
end position
Paste text from clipboard to specified @position.
position to paste
Set text contents of @text.
string to set for text contents of @text
Insert text at a given position.
the text to insert
the length of text to insert, in bytes
The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.
Copy text from @start_pos up to, but not including @end_pos
to the clipboard.
start position
end position
Copy text from @start_pos up to, but not including @end_pos
to the clipboard and then delete from the widget.
start position
end position
Delete text @start_pos up to, but not including @end_pos.
start position
end position
Paste text from clipboard to specified @position.
position to paste
string to set for text contents of @text
the text to insert
the length of text to insert, in bytes
The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.
start position
end position
start position
end position
start position
end position
position to paste
A function which is called when an object emits a matching event,
as used in #atk_add_focus_tracker.
Currently the only events for which object-specific handlers are
supported are events of type "focus:". Most clients of ATK will prefer to
attach signal handlers for the various ATK signals instead.
An #AtkObject instance for whom the callback will be called when the specified event (e.g. 'focus:') takes place.
An #AtkEventListenerInit function is a special function that is
called in order to initialize the per-object event registration system
used by #AtkEventListener, if any preparation is required.
Gets the accessible object for the specified @obj.
a #AtkObject which is the accessible object for the @obj
a #GObject
Gets the GObject for which @obj is the accessible object.
a #GObject which is the object for which @obj is the accessible object
Get a the URI associated with the anchor specified
by @i of @link_.
Multiple anchors are primarily used by client-side image maps.
a string specifying the URI
a (zero-index) integer specifying the desired anchor
Returns the item associated with this hyperlinks nth anchor.
For instance, the returned #AtkObject will implement #AtkText
if @link_ is a text hyperlink, #AtkImage if @link_ is an image
hyperlink etc.
Multiple anchors are primarily used by client-side image maps.
an #AtkObject associated with this hyperlinks i-th anchor
a (zero-index) integer specifying the desired anchor
Gets the index with the hypertext document at which this link ends.
the index with the hypertext document at which this link ends
Gets the index with the hypertext document at which this link begins.
the index with the hypertext document at which this link begins
Since the document that a link is associated with may have changed
this method returns %TRUE if the link is still valid (with
respect to the document it references) and %FALSE otherwise.
whether or not this link is still valid
Gets the number of anchors associated with this hyperlink.
the number of anchors associated with this hyperlink
Get a the URI associated with the anchor specified
by @i of @link_.
Multiple anchors are primarily used by client-side image maps.
a string specifying the URI
a (zero-index) integer specifying the desired anchor
Returns the item associated with this hyperlinks nth anchor.
For instance, the returned #AtkObject will implement #AtkText
if @link_ is a text hyperlink, #AtkImage if @link_ is an image
hyperlink etc.
Multiple anchors are primarily used by client-side image maps.
an #AtkObject associated with this hyperlinks i-th anchor
a (zero-index) integer specifying the desired anchor
Gets the index with the hypertext document at which this link ends.
the index with the hypertext document at which this link ends
Gets the index with the hypertext document at which this link begins.
the index with the hypertext document at which this link begins
Since the document that a link is associated with may have changed
this method returns %TRUE if the link is still valid (with
respect to the document it references) and %FALSE otherwise.
whether or not this link is still valid
Indicates whether the link currently displays some or all of its
content inline. Ordinary HTML links will usually return
%FALSE, but an inline <src> HTML element will return
%TRUE.
whether or not this link displays its content inline.
Gets the number of anchors associated with this hyperlink.
the number of anchors associated with this hyperlink
a string specifying the URI
a (zero-index) integer specifying the desired anchor
an #AtkObject associated with this hyperlinks i-th anchor
a (zero-index) integer specifying the desired anchor
the index with the hypertext document at which this link ends
the index with the hypertext document at which this link begins
whether or not this link is still valid
the number of anchors associated with this hyperlink
Gets the hyperlink associated with this object.
Returns an AtkHyperlink object which points to this implementing AtkObject.
Gets the hyperlink associated with this object.
Returns an AtkHyperlink object which points to this implementing AtkObject.
Gets the link in this hypertext document at index
index @link_index
the link in this hypertext document at
an integer specifying the desired link
Gets the number of links within this hypertext document.
the number of links within this hypertext document
Gets the index into the array of hyperlinks that is associated with
the character specified by @char_index.
or -1 if there is no hyperlink associated with this character.
an index into the array of hyperlinks in @hypertext,
a character index
Gets the link in this hypertext document at index
index @link_index
the link in this hypertext document at
an integer specifying the desired link
Gets the number of links within this hypertext document.
the number of links within this hypertext document
Gets the index into the array of hyperlinks that is associated with
the character specified by @char_index.
or -1 if there is no hyperlink associated with this character.
an index into the array of hyperlinks in @hypertext,
a character index
the link in this hypertext document at
an integer specifying the desired link
the number of links within this hypertext document
an index into the array of hyperlinks in @hypertext,
a character index
Gets the position of the image in the form of a point specifying the
images top-left corner.
address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
specifies whether the coordinates are relative to the screen or to the components top level window
Get a textual description of this image.
a string representing the image description
Get the width and height in pixels for the specified image.
The values of @width and @height are returned as -1 if the
values cannot be obtained (for instance, if the object is not onscreen).
filled with the image width, or -1 if the value cannot be obtained.
filled with the image height, or -1 if the value cannot be obtained.
Sets the textual description for this image.
not be completed.
boolean TRUE, or FALSE if operation could
a string description to set for @image
Since ATK 1.12
Returns a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.
Get a textual description of this image.
a string representing the image description
Get the width and height in pixels for the specified image.
The values of @width and @height are returned as -1 if the
values cannot be obtained (for instance, if the object is not onscreen).
filled with the image width, or -1 if the value cannot be obtained.
filled with the image height, or -1 if the value cannot be obtained.
Sets the textual description for this image.
not be completed.
boolean TRUE, or FALSE if operation could
a string description to set for @image
Gets the position of the image in the form of a point specifying the
images top-left corner.
address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
specifies whether the coordinates are relative to the screen or to the components top level window
Since ATK 1.12
Returns a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.
address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
specifies whether the coordinates are relative to the screen or to the components top level window
a string representing the image description
filled with the image width, or -1 if the value cannot be obtained.
filled with the image height, or -1 if the value cannot be obtained.
boolean TRUE, or FALSE if operation could
a string description to set for @image
Gets a reference to an object's #AtkObject implementation, if
the object implements #AtkObjectIface
a reference to an object's #AtkObject implementation
Encapsulates information about a key event.
An #AtkKeySnoopFunc is a type of callback which is called whenever a key event occurs,
if registered via atk_add_key_event_listener. It allows for pre-emptive
interception of key events via the return code as described below.
discarded without being passed to the normal GUI recipient; FALSE (zero) if the
event dispatch to the client application should proceed as normal.
TRUE (nonzero) if the event emission should be stopped and the event
an AtkKeyEventStruct containing information about the key event for which notification is being given.
a block of data which will be passed to the event listener, on notification.
Obtain the singleton instance of AtkMisc for this application.
The singleton instance of AtkMisc for this application.
Take the thread mutex for the GUI toolkit,
if one exists.
(This method is implemented by the toolkit ATK implementation layer;
for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
Release the thread mutex for the GUI toolkit,
if one exists. This method, and atk_misc_threads_enter,
are needed in some situations by threaded application code which
services ATK requests, since fulfilling ATK requests often
requires calling into the GUI toolkit. If a long-running or
potentially blocking call takes place inside such a block, it should
be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls.
(This method is implemented by the toolkit ATK implementation layer;
for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).
Take the thread mutex for the GUI toolkit,
if one exists.
(This method is implemented by the toolkit ATK implementation layer;
for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
Release the thread mutex for the GUI toolkit,
if one exists. This method, and atk_misc_threads_enter,
are needed in some situations by threaded application code which
services ATK requests, since fulfilling ATK requests often
requires calling into the GUI toolkit. If a long-running or
potentially blocking call takes place inside such a block, it should
be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls.
(This method is implemented by the toolkit ATK implementation layer;
for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).
Provides a default (non-functioning stub) #AtkObject.
Application maintainers should not use this method.
a default (non-functioning stub) #AtkObject
a #GObject
Creates an instance of an #AtkObjectFactory which generates primitive
(non-functioning) #AtkObjects.
an instance of an #AtkObjectFactory
Gets the accessible name of the accessible.
a character string representing the accessible name of the object.
Gets the accessible description of the accessible.
of the accessible.
a character string representing the accessible description
Gets the accessible parent of the accessible.
a #AtkObject representing the accessible parent of the accessible
Gets the 0-based index of this accessible in its parent; returns -1 if the
accessible does not have an accessible parent.
an integer which is the index of the accessible in its parent
Gets the #AtkRelationSet associated with the object.
an #AtkRelationSet representing the relation set of the object.
Gets the role of the accessible.
an #AtkRole which is the role of the accessible
Gets a reference to the state set of the accessible; the caller must
unreference it when it is no longer needed.
set of the accessible
a reference to an #AtkStateSet which is the state
Sets the accessible name of the accessible.
a character string to be set as the accessible name
Sets the accessible description of the accessible.
Sets the accessible parent of the accessible.
Sets the role of the accessible.
Specifies a function to be called when a property changes value.
atk_object_remove_property_change_handler()
a #guint which is the handler id used in
Removes a property change handler.
This function is called when implementing subclasses of #AtkObject.
It does initialization required for the new object. It is intended
that this function should called only in the ..._new() functions used
to create an instance of a subclass of #AtkObject
a #gpointer which identifies the object for which the AtkObject was created.
Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of
name-value pairs. As such these attributes may be considered weakly-typed properties or annotations,
as distinct from strongly-typed object data available via other get/set methods.
Not all objects have explicit "name-value pair" #AtkAttributeSet properties.
the object, or an empty set if the object has no name-value pair attributes assigned to it.
an #AtkAttributeSet consisting of all explicit properties/annotations applied to
Gets the accessible name of the accessible.
a character string representing the accessible name of the object.
Gets the accessible description of the accessible.
of the accessible.
a character string representing the accessible description
Gets the accessible parent of the accessible.
a #AtkObject representing the accessible parent of the accessible
Gets the number of accessible children of the accessible.
of the accessible.
an integer representing the number of accessible children
Gets a reference to the specified accessible child of the object.
The accessible children are 0-based so the first accessible child is
at index 0, the second at index 1 and so on.
of the accessible.
an #AtkObject representing the specified accessible child
a gint representing the position of the child, starting from 0
Gets the #AtkRelationSet associated with the object.
an #AtkRelationSet representing the relation set of the object.
Gets the role of the accessible.
an #AtkRole which is the role of the accessible
Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of
name-value pairs. As such these attributes may be considered weakly-typed properties or annotations,
as distinct from strongly-typed object data available via other get/set methods.
Not all objects have explicit "name-value pair" #AtkAttributeSet properties.
the object, or an empty set if the object has no name-value pair attributes assigned to it.
an #AtkAttributeSet consisting of all explicit properties/annotations applied to
Gets a reference to the state set of the accessible; the caller must
unreference it when it is no longer needed.
set of the accessible
a reference to an #AtkStateSet which is the state
Gets the 0-based index of this accessible in its parent; returns -1 if the
accessible does not have an accessible parent.
an integer which is the index of the accessible in its parent
Sets the accessible name of the accessible.
a character string to be set as the accessible name
Sets the accessible description of the accessible.
Sets the accessible parent of the accessible.
Sets the role of the accessible.
Specifies a function to be called when a property changes value.
atk_object_remove_property_change_handler()
a #guint which is the handler id used in
Removes a property change handler.
Emits a state-change signal for the specified state.
an #AtkState whose state is changed
This function is called when implementing subclasses of #AtkObject.
It does initialization required for the new object. It is intended
that this function should called only in the ..._new() functions used
to create an instance of a subclass of #AtkObject
a #gpointer which identifies the object for which the AtkObject was created.
Adds a relationship of the specified type with the specified target.
Returns TRUE if the relationship is added.
The #AtkRelationType of the relation
The #AtkObject which is to be the target of the relation.
Removes a relationship of the specified type with the specified target.
Returns TRUE if the relationship is removed.
The #AtkRelationType of the relation
The #AtkObject which is the target of the relation to be removed.
a character string representing the accessible name of the object.
a character string representing the accessible description
a #AtkObject representing the accessible parent of the accessible
an integer which is the index of the accessible in its parent
an #AtkRelationSet representing the relation set of the object.
an #AtkRole which is the role of the accessible
a reference to an #AtkStateSet which is the state
a character string to be set as the accessible name
a #guint which is the handler id used in
a #gpointer which identifies the object for which the AtkObject was created.
an #AtkAttributeSet consisting of all explicit properties/annotations applied to
Inform @factory that it is no longer being used to create
accessibles. When called, @factory may need to inform
#AtkObjects which it has created that they need to be re-instantiated.
in object registries.
Provides an #AtkObject that implements an accessibility interface
on behalf of @obj
on behalf of @obj
an #AtkObject that implements an accessibility interface
a #GObject
Inform @factory that it is no longer being used to create
accessibles. When called, @factory may need to inform
#AtkObjects which it has created that they need to be re-instantiated.
in object registries.
Gets the GType of the accessible which is created by the factory.
The value G_TYPE_INVALID is returned if no type if found.
the type of the accessible which is created by the @factory.
Associate an #AtkObjectFactory subclass with a #GType. Note:
The associated @factory_type will thereafter be responsible for
the creation of new #AtkObject implementations for instances
appropriate for @type.
an #AtkObject type
an #AtkObjectFactory type to associate with @type. Must implement AtkObject appropriate for @type.
Provides a #GType indicating the #AtkObjectFactory subclass
associated with @type.
a #GType associated with type @type
a #GType with which to look up the associated #AtkObjectFactory subclass
Gets an #AtkObjectFactory appropriate for creating #AtkObjects
appropriate for @type.
appropriate for @type.
an #AtkObjectFactory appropriate for creating #AtkObjects
a #GType with which to look up the associated #AtkObjectFactory
Create a new relation for the specified key and the specified list
of targets. See also atk_object_add_relationship().
a pointer to a new #AtkRelation
an array of pointers to #AtkObjects
number of #AtkObjects pointed to by @targets
an #AtkRelationType with which to create the new #AtkRelation
Associate @name with a new #AtkRelationType
an #AtkRelationType associated with @name
a name string
Gets the description string describing the #AtkRelationType @type.
the string describing the AtkRelationType
The #AtkRelationType whose name is required
Get the #AtkRelationType type corresponding to a relation name.
or #ATK_RELATION_NULL if no matching relation type is found.
the #AtkRelationType enumerated type corresponding to the specified name,
a string which is the (non-localized) name of an ATK relation type.
Gets the type of @relation
the type of @relation
Gets the target list of @relation
the target list of @relation
Adds the specified AtkObject to the target for the relation, if it is
not already present. See also atk_object_add_relationship().
an #AtkObject
Remove the specified AtkObject from the target for the relation.
Returns TRUE if the removal is successful.
an #AtkObject
Creates a new empty relation set.
a new #AtkRelationSet
Determines whether the relation set contains a relation that matches the
specified type.
in @set, %FALSE otherwise
%TRUE if @relationship is the relationship type of a relation
an #AtkRelationType
Removes a relation from the relation set.
This function unref's the #AtkRelation so it will be deleted unless there
is another reference to it.
an #AtkRelation
Add a new relation to the current relation set if it is not already
present.
This function ref's the AtkRelation so the caller of this function
should unref it to ensure that it will be destroyed when the AtkRelationSet
is destroyed.
an #AtkRelation
Determines the number of relations in a relation set.
an integer representing the number of relations in the set.
Finds a relation that matches the specified type.
an #AtkRelation, which is a relation matching the specified type.
an #AtkRelationType
Add a new relation of the specified type with the specified target to
the current relation set if the relation set does not contain a relation
of that type. If it is does contain a relation of that typea the target
is added to the relation.
an #AtkRelationType
an #AtkObject
Adds the specified accessible child of the object to the
object's selection.
TRUE if success, FALSE otherwise.
a #gint specifying the child index.
Clears the selection in the object so that no children in the object
are selected.
TRUE if success, FALSE otherwise.
Gets a reference to the accessible object representing the specified
selected child of the object.
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
if @selection does not implement this interface.
an #AtkObject representing the selected accessible , or %NULL
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Gets the number of accessible children currently selected.
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
if @selection does not implement this interface.
a gint representing the number of items selected, or 0
Determines if the current child of this object is selected
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
if @selection does not implement this interface.
a gboolean representing the specified child is selected, or 0
a #gint specifying the child index.
Removes the specified child of the object from the object's selection.
TRUE if success, FALSE otherwise.
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Causes every child of the object to be selected if the object
supports multiple selections.
TRUE if success, FALSE otherwise.
Adds the specified accessible child of the object to the
object's selection.
TRUE if success, FALSE otherwise.
a #gint specifying the child index.
Clears the selection in the object so that no children in the object
are selected.
TRUE if success, FALSE otherwise.
Gets a reference to the accessible object representing the specified
selected child of the object.
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
if @selection does not implement this interface.
an #AtkObject representing the selected accessible , or %NULL
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Gets the number of accessible children currently selected.
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
if @selection does not implement this interface.
a gint representing the number of items selected, or 0
Determines if the current child of this object is selected
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
if @selection does not implement this interface.
a gboolean representing the specified child is selected, or 0
a #gint specifying the child index.
Removes the specified child of the object from the object's selection.
TRUE if success, FALSE otherwise.
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Causes every child of the object to be selected if the object
supports multiple selections.
TRUE if success, FALSE otherwise.
TRUE if success, FALSE otherwise.
a #gint specifying the child index.
TRUE if success, FALSE otherwise.
an #AtkObject representing the selected accessible , or %NULL
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
a gint representing the number of items selected, or 0
a gboolean representing the specified child is selected, or 0
a #gint specifying the child index.
TRUE if success, FALSE otherwise.
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
TRUE if success, FALSE otherwise.
Embeds the children of an #AtkPlug as the children of the #AtkSocket. The
plug may be in the same process or in a different process.
the ID of an #AtkPlug
Embeds the children of an #AtkPlug as the children of the #AtkSocket. The
plug may be in the same process or in a different process.
the ID of an #AtkPlug
Determines whether or not the socket has an embedded plug.
TRUE if a plug is embedded in the socket
the ID of an #AtkPlug
Creates a new empty state set.
a new #AtkStateSet
Checks whether the state set is empty, i.e. has no states set.
%TRUE if @set has no states set, otherwise %FALSE
Add a new state for the specified type to the current state set if
it is not already present.
%TRUE if the state for @type is not already in @set.
an #AtkStateType
Add the states for the specified types to the current state set.
an array of #AtkStateType
The number of elements in the array
Removes all states from the state set.
Checks whether the state for the specified type is in the specified set.
%TRUE if @type is the state type is in @set.
an #AtkStateType
Checks whether the states for all the specified types are in the
specified set.
%TRUE if all the states for @type are in @set.
an array of #AtkStateType
The number of elements in the array
Removes the state for the specified type from the state set.
%TRUE if @type was the state type is in @set.
an #AtkType
Constructs the intersection of the two sets, returning %NULL if the
intersection is empty.
a new #AtkStateSet which is the intersection of the two sets.
another #AtkStateSet
Constructs the union of the two sets.
returning %NULL is empty.
a new #AtkStateSet which is the union of the two sets,
another #AtkStateSet
Constructs the exclusive-or of the two sets, returning %NULL is empty.
The set returned by this operation contains the states in exactly
one of the two sets.
in exactly one of the two sets.
a new #AtkStateSet which contains the states which are
another #AtkStateSet
Gets the number of mime types supported by this object.
a gint which is the number of mime types supported by the object.
Gets the character string of the specified mime type. The first mime
type is at position 0, the second at position 1, and so on.
should not free the character string.
a gint representing the position of the mime type starting from 0
Gets the content in the specified mime type.
type.
A #GIOChannel which contains the content in the specified mime
a gchar* representing the mime type
Get a string representing a URI in IETF standard format
(see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content
may be streamed in the specified mime-type, if one is available.
If mime_type is NULL, the URI for the default (and possibly only) mime-type is
returned.
Note that it is possible for get_uri to return NULL but for
get_stream to work nonetheless, since not all GIOChannels connect to URIs.
can be constructed.
Returns a string representing a URI, or NULL if no corresponding URI
a gchar* representing the mime type, or NULL to request a URI for the default mime type.
Gets the number of mime types supported by this object.
a gint which is the number of mime types supported by the object.
Gets the character string of the specified mime type. The first mime
type is at position 0, the second at position 1, and so on.
should not free the character string.
a gint representing the position of the mime type starting from 0
Gets the content in the specified mime type.
type.
A #GIOChannel which contains the content in the specified mime
a gchar* representing the mime type
Get a string representing a URI in IETF standard format
(see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content
may be streamed in the specified mime-type, if one is available.
If mime_type is NULL, the URI for the default (and possibly only) mime-type is
returned.
Note that it is possible for get_uri to return NULL but for
get_stream to work nonetheless, since not all GIOChannels connect to URIs.
can be constructed.
Returns a string representing a URI, or NULL if no corresponding URI
a gchar* representing the mime type, or NULL to request a URI for the default mime type.
a gint which is the number of mime types supported by the object.
a gint representing the position of the mime type starting from 0
A #GIOChannel which contains the content in the specified mime
a gchar* representing the mime type
Returns a string representing a URI, or NULL if no corresponding URI
a gchar* representing the mime type, or NULL to request a URI for the default mime type.
Get a reference to the table cell at @row, @column.
a AtkObject* representing the referred to accessible
a #gint representing a row in @table
a #gint representing a column in @table
Gets a #gint representing the index at the specified @row and @column.
The value -1 is returned if the object at row,column is not a child
of table or table does not implement this interface.
a #gint representing the index at specified position.
a #gint representing a row in @table
a #gint representing a column in @table
Gets a #gint representing the column at the specified @index_.
or -1 if the table does not implement this interface
a gint representing the column at the specified index,
a #gint representing an index in @table
Gets a #gint representing the row at the specified @index_.
or -1 if the table does not implement this interface
a gint representing the row at the specified index,
a #gint representing an index in @table
Gets the number of columns in the table.
if value does not implement this interface.
a gint representing the number of columns, or 0
Gets the number of rows in the table.
if value does not implement this interface.
a gint representing the number of rows, or 0
Gets the number of columns occupied by the accessible object
at the specified @row and @column in the @table.
if value does not implement this interface.
a gint representing the column extent at specified position, or 0
a #gint representing a row in @table
a #gint representing a column in @table
Gets the number of rows occupied by the accessible object
at a specified @row and @column in the @table.
if value does not implement this interface.
a gint representing the row extent at specified position, or 0
a #gint representing a row in @table
a #gint representing a column in @table
Gets the caption for the @table.
if value does not implement this interface.
a AtkObject* representing the table caption, or %NULL
Gets the description text of the specified @column in the table
if value does not implement this interface.
a gchar* representing the column description, or %NULL
a #gint representing a column in @table
Gets the column header of a specified column in an accessible table.
%NULL if value does not implement this interface.
a AtkObject* representing the specified column header, or
a #gint representing a column in the table
Gets the description text of the specified row in the table
if value does not implement this interface.
a gchar* representing the row description, or %NULL
a #gint representing a row in @table
Gets the row header of a specified row in an accessible table.
%NULL if value does not implement this interface.
a AtkObject* representing the specified row header, or
a #gint representing a row in the table
Gets the summary description of the table.
or zero if value does not implement this interface.
a AtkObject* representing a summary description of the table,
Sets the caption for the table.
a #AtkObject representing the caption to set for @table
Sets the description text for the specified @column of the @table.
a #gint representing a column in @table
a #gchar representing the description text to set for the specified @column of the @table
Sets the specified column header to @header.
a #gint representing a column in @table
an #AtkTable
Sets the description text for the specified @row of @table.
a #gint representing a row in @table
a #gchar representing the description text to set for the specified @row of @table
Sets the specified row header to @header.
a #gint representing a row in @table
an #AtkTable
Sets the summary description of the table.
an #AtkObject representing the summary description to set for @table
Gets the selected columns of the table by initializing **selected with
the selected column numbers. This array should be freed by the caller.
or %0 if value does not implement this interface.
a gint representing the number of selected columns,
a #gint** that is to contain the selected columns numbers
Gets the selected rows of the table by initializing **selected with
the selected row numbers. This array should be freed by the caller.
or zero if value does not implement this interface.
a gint representing the number of selected rows,
a #gint** that is to contain the selected row numbers
Gets a boolean value indicating whether the specified @column
is selected
if value does not implement this interface.
a gboolean representing if the column is selected, or 0
a #gint representing a column in @table
Gets a boolean value indicating whether the specified @row
is selected
if value does not implement this interface.
a gboolean representing if the row is selected, or 0
a #gint representing a row in @table
Gets a boolean value indicating whether the accessible object
at the specified @row and @column is selected
if value does not implement this interface.
a gboolean representing if the cell is selected, or 0
a #gint representing a row in @table
a #gint representing a column in @table
Adds the specified @row to the selection.
or 0 if value does not implement this interface.
a gboolean representing if row was successfully added to selection,
a #gint representing a row in @table
Removes the specified @row from the selection.
the selection, or 0 if value does not implement this interface.
a gboolean representing if the row was successfully removed from
a #gint representing a row in @table
Adds the specified @column to the selection.
the selection, or 0 if value does not implement this interface.
a gboolean representing if the column was successfully added to
a #gint representing a column in @table
Adds the specified @column to the selection.
the selection, or 0 if value does not implement this interface.
a gboolean representing if the column was successfully removed from
a #gint representing a column in @table
Get a reference to the table cell at @row, @column.
a AtkObject* representing the referred to accessible
a #gint representing a row in @table
a #gint representing a column in @table
Gets a #gint representing the index at the specified @row and @column.
The value -1 is returned if the object at row,column is not a child
of table or table does not implement this interface.
a #gint representing the index at specified position.
a #gint representing a row in @table
a #gint representing a column in @table
Gets a #gint representing the column at the specified @index_.
or -1 if the table does not implement this interface
a gint representing the column at the specified index,
a #gint representing an index in @table
Gets a #gint representing the row at the specified @index_.
or -1 if the table does not implement this interface
a gint representing the row at the specified index,
a #gint representing an index in @table
Gets the number of columns in the table.
if value does not implement this interface.
a gint representing the number of columns, or 0
Gets the number of rows in the table.
if value does not implement this interface.
a gint representing the number of rows, or 0
Gets the number of columns occupied by the accessible object
at the specified @row and @column in the @table.
if value does not implement this interface.
a gint representing the column extent at specified position, or 0
a #gint representing a row in @table
a #gint representing a column in @table
Gets the number of rows occupied by the accessible object
at a specified @row and @column in the @table.
if value does not implement this interface.
a gint representing the row extent at specified position, or 0
a #gint representing a row in @table
a #gint representing a column in @table
Gets the caption for the @table.
if value does not implement this interface.
a AtkObject* representing the table caption, or %NULL
Gets the description text of the specified @column in the table
if value does not implement this interface.
a gchar* representing the column description, or %NULL
a #gint representing a column in @table
Gets the column header of a specified column in an accessible table.
%NULL if value does not implement this interface.
a AtkObject* representing the specified column header, or
a #gint representing a column in the table
Gets the description text of the specified row in the table
if value does not implement this interface.
a gchar* representing the row description, or %NULL
a #gint representing a row in @table
Gets the row header of a specified row in an accessible table.
%NULL if value does not implement this interface.
a AtkObject* representing the specified row header, or
a #gint representing a row in the table
Gets the summary description of the table.
or zero if value does not implement this interface.
a AtkObject* representing a summary description of the table,
Sets the caption for the table.
a #AtkObject representing the caption to set for @table
Sets the description text for the specified @column of the @table.
a #gint representing a column in @table
a #gchar representing the description text to set for the specified @column of the @table
Sets the specified column header to @header.
a #gint representing a column in @table
an #AtkTable
Sets the description text for the specified @row of @table.
a #gint representing a row in @table
a #gchar representing the description text to set for the specified @row of @table
Sets the specified row header to @header.
a #gint representing a row in @table
an #AtkTable
Sets the summary description of the table.
an #AtkObject representing the summary description to set for @table
Gets the selected columns of the table by initializing **selected with
the selected column numbers. This array should be freed by the caller.
or %0 if value does not implement this interface.
a gint representing the number of selected columns,
a #gint** that is to contain the selected columns numbers
Gets the selected rows of the table by initializing **selected with
the selected row numbers. This array should be freed by the caller.
or zero if value does not implement this interface.
a gint representing the number of selected rows,
a #gint** that is to contain the selected row numbers
Gets a boolean value indicating whether the specified @column
is selected
if value does not implement this interface.
a gboolean representing if the column is selected, or 0
a #gint representing a column in @table
Gets a boolean value indicating whether the specified @row
is selected
if value does not implement this interface.
a gboolean representing if the row is selected, or 0
a #gint representing a row in @table
Gets a boolean value indicating whether the accessible object
at the specified @row and @column is selected
if value does not implement this interface.
a gboolean representing if the cell is selected, or 0
a #gint representing a row in @table
a #gint representing a column in @table
Adds the specified @row to the selection.
or 0 if value does not implement this interface.
a gboolean representing if row was successfully added to selection,
a #gint representing a row in @table
Removes the specified @row from the selection.
the selection, or 0 if value does not implement this interface.
a gboolean representing if the row was successfully removed from
a #gint representing a row in @table
Adds the specified @column to the selection.
the selection, or 0 if value does not implement this interface.
a gboolean representing if the column was successfully added to
a #gint representing a column in @table
Adds the specified @column to the selection.
the selection, or 0 if value does not implement this interface.
a gboolean representing if the column was successfully removed from
a #gint representing a column in @table
a AtkObject* representing the referred to accessible
a #gint representing a row in @table
a #gint representing a column in @table
a #gint representing the index at specified position.
a #gint representing a row in @table
a #gint representing a column in @table
a gint representing the column at the specified index,
a #gint representing an index in @table
a gint representing the row at the specified index,
a #gint representing an index in @table
a gint representing the number of columns, or 0
a gint representing the number of rows, or 0
a gint representing the column extent at specified position, or 0
a #gint representing a row in @table
a #gint representing a column in @table
a gint representing the row extent at specified position, or 0
a #gint representing a row in @table
a #gint representing a column in @table
a AtkObject* representing the table caption, or %NULL
a gchar* representing the column description, or %NULL
a #gint representing a column in @table
a AtkObject* representing the specified column header, or
a #gint representing a column in the table
a gchar* representing the row description, or %NULL
a #gint representing a row in @table
a AtkObject* representing the specified row header, or
a #gint representing a row in the table
a AtkObject* representing a summary description of the table,
a #AtkObject representing the caption to set for @table
a #gint representing a column in @table
a #gchar representing the description text to set for the specified @column of the @table
a #gint representing a column in @table
an #AtkTable
a #gint representing a row in @table
a #gchar representing the description text to set for the specified @row of @table
a #gint representing a row in @table
an #AtkTable
an #AtkObject representing the summary description to set for @table
a gint representing the number of selected columns,
a #gint** that is to contain the selected columns numbers
a gint representing the number of selected rows,
a #gint** that is to contain the selected row numbers
a gboolean representing if the column is selected, or 0
a #gint representing a column in @table
a gboolean representing if the row is selected, or 0
a #gint representing a row in @table
a gboolean representing if the cell is selected, or 0
a #gint representing a row in @table
a #gint representing a column in @table
a gboolean representing if row was successfully added to selection,
a #gint representing a row in @table
a gboolean representing if the row was successfully removed from
a #gint representing a row in @table
a gboolean representing if the column was successfully added to
a #gint representing a column in @table
a gboolean representing if the column was successfully removed from
a #gint representing a column in @table
Gets the specified text.
the text from @start_offset up to, but not including @end_offset.
start position
end position
Gets the specified text.
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the
offset is returned.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start after the offset to the next word start.
The returned string will contain the word after the offset if the offset
is inside a word or if the offset is not inside a word.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end at or after the offset to the next work end.
The returned string will contain the word after the offset if the offset
is inside a word and will contain the word after the word after the offset
if the offset is not inside a word.
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start after the offset to the next sentence
start.
The returned string will contain the sentence after the offset if the offset
is inside a sentence or if the offset is not inside a sentence.
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end at or after the offset to the next sentence end.
The returned string will contain the sentence after the offset if the offset
is inside a sentence and will contain the sentence after the sentence
after the offset if the offset is not inside a sentence.
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start after the offset to the next line start.
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end at or after the offset to the next line start.
the text after @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
Gets the specified text.
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
offset is returned.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start at or before the offset to the word start after
the offset.
The returned string will contain the word at the offset if the offset
is inside a word and will contain the word before the offset if the
offset is not inside a word.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end before the offset to the word end at or after the
offset.
The returned string will contain the word at the offset if the offset
is inside a word and will contain the word after to the offset if the
offset is not inside a word.
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start at or before the offset to the sentence
start after the offset.
The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence before the offset
if the offset is not inside a sentence.
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end before the offset to the sentence end at or
after the offset.
The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence after the offset
if the offset is not inside a sentence.
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start at or before the offset to the line
start after the offset.
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the offset to the line end at or after
the offset.
the text at @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
Gets the specified text.
the character at @offset.
position
Gets the specified text.
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the
offset is returned.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start before the word start before the offset to
the word start before the offset.
The returned string will contain the word before the offset if the offset
is inside a word and will contain the word before the word before the
offset if the offset is not inside a word.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end before the word end at or before the offset to the
word end at or before the offset.
The returned string will contain the word before the offset if the offset
is inside a word or if the offset is not inside a word.
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start before the sentence start before
the offset to the sentence start before the offset.
The returned string will contain the sentence before the offset if the
offset is inside a sentence and will contain the sentence before the
sentence before the offset if the offset is not inside a sentence.
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end before the sentence end at or before the offset to
the sentence end at or before the offset.
The returned string will contain the sentence before the offset if the
offset is inside a sentence or if the offset is not inside a sentence.
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start before the line start ar or before the offset
to the line start ar or before the offset.
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the line end before the offset to the
line end before the offset.
the text before @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
Gets the offset position of the caret (cursor).
the offset position of the caret (cursor).
Get the bounding box containing the glyph representing the character at
a particular text offset.
The offset of the text character for which bounding information is required.
Pointer for the x cordinate of the bounding box
Pointer for the y cordinate of the bounding box
Pointer for the width of the bounding box
Pointer for the height of the bounding box
specify whether coordinates are relative to the screen or widget window
Gets the character count.
the number of characters.
Gets the offset of the character located at coordinates @x and @y. @x and @y
are interpreted as being relative to the screen or this widget's window
depending on @coords.
the specified @x and @y coordinates.
the offset to the character which is located at
screen x-position of character
screen y-position of character
specify whether coordinates are relative to the screen or widget window
Gets the number of selected regions.
occurred.
The number of selected regions, or -1 if a failure
Gets the text from the specified selection.
the selected text.
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
passes back the start position of the selected region
passes back the end position of (e.g. offset immediately past) the selected region
Adds a selection bounded by the specified offsets.
%TRUE if success, %FALSE otherwise
the start position of the selected region
the offset of the first character after the selected region.
Removes the specified selection.
%TRUE if success, %FALSE otherwise
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
Changes the start and end offset of the specified selection.
%TRUE if success, %FALSE otherwise
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
the new start position of the selection
the new end position of (e.g. offset immediately past) the selection
Sets the caret (cursor) position to the specified @offset.
%TRUE if success, %FALSE otherwise.
position
Get the bounding box for text within the specified range.
The offset of the first text character for which boundary information is required.
The offset of the text character after the last character for which boundary information is required.
Specify whether coordinates are relative to the screen or widget window.
A pointer to a AtkTextRectangle which is filled in by this function.
Get the ranges of text in the specified bounding box.
by this function will be NULL.
Array of AtkTextRange. The last element of the array returned
An AtkTextRectagle giving the dimensions of the bounding box.
Specify whether coordinates are relative to the screen or widget window.
Specify the horizontal clip type.
Specify the vertical clip type.
Gets the specified text.
the text from @start_offset up to, but not including @end_offset.
start position
end position
Gets the specified text.
the character at @offset.
position
Gets the specified text.
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the
offset is returned.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start after the offset to the next word start.
The returned string will contain the word after the offset if the offset
is inside a word or if the offset is not inside a word.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end at or after the offset to the next work end.
The returned string will contain the word after the offset if the offset
is inside a word and will contain the word after the word after the offset
if the offset is not inside a word.
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start after the offset to the next sentence
start.
The returned string will contain the sentence after the offset if the offset
is inside a sentence or if the offset is not inside a sentence.
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end at or after the offset to the next sentence end.
The returned string will contain the sentence after the offset if the offset
is inside a sentence and will contain the sentence after the sentence
after the offset if the offset is not inside a sentence.
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start after the offset to the next line start.
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end at or after the offset to the next line start.
the text after @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
Gets the specified text.
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
offset is returned.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start at or before the offset to the word start after
the offset.
The returned string will contain the word at the offset if the offset
is inside a word and will contain the word before the offset if the
offset is not inside a word.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end before the offset to the word end at or after the
offset.
The returned string will contain the word at the offset if the offset
is inside a word and will contain the word after to the offset if the
offset is not inside a word.
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start at or before the offset to the sentence
start after the offset.
The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence before the offset
if the offset is not inside a sentence.
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end before the offset to the sentence end at or
after the offset.
The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence after the offset
if the offset is not inside a sentence.
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start at or before the offset to the line
start after the offset.
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the offset to the line end at or after
the offset.
the text at @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
Gets the specified text.
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the
offset is returned.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start before the word start before the offset to
the word start before the offset.
The returned string will contain the word before the offset if the offset
is inside a word and will contain the word before the word before the
offset if the offset is not inside a word.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end before the word end at or before the offset to the
word end at or before the offset.
The returned string will contain the word before the offset if the offset
is inside a word or if the offset is not inside a word.
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start before the sentence start before
the offset to the sentence start before the offset.
The returned string will contain the sentence before the offset if the
offset is inside a sentence and will contain the sentence before the
sentence before the offset if the offset is not inside a sentence.
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end before the sentence end at or before the offset to
the sentence end at or before the offset.
The returned string will contain the sentence before the offset if the
offset is inside a sentence or if the offset is not inside a sentence.
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start before the line start ar or before the offset
to the line start ar or before the offset.
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the line end before the offset to the
line end before the offset.
the text before @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
Gets the offset position of the caret (cursor).
the offset position of the caret (cursor).
Get the bounding box containing the glyph representing the character at
a particular text offset.
The offset of the text character for which bounding information is required.
Pointer for the x cordinate of the bounding box
Pointer for the y cordinate of the bounding box
Pointer for the width of the bounding box
Pointer for the height of the bounding box
specify whether coordinates are relative to the screen or widget window
Gets the character count.
the number of characters.
Gets the offset of the character located at coordinates @x and @y. @x and @y
are interpreted as being relative to the screen or this widget's window
depending on @coords.
the specified @x and @y coordinates.
the offset to the character which is located at
screen x-position of character
screen y-position of character
specify whether coordinates are relative to the screen or widget window
Gets the number of selected regions.
occurred.
The number of selected regions, or -1 if a failure
Gets the text from the specified selection.
the selected text.
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
passes back the start position of the selected region
passes back the end position of (e.g. offset immediately past) the selected region
Adds a selection bounded by the specified offsets.
%TRUE if success, %FALSE otherwise
the start position of the selected region
the offset of the first character after the selected region.
Removes the specified selection.
%TRUE if success, %FALSE otherwise
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
Changes the start and end offset of the specified selection.
%TRUE if success, %FALSE otherwise
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
the new start position of the selection
the new end position of (e.g. offset immediately past) the selection
Sets the caret (cursor) position to the specified @offset.
%TRUE if success, %FALSE otherwise.
position
Get the bounding box for text within the specified range.
The offset of the first text character for which boundary information is required.
The offset of the text character after the last character for which boundary information is required.
Specify whether coordinates are relative to the screen or widget window.
A pointer to a AtkTextRectangle which is filled in by this function.
Get the ranges of text in the specified bounding box.
by this function will be NULL.
Array of AtkTextRange. The last element of the array returned
An AtkTextRectagle giving the dimensions of the bounding box.
Specify whether coordinates are relative to the screen or widget window.
Specify the horizontal clip type.
Specify the vertical clip type.
the text from @start_offset up to, but not including @end_offset.
start position
end position
the text after @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
the text at @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
the character at @offset.
position
the text before @offset bounded by the specified @boundary_type.
position
An #AtkTextBoundary
the start offset of the returned string
the offset of the first character after the returned substring
the offset position of the caret (cursor).
The offset of the text character for which bounding information is required.
Pointer for the x cordinate of the bounding box
Pointer for the y cordinate of the bounding box
Pointer for the width of the bounding box
Pointer for the height of the bounding box
specify whether coordinates are relative to the screen or widget window
the number of characters.
the offset to the character which is located at
screen x-position of character
screen y-position of character
specify whether coordinates are relative to the screen or widget window
The number of selected regions, or -1 if a failure
the selected text.
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
passes back the start position of the selected region
passes back the end position of (e.g. offset immediately past) the selected region
%TRUE if success, %FALSE otherwise
the start position of the selected region
the offset of the first character after the selected region.
%TRUE if success, %FALSE otherwise
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
%TRUE if success, %FALSE otherwise
The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
the new start position of the selection
the new end position of (e.g. offset immediately past) the selection
%TRUE if success, %FALSE otherwise.
position
The offset of the first text character for which boundary information is required.
The offset of the text character after the last character for which boundary information is required.
Specify whether coordinates are relative to the screen or widget window.
A pointer to a AtkTextRectangle which is filled in by this function.
Array of AtkTextRange. The last element of the array returned
An AtkTextRectagle giving the dimensions of the bounding box.
Specify whether coordinates are relative to the screen or widget window.
Specify the horizontal clip type.
Specify the vertical clip type.
A structure used to describe a text range.
A structure used to store a rectangle used by AtkText.
Gets the value of this object.
a #GValue representing the current accessible value
Gets the maximum value of this object.
a #GValue representing the maximum accessible value
Gets the minimum value of this object.
a #GValue representing the minimum accessible value
Sets the value of this object.
%TRUE if new value is successfully set, %FALSE otherwise.
a #GValue which is the desired new accessible value.
Gets the minimum increment by which the value of this object may be changed. If zero,
the minimum increment is undefined, which may mean that it is limited only by the
floating point precision of the platform.
a #GValue representing the minimum increment by which the accessible value may be changed
Gets the value of this object.
a #GValue representing the current accessible value
Gets the maximum value of this object.
a #GValue representing the maximum accessible value
Gets the minimum value of this object.
a #GValue representing the minimum accessible value
Sets the value of this object.
%TRUE if new value is successfully set, %FALSE otherwise.
a #GValue which is the desired new accessible value.
Gets the minimum increment by which the value of this object may be changed. If zero,
the minimum increment is undefined, which may mean that it is limited only by the
floating point precision of the platform.
a #GValue representing the minimum increment by which the accessible value may be changed
a #GValue representing the current accessible value
a #GValue representing the maximum accessible value
a #GValue representing the minimum accessible value
%TRUE if new value is successfully set, %FALSE otherwise.
a #GValue which is the desired new accessible value.
a #GValue representing the minimum increment by which the accessible value may be changed
Adds the specified function to the list of functions to be called
when an object receives focus.
added focus tracker id, or 0 on failure.
Function to be added to the list of functions to be called when an object receives focus.
Adds the specified function to the list of functions to be called
when an event of type event_type occurs.
added event listener id, or 0 on failure.
the listener to notify
the type of event for which notification is requested
Adds the specified function to the list of functions to be called
when a key event occurs. The @data element will be passed to the
#AtkKeySnoopFunc (@listener) as the @func_data param, on notification.
added event listener id, or 0 on failure.
the listener to notify
a #gpointer that points to a block of data that should be sent to the registered listeners, along with the event notification, when it occurs.
Frees the memory used by an #AtkAttributeSet, including all its
#AtkAttributes.
The #AtkAttributeSet to free
Specifies the function to be called for focus tracker initialization.
This function should be called by an implementation of the
ATK interface if any specific work needs to be done to enable
focus tracking.
Function to be called for focus tracker initialization
Cause the focus tracker functions which have been specified to be
executed for the object.
an #AtkObject
Gets the currently focused object.
the currently focused object for the current application
Gets the root accessible container for the current application.
the root accessible container for the current application
Gets name string for the GUI toolkit implementing ATK for this application.
name string for the GUI toolkit implementing ATK for this application
Gets version string for the GUI toolkit implementing ATK for this application.
version string for the GUI toolkit implementing ATK for this application
Gets the current version for ATK.
version string for ATK
Removes the specified focus tracker from the list of functions
to be called when any object receives focus.
the id of the focus tracker to remove
Removes the specified event listener
the id of the event listener to remove
Removes the specified event listener
the id of the event listener to remove
Get the #AtkRole type corresponding to a rolew name.
or #ATK_ROLE_INVALID if no matching role is found.
the #AtkRole enumerated type corresponding to the specified
a string which is the (non-localized) name of an ATK role.
Gets the localized description string describing the #AtkRole @role.
the localized string describing the AtkRole
The #AtkRole whose localized name is required
Gets the description string describing the #AtkRole @role.
the string describing the AtkRole
The #AtkRole whose name is required
Registers the role specified by @name.
an #AtkRole for the new role.
a character string describing the new role.
Gets the #AtkStateType corresponding to the description string @name.
an #AtkStateType corresponding to @name
a character string state name
Gets the description string describing the #AtkStateType @type.
the string describing the AtkStateType
The #AtkStateType whose name is required
Register a new object state.
an #AtkState value for the new state.
a character string describing the new state.
Get the #AtkTextAttribute type corresponding to a text attribute name.
or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found.
the #AtkTextAttribute enumerated type corresponding to the specified
a string which is the (non-localized) name of an ATK text attribute.
Gets the name corresponding to the #AtkTextAttribute
a string containing the name; this string should not be freed
The #AtkTextAttribute whose name is required
Gets the value for the index of the #AtkTextAttribute
NULL is returned if there are no values maintained for the attr value.
a string containing the value; this string should not be freed;
The #AtkTextAttribute for which a value is required
The index of the required value
Associate @name with a new #AtkTextAttribute
an #AtkTextAttribute associated with @name
a name string
Frees the memory associated with an array of AtkTextRange. It is assumed
that the array was returned by the function atk_text_get_bounded_ranges
and is NULL terminated.
A pointer to an array of #AtkTextRange which is to be freed.