Table caption.
Accessible table column description.
Accessible table column header.
Accessible table row description.
Accessible table row header.
Numeric value of this object, in case being and AtkValue.
Adds the specified column to the selection.
a #gint representing a column in table
Adds a relationship of the specified type with the specified target.
The #AtkRelationType of the relation
The #AtkObject which is to be the target of the relation.
Adds the specified row to the selection.
a #gint representing a row in table
Adds the specified accessible child of the object to the object's selection.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Clears the selection in the object so that no children in the object are selected.
Checks whether the specified point is within the extent of the component.
Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
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
Perform the specified action on the object.
the action index corresponding to the action to be performed
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets the accessible id of the accessible.
Returns the alpha value (i.e. the opacity) for this
component, on a scale from 0 (fully transparent) to 1.0
(fully opaque).
Retrieves the value of the given attribute_name inside document.
a character string representing the name of the attribute whose value is being queried.
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.
Get the ranges of text in the specified bounding box.
An AtkTextRectangle 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 offset of the position of the caret (cursor).
Gets the specified text.
a character offset within text
Gets the character count.
If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1.
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.
specify whether coordinates are relative to the screen or widget window
Gets a #gint representing the column at the specified index_.
a #gint representing an index in table
Gets the description text of the specified column in the table
a #gint representing a column in table
Gets the number of columns occupied by the accessible object
at the specified row and column in the table.
a #gint representing a row in table
a #gint representing a column in table
Returns the number of columns occupied by this cell accessible.
Retrieves the current page number inside document.
Gets the value of this object.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Creates an #AtkAttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned.
Returns a description of the specified action of the object.
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.
Gets a string indicating the document type.
Gets the rectangle which gives the extent of the component.
If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.
specifies whether the coordinates are relative to the screen or to the components top level window
Get a textual description of this image.
Retrieves the locale identifier associated to the #AtkImage.
Gets the position of the image in the form of a point specifying the images top-left corner.
If the position can not be obtained (e.g. missing support), x and y are set to -1.
specifies whether the coordinates are relative to the screen or to the components top level window
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).
If the size can not be obtained (e.g. missing support), x and y are set to -1.
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.
Gets a #gint representing the index at the specified row and
column.
a #gint representing a row in table
a #gint representing a column in table
Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut".
Example: For a traditional "New..." menu item, the expected return value would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.
the action index corresponding to the action to be performed
Gets the index into the array of hyperlinks that is associated with
the character specified by char_index.
a character index
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.
Returns the localized name of the specified action of the object.
the action index corresponding to the action to be performed
Gets the maximum value of this object.
Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.
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.
Gets the minimum value of this object.
Gets the number of accessible children of the accessible.
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.
Gets the number of columns in the table.
Gets the number of links within this hypertext document.
Gets the number of rows in the table.
Gets the number of selected regions.
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 interaction techniques of the same name: i.e. "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.
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of accessible.
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.
screen x-position of character
screen y-position of character
specify whether coordinates are relative to the screen or widget window
Retrieves the total number of pages inside document.
Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk_object_set_parent(), and will return it with this method.
If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent().
Gets the position of component in the form of
a point specifying component's top-left corner.
If the position can not be obtained (e.g. a non-embedded plug or missing support), x and y are set to -1.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Get the bounding box for text within the specified range.
If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1.
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.
Gets a #gint representing the row at the specified index_.
a #gint representing an index in table
Gets the row and column indexes and span of this cell accessible.
Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object.
Gets the description text of the specified row in the table
a #gint representing a row in table
Gets the number of rows occupied by the accessible object
at a specified row and column in the table.
a #gint representing a row in table
a #gint representing a column in table
Returns the number of rows occupied by this cell accessible.
Creates an #AtkAttributeSet which consists of the attributes explicitly
set at the position offset in the text. start_offset and end_offset are
set to the start and end of the range around offset where the attributes are
invariant. Note that end_offset is the offset of the first character
after the range. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be
returned.
the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location.
Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.
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.
a #gint** that is to contain the selected row numbers
Gets the text from the specified selection.
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.
Gets the number of accessible children currently selected. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.
Gets the size of the component in terms of width and height.
If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.
Gets a portion of the text exposed through an #AtkText according to a given offset
and a specific granularity, along with the start and end offsets defining the
boundaries of such a portion of text.
If granularity is ATK_TEXT_GRANULARITY_CHAR the character at the
offset is returned.
If granularity is ATK_TEXT_GRANULARITY_WORD 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 granularity is ATK_TEXT_GRANULARITY_SENTENCE 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 granularity is ATK_TEXT_GRANULARITY_LINE the returned string
is from the line start at or before the offset to the line
start after the offset.
If granularity is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string
is from the start of the paragraph at or before the offset to the start
of the following paragraph after the offset.
position
An #AtkTextGranularity
Gets the specified text.
a starting character offset within text
an ending character offset within text, or -1 for the end of the string.
Gets the specified text.
position
An #AtkTextBoundary
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_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_LINE_START the returned string is from the line start at or before the offset to the line start after the offset.
position
An #AtkTextBoundary
Gets the specified text.
position
An #AtkTextBoundary
Gets the current value and the human readable text alternative of
obj. text is a newly created string, that must be freed by the
caller. Can be NULL if no descriptor is available.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Grabs focus for this component.
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.
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.
Determines if the current child of this object is selected Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.
a #gint specifying the child index.
Gets a boolean value indicating whether the specified column
is selected
a #gint representing a column in table
Checks whether object has a [floating][floating-ref] reference.
Gets a boolean value indicating whether the specified row
is selected
a #gint representing a row in table
Gets a boolean value indicating whether the accessible object
at the specified row and column is selected
a #gint representing a row in table
a #gint representing a column in table
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Emits a state-change signal for the specified state.
Note that as a general rule when the state of an existing object changes, emitting a notification is expected.
an #AtkState whose state is changed
a gboolean which indicates whether the state is being set on or off
Paste text from clipboard to specified position.
position to paste
Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns %NULL.
This method is intended as an utility for ATK implementors, and not to be exposed to accessible tools. See atk_object_get_parent() for further reference.
Gets a reference to the accessible child, if one exists, at the
coordinate point specified by x and y.
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the #AtkRelationSet associated with the object.
Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Adds the specified column to the selection.
a #gint representing a column in table
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
Removes a property change handler.
a guint which identifies the handler to be removed.
Removes a relationship of the specified type with the specified target.
The #AtkRelationType of the relation
The #AtkObject which is the target of the relation to be removed.
Removes the specified row from the selection.
a #gint representing a row in table
Removes the specified child of the object from the object's selection.
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Makes a substring of text visible on the screen by scrolling all necessary parents.
start offset in the text
end offset in the text, or -1 for the end of the text.
specify where the object should be made visible.
Move the top-left of a substring of text to a given position of the screen
by scrolling all necessary parents.
start offset in the text
end offset in the text, or -1 for the end of the text.
specify whether coordinates are relative to the screen or to the parent object.
x-position where to scroll to
y-position where to scroll to
Makes component visible on the screen by scrolling all necessary parents.
Contrary to atk_component_set_position, this does not actually move
component in its parent, this only makes the parents scroll so that the
object shows up on the screen, given its current position within the parents.
specify where the object should be made visible.
Move the top-left of component to a given position of the screen by
scrolling all necessary parents.
specify whether coordinates are relative to the screen or to the parent object.
x-position where to scroll to
y-position where to scroll to
Causes every child of the object to be selected if the object supports multiple selections.
Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.
a character string to be set as the accessible id
Sets the value for the given attribute_name inside document.
a character string representing the name of the attribute whose value is being set.
a string value to be associated with attribute_name.
Sets the caret (cursor) position to the specified offset.
In the case of rich-text content, this method should either grab focus or move the sequential focus navigation starting point (if the application supports this concept) as if the user had clicked on the new caret position. Typically, this means that the target of this operation is the node containing the new caret position or one of its ancestors. In other words, after this method is called, if the user advances focus, it should move to the first focusable node following the new caret position.
Calling this method should also scroll the application viewport in a way that matches the behavior of the application's typical caret motion or tab navigation as closely as possible. This also means that if the application's caret motion or focus navigation does not trigger a scroll operation, this method should not trigger one either. If the application does not have a caret motion or focus navigation operation, this method should try to scroll the new caret position into view while minimizing unnecessary scroll motion.
the character offset of the new caret position
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 value of this object.
a #GValue which is the desired new accessible value.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets a description of the specified action of the object.
Sets the extents of component.
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 textual description for this image.
a string description to set for image
Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
a character string to be set as the accessible name
Sets the position of component.
Contrary to atk_component_scroll_to, this does not trigger any scrolling,
this just moves component in its parent.
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the component's top level window
Sets a property on an object.
the name of the property to set
the value
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 attributes for a specified range. See the ATK_ATTRIBUTE macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets.
an #AtkAttributeSet
start of range in which to set attributes
end of range in which to set attributes
Changes the start and end offset of the specified selection.
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 starting character offset of the selection
the new end position of (e.g. offset immediately past) the selection
Set the size of the component in terms of width and height.
width to set for component
height to set for component
Set text contents of text.
string to set for text contents of text
Sets the value of this object.
This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an #AtkValue::value-changed signal emission.
Note for implementors: the deprecated atk_value_set_current_value() method returned TRUE or FALSE depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned TRUE in any case. For that reason it is not required anymore to return if the value was properly assigned or not.
a double which is the desired new accessible value.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Adds the specified column to the selection.
a #gint representing a column in table
Adds the specified row to the selection.
a #gint representing a row in table
Adds the specified accessible child of the object to the object's selection.
Clears the selection in the object so that no children in the object are selected.
Checks whether the specified point is within the extent of the component.
Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
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
Perform the specified action on the object.
the action index corresponding to the action to be performed
Returns the alpha value (i.e. the opacity) for this
component, on a scale from 0 (fully transparent) to 1.0
(fully opaque).
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.
Get the ranges of text in the specified bounding box.
An AtkTextRectangle 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 offset of the position of the caret (cursor).
Gets the specified text.
a character offset within text
Gets the character count.
If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1.
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.
specify whether coordinates are relative to the screen or widget window
Gets a #gint representing the column at the specified index_.
a #gint representing an index in table
Gets the description text of the specified column in the table
a #gint representing a column in table
Gets the number of columns occupied by the accessible object
at the specified row and column in the table.
a #gint representing a row in table
a #gint representing a column in table
Returns the number of columns occupied by this cell accessible.
Retrieves the current page number inside document.
Gets the value of this object.
Creates an #AtkAttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned.
Returns a description of the specified action of the object.
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.
Retrieves the value of the given attribute_name inside document.
a character string representing the name of the attribute whose value is being queried.
Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.
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.
Gets a string indicating the document type.
Gets the rectangle which gives the extent of the component.
If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.
specifies whether the coordinates are relative to the screen or to the components top level window
Get a textual description of this image.
Retrieves the locale identifier associated to the #AtkImage.
Gets the position of the image in the form of a point specifying the images top-left corner.
If the position can not be obtained (e.g. missing support), x and y are set to -1.
specifies whether the coordinates are relative to the screen or to the components top level window
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).
If the size can not be obtained (e.g. missing support), x and y are set to -1.
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.
Gets a #gint representing the index at the specified row and
column.
a #gint representing a row in table
a #gint representing a column in table
Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut".
Example: For a traditional "New..." menu item, the expected return value would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.
the action index corresponding to the action to be performed
Gets the index into the array of hyperlinks that is associated with
the character specified by char_index.
a character index
Returns the localized name of the specified action of the object.
the action index corresponding to the action to be performed
Gets the maximum value of this object.
Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.
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.
Gets the minimum value of this object.
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.
Gets the number of columns in the table.
Gets the number of links within this hypertext document.
Gets the number of rows in the table.
Gets the number of selected regions.
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 interaction techniques of the same name: i.e. "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.
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of accessible.
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.
screen x-position of character
screen y-position of character
specify whether coordinates are relative to the screen or widget window
Retrieves the total number of pages inside document.
Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk_object_set_parent(), and will return it with this method.
If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent().
Gets the position of component in the form of
a point specifying component's top-left corner.
If the position can not be obtained (e.g. a non-embedded plug or missing support), x and y are set to -1.
Get the bounding box for text within the specified range.
If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1.
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.
Gets a #gint representing the row at the specified index_.
a #gint representing an index in table
Gets the row and column indexes and span of this cell accessible.
Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object.
Gets the description text of the specified row in the table
a #gint representing a row in table
Gets the number of rows occupied by the accessible object
at a specified row and column in the table.
a #gint representing a row in table
a #gint representing a column in table
Returns the number of rows occupied by this cell accessible.
Creates an #AtkAttributeSet which consists of the attributes explicitly
set at the position offset in the text. start_offset and end_offset are
set to the start and end of the range around offset where the attributes are
invariant. Note that end_offset is the offset of the first character
after the range. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be
returned.
the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location.
Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.
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.
a #gint** that is to contain the selected row numbers
Gets the text from the specified selection.
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.
Gets the number of accessible children currently selected. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.
Gets the size of the component in terms of width and height.
If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.
Gets a portion of the text exposed through an #AtkText according to a given offset
and a specific granularity, along with the start and end offsets defining the
boundaries of such a portion of text.
If granularity is ATK_TEXT_GRANULARITY_CHAR the character at the
offset is returned.
If granularity is ATK_TEXT_GRANULARITY_WORD 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 granularity is ATK_TEXT_GRANULARITY_SENTENCE 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 granularity is ATK_TEXT_GRANULARITY_LINE the returned string
is from the line start at or before the offset to the line
start after the offset.
If granularity is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string
is from the start of the paragraph at or before the offset to the start
of the following paragraph after the offset.
position
An #AtkTextGranularity
Gets the specified text.
a starting character offset within text
an ending character offset within text, or -1 for the end of the string.
Gets the specified text.
position
An #AtkTextBoundary
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_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_LINE_START the returned string is from the line start at or before the offset to the line start after the offset.
position
An #AtkTextBoundary
Gets the specified text.
position
An #AtkTextBoundary
Gets the current value and the human readable text alternative of
obj. text is a newly created string, that must be freed by the
caller. Can be NULL if no descriptor is available.
Grabs focus for this component.
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.
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.
Determines if the current child of this object is selected Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.
a #gint specifying the child index.
Gets a boolean value indicating whether the specified column
is selected
a #gint representing a column in table
Gets a boolean value indicating whether the specified row
is selected
a #gint representing a row in table
Gets a boolean value indicating whether the accessible object
at the specified row and column is selected
a #gint representing a row in table
a #gint representing a column in table
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
Paste text from clipboard to specified position.
position to paste
Gets a reference to the accessible child, if one exists, at the
coordinate point specified by x and y.
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the components top level window
Gets the #AtkRelationSet associated with the object.
Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on %NULL or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Adds the specified column to the selection.
a #gint representing a column in table
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
Removes a property change handler.
a guint which identifies the handler to be removed.
Removes the specified row from the selection.
a #gint representing a row in table
Removes the specified child of the object from the object's selection.
a #gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).
Makes a substring of text visible on the screen by scrolling all necessary parents.
start offset in the text
end offset in the text, or -1 for the end of the text.
specify where the object should be made visible.
Move the top-left of a substring of text to a given position of the screen
by scrolling all necessary parents.
start offset in the text
end offset in the text, or -1 for the end of the text.
specify whether coordinates are relative to the screen or to the parent object.
x-position where to scroll to
y-position where to scroll to
Makes component visible on the screen by scrolling all necessary parents.
Contrary to atk_component_set_position, this does not actually move
component in its parent, this only makes the parents scroll so that the
object shows up on the screen, given its current position within the parents.
specify where the object should be made visible.
Move the top-left of component to a given position of the screen by
scrolling all necessary parents.
specify whether coordinates are relative to the screen or to the parent object.
x-position where to scroll to
y-position where to scroll to
Causes every child of the object to be selected if the object supports multiple selections.
Sets the caret (cursor) position to the specified offset.
In the case of rich-text content, this method should either grab focus or move the sequential focus navigation starting point (if the application supports this concept) as if the user had clicked on the new caret position. Typically, this means that the target of this operation is the node containing the new caret position or one of its ancestors. In other words, after this method is called, if the user advances focus, it should move to the first focusable node following the new caret position.
Calling this method should also scroll the application viewport in a way that matches the behavior of the application's typical caret motion or tab navigation as closely as possible. This also means that if the application's caret motion or focus navigation does not trigger a scroll operation, this method should not trigger one either. If the application does not have a caret motion or focus navigation operation, this method should try to scroll the new caret position into view while minimizing unnecessary scroll motion.
the character offset of the new caret position
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 value of this object.
a #GValue which is the desired new accessible value.
Sets a description of the specified action of the object.
Sets the value for the given attribute_name inside document.
a character string representing the name of the attribute whose value is being set.
a string value to be associated with attribute_name.
Sets the extents of component.
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 textual description for this image.
a string description to set for image
Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
a character string to be set as the accessible name
Sets the position of component.
Contrary to atk_component_scroll_to, this does not trigger any scrolling,
this just moves component in its parent.
x coordinate
y coordinate
specifies whether the coordinates are relative to the screen or to the component's top level window
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 attributes for a specified range. See the ATK_ATTRIBUTE macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets.
an #AtkAttributeSet
start of range in which to set attributes
end of range in which to set attributes
Changes the start and end offset of the specified selection.
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 starting character offset of the selection
the new end position of (e.g. offset immediately past) the selection
Set the size of the component in terms of width and height.
width to set for component
height to set for component
Set text contents of text.
string to set for text contents of text
Sets the value of this object.
This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an #AtkValue::value-changed signal emission.
Note for implementors: the deprecated atk_value_set_current_value() method returned TRUE or FALSE depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned TRUE in any case. For that reason it is not required anymore to return if the value was properly assigned or not.
a double which is the desired new accessible value.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Provides a default (non-functioning stub) #AtkObject. Application maintainers should not use this method.
Provides a default (non-functioning stub) #AtkObject. Application maintainers should not use this method.
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Provides a default (non-functioning stub) #AtkObject. Application maintainers should not use this method.