[atkmm] Regenerated *_docs.xml file.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [atkmm] Regenerated *_docs.xml file.
- Date: Tue, 24 Mar 2015 19:02:52 +0000 (UTC)
commit c44833ce49573f6cd31956b98cd7fd82ad38466c
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Mar 24 19:48:49 2015 +0100
Regenerated *_docs.xml file.
atk/src/atk_docs.xml | 1816 +++++++++++++++++++++++++++++++++++++-------------
1 files changed, 1343 insertions(+), 473 deletions(-)
---
diff --git a/atk/src/atk_docs.xml b/atk/src/atk_docs.xml
index 84aa935..1424f71 100644
--- a/atk/src/atk_docs.xml
+++ b/atk/src/atk_docs.xml
@@ -1,4 +1,23 @@
<root>
+<signal name="AtkComponent::bounds-changed">
+<description>
+The 'bounds-changed" signal is emitted when the bposition or
+size of the component changes.
+
+</description>
+<parameters>
+<parameter name="atkcomponent">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="arg1">
+<parameter_description> The AtkRectangle giving the new position and size.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<enum name="AtkCoordType">
<description>
Specifies how xy coordinates are to be interpreted. Used by functions such
@@ -18,6 +37,102 @@ top-level window
</parameters>
</enum>
+<signal name="AtkDocument::load-complete">
+<description>
+The 'load-complete' signal is emitted when a pending load of
+a static document has completed. This signal is to be
+expected by ATK clients if and when AtkDocument implementors
+expose ATK_STATE_BUSY. If the state of an AtkObject which
+implements AtkDocument does not include ATK_STATE_BUSY, it
+should be safe for clients to assume that the AtkDocument's
+static contents are fully loaded into the container.
+(Dynamic document contents should be exposed via other
+signals.)
+
+</description>
+<parameters>
+<parameter name="atkdocument">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkDocument::load-stopped">
+<description>
+The 'load-stopped' signal is emitted when a pending load of
+document contents is cancelled, paused, or otherwise
+interrupted by the user or application logic. It should not
+however be emitted while waiting for a resource (for instance
+while blocking on a file or network read) unless a
+user-significant timeout has occurred.
+
+</description>
+<parameters>
+<parameter name="atkdocument">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkDocument::page-changed">
+<description>
+The 'page-changed' signal is emitted when the current page of
+a document changes, e.g. pressing page up/down in a document
+viewer.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="atkdocument">
+<parameter_description> the object on which the signal was emitted
+</parameter_description>
+</parameter>
+<parameter name="page_number">
+<parameter_description> the new page number. If this value is unknown
+or not applicable, -1 should be provided.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkDocument::reload">
+<description>
+The 'reload' signal is emitted when the contents of a
+document is refreshed from its source. Once 'reload' has
+been emitted, a matching 'load-complete' or 'load-stopped'
+signal should follow, which clients may await before
+interrogating ATK for the latest document content.
+
+</description>
+<parameters>
+<parameter name="atkdocument">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkHyperlink::link-activated">
+<description>
+The signal link-activated is emitted when a link is activated.
+
+</description>
+<parameters>
+<parameter name="atkhyperlink">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<enum name="AtkHyperlinkStateFlags">
<description>
Describes the type of link
@@ -31,6 +146,26 @@ Describes the type of link
</parameters>
</enum>
+<signal name="AtkHypertext::link-selected">
+<description>
+The "link-selected" signal is emitted by an AtkHyperText
+object when one of the hyperlinks associated with the object
+is selected.
+
+</description>
+<parameters>
+<parameter name="atkhypertext">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="arg1">
+<parameter_description> the index of the hyperlink which is selected
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<enum name="AtkKeyEventType">
<description>
Specifies the type of a keyboard evemt.
@@ -97,6 +232,148 @@ determinations of when components occlude one another.
</parameters>
</enum>
+<signal name="AtkObject::active-descendant-changed">
+<description>
+The "active-descendant-changed" signal is emitted by an object
+which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus
+object in the object changes. For instance, a table will emit the
+signal when the cell in the table which has focus changes.
+
+</description>
+<parameters>
+<parameter name="atkobject">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="arg1">
+<parameter_description> the newly focused object.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkObject::children-changed">
+<description>
+The signal "children-changed" is emitted when a child is added or
+removed form an object. It supports two details: "add" and
+"remove"
+
+</description>
+<parameters>
+<parameter name="atkobject">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="arg1">
+<parameter_description> The index of the added or removed child. The value can be
+-1. This is used if the value is not known by the implementor
+when the child is added/removed or irrelevant.
+</parameter_description>
+</parameter>
+<parameter name="arg2">
+<parameter_description> A gpointer to the child AtkObject which was added or
+removed. If the child was removed, it is possible that it is not
+available for the implementor. In that case this pointer can be
+NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkObject::focus-event">
+<description>
+The signal "focus-event" is emitted when an object gained or lost
+focus.
+
+Deprecated: 2.9.4: Use #AtkObject::state-change signal instead.
+
+</description>
+<parameters>
+<parameter name="atkobject">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
+<parameter name="arg1">
+<parameter_description> a boolean value which indicates whether the object gained
+or lost focus.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkObject::property-change">
+<description>
+The signal "property-change" is emitted when an object's property
+value changes. @arg1 contains an #AtkPropertyValues with the name
+and the new value of the property whose value has changed. Note
+that, as with GObject notify, getting this signal does not
+guarantee that the value of the property has actually changed; it
+may also be emitted when the setter of the property is called to
+reinstate the previous value.
+
+Toolkit implementor note: ATK implementors should use
+g_object_notify() to emit property-changed
+notifications. #AtkObject::property-changed is needed by the
+implementation of atk_add_global_event_listener() because GObject
+notify doesn't support emission hooks.
+
+</description>
+<parameters>
+<parameter name="atkobject">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="arg1">
+<parameter_description> an #AtkPropertyValues containing the new value of the
+property which changed.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkObject::state-change">
+<description>
+The "state-change" signal is emitted when an object's state
+changes. The detail value identifies the state type which has
+changed.
+
+</description>
+<parameters>
+<parameter name="atkobject">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="arg1">
+<parameter_description> The name of the state which has changed
+</parameter_description>
+</parameter>
+<parameter name="arg2">
+<parameter_description> A boolean which indicates whether the state has been set or unset.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkObject::visible-data-changed">
+<description>
+The "visible-data-changed" signal is emitted when the visual
+appearance of the object changed.
+
+</description>
+<parameters>
+<parameter name="atkobject">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<enum name="AtkRelationType">
<description>
Describes the type of the relation
@@ -183,439 +460,298 @@ this object's content is visualy embedded in another object.
</parameters>
</enum>
-<enum name="AtkRole">
+<signal name="AtkSelection::selection-changed">
<description>
-Describes the role of an object
-
-These are the built-in enumerated roles that UI components can have in
-ATK. Other roles may be added at runtime, so an AtkRole >=
-ATK_ROLE_LAST_DEFINED is not necessarily an error.
+The "selection-changed" signal is emitted by an object which
+implements AtkSelection interface when the selection changes.
</description>
<parameters>
-<parameter name="ATK_ROLE_INVALID">
-<parameter_description> Invalid role
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_ACCEL_LABEL">
-<parameter_description> A label which represents an accelerator
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_ALERT">
-<parameter_description> An object which is an alert to the user. Assistive Technologies typically respond to
ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used
for warning dialogs, etc.
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_ANIMATION">
-<parameter_description> An object which is an animated image
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_ARROW">
-<parameter_description> An arrow in one of the four cardinal directions
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_CALENDAR">
-<parameter_description> An object that displays a calendar and allows the user to select a date
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_CANVAS">
-<parameter_description> An object that can be drawn into and is used to trap events
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_CHECK_BOX">
-<parameter_description> A choice that can be checked or unchecked and provides a separate indicator for the
current state
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_CHECK_MENU_ITEM">
-<parameter_description> A menu item with a check box
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_COLOR_CHOOSER">
-<parameter_description> A specialized dialog that lets the user choose a color
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_COLUMN_HEADER">
-<parameter_description> The header for a column of data
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_COMBO_BOX">
-<parameter_description> A collapsible list of choices the user can select from
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_DATE_EDITOR">
-<parameter_description> An object whose purpose is to allow a user to edit a date
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_DESKTOP_ICON">
-<parameter_description> An inconifed internal frame within a DESKTOP_PANE
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_DESKTOP_FRAME">
-<parameter_description> A pane that supports internal frames and iconified versions of those internal frames
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_DIAL">
-<parameter_description> An object whose purpose is to allow a user to set a value
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_DIALOG">
-<parameter_description> A top level window with title bar and a border
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_DIRECTORY_PANE">
-<parameter_description> A pane that allows the user to navigate through and select the contents of a
directory
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_DRAWING_AREA">
-<parameter_description> An object used for drawing custom user interface elements
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_FILE_CHOOSER">
-<parameter_description> A specialized dialog that lets the user choose a file
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_FILLER">
-<parameter_description> A object that fills up space in a user interface
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_FONT_CHOOSER">
-<parameter_description> A specialized dialog that lets the user choose a font
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_FRAME">
-<parameter_description> A top level window with a title bar, border, menubar, etc.
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_GLASS_PANE">
-<parameter_description> A pane that is guaranteed to be painted on top of all panes beneath it
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_HTML_CONTAINER">
-<parameter_description> A document container for HTML, whose children represent the document content
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_ICON">
-<parameter_description> A small fixed size picture, typically used to decorate components
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_IMAGE">
-<parameter_description> An object whose primary purpose is to display an image
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_INTERNAL_FRAME">
-<parameter_description> A frame-like object that is clipped by a desktop pane
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_LABEL">
-<parameter_description> An object used to present an icon or short string in an interface
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_LAYERED_PANE">
-<parameter_description> A specialized pane that allows its children to be drawn in layers, providing a form
of stacking order
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_LIST">
-<parameter_description> An object that presents a list of objects to the user and allows the user to select
one or more of them
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_LIST_ITEM">
-<parameter_description> An object that represents an element of a list
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_MENU">
-<parameter_description> An object usually found inside a menu bar that contains a list of actions the user
can choose from
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_MENU_BAR">
-<parameter_description> An object usually drawn at the top of the primary dialog box of an application that
contains a list of menus the user can choose from
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_MENU_ITEM">
-<parameter_description> An object usually contained in a menu that presents an action the user can choose
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_OPTION_PANE">
-<parameter_description> A specialized pane whose primary use is inside a DIALOG
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_PAGE_TAB">
-<parameter_description> An object that is a child of a page tab list
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_PAGE_TAB_LIST">
-<parameter_description> An object that presents a series of panels (or page tabs), one at a time, through
some mechanism provided by the object
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_PANEL">
-<parameter_description> A generic container that is often used to group objects
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_PASSWORD_TEXT">
-<parameter_description> A text object uses for passwords, or other places where the text content is not
shown visibly to the user
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_POPUP_MENU">
-<parameter_description> A temporary window that is usually used to offer the user a list of choices, and
then hides when the user selects one of those choices
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_PROGRESS_BAR">
-<parameter_description> An object used to indicate how much of a task has been completed
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_PUSH_BUTTON">
-<parameter_description> An object the user can manipulate to tell the application to do something
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_RADIO_BUTTON">
-<parameter_description> A specialized check box that will cause other radio buttons in the same group to
become unchecked when this one is checked
+<parameter name="atkselection">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_RADIO_MENU_ITEM">
-<parameter_description> A check menu item which belongs to a group. At each instant exactly one of the radio
menu items from a group is selected
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_ROOT_PANE">
-<parameter_description> A specialized pane that has a glass pane and a layered pane as its children
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_ROW_HEADER">
-<parameter_description> The header for a row of data
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_SCROLL_BAR">
-<parameter_description> An object usually used to allow a user to incrementally view a large amount of data.
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_SCROLL_PANE">
-<parameter_description> An object that allows a user to incrementally view a large amount of information
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_SEPARATOR">
-<parameter_description> An object usually contained in a menu to provide a visible and logical separation of
the contents in a menu
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_SLIDER">
-<parameter_description> An object that allows the user to select from a bounded range
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_SPLIT_PANE">
-<parameter_description> A specialized panel that presents two other panels at the same time
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_SPIN_BUTTON">
-<parameter_description> An object used to get an integer or floating point number from the user
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_STATUSBAR">
-<parameter_description> An object which reports messages of minor importance to the user
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TABLE">
-<parameter_description> An object used to represent information in terms of rows and columns
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TABLE_CELL">
-<parameter_description> A cell in a table
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TABLE_COLUMN_HEADER">
-<parameter_description> The header for a column of a table
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TABLE_ROW_HEADER">
-<parameter_description> The header for a row of a table
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TEAR_OFF_MENU_ITEM">
-<parameter_description> A menu item used to tear off and reattach its menu
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TERMINAL">
-<parameter_description> An object that represents an accessible terminal. @Since: ATK-0.6
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TEXT">
-<parameter_description> An object that presents text to the user
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TOGGLE_BUTTON">
-<parameter_description> A specialized push button that can be checked or unchecked, but does not provide a
separate indicator for the current state
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TOOL_BAR">
-<parameter_description> A bar or palette usually composed of push buttons or toggle buttons
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TOOL_TIP">
-<parameter_description> An object that provides information about another object
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TREE">
-<parameter_description> An object used to represent hierarchical information to the user
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_TREE_TABLE">
-<parameter_description> An object capable of expanding and collapsing rows as well as showing multiple
columns of data. @Since: ATK-0.7
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_UNKNOWN">
-<parameter_description> The object contains some Accessible information, but its role is not known
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_VIEWPORT">
-<parameter_description> An object usually used in a scroll pane
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_WINDOW">
-<parameter_description> A top level window with no title or border.
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_HEADER">
-<parameter_description> An object that serves as a document header. @Since: ATK-1.1.1
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_FOOTER">
-<parameter_description> An object that serves as a document footer. @Since: ATK-1.1.1
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_PARAGRAPH">
-<parameter_description> An object which is contains a paragraph of text content. @Since: ATK-1.1.1
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_RULER">
-<parameter_description> An object which describes margins and tab stops, etc. for text objects which it
controls (should have CONTROLLER_FOR relation to such). @Since: ATK-1.1.1
-</parameter_description>
-</parameter>
-<parameter name="ATK_ROLE_APPLICATION">
-<parameter_description> The object is an application object, which may contain @ATK_ROLE_FRAME objects or
other types of accessibles. The root accessible of any application's ATK hierarchy should have
ATK_ROLE_APPLICATION. @Since: ATK-1.1.4
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkTable::column-deleted">
+<description>
+The "column-deleted" signal is emitted by an object which
+implements the AtkTable interface when a column is deleted.
+
+</description>
+<parameters>
+<parameter name="atktable">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_AUTOCOMPLETE">
-<parameter_description> The object is a dialog or list containing items for insertion into an entry widget,
for instance a list of words for completion of a text entry. @Since: ATK-1.3
+<parameter name="arg1">
+<parameter_description> The index of the first column deleted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_EDITBAR">
-<parameter_description> The object is an editable text object in a toolbar. @Since: ATK-1.5
+<parameter name="arg2">
+<parameter_description> The number of columns deleted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_EMBEDDED">
-<parameter_description> The object is an embedded container within a document or panel. This role is a
grouping "hint" indicating that the contained objects share a context. @Since: ATK-1.7.2
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkTable::column-inserted">
+<description>
+The "column-inserted" signal is emitted by an object which
+implements the AtkTable interface when a column is inserted.
+
+</description>
+<parameters>
+<parameter name="atktable">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_ENTRY">
-<parameter_description> The object is a component whose textual content may be entered or modified by the
user, provided @ATK_STATE_EDITABLE is present. @Since: ATK-1.11
+<parameter name="arg1">
+<parameter_description> The index of the column inserted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_CHART">
-<parameter_description> The object is a graphical depiction of quantitative data. It may contain multiple
subelements whose attributes and/or description may be queried to obtain both the quantitative data and
information about how the data is being presented. The LABELLED_BY relation is particularly important in
interpreting objects of this type, as is the accessible-description property. @Since: ATK-1.11
+<parameter name="arg2">
+<parameter_description> The number of colums inserted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_CAPTION">
-<parameter_description> The object contains descriptive information, usually textual, about another user
interface element such as a table, chart, or image. @Since: ATK-1.11
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkTable::column-reordered">
+<description>
+The "column-reordered" signal is emitted by an object which
+implements the AtkTable interface when the columns are
+reordered.
+
+</description>
+<parameters>
+<parameter name="atktable">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_DOCUMENT_FRAME">
-<parameter_description> The object is a visual frame or container which contains a view of document content.
Document frames may occur within another Document instance, in which case the second document may be said to
be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a
singleton descendant, should implement the Document interface. @Since: ATK-1.11
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkTable::model-changed">
+<description>
+The "model-changed" signal is emitted by an object which
+implements the AtkTable interface when the model displayed by
+the table changes.
+
+</description>
+<parameters>
+<parameter name="atktable">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_HEADING">
-<parameter_description> The object serves as a heading for content which follows it in a document. The
'heading level' of the heading, if availabe, may be obtained by querying the object's attributes.
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkTable::row-deleted">
+<description>
+The "row-deleted" signal is emitted by an object which
+implements the AtkTable interface when a row is deleted.
+
+</description>
+<parameters>
+<parameter name="atktable">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_PAGE">
-<parameter_description> The object is a containing instance which encapsulates a page of information.
@ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. @Since: ATK-1.11
+<parameter name="arg1">
+<parameter_description> The index of the first row deleted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_SECTION">
-<parameter_description> The object is a containing instance of document content which constitutes a
particular 'logical' section of the document. The type of content within a section, and the nature of the
section division itself, may be obtained by querying the object's attributes. Sections may be nested. @Since:
ATK-1.11
+<parameter name="arg2">
+<parameter_description> The number of rows deleted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_REDUNDANT_OBJECT">
-<parameter_description> The object is redundant with another object in the hierarchy, and is exposed for
purely technical reasons. Objects of this role should normally be ignored by clients. @Since: ATK-1.11
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkTable::row-inserted">
+<description>
+The "row-inserted" signal is emitted by an object which
+implements the AtkTable interface when a row is inserted.
+
+</description>
+<parameters>
+<parameter name="atktable">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_FORM">
-<parameter_description> The object is a container for form controls, for instance as part of a
-web form or user-input form within a document. This role is primarily a tag/convenience for
-clients when navigating complex documents, it is not expected that ordinary GUI containers will
-always have ATK_ROLE_FORM. @Since: ATK-1.12.0
+<parameter name="arg1">
+<parameter_description> The index of the first row inserted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_LINK">
-<parameter_description> The object is a hypertext anchor, i.e. a "link" in a
-hypertext document. Such objects are distinct from 'inline'
-content which may also use the Hypertext/Hyperlink interfaces
-to indicate the range/location within a text object where
-an inline or embedded object lies. @Since: ATK-1.12.1
+<parameter name="arg2">
+<parameter_description> The number of rows inserted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_INPUT_METHOD_WINDOW">
-<parameter_description> The object is a window or similar viewport
-which is used to allow composition or input of a 'complex character',
-in other words it is an "input method window." @Since: ATK-1.12.1
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkTable::row-reordered">
+<description>
+The "row-reordered" signal is emitted by an object which
+implements the AtkTable interface when the rows are
+reordered.
+
+</description>
+<parameters>
+<parameter name="atktable">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_TABLE_ROW">
-<parameter_description> A row in a table. @Since: ATK-2.1.0
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkText::text-attributes-changed">
+<description>
+The "text-attributes-changed" signal is emitted when the text
+attributes of the text of an object which implements AtkText
+changes.
+
+</description>
+<parameters>
+<parameter name="atktext">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_TREE_ITEM">
-<parameter_description> An object that represents an element of a tree. @Since: ATK-2.1.0
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkText::text-caret-moved">
+<description>
+The "text-caret-moved" signal is emitted when the caret
+position of the text of an object which implements AtkText
+changes.
+
+</description>
+<parameters>
+<parameter name="atktext">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_DOCUMENT_SPREADSHEET">
-<parameter_description> A document frame which contains a spreadsheet. @Since: ATK-2.1.0
+<parameter name="arg1">
+<parameter_description> The new position of the text caret.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_DOCUMENT_PRESENTATION">
-<parameter_description> A document frame which contains a presentation or slide content. @Since: ATK-2.1.0
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkText::text-changed">
+<description>
+The "text-changed" signal is emitted when the text of the
+object which implements the AtkText interface changes, This
+signal will have a detail which is either "insert" or
+"delete" which identifies whether the text change was an
+insertion or a deletion.
+
+Deprecated: 2.9.4: Use #AtkObject::text-insert or
+#AtkObject::text-remove instead.
+
+</description>
+<parameters>
+<parameter name="atktext">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_DOCUMENT_TEXT">
-<parameter_description> A document frame which contains textual content, such as found in a word processing
application. @Since: ATK-2.1.0
+<parameter name="arg1">
+<parameter_description> The position (character offset) of the insertion or deletion.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_DOCUMENT_WEB">
-<parameter_description> A document frame which contains HTML or other markup suitable for display in a web
browser. @Since: ATK-2.1.0
+<parameter name="arg2">
+<parameter_description> The length (in characters) of text inserted or deleted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_DOCUMENT_EMAIL">
-<parameter_description> A document frame which contains email content to be displayed or composed either in
plain text or HTML. @Since: ATK-2.1.0
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkText::text-insert">
+<description>
+The "text-insert" signal is emitted when a new text is
+inserted. If the signal was not triggered by the user
+(e.g. typing or pasting text), the "system" detail should be
+included.
+
+</description>
+<parameters>
+<parameter name="atktext">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_COMMENT">
-<parameter_description> An object found within a document and designed to present a comment, note, or other
annotation. In some cases, this object might not be visible until activated. @Since: ATK-2.1.0
+<parameter name="arg1">
+<parameter_description> The position (character offset) of the insertion.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_LIST_BOX">
-<parameter_description> A non-collapsible list of choices the user can select from. @Since: ATK-2.1.0
+<parameter name="arg2">
+<parameter_description> The length (in characters) of text inserted.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_GROUPING">
-<parameter_description> A group of related widgets. This group typically has a label. @Since: ATK-2.1.0
+<parameter name="arg3">
+<parameter_description> The new text inserted
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_IMAGE_MAP">
-<parameter_description> An image map object. Usually a graphic with multiple hotspots, where each hotspot
can be activated resulting in the loading of another document or section of a document. @Since: ATK-2.1.0
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkText::text-remove">
+<description>
+The "text-remove" signal is emitted when a new text is
+removed. If the signal was not triggered by the user
+(e.g. typing or pasting text), the "system" detail should be
+included.
+
+</description>
+<parameters>
+<parameter name="atktext">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_NOTIFICATION">
-<parameter_description> A transitory object designed to present a message to the user, typically at the
desktop level rather than inside a particular application. @Since: ATK-2.1.0
+<parameter name="arg1">
+<parameter_description> The position (character offset) of the removal.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_INFO_BAR">
-<parameter_description> An object designed to present a message to the user within an existing window.
@Since: ATK-2.1.0
+<parameter name="arg2">
+<parameter_description> The length (in characters) of text removed.
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_LEVEL_BAR">
-<parameter_description> A bar that serves as a level indicator to, for instance, show the strength of a
password or the state of a battery. @Since: ATK-2.7.3
+<parameter name="arg3">
+<parameter_description> The old text removed
</parameter_description>
</parameter>
-<parameter name="ATK_ROLE_LAST_DEFINED">
-<parameter_description> not a valid role, used for finding end of the enumeration
+</parameters>
+<return></return>
+</signal>
+
+<signal name="AtkText::text-selection-changed">
+<description>
+The "text-selection-changed" signal is emitted when the
+selected text of an object which implements AtkText changes.
+
+</description>
+<parameters>
+<parameter name="atktext">
+<parameter_description> the object which received the signal.
</parameter_description>
</parameter>
</parameters>
-</enum>
+<return></return>
+</signal>
<enum name="AtkTextAttribute">
<description>
@@ -624,7 +760,7 @@ Describes the text attributes supported
</description>
<parameters>
<parameter name="ATK_TEXT_ATTR_INVALID">
-<parameter_description> Invalid attribute
+<parameter_description> Invalid attribute, like bad spelling or grammar.
</parameter_description>
</parameter>
<parameter name="ATK_TEXT_ATTR_LEFT_MARGIN">
@@ -676,7 +812,7 @@ Describes the text attributes supported
</parameter_description>
</parameter>
<parameter name="ATK_TEXT_ATTR_SIZE">
-<parameter_description> The size of the characters.
+<parameter_description> The size of the characters in points. eg: 10
</parameter_description>
</parameter>
<parameter name="ATK_TEXT_ATTR_SCALE">
@@ -744,12 +880,9 @@ Describes the text attributes supported
<enum name="AtkTextBoundary">
<description>
-Text boundary types used for specifying boundaries for regions of
-text. Note that some boundaries are deprecated since 2.9.3., not
-marked explicitly due to the lack of a formal method to mark as
-deprecated some elements from a enum.
-
-
+Text boundary types used for specifying boundaries for regions of text.
+This enumerationis deprecated since 2.9.4 and should not be used. Use
+AtkTextGranularity with #atk_text_get_string_at_offset instead.
</description>
<parameters>
@@ -764,8 +897,7 @@ deprecated some elements from a enum.
</parameter>
<parameter name="ATK_TEXT_BOUNDARY_WORD_END">
<parameter_description> Boundary is the end (i.e. last
-character) of a word. This boundary is deprecated, and should not be
-used.
+character) of a word.
</parameter_description>
</parameter>
<parameter name="ATK_TEXT_BOUNDARY_SENTENCE_START">
@@ -776,8 +908,7 @@ used.
<parameter_description> Boundary is the last (terminal)
character in a sentence; in languages which use "sentence stop"
punctuation such as English, the boundary is thus the '.', '?', or
-similar terminal punctuation character. This boundary is
-deprecated, and should not be used.
+similar terminal punctuation character.
</parameter_description>
</parameter>
<parameter name="ATK_TEXT_BOUNDARY_LINE_START">
@@ -787,7 +918,7 @@ character immediately following a newline, linefeed, or return character.
</parameter>
<parameter name="ATK_TEXT_BOUNDARY_LINE_END">
<parameter_description> Boundary is the linefeed, or return
-character. This boundary is deprecated, and should not be used.
+character.
</parameter_description>
</parameter>
</parameters>
@@ -818,12 +949,87 @@ Describes the type of clipping required.
</parameters>
</enum>
+<enum name="AtkTextGranularity">
+<description>
+Text granularity types used for specifying the granularity of the region of
+text we are interested in.
+
+</description>
+<parameters>
+<parameter name="ATK_TEXT_GRANULARITY_CHAR">
+<parameter_description> Granularity is defined by the boundaries between characters
+(including non-printing characters)
+</parameter_description>
+</parameter>
+<parameter name="ATK_TEXT_GRANULARITY_WORD">
+<parameter_description> Granularity is defined by the boundaries of a word,
+starting at the beginning of the current word and finishing at the beginning of
+the following one, if present.
+</parameter_description>
+</parameter>
+<parameter name="ATK_TEXT_GRANULARITY_SENTENCE">
+<parameter_description> Granularity is defined by the boundaries of a sentence,
+starting at the beginning of the current sentence and finishing at the beginning of
+the following one, if present.
+</parameter_description>
+</parameter>
+<parameter name="ATK_TEXT_GRANULARITY_LINE">
+<parameter_description> Granularity is defined by the boundaries of a line,
+starting at the beginning of the current line and finishing at the beginning of
+the following one, if present.
+</parameter_description>
+</parameter>
+<parameter name="ATK_TEXT_GRANULARITY_PARAGRAPH">
+<parameter_description> Granularity is defined by the boundaries of a paragraph,
+starting at the beginning of the current paragraph and finishing at the beginning of
+the following one, if present.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="AtkValue::value-changed">
+<description>
+The 'value-changed' signal is emitted when the current value
+that represent the object changes. @value is the numerical
+representation of this new value. @text is the human
+readable text alternative of @value, and can be NULL if it is
+not available. Note that if there is a textual description
+associated with the new numeric value, that description
+should be included regardless of whether or not it has also
+changed.
+
+Example: a password meter whose value changes as the user
+types their new password. Appropiate value text would be
+"weak", "acceptable" and "strong".
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="atkvalue">
+<parameter_description> the object on which the signal was emitted.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the new value in a numerical form.
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> human readable text alternative (also called
+description) of this object. NULL if not available.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<signal name="AtkWindow::activate">
<description>
The signal #AtkWindow::activate is emitted when a window
becomes the active window of the application or session.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -840,7 +1046,7 @@ Since: 2.1.5
The signal #AtkWindow::create is emitted when a new window
is created.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -857,7 +1063,7 @@ Since: 2.1.5
The signal #AtkWindow::deactivate is emitted when a window is
no longer the active window of the application or session.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -874,7 +1080,7 @@ Since: 2.1.5
The signal #AtkWindow::destroy is emitted when a window is
destroyed.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -891,7 +1097,7 @@ Since: 2.1.5
The signal #AtkWindow::maximize is emitted when a window
is maximized.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -908,7 +1114,7 @@ Since: 2.1.5
The signal #AtkWindow::minimize is emitted when a window
is minimized.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -925,7 +1131,7 @@ Since: 2.1.5
The signal #AtkWindow::move is emitted when a window
is moved.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -942,7 +1148,7 @@ Since: 2.1.5
The signal #AtkWindow::resize is emitted when a window
is resized.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -959,7 +1165,7 @@ Since: 2.1.5
The signal #AtkWindow::restore is emitted when a window
is restored.
-Since: 2.1.5
+Since: 2.2
</description>
<parameters>
@@ -1008,8 +1214,8 @@ Returns a description of the specified action of the object.
</parameter_description>
</parameter>
</parameters>
-<return>a description string, or %NULL
-if @action does not implement this interface.
+<return> a description string, or %NULL if @action does
+not implement this interface.
</return>
</function>
@@ -1050,8 +1256,8 @@ it would be represented by ";;Ctrl+N" and ";;Strg+N" respect
</parameter_description>
</parameter>
</parameters>
-<return>the keybinding which can be used to activate this action, or %NULL
-if there is no keybinding for this action.
+<return> the keybinding which can be used to activate
+this action, or %NULL if there is no keybinding for this action.
</return>
</function>
@@ -1072,8 +1278,8 @@ Returns the localized name of the specified action of the object.
</parameter_description>
</parameter>
</parameters>
-<return>a name string, or %NULL
-if @action does not implement this interface.
+<return> a name string, or %NULL if @action does not
+implement this interface.
</return>
</function>
@@ -1125,8 +1331,8 @@ NIL.
</parameter_description>
</parameter>
</parameters>
-<return>a name string, or %NULL
-if @action does not implement this interface.
+<return> a name string, or %NULL if @action does not
+implement this interface.
</return>
</function>
@@ -1159,6 +1365,10 @@ Sets a description of the specified action of the object.
Adds the specified function to the list of functions to be called
when an object receives focus.
+Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+to be implemented by ATK itself. If you need focus tracking on your
+implementation, subscribe to the state-changed:focused signal.
+
</description>
<parameters>
@@ -1194,10 +1404,19 @@ ATK:AtkObject:state-change
ATK:AtkText:text-selection-changed
ATK:AtkText:text-insert:system
-Toolkit implementor note: Atk provides a default implementation for
-this virtual method, and that implementation should be enough for
-most of the cases. You should have a really good reason to
-reimplement this method.
+Toolkit implementor note: ATK provides a default implementation for
+this virtual method. ATK implementors are discouraged from
+reimplementing this method.
+
+Toolkit implementor note: this method is not intended to be used by
+ATK implementors but by ATK consumers.
+
+ATK consumers note: as this method adds a listener for a given ATK
+type, that type should be already registered on the GType system
+before calling this method. A simple way to do that is creating an
+instance of #AtkNoOpObject. This class implements all ATK
+interfaces, so creating the instance will register all ATK types as
+a collateral effect.
</description>
@@ -1259,6 +1478,9 @@ 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
+Deprecated: 2.9.4: If you need to track when an object gains or
+lose the focus, use state-changed:focused notification instead.
+
</description>
<parameters>
@@ -1271,7 +1493,7 @@ already added it is not added again
</parameter_description>
</parameter>
</parameters>
-<return> a handler id which can be used in atk_component_remove_focus_handler
+<return> a handler id which can be used in atk_component_remove_focus_handler()
or zero if the handler was already added.
</return>
</function>
@@ -1280,6 +1502,10 @@ or zero if the handler was already added.
<description>
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.
+
</description>
<parameters>
@@ -1401,6 +1627,8 @@ container.
Gets the position of @component in the form of
a point specifying @component's top-left corner.
+Deprecated: Since 2.12. Use atk_component_get_extents() instead.
+
</description>
<parameters>
<parameter name="component">
@@ -1428,6 +1656,8 @@ or to the components top level window
<description>
Gets the size of the @component in terms of width and height.
+Deprecated: Since 2.12. Use atk_component_get_extents() instead.
+
</description>
<parameters>
<parameter name="component">
@@ -1488,7 +1718,8 @@ or to the components top level window
</parameter_description>
</parameter>
</parameters>
-<return> a reference to the accessible child, if one exists
+<return> a reference to the accessible
+child, if one exists
</return>
</function>
@@ -1498,6 +1729,10 @@ Remove the handler specified by @handler_id from the list of
functions to be executed when this object receives focus events
(in or out).
+Deprecated: 2.9.4: If you need to track when an object gains or
+lose the focus, use state-changed:focused notification instead.
+
+
</description>
<parameters>
<parameter name="component">
@@ -1620,10 +1855,9 @@ whose value is being queried.
</parameter_description>
</parameter>
</parameters>
-<return> a string value associated with the named attribute for this
-document, or NULL if a value for #attribute_name has not been specified
-for this document.
-Virtual: get_document_attribute_value
+<return> a string value associated with the named
+attribute for this document, or NULL if a value for
+#attribute_name has not been specified for this document.
</return>
</function>
@@ -1645,7 +1879,23 @@ Since: 1.12
<return> An AtkAttributeSet containing the explicitly
set name-value-pair attributes associated with this document
as a whole.
-Virtual: get_document_attributes
+</return>
+</function>
+
+<function name="atk_document_get_current_page_number">
+<description>
+Since: 2.12
+
+
+</description>
+<parameters>
+<parameter name="document">
+<parameter_description> the #AtkDocument
+</parameter_description>
+</parameter>
+</parameters>
+<return> current page number inside @document. -1 if not
+implemented, not know by the implementor or irrelevant.
</return>
</function>
@@ -1655,6 +1905,10 @@ 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.
+Deprecated: Since 2.12. @document is already a representation of
+the document. Use it directly, or one of his children, as an
+instance of the DOM.
+
</description>
<parameters>
@@ -1671,6 +1925,9 @@ how to cast this pointer.
<description>
Gets a string indicating the document type.
+Deprecated: Since 2.12. Please use atk_document_get_attributes() to
+ask for the document type if it applies.
+
</description>
<parameters>
@@ -1691,8 +1948,7 @@ text substrings or images within this document may have
a different locale, see atk_text_get_attributes and
atk_image_get_image_locale.
-Deprecated: This method is deprecated since ATK version
-2.7.90. Please use atk_object_get_object_locale() instead.
+Deprecated: 2.7.90: Please use atk_object_get_object_locale() instead.
</description>
@@ -1705,7 +1961,23 @@ Deprecated: This method is deprecated since ATK version
<return> a UTF-8 string indicating the POSIX-style LC_MESSAGES
locale of the document content as a whole, or NULL if
the document content does not specify a locale.
-Virtual: get_document_locale
+</return>
+</function>
+
+<function name="atk_document_get_page_count">
+<description>
+Since: 2.12
+
+
+</description>
+<parameters>
+<parameter name="document">
+<parameter_description> the #AtkDocument
+</parameter_description>
+</parameter>
+</parameters>
+<return> total page count of @document. -1 if not implemented, not
+know by the implementor or irrelevant.
</return>
</function>
@@ -1733,7 +2005,6 @@ whose value is being set.
<return> TRUE if #value is successfully associated with #attribute_name
for this document, FALSE otherwise (e.g. if the document does not
allow the attribute to be modified).
-Virtual: set_document_attribute
</return>
</function>
@@ -1908,6 +2179,10 @@ This function should be called by an implementation of the
ATK interface if any specific work needs to be done to enable
focus tracking.
+Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+to be implemented by ATK itself.
+
+
</description>
<parameters>
<parameter name="init">
@@ -1923,6 +2198,12 @@ focus tracking.
Cause the focus tracker functions which have been specified to be
executed for the object.
+Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+to be implemented by ATK itself. As #AtkObject::focus-event was
+deprecated in favor of a #AtkObject::state-change signal, in order
+to notify a focus change on your implementation, you can use
+atk_object_notify_state_change() instead.
+
</description>
<parameters>
<parameter name="object">
@@ -1938,7 +2219,7 @@ executed for the object.
Returns the binary age as passed to libtool when building the ATK
library the process is running against.
-Since: 2.7.4
+Since: 2.8
</description>
<parameters>
@@ -1987,7 +2268,7 @@ application
Returns the interface age as passed to libtool when building the
ATK library the process is running against.
-Since: 2.7.4
+Since: 2.8
</description>
<parameters>
@@ -2007,7 +2288,7 @@ your code is running against. In contrast, the #ATK_MAJOR_VERSION
macro represents the major version of the ATK headers you have
included when compiling your code.
-Since: 2.7.4
+Since: 2.8
</description>
<parameters>
@@ -2027,7 +2308,7 @@ your code is are running against. In contrast, the
#ATK_MICRO_VERSION macro represents the micro version of the ATK
headers you have included when compiling your code.
-Since: 2.7.4
+Since: 2.8
</description>
<parameters>
@@ -2047,7 +2328,7 @@ your code is are running against. In contrast, the
#ATK_MINOR_VERSION macro represents the minor version of the ATK
headers you have included when compiling your code.
-Since: 2.7.4
+Since: 2.8
</description>
<parameters>
@@ -2264,7 +2545,7 @@ 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.
-a *
+
</description>
<parameters>
@@ -2284,9 +2565,8 @@ Determines whether this AtkHyperlink is selected
Since: 1.4
-Deprecated: This method is deprecated since ATK version 1.8.
-Please use ATK_STATE_SELECTED to indicate when a hyperlink within a
-Hypertext container is selected.
+Deprecated: 1.8: Please use ATK_STATE_FOCUSABLE for all links,
+and ATK_STATE_FOCUSED for focused links.
</description>
@@ -2296,7 +2576,7 @@ Hypertext container is selected.
</parameter_description>
</parameter>
</parameters>
-<return> True is the AtkHyperlink is selected, False otherwise
+<return> True if the AtkHyperlink is selected, False otherwise
</return>
</function>
@@ -2396,7 +2676,7 @@ Get a textual description of this image.
<function name="atk_image_get_image_locale">
<description>
-Since ATK 1.12
+Since: 1.12
</description>
@@ -2406,7 +2686,9 @@ Since ATK 1.12
</parameter_description>
</parameter>
</parameters>
-<return>a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the
image does not specify a locale.
+<return> a string corresponding to the POSIX
+LC_MESSAGES locale used by the image description, or %NULL if the
+image does not specify a locale.
</return>
</function>
@@ -2509,6 +2791,8 @@ Obtain the singleton instance of AtkMisc for this application.
Since: 1.13
+Deprecated: Since 2.12.
+
</description>
<parameters>
@@ -2525,6 +2809,8 @@ if one exists.
(This method is implemented by the toolkit ATK implementation layer;
for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
+Deprecated: Since 2.12.
+
Since: 1.13
@@ -2550,6 +2836,8 @@ 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).
+Deprecated: Since 2.12.
+
Since: 1.13
@@ -2613,13 +2901,14 @@ Adds a relationship of the specified type with the specified target.
</parameter_description>
</parameter>
</parameters>
-<return>TRUE if the relationship is added.
+<return> TRUE if the relationship is added.
</return>
</function>
<function name="atk_object_connect_property_change_handler">
<description>
-Specifies a function to be called when a property changes value.
+Deprecated: Since 2.12. Connect directly to property-change or
+notify signals.
</description>
@@ -2833,7 +3122,7 @@ Gets the accessible name of the accessible.
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of @accessible.
-Since: 2.7.90
+Since: 2.8
</description>
@@ -2850,7 +3139,14 @@ locale of @accessible.
<function name="atk_object_get_parent">
<description>
-Gets the accessible parent of the accessible.
+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().
</description>
@@ -2860,8 +3156,8 @@ Gets the accessible parent of the accessible.
</parameter_description>
</parameter>
</parameters>
-<return> a #AtkObject representing the accessible parent
-of the accessible
+<return> an #AtkObject representing the accessible
+parent of the accessible
</return>
</function>
@@ -2904,7 +3200,10 @@ to create an instance of a subclass of #AtkObject
<function name="atk_object_notify_state_change">
<description>
-Emits a state-change signal for the specified state.
+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.
</description>
<parameters>
@@ -2924,6 +3223,29 @@ Emits a state-change signal for the specified state.
<return></return>
</function>
+<function name="atk_object_peek_parent">
+<description>
+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.
+
+
+</description>
+<parameters>
+<parameter name="accessible">
+<parameter_description> an #AtkObject
+</parameter_description>
+</parameter>
+</parameters>
+<return> an #AtkObject representing the accessible
+parent of the accessible if assigned
+</return>
+</function>
+
<function name="atk_object_ref_accessible_child">
<description>
Gets a reference to the specified accessible child of the object.
@@ -2984,6 +3306,8 @@ set of the accessible
<function name="atk_object_remove_property_change_handler">
<description>
+Deprecated: Since 2.12.
+
Removes a property change handler.
</description>
@@ -3020,7 +3344,7 @@ Removes a relationship of the specified type with the specified target.
</parameter_description>
</parameter>
</parameters>
-<return>TRUE if the relationship is removed.
+<return> TRUE if the relationship is removed.
</return>
</function>
@@ -3068,7 +3392,7 @@ a empty value you can use "".
<function name="atk_object_set_parent">
<description>
-Sets the accessible parent of the accessible.
+Sets the accessible parent of the accessible. @parent can be NULL.
</description>
<parameters>
@@ -3117,7 +3441,7 @@ Since: 1.30
</description>
<parameters>
-<parameter name="obj">
+<parameter name="plug">
<parameter_description> an #AtkPlug
</parameter_description>
</parameter>
@@ -3127,6 +3451,121 @@ Since: 1.30
</return>
</function>
+<function name="atk_range_copy">
+<description>
+Returns a new #AtkRange that is a exact copy of @src
+
+Since: 2.12
+
+
+</description>
+<parameters>
+<parameter name="src">
+<parameter_description> #AtkRange to copy
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #AtkRange copy of @src
+</return>
+</function>
+
+<function name="atk_range_free">
+<description>
+Free @range
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="range">
+<parameter_description> #AtkRange to free
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="atk_range_get_description">
+<description>
+Returns the human readable description of @range
+
+Since: 2.12
+
+
+</description>
+<parameters>
+<parameter name="range">
+<parameter_description> an #AtkRange
+</parameter_description>
+</parameter>
+</parameters>
+<return> the human-readable description of @range
+</return>
+</function>
+
+<function name="atk_range_get_lower_limit">
+<description>
+Returns the lower limit of @range
+
+Since: 2.12
+
+
+</description>
+<parameters>
+<parameter name="range">
+<parameter_description> an #AtkRange
+</parameter_description>
+</parameter>
+</parameters>
+<return> the lower limit of @range
+</return>
+</function>
+
+<function name="atk_range_get_upper_limit">
+<description>
+Returns the upper limit of @range
+
+Since: 2.12
+
+
+</description>
+<parameters>
+<parameter name="range">
+<parameter_description> an #AtkRange
+</parameter_description>
+</parameter>
+</parameters>
+<return> the upper limit of @range
+</return>
+</function>
+
+<function name="atk_range_new">
+<description>
+Creates a new #AtkRange.
+
+Since: 2.12
+
+
+</description>
+<parameters>
+<parameter name="lower_limit">
+<parameter_description> inferior limit for this range
+</parameter_description>
+</parameter>
+<parameter name="upper_limit">
+<parameter_description> superior limit for this range
+</parameter_description>
+</parameter>
+<parameter name="description">
+<parameter_description> human readable description of this range.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #AtkRange
+
+</return>
+</function>
+
<function name="atk_registry_get_factory">
<description>
Gets an #AtkObjectFactory appropriate for creating #AtkObjects
@@ -3294,7 +3733,7 @@ Remove the specified AtkObject from the target for the relation.
</parameter_description>
</parameter>
</parameters>
-<return>TRUE if the removal is successful.
+<return> TRUE if the removal is successful.
</return>
</function>
@@ -3537,6 +3976,10 @@ Associate @name with a new #AtkRelationType
<function name="atk_remove_focus_tracker">
<description>
+Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+to be implemented by ATK itself. If you need focus tracking on your
+implementation, subscribe to the state-changed:focused signal.
+
Removes the specified focus tracker from the list of functions
to be called when any object receives focus.
@@ -3555,10 +3998,12 @@ to be called when any object receives focus.
@listener_id is the value returned by #atk_add_global_event_listener
when you registered that event listener.
-Toolkit implementor note: Atk provides a default implementation for
-this virtual method, and that implementation should be enough for
-most of the cases. You should have a really good reason to
-reimplement this method.
+Toolkit implementor note: ATK provides a default implementation for
+this virtual method. ATK implementors are discouraged from
+reimplementing this method.
+
+Toolkit implementor note: this method is not intended to be used by
+ATK implementors but by ATK consumers.
Removes the specified event listener
@@ -3601,8 +4046,7 @@ Get the #AtkRole type corresponding to a rolew name.
</parameter_description>
</parameter>
</parameters>
-<return> the #AtkRole enumerated type corresponding to the specified
-name,
+<return> the #AtkRole enumerated type corresponding to the specified name,
or #ATK_ROLE_INVALID if no matching role is found.
</return>
</function>
@@ -3641,7 +4085,12 @@ Gets the description string describing the #AtkRole @role.
<function name="atk_role_register">
<description>
-Registers the role specified by @name.
+Registers the role specified by @name. @name must be a meaningful
+name. So it should not be empty, or consisting on whitespaces.
+
+Deprecated: Since 2.12. If your application/toolkit doesn't find a
+suitable role for a specific object defined at #AtkRole, please
+submit a bug in order to add a new role to the specification.
</description>
@@ -3651,7 +4100,8 @@ Registers the role specified by @name.
</parameter_description>
</parameter>
</parameters>
-<return> an #AtkRole for the new role.
+<return> an #AtkRole for the new role if added
+properly. ATK_ROLE_INVALID in case of error.
</return>
</function>
@@ -3761,8 +4211,9 @@ ith selection as opposed to the ith child).
</parameter_description>
</parameter>
</parameters>
-<return> an #AtkObject representing the selected
-accessible , or %NULL if @selection does not implement this interface.
+<return> an #AtkObject representing the
+selected accessible, or %NULL if @selection does not implement this
+interface.
</return>
</function>
@@ -3853,8 +4304,13 @@ Since: 1.30
<function name="atk_state_set_add_state">
<description>
-Add a new state for the specified type to the current state set if
-it is not already present.
+Adds the state of the specified type to the state set if it is not already
+present.
+
+Note that because an #AtkStateSet is a read-only object, this method should
+be used to add a state to a newly-created set which will then be returned by
+#atk_object_ref_state_set. It should not be used to modify the existing state
+of an object. See also #atk_object_notify_state_change.
</description>
@@ -3874,7 +4330,12 @@ it is not already present.
<function name="atk_state_set_add_states">
<description>
-Add the states for the specified types to the current state set.
+Adds the states of the specified types to the state set.
+
+Note that because an #AtkStateSet is a read-only object, this method should
+be used to add states to a newly-created set which will then be returned by
+#atk_object_ref_state_set. It should not be used to modify the existing state
+of an object. See also #atk_object_notify_state_change.
</description>
<parameters>
@@ -4019,8 +4480,8 @@ Constructs the union of the two sets.
</parameter_description>
</parameter>
</parameters>
-<return> a new #AtkStateSet which is the union of the two
-sets, returning %NULL is empty.
+<return> a new #AtkStateSet which is
+the union of the two sets, returning %NULL is empty.
</return>
</function>
@@ -4028,6 +4489,11 @@ sets, returning %NULL is empty.
<description>
Removes the state for the specified type from the state set.
+Note that because an #AtkStateSet is a read-only object, this method should
+be used to remove a state to a newly-created set which will then be returned
+by #atk_object_ref_state_set. It should not be used to modify the existing
+state of an object. See also #atk_object_notify_state_change.
+
</description>
<parameters>
@@ -4199,8 +4665,8 @@ for the default mime type.
</parameter_description>
</parameter>
</parameters>
-<return> Returns a string representing a URI, or NULL if no corresponding URI
-can be constructed.
+<return> Returns a string representing a URI, or %NULL
+if no corresponding URI can be constructed.
</return>
</function>
@@ -4247,6 +4713,164 @@ or 0 if value does not implement this interface.
</return>
</function>
+<function name="atk_table_cell_get_column_header_cells">
+<description>
+Returns the column headers as an array of cell accessibles.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="cell">
+<parameter_description> a GObject instance that implements AtkTableCellIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> a GPtrArray of AtkObjects
+representing the column header cells.
+
+</return>
+</function>
+
+<function name="atk_table_cell_get_column_span">
+<description>
+Returns the number of columns occupied by this cell accessible.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="cell">
+<parameter_description> a GObject instance that implements AtkTableCellIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> a gint representing the number of columns occupied by this cell,
+or 0 if the cell does not implement this method.
+
+</return>
+</function>
+
+<function name="atk_table_cell_get_position">
+<description>
+Retrieves the tabular position of this cell.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="cell">
+<parameter_description> a GObject instance that implements AtkTableCellIface
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> the row of the given cell.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> the column of the given cell.
+</parameter_description>
+</parameter>
+</parameters>
+<return> TRUE if successful; FALSE otherwise.
+
+</return>
+</function>
+
+<function name="atk_table_cell_get_row_column_span">
+<description>
+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.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="cell">
+<parameter_description> a GObject instance that implements AtkTableCellIface
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> the row index of the given cell.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> the column index of the given cell.
+</parameter_description>
+</parameter>
+<parameter name="row_span">
+<parameter_description> the number of rows occupied by this cell.
+</parameter_description>
+</parameter>
+<parameter name="column_span">
+<parameter_description> the number of columns occupied by this cell.
+</parameter_description>
+</parameter>
+</parameters>
+<return> TRUE if successful; FALSE otherwise.
+
+</return>
+</function>
+
+<function name="atk_table_cell_get_row_header_cells">
+<description>
+Returns the row headers as an array of cell accessibles.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="cell">
+<parameter_description> a GObject instance that implements AtkTableCellIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> a GPtrArray of AtkObjects
+representing the row header cells.
+
+</return>
+</function>
+
+<function name="atk_table_cell_get_row_span">
+<description>
+Returns the number of rows occupied by this cell accessible.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="cell">
+<parameter_description> a GObject instance that implements AtkTableCellIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> a gint representing the number of rows occupied by this cell,
+or 0 if the cell does not implement this method.
+
+</return>
+</function>
+
+<function name="atk_table_cell_get_table">
+<description>
+Returns a reference to the accessible of the containing table.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="cell">
+<parameter_description> a GObject instance that implements AtkTableCellIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> the atk object for the containing table.
+
+</return>
+</function>
+
<function name="atk_table_get_caption">
<description>
Gets the caption for the @table.
@@ -4259,14 +4883,16 @@ Gets the caption for the @table.
</parameter_description>
</parameter>
</parameters>
-<return> a AtkObject* representing the table caption, or
-%NULL if value does not implement this interface.
+<return> a AtkObject* representing the
+table caption, or %NULL if value does not implement this interface.
</return>
</function>
<function name="atk_table_get_column_at_index">
<description>
-Gets a #gint representing the column at the specified @index_.
+Gets a #gint representing the column at the specified @index_.
+
+Deprecated: Since 2.12.
</description>
@@ -4281,7 +4907,7 @@ Gets a #gint representing the column at the specified @index_.
</parameter>
</parameters>
<return> a gint representing the column at the specified index,
-or -1 if the table does not implement this interface
+or -1 if the table does not implement this method.
</return>
</function>
@@ -4348,14 +4974,19 @@ Gets the column header of a specified column in an accessible table.
</parameter_description>
</parameter>
</parameters>
-<return> a AtkObject* representing the specified column
-header, or %NULL if value does not implement this interface.
+<return> a AtkObject* representing the
+specified column header, or %NULL if value does not implement this
+interface.
</return>
</function>
<function name="atk_table_get_index_at">
<description>
-Gets a #gint representing the index at the specified @row and @column.
+Gets a #gint representing the index at the specified @row and
+ column
+
+Deprecated: Since 2.12. Use atk_table_ref_at() in order to get the
+accessible that represents the cell at (@row, @column)
</description>
@@ -4417,6 +5048,8 @@ if value does not implement this interface.
<description>
Gets a #gint representing the row at the specified @index_.
+Deprecated: since 2.12.
+
</description>
<parameters>
@@ -4430,7 +5063,7 @@ Gets a #gint representing the row at the specified @index_.
</parameter>
</parameters>
<return> a gint representing the row at the specified index,
-or -1 if the table does not implement this interface
+or -1 if the table does not implement this method.
</return>
</function>
@@ -4450,8 +5083,8 @@ Gets the description text of the specified row in the table
</parameter_description>
</parameter>
</parameters>
-<return> a gchar* representing the row description, or %NULL
-if value does not implement this interface.
+<return> a gchar* representing the row description, or
+%NULL if value does not implement this interface.
</return>
</function>
@@ -4497,8 +5130,9 @@ Gets the row header of a specified row in an accessible table.
</parameter_description>
</parameter>
</parameters>
-<return> a AtkObject* representing the specified row
-header, or %NULL if value does not implement this interface.
+<return> a AtkObject* representing the
+specified row header, or %NULL if value does not implement this
+interface.
</return>
</function>
@@ -4635,7 +5269,8 @@ if value does not implement this interface.
<function name="atk_table_ref_at">
<description>
-Get a reference to the table cell at @row, @column.
+Get a reference to the table cell at @row, @column. This cell
+should implement the interface #AtkTableCell
</description>
@@ -4653,8 +5288,8 @@ Get a reference to the table cell at @row, @column.
</parameter_description>
</parameter>
</parameters>
-<return> a AtkObject* representing the referred to
-accessible
+<return> an #AtkObject representing the referred
+to accessible
</return>
</function>
@@ -4901,8 +5536,9 @@ Gets the value for the index of the #AtkTextAttribute
</parameter_description>
</parameter>
</parameters>
-<return> a string containing the value; this string should not be freed;
-NULL is returned if there are no values maintained for the attr value.
+<return> a string containing the value; this string
+should not be freed; %NULL is returned if there are no values
+maintained for the attr value.
</return>
</function>
@@ -4973,7 +5609,6 @@ Since: 1.3
</parameters>
<return> Array of AtkTextRange. The last
element of the array returned by this function will be NULL.
-Virtual: get_bounded_ranges
</return>
</function>
@@ -5243,6 +5878,74 @@ to free the returned string.
</return>
</function>
+<function name="atk_text_get_string_at_offset">
+<description>
+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.
+
+Since: 2.10
+
+
+</description>
+<parameters>
+<parameter name="text">
+<parameter_description> an #AtkText
+</parameter_description>
+</parameter>
+<parameter name="offset">
+<parameter_description> position
+</parameter_description>
+</parameter>
+<parameter name="granularity">
+<parameter_description> An #AtkTextGranularity
+</parameter_description>
+</parameter>
+<parameter name="start_offset">
+<parameter_description> the start offset of the returned string, or -1
+if an error has occurred (e.g. invalid offset, not implemented)
+</parameter_description>
+</parameter>
+<parameter name="end_offset">
+<parameter_description> the offset of the first character after the returned string,
+or -1 if an error has occurred (e.g. invalid offset, not implemented)
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string containing the text
+at the @offset bounded by the specified @granularity. Use
+g_free() to free the returned string. Returns %NULL if the
+offset is invalid or no implementation is available.
+</return>
+</function>
+
<function name="atk_text_get_text">
<description>
Gets the specified text.
@@ -5272,8 +5975,7 @@ to, but not including @end_offset. Use g_free() to free the returned string.
<description>
Gets the specified text.
-Deprecated: This method is deprecated since ATK version
-2.9.3. Please use atk_text_get_at_offset() instead.
+Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
</description>
@@ -5332,6 +6034,9 @@ 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.
+Deprecated: This method is deprecated since ATK version
+2.9.4. Please use atk_text_get_string_at_offset() instead.
+
</description>
<parameters>
@@ -5366,8 +6071,7 @@ the specified @boundary_type. Use g_free() to free the returned string.
<description>
Gets the specified text.
-Deprecated: This method is deprecated since ATK version
-2.9.3. Please use atk_text_get_at_offset() instead.
+Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
</description>
@@ -5480,6 +6184,9 @@ the selection
<description>
Gets the value of this object.
+Deprecated: Since 2.12. Use atk_value_get_value_and_text()
+instead.
+
</description>
<parameters>
<parameter name="obj">
@@ -5494,10 +6201,34 @@ Gets the value of this object.
<return></return>
</function>
+<function name="atk_value_get_increment">
+<description>
+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.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="obj">
+<parameter_description> a GObject instance that implements AtkValueIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> the minimum increment by which the value of this
+object may be changed. zero if undefined.
+
+</return>
+</function>
+
<function name="atk_value_get_maximum_value">
<description>
Gets the maximum value of this object.
+Deprecated: Since 2.12. Use atk_value_get_range() instead.
+
</description>
<parameters>
<parameter name="obj">
@@ -5520,6 +6251,8 @@ floating point precision of the platform.
Since: 1.12
+Deprecated: Since 2.12. Use atk_value_get_increment() instead.
+
</description>
<parameters>
<parameter name="obj">
@@ -5538,6 +6271,8 @@ Since: 1.12
<description>
Gets the minimum value of this object.
+Deprecated: Since 2.12. Use atk_value_get_range() instead.
+
</description>
<parameters>
<parameter name="obj">
@@ -5552,10 +6287,79 @@ Gets the minimum value of this object.
<return></return>
</function>
+<function name="atk_value_get_range">
+<description>
+Gets the range of this object.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="obj">
+<parameter_description> a GObject instance that implements AtkValueIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated #AtkRange
+that represents the minimum, maximum and descriptor (if available)
+of @obj. NULL if that range is not defined.
+
+</return>
+</function>
+
+<function name="atk_value_get_sub_ranges">
+<description>
+Gets the list of subranges defined for this object. See #AtkValue
+introduction for examples of subranges and when to expose them.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="obj">
+<parameter_description> a GObject instance that implements AtkValueIface
+</parameter_description>
+</parameter>
+</parameters>
+<return> an #GSList of
+#AtkRange which each of the subranges defined for this object. Free
+the returns list with g_slist_free().
+
+</return>
+</function>
+
+<function name="atk_value_get_value_and_text">
+<description>
+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 not descriptor is available.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="obj">
+<parameter_description> a GObject instance that implements AtkValueIface
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> address of #gdouble to put the current value of @obj
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> address of #gchar to put the human
+readable text alternative for @value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="atk_value_set_current_value">
<description>
Sets the value of this object.
+Deprecated: Since 2.12. Use atk_value_set_value() instead.
</description>
<parameters>
@@ -5569,6 +6373,72 @@ Sets the value of this object.
</parameter>
</parameters>
<return> %TRUE if new value is successfully set, %FALSE otherwise.
+
+</return>
+</function>
+
+<function name="atk_value_set_value">
+<description>
+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.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="obj">
+<parameter_description> a GObject instance that implements AtkValueIface
+</parameter_description>
+</parameter>
+<parameter name="new_value">
+<parameter_description> a double which is the desired new accessible value.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="atk_value_type_get_localized_name">
+<description>
+Gets the localized description string describing the #AtkValueType @value_type.
+
+
+</description>
+<parameters>
+<parameter name="value_type">
+<parameter_description> The #AtkValueType whose localized name is required
+</parameter_description>
+</parameter>
+</parameters>
+<return> the localized string describing the #AtkValueType
+</return>
+</function>
+
+<function name="atk_value_type_get_name">
+<description>
+Gets the description string describing the #AtkValueType @value_type.
+
+
+</description>
+<parameters>
+<parameter name="role">
+<parameter_description> The #AtkValueType whose name is required
+</parameter_description>
+</parameter>
+</parameters>
+<return> the string describing the #AtkValueType
</return>
</function>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
