`Action` should be implemented by instances of `Object` classes with which the user can interact directly, i.e. buttons, checkboxes, scrollbars, e.g. components which are not "passive" providers of UI information. Exceptions: when the user interaction is already covered by another appropriate interface such as `EditableText` (insert/delete text, etc.) or `Value` (set value) then these actions should not be exposed by `Action` as well. Though most UI interactions on components should be invocable via keyboard as well as mouse, there will generally be a close mapping between "mouse actions" that are possible on a component and the AtkActions. Where mouse and keyboard actions are redundant in effect, `Action` should expose only one action rather than exposing redundant actions if possible. By convention we have been using "mouse centric" terminology for `Action` names. # Implements [`AtkActionExt`](trait.AtkActionExt.html) Trait containing all `Action` methods. # Implementors [`Action`](struct.Action.html), [`Hyperlink`](struct.Hyperlink.html), [`NoOpObject`](struct.NoOpObject.html) Perform the specified action on the object. ## `i` the action index corresponding to the action to be performed # Returns `true` if success, `false` otherwise Returns a description of the specified action of the object. ## `i` the action index corresponding to the action to be performed # Returns a description string, or `None` if `self` does not implement this interface. 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". - The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for a button. - The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a traditional "New..." menu item. - The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a traditional "New..." menu item. 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. ## `i` the action index corresponding to the action to be performed # Returns the keybinding which can be used to activate this action, or `None` if there is no keybinding for this action. Returns the localized name of the specified action of the object. ## `i` the action index corresponding to the action to be performed # Returns a name string, or `None` if `self` does not implement this interface. Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object. # Returns a the number of actions, or 0 if `self` does not implement this interface. 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 `Action::do_action` may be NIL. ## `i` the action index corresponding to the action to be performed # Returns a name string, or `None` if `self` does not implement this interface. Sets a description of the specified action of the object. ## `i` the action index corresponding to the action to be performed ## `desc` the description to be assigned to this action # Returns a gboolean representing if the description was successfully set; `Component` should be implemented by most if not all UI elements with an actual on-screen presence, i.e. components which can be said to have a screen-coordinate bounding box. Virtually all widgets will need to have `Component` implementations provided for their corresponding `Object` class. In short, only UI elements which are *not* GUI elements will omit this ATK interface. A possible exception might be textual information with a transparent background, in which case text glyph bounding box information is provided by `Text`. # Implements [`ComponentExt`](trait.ComponentExt.html) Trait containing all `Component` methods. # Implementors [`Component`](struct.Component.html), [`NoOpObject`](struct.NoOpObject.html), [`Plug`](struct.Plug.html), [`Socket`](struct.Socket.html) Checks whether the specified point is within the extent of the `self`. Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it. ## `x` x coordinate ## `y` y coordinate ## `coord_type` specifies whether the coordinates are relative to the screen or to the components top level window # Returns `true` or `false` indicating whether the specified point is within the extent of the `self` or not Returns the alpha value (i.e. the opacity) for this `self`, on a scale from 0 (fully transparent) to 1.0 (fully opaque). # Returns An alpha value from 0 to 1.0, inclusive. Gets the rectangle which gives the extent of the `self`. ## `x` address of `gint` to put x coordinate ## `y` address of `gint` to put y coordinate ## `width` address of `gint` to put width ## `height` address of `gint` to put height ## `coord_type` specifies whether the coordinates are relative to the screen or to the components top level window Gets the layer of the component. # Returns an `Layer` which is the layer of the component Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW. # Returns a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container. Gets the position of `self` in the form of a point specifying `self`'s top-left corner. # Deprecated Since 2.12. Use `Component::get_extents` instead. ## `x` address of `gint` to put x coordinate position ## `y` address of `gint` to put y coordinate position ## `coord_type` specifies whether the coordinates are relative to the screen or to the components top level window Gets the size of the `self` in terms of width and height. # Deprecated Since 2.12. Use `Component::get_extents` instead. ## `width` address of `gint` to put width of `self` ## `height` address of `gint` to put height of `self` Grabs focus for this `self`. # Returns `true` if successful, `false` otherwise. Gets a reference to the accessible child, if one exists, at the coordinate point specified by `x` and `y`. ## `x` x coordinate ## `y` y coordinate ## `coord_type` specifies whether the coordinates are relative to the screen or to the components top level window # Returns a reference to the accessible child, if one exists Makes `self` visible on the screen by scrolling all necessary parents. Contrary to atk_component_set_position, this does not actually move `self` 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. Feature: `v2_30` ## `type_` specify where the object should be made visible. # Returns whether scrolling was successful. Makes an object visible on the screen at a given position by scrolling all necessary parents. Feature: `v2_30` ## `coords` specify whether coordinates are relative to the screen or to the parent object. ## `x` x-position where to scroll to ## `y` y-position where to scroll to # Returns whether scrolling was successful. Sets the extents of `self`. ## `x` x coordinate ## `y` y coordinate ## `width` width to set for `self` ## `height` height to set for `self` ## `coord_type` specifies whether the coordinates are relative to the screen or to the components top level window # Returns `true` or `false` whether the extents were set or not Sets the position of `self`. Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves `self` in its parent. ## `x` x coordinate ## `y` y coordinate ## `coord_type` specifies whether the coordinates are relative to the screen or to the component's top level window # Returns `true` or `false` whether or not the position was set or not Set the size of the `self` in terms of width and height. ## `width` width to set for `self` ## `height` height to set for `self` # Returns `true` or `false` whether the size was set or not The 'bounds-changed" signal is emitted when the bposition or size of the component changes. ## `arg1` The AtkRectangle giving the new position and size. Specifies how xy coordinates are to be interpreted. Used by functions such as `Component::get_position` and `Text::get_character_extents` specifies xy coordinates relative to the screen specifies xy coordinates relative to the widget's top-level window specifies xy coordinates relative to the widget's immediate parent. Since: 2.30 The AtkDocument interface should be supported by any object whose content is a representation or view of a document. The AtkDocument interface should appear on the toplevel container for the document content; however AtkDocument instances may be nested (i.e. an AtkDocument may be a descendant of another AtkDocument) in those cases where one document contains "embedded content" which can reasonably be considered a document in its own right. # Implements [`DocumentExt`](trait.DocumentExt.html) Trait containing all `Document` methods. # Implementors [`Document`](struct.Document.html), [`NoOpObject`](struct.NoOpObject.html) Retrieves the value of the given `attribute_name` inside `self`. ## `attribute_name` a character string representing the name of the attribute whose value is being queried. # Returns a string value associated with the named attribute for this document, or `None` if a value for `attribute_name` has not been specified for this document. Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs. # Returns An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole. Retrieves the current page number inside `self`. # Returns the current page number inside `self`, or -1 if not implemented, not know by the implementor, or irrelevant. 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. `self` is already a representation of the document. Use it directly, or one of its children, as an instance of the DOM. # Returns a `gpointer` that points to an instance of the DOM. Gets a string indicating the document type. # Deprecated Since 2.12. Please use `Document::get_attributes` to ask for the document type if it applies. # Returns a string indicating the document type Retrieves the total number of pages inside `self`. # Returns total page count of `self`, or -1 if not implemented, not know by the implementor or irrelevant. Sets the value for the given `attribute_name` inside `self`. ## `attribute_name` a character string representing the name of the attribute whose value is being set. ## `attribute_value` a string value to be associated with `attribute_name`. # Returns `true` if `attribute_value` is successfully associated with `attribute_name` for this `self`, and `false` if if the document does not allow the attribute to be modified 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.) 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. The 'page-changed' signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer. ## `page_number` the new page number. If this value is unknown or not applicable, -1 should be provided. 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. `EditableText` should be implemented by UI components which contain text which the user can edit, via the `Object` corresponding to that component (see `Object`). `EditableText` is a subclass of `Text`, and as such, an object which implements `EditableText` is by definition an `Text` implementor as well. See also: `Text` # Implements [`EditableTextExt`](trait.EditableTextExt.html), [`EditableTextExtManual`](prelude/trait.EditableTextExtManual.html) Trait containing all `EditableText` methods. # Implementors [`EditableText`](struct.EditableText.html), [`NoOpObject`](struct.NoOpObject.html) Copy text from `start_pos` up to, but not including `end_pos` to the clipboard. ## `start_pos` start position ## `end_pos` end position Copy text from `start_pos` up to, but not including `end_pos` to the clipboard and then delete from the widget. ## `start_pos` start position ## `end_pos` end position Delete text `start_pos` up to, but not including `end_pos`. ## `start_pos` start position ## `end_pos` end position Insert text at a given position. ## `string` the text to insert ## `length` the length of text to insert, in bytes ## `position` 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. Paste text from clipboard to specified `position`. ## `position` position to paste 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. ## `attrib_set` an `AttributeSet` ## `start_offset` start of range in which to set attributes ## `end_offset` end of range in which to set attributes # Returns `true` if attributes successfully set for the specified range, otherwise `false` Set text contents of `self`. ## `string` string to set for text contents of `self` This object class is derived from AtkObject. It can be used as a basis for implementing accessible objects for GObjects which are not derived from `GtkWidget`. One example of its use is in providing an accessible object for GnomeCanvasItem in the GAIL library. # Implements [`GObjectAccessibleExt`](trait.GObjectAccessibleExt.html), [`AtkObjectExt`](trait.AtkObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `GObjectAccessible` methods. # Implementors [`GObjectAccessible`](struct.GObjectAccessible.html) Gets the accessible object for the specified `obj`. ## `obj` a `gobject::Object` # Returns a `Object` which is the accessible object for the `obj` Gets the GObject for which `self` is the accessible object. # Returns a `gobject::Object` which is the object for which `self` is the accessible object An ATK object which encapsulates a link or set of links (for instance in the case of client-side image maps) in a hypertext document. It may implement the AtkAction interface. AtkHyperlink may also be used to refer to inline embedded content, since it allows specification of a start and end offset within the host AtkHypertext object. # Implements [`HyperlinkExt`](trait.HyperlinkExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`AtkActionExt`](trait.AtkActionExt.html) Trait containing all `Hyperlink` methods. # Implementors [`Hyperlink`](struct.Hyperlink.html) Gets the index with the hypertext document at which this link ends. # Returns the index with the hypertext document at which this link ends Gets the number of anchors associated with this hyperlink. # Returns the number of anchors associated with this hyperlink Returns the item associated with this hyperlinks nth anchor. For instance, the returned `Object` will implement `Text` if `self` is a text hyperlink, `Image` if `self` is an image hyperlink etc. Multiple anchors are primarily used by client-side image maps. ## `i` a (zero-index) integer specifying the desired anchor # Returns an `Object` associated with this hyperlinks i-th anchor Gets the index with the hypertext document at which this link begins. # Returns the index with the hypertext document at which this link begins Get a the URI associated with the anchor specified by `i` of `self`. Multiple anchors are primarily used by client-side image maps. ## `i` a (zero-index) integer specifying the desired anchor # Returns a string specifying the URI 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`. # Returns whether or not this link displays its content inline. Since the document that a link is associated with may have changed this method returns `true` if the link is still valid (with respect to the document it references) and `false` otherwise. # Returns whether or not this link is still valid The signal link-activated is emitted when a link is activated. AtkHyperlinkImpl allows AtkObjects to refer to their associated AtkHyperlink instance, if one exists. AtkHyperlinkImpl differs from AtkHyperlink in that AtkHyperlinkImpl is an interface, whereas AtkHyperlink is a object type. The AtkHyperlinkImpl interface allows a client to query an AtkObject for the availability of an associated AtkHyperlink instance, and obtain that instance. It is thus particularly useful in cases where embedded content or inline content within a text object is present, since the embedding text object implements AtkHypertext and the inline/embedded objects are exposed as children which implement AtkHyperlinkImpl, in addition to their being obtainable via AtkHypertext:getLink followed by AtkHyperlink:getObject. The AtkHyperlinkImpl interface should be supported by objects exposed within the hierarchy as children of an AtkHypertext container which correspond to "links" or embedded content within the text. HTML anchors are not, for instance, normally exposed this way, but embedded images and components which appear inline in the content of a text object are. The AtkHyperlinkIface interface allows a means of determining which children are hyperlinks in this sense of the word, and for obtaining their corresponding AtkHyperlink object, from which the embedding range, URI, etc. can be obtained. To some extent this interface exists because, for historical reasons, AtkHyperlink was defined as an object type, not an interface. Thus, in order to interact with AtkObjects via AtkHyperlink semantics, a new interface was required. # Implements [`HyperlinkImplExt`](trait.HyperlinkImplExt.html) Trait containing all `HyperlinkImpl` methods. # Implementors [`HyperlinkImpl`](struct.HyperlinkImpl.html) Gets the hyperlink associated with this object. # Returns an AtkHyperlink object which points to this implementing AtkObject. Describes the type of link Link is inline An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document. A Hypertext instance is associated with one or more Hyperlinks, which are associated with particular offsets within the Hypertext's included content. While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets. # Implements [`HypertextExt`](trait.HypertextExt.html) Trait containing all `Hypertext` methods. # Implementors [`Hypertext`](struct.Hypertext.html), [`NoOpObject`](struct.NoOpObject.html) Gets the link in this hypertext document at index `link_index` ## `link_index` an integer specifying the desired link # Returns the link in this hypertext document at index `link_index` Gets the index into the array of hyperlinks that is associated with the character specified by `char_index`. ## `char_index` a character index # Returns an index into the array of hyperlinks in `self`, or -1 if there is no hyperlink associated with this character. Gets the number of links within this hypertext document. # Returns the number of links within this hypertext document The "link-selected" signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected. ## `arg1` the index of the hyperlink which is selected `Image` should be implemented by `Object` subtypes on behalf of components which display image/pixmap information onscreen, and which provide information (other than just widget borders, etc.) via that image content. For instance, icons, buttons with icons, toolbar elements, and image viewing panes typically should implement `Image`. `Image` primarily provides two types of information: coordinate information (useful for screen review mode of screenreaders, and for use by onscreen magnifiers), and descriptive information. The descriptive information is provided for alternative, text-only presentation of the most significant information present in the image. # Implements [`AtkImageExt`](trait.AtkImageExt.html) Trait containing all `Image` methods. # Implementors [`Image`](struct.Image.html), [`NoOpObject`](struct.NoOpObject.html) Get a textual description of this image. # Returns a string representing the image description Retrieves the locale identifier associated to the `Image`. # Returns a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or `None` if the image does not specify a locale. Gets the position of the image in the form of a point specifying the images top-left corner. ## `x` address of `gint` to put x coordinate position; otherwise, -1 if value cannot be obtained. ## `y` address of `gint` to put y coordinate position; otherwise, -1 if value cannot be obtained. ## `coord_type` 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). ## `width` filled with the image width, or -1 if the value cannot be obtained. ## `height` filled with the image height, or -1 if the value cannot be obtained. Sets the textual description for this image. ## `description` a string description to set for `self` # Returns boolean TRUE, or FALSE if operation could not be completed. Describes the layer of a component These enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another. The object does not have a layer This layer is reserved for the desktop background This layer is used for Canvas components This layer is normally used for components This layer is used for layered components This layer is used for popup components, such as menus This layer is reserved for future use. This layer is used for toplevel windows. A set of utility functions for thread locking. This interface and all his related methods are deprecated since 2.12. # Implements [`AtkMiscExt`](trait.AtkMiscExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `Misc` methods. # Implementors [`Misc`](struct.Misc.html) Obtain the singleton instance of AtkMisc for this application. # Deprecated Since 2.12. # Returns The singleton instance of AtkMisc for this application. Take the thread mutex for the GUI toolkit, if one exists. (This method is implemented by the toolkit ATK implementation layer; for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER). # Deprecated Since 2.12. Release the thread mutex for the GUI toolkit, if one exists. This method, and atk_misc_threads_enter, are needed in some situations by threaded application code which services ATK requests, since fulfilling ATK requests often requires calling into the GUI toolkit. If a long-running or potentially blocking call takes place inside such a block, it should be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls. (This method is implemented by the toolkit ATK implementation layer; for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE). # Deprecated Since 2.12. An AtkNoOpObject is an AtkObject which purports to implement all ATK interfaces. It is the type of AtkObject which is created if an accessible object is requested for an object type for which no factory type is specified. # Implements [`AtkObjectExt`](trait.AtkObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`AtkActionExt`](trait.AtkActionExt.html), [`ComponentExt`](trait.ComponentExt.html), [`DocumentExt`](trait.DocumentExt.html), [`EditableTextExt`](trait.EditableTextExt.html), [`HypertextExt`](trait.HypertextExt.html), [`AtkImageExt`](trait.AtkImageExt.html), [`SelectionExt`](trait.SelectionExt.html), [`TableExt`](trait.TableExt.html), [`TableCellExt`](trait.TableCellExt.html), [`TextExt`](trait.TextExt.html), [`ValueExt`](trait.ValueExt.html), [`AtkWindowExt`](trait.AtkWindowExt.html), [`EditableTextExtManual`](prelude/trait.EditableTextExtManual.html), [`TableExtManual`](prelude/trait.TableExtManual.html) Provides a default (non-functioning stub) `Object`. Application maintainers should not use this method. ## `obj` a `gobject::Object` # Returns a default (non-functioning stub) `Object` The AtkObjectFactory which creates an AtkNoOpObject. An instance of this is created by an AtkRegistry if no factory type has not been specified to create an accessible object of a particular type. # Implements [`ObjectFactoryExt`](trait.ObjectFactoryExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Creates an instance of an `ObjectFactory` which generates primitive (non-functioning) `AtkObjects`. # Returns an instance of an `ObjectFactory` This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of `Object` (or instances of AtkObject-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of `Object` may also be queried as to whether they implement other ATK interfaces (e.g. `Action`, `Component`, etc.), as appropriate to the role which a given UI component plays in a user interface. All UI components in an application which provide useful information or services to the user must provide corresponding `Object` instances on request (in GTK+, for instance, usually on a call to `gtk_widget_get_accessible` ()), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited `Object` implementation is insufficient, via instances of a new `Object` subclass. See also: `ObjectFactory`, `Registry`. (GTK+ users see also ``GtkAccessible``). # Implements [`AtkObjectExt`](trait.AtkObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `Object` methods. # Implementors [`GObjectAccessible`](struct.GObjectAccessible.html), [`NoOpObject`](struct.NoOpObject.html), [`Object`](struct.Object.html), [`Plug`](struct.Plug.html), [`Socket`](struct.Socket.html), [`TableCell`](struct.TableCell.html), [`Window`](struct.Window.html) Adds a relationship of the specified type with the specified target. ## `relationship` The `RelationType` of the relation ## `target` The `Object` which is to be the target of the relation. # Returns TRUE if the relationship is added. Gets the accessible id of the accessible. Feature: `v2_34` # Returns a character string representing the accessible id of the object, or NULL if no such string was set. Get a list of properties applied to this object as a whole, as an `AttributeSet` 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" `AttributeSet` properties. # Returns an `AttributeSet` consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This `atkattributeset` should be freed by a call to `Attribute::set_free`. Gets the accessible description of the accessible. # Returns a character string representing the accessible description of the accessible. Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. # Returns an integer which is the index of the accessible in its parent Gets the layer of the accessible. # Deprecated Use atk_component_get_layer instead. # Returns an `Layer` which is the layer of the accessible Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI. # Deprecated Use atk_component_get_mdi_zorder instead. # Returns a gint which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container. Gets the number of accessible children of the accessible. # Returns an integer representing the number of accessible children of the accessible. Gets the accessible name of the accessible. # Returns a character string representing the accessible name of the object. Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of `self`. # Returns a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of `self`. Gets the accessible parent of the accessible. By default this is the one assigned with `AtkObjectExt::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 `AtkObjectExt::set_parent`, and will return it with this method. If you are only interested on the parent assigned with `AtkObjectExt::set_parent`, use `AtkObjectExt::peek_parent`. # Returns an `Object` representing the accessible parent of the accessible Gets the role of the accessible. # Returns an `Role` which is the role of the accessible This function is called when implementing subclasses of `Object`. 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 `Object` ## `data` a `gpointer` which identifies the object for which the AtkObject was created. 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. ## `state` an `State` whose state is changed ## `value` a gboolean which indicates whether the state is being set on or off Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns `None`. This method is intended as an utility for ATK implementors, and not to be exposed to accessible tools. See `AtkObjectExt::get_parent` for further reference. # Returns an `Object` representing the accessible parent of the accessible if assigned Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on. ## `i` a gint representing the position of the child, starting from 0 # Returns an `Object` representing the specified accessible child of the accessible. Gets the `RelationSet` associated with the object. # Returns an `RelationSet` representing the relation set of the object. Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. # Returns a reference to an `StateSet` which is the state set of the accessible Removes a relationship of the specified type with the specified target. ## `relationship` The `RelationType` of the relation ## `target` The `Object` which is the target of the relation to be removed. # Returns TRUE if the relationship is removed. 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. Feature: `v2_34` ## `name` a character string to be set as the accessible id Sets the accessible description of the accessible. You can't set the description 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 "". ## `description` a character string to be set as the accessible description 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 "". ## `name` a character string to be set as the accessible name Sets the accessible parent of the accessible. `parent` can be NULL. ## `parent` an `Object` to be set as the accessible parent Sets the role of the accessible. ## `role` an `Role` to be set as the role 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. ## `arg1` the newly focused object. The signal "children-changed" is emitted when a child is added or removed form an object. It supports two details: "add" and "remove" ## `arg1` 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. ## `arg2` 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. The signal "property-change" is emitted when an object's property value changes. `arg1` contains an `PropertyValues` 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 `gobject::ObjectExt::notify` to emit property-changed notifications. `Object::property-changed` is needed by the implementation of `atk_add_global_event_listener` because GObject notify doesn't support emission hooks. ## `arg1` an `PropertyValues` containing the new value of the property which changed. The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed. ## `arg1` The name of the state which has changed ## `arg2` A boolean which indicates whether the state has been set or unset. The "visible-data-changed" signal is emitted when the visual appearance of the object changed. Table caption. # Deprecated Since 1.3. Use table-caption-object instead. Table caption. # Deprecated Since 1.3. Use table-caption-object instead. Accessible table column description. # Deprecated Since 2.12. Use `Table::get_column_description` and `Table::set_column_description` instead. Accessible table column description. # Deprecated Since 2.12. Use `Table::get_column_description` and `Table::set_column_description` instead. Accessible table column header. # Deprecated Since 2.12. Use `Table::get_column_header` and `Table::set_column_header` instead. Accessible table column header. # Deprecated Since 2.12. Use `Table::get_column_header` and `Table::set_column_header` instead. Accessible table row description. # Deprecated Since 2.12. Use `Table::get_row_description` and `Table::set_row_description` instead. Accessible table row description. # Deprecated Since 2.12. Use `Table::get_row_description` and `Table::set_row_description` instead. Accessible table row header. # Deprecated Since 2.12. Use `Table::get_row_header` and `Table::set_row_header` instead. Accessible table row header. # Deprecated Since 2.12. Use `Table::get_row_header` and `Table::set_row_header` instead. Numeric value of this object, in case being and AtkValue. # Deprecated Since 2.12. Use `Value::get_value_and_text` to get the value, and value-changed signal to be notified on their value changes. Numeric value of this object, in case being and AtkValue. # Deprecated Since 2.12. Use `Value::get_value_and_text` to get the value, and value-changed signal to be notified on their value changes. This class is the base object class for a factory used to create an accessible object for a specific GType. The function `RegistryExt::set_factory_type` is normally called to store in the registry the factory type to be used to create an accessible of a particular GType. # Implements [`ObjectFactoryExt`](trait.ObjectFactoryExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `ObjectFactory` methods. # Implementors [`NoOpObjectFactory`](struct.NoOpObjectFactory.html), [`ObjectFactory`](struct.ObjectFactory.html) Provides an `Object` that implements an accessibility interface on behalf of `obj` ## `obj` a `gobject::Object` # Returns an `Object` that implements an accessibility interface on behalf of `obj` Gets the GType of the accessible which is created by the factory. # Returns the type of the accessible which is created by the `self`. The value G_TYPE_INVALID is returned if no type if found. Inform `self` that it is no longer being used to create accessibles. When called, `self` may need to inform `AtkObjects` which it has created that they need to be re-instantiated. Note: primarily used for runtime replacement of `AtkObjectFactorys` in object registries. See `Socket` # Implements [`AtkPlugExt`](trait.AtkPlugExt.html), [`AtkObjectExt`](trait.AtkObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ComponentExt`](trait.ComponentExt.html) Trait containing all `Plug` methods. # Implementors [`Plug`](struct.Plug.html) Creates a new `Plug` instance. # Returns the newly created `Plug` Gets the unique ID of an `Plug` object, which can be used to embed inside of an `Socket` using `AtkSocketExt::embed`. Internally, this calls a class function that should be registered by the IPC layer (usually at-spi2-atk). The implementor of an `Plug` object should call this function (after atk-bridge is loaded) and pass the value to the process implementing the `Socket`, so it could embed the plug. # Returns the unique ID for the plug `Range` are used on `Value`, in order to represent the full range of a given component (for example an slider or a range control), or to define each individual subrange this full range is splitted if available. See `Value` documentation for further details. Creates a new `Range`. ## `lower_limit` inferior limit for this range ## `upper_limit` superior limit for this range ## `description` human readable description of this range. # Returns a new `Range` Returns a new `Range` that is a exact copy of `self` # Returns a new `Range` copy of `self` Free `self` Returns the human readable description of `self` # Returns the human-readable description of `self` Returns the lower limit of `self` # Returns the lower limit of `self` Returns the upper limit of `self` # Returns the upper limit of `self` A data structure for holding a rectangle. Those coordinates are relative to the component top-level parent. The AtkRegistry is normally used to create appropriate ATK "peers" for user interface components. Application developers usually need only interact with the AtkRegistry by associating appropriate ATK implementation classes with GObject classes via the atk_registry_set_factory_type call, passing the appropriate GType for application custom widget classes. # Implements [`RegistryExt`](trait.RegistryExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `Registry` methods. # Implementors [`Registry`](struct.Registry.html) Gets an `ObjectFactory` appropriate for creating `AtkObjects` appropriate for `type_`. ## `type_` a `glib::Type` with which to look up the associated `ObjectFactory` # Returns an `ObjectFactory` appropriate for creating `AtkObjects` appropriate for `type_`. Provides a `glib::Type` indicating the `ObjectFactory` subclass associated with `type_`. ## `type_` a `glib::Type` with which to look up the associated `ObjectFactory` subclass # Returns a `glib::Type` associated with type `type_` Associate an `ObjectFactory` subclass with a `glib::Type`. Note: The associated `factory_type` will thereafter be responsible for the creation of new `Object` implementations for instances appropriate for `type_`. ## `type_` an `Object` type ## `factory_type` an `ObjectFactory` type to associate with `type_`. Must implement AtkObject appropriate for `type_`. An AtkRelation describes a relation between an object and one or more other objects. The actual relations that an object has with other objects are defined as an AtkRelationSet, which is a set of AtkRelations. # Implements [`RelationExt`](trait.RelationExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `Relation` methods. # Implementors [`Relation`](struct.Relation.html) Create a new relation for the specified key and the specified list of targets. See also `AtkObjectExt::add_relationship`. ## `targets` an array of pointers to `AtkObjects` ## `n_targets` number of `AtkObjects` pointed to by `targets` ## `relationship` an `RelationType` with which to create the new `Relation` # Returns a pointer to a new `Relation` Adds the specified AtkObject to the target for the relation, if it is not already present. See also `AtkObjectExt::add_relationship`. ## `target` an `Object` Gets the type of `self` # Returns the type of `self` Gets the target list of `self` # Returns the target list of `self` Remove the specified AtkObject from the target for the relation. ## `target` an `Object` # Returns TRUE if the removal is successful. The AtkRelationSet held by an object establishes its relationships with objects beyond the normal "parent/child" hierarchical relationships that all user interface objects have. AtkRelationSets establish whether objects are labelled or controlled by other components, share group membership with other components (for instance within a radio-button group), or share content which "flows" between them, among other types of possible relationships. # Implements [`RelationSetExt`](trait.RelationSetExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `RelationSet` methods. # Implementors [`RelationSet`](struct.RelationSet.html) Creates a new empty relation set. # Returns a new `RelationSet` Add a new relation to the current relation set if it is not already present. This function ref's the AtkRelation so the caller of this function should unref it to ensure that it will be destroyed when the AtkRelationSet is destroyed. ## `relation` an `Relation` Add a new relation of the specified type with the specified target to the current relation set if the relation set does not contain a relation of that type. If it is does contain a relation of that typea the target is added to the relation. ## `relationship` an `RelationType` ## `target` an `Object` Determines whether the relation set contains a relation that matches the specified type. ## `relationship` an `RelationType` # Returns `true` if `relationship` is the relationship type of a relation in `self`, `false` otherwise Determines whether the relation set contains a relation that matches the specified pair formed by type `relationship` and object `target`. ## `relationship` an `RelationType` ## `target` an `Object` # Returns `true` if `self` contains a relation with the relationship type `relationship` with an object `target`, `false` otherwise Determines the number of relations in a relation set. # Returns an integer representing the number of relations in the set. Determines the relation at the specified position in the relation set. ## `i` a gint representing a position in the set, starting from 0. # Returns a `Relation`, which is the relation at position i in the set. Finds a relation that matches the specified type. ## `relationship` an `RelationType` # Returns an `Relation`, which is a relation matching the specified type. Removes a relation from the relation set. This function unref's the `Relation` so it will be deleted unless there is another reference to it. ## `relation` an `Relation` Describes the type of the relation Not used, represens "no relationship" or an error condition. Indicates an object controlled by one or more target objects. Indicates an object is an controller for one or more target objects. Indicates an object is a label for one or more target objects. Indicates an object is labelled by one or more target objects. Indicates an object is a member of a group of one or more target objects. Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell. Indicates that the object has content that flows logically to another AtkObject in a sequential way, (for instance text-flow). Indicates that the object has content that flows logically from another AtkObject in a sequential way, (for instance text-flow). Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component. Indicates that the object visually embeds another object's content, i.e. this object's content flows around another's content. Reciprocal of `RelationType::Embeds`, indicates that this object's content is visualy embedded in another object. Indicates that an object is a popup for another object. Indicates that an object is a parent window of another object. Reciprocal of `RelationType::DescriptionFor`. Indicates that one or more target objects provide descriptive information about this object. This relation type is most appropriate for information that is not essential as its presentation may be user-configurable and/or limited to an on-demand mechanism such as an assistive technology command. For brief, essential information such as can be found in a widget's on-screen label, use `RelationType::LabelledBy`. For an on-screen error message, use `RelationType::ErrorMessage`. For lengthy extended descriptive information contained in an on-screen object, consider using `RelationType::Details` as assistive technologies may provide a means for the user to navigate to objects containing detailed descriptions so that their content can be more closely reviewed. Reciprocal of `RelationType::DescribedBy`. Indicates that this object provides descriptive information about the target object(s). See also `RelationType::DetailsFor` and `RelationType::ErrorFor`. Indicates an object is a cell in a treetable and is expanded to display other cells in the same column. Reciprocal of `RelationType::DetailsFor`. Indicates that this object has a detailed or extended description, the contents of which can be found in the target object(s). This relation type is most appropriate for information that is sufficiently lengthy as to make navigation to the container of that information desirable. For less verbose information suitable for announcement only, see `RelationType::DescribedBy`. If the detailed information describes an error condition, `RelationType::ErrorFor` should be used instead. `Since`: ATK-2.26. Reciprocal of `RelationType::Details`. Indicates that this object provides a detailed or extended description about the target object(s). See also `RelationType::DescriptionFor` and `RelationType::ErrorFor`. `Since`: ATK-2.26. Reciprocal of `RelationType::ErrorFor`. Indicates that this object has one or more errors, the nature of which is described in the contents of the target object(s). Objects that have this relation type should also contain `StateType::InvalidEntry` in their `StateSet`. `Since`: ATK-2.26. Reciprocal of `RelationType::ErrorMessage`. Indicates that this object contains an error message describing an invalid condition in the target object(s). `Since`: ATK_2.26. Not used, this value indicates the end of the enumeration. 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 >= `Role::LastDefined` is not necessarily an error. Invalid role A label which represents an accelerator 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. An object which is an animated image An arrow in one of the four cardinal directions An object that displays a calendar and allows the user to select a date An object that can be drawn into and is used to trap events A choice that can be checked or unchecked and provides a separate indicator for the current state A menu item with a check box A specialized dialog that lets the user choose a color The header for a column of data A collapsible list of choices the user can select from An object whose purpose is to allow a user to edit a date An inconifed internal frame within a DESKTOP_PANE A pane that supports internal frames and iconified versions of those internal frames An object whose purpose is to allow a user to set a value A top level window with title bar and a border A pane that allows the user to navigate through and select the contents of a directory An object used for drawing custom user interface elements A specialized dialog that lets the user choose a file A object that fills up space in a user interface A specialized dialog that lets the user choose a font A top level window with a title bar, border, menubar, etc. A pane that is guaranteed to be painted on top of all panes beneath it A document container for HTML, whose children represent the document content A small fixed size picture, typically used to decorate components An object whose primary purpose is to display an image A frame-like object that is clipped by a desktop pane An object used to present an icon or short string in an interface A specialized pane that allows its children to be drawn in layers, providing a form of stacking order An object that presents a list of objects to the user and allows the user to select one or more of them An object that represents an element of a list An object usually found inside a menu bar that contains a list of actions the user can choose from 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 An object usually contained in a menu that presents an action the user can choose A specialized pane whose primary use is inside a DIALOG An object that is a child of a page tab list An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object A generic container that is often used to group objects A text object uses for passwords, or other places where the text content is not shown visibly to the user 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 An object used to indicate how much of a task has been completed An object the user can manipulate to tell the application to do something A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected A specialized pane that has a glass pane and a layered pane as its children The header for a row of data An object usually used to allow a user to incrementally view a large amount of data. An object that allows a user to incrementally view a large amount of information An object usually contained in a menu to provide a visible and logical separation of the contents in a menu An object that allows the user to select from a bounded range A specialized panel that presents two other panels at the same time An object used to get an integer or floating point number from the user An object which reports messages of minor importance to the user An object used to represent information in terms of rows and columns A cell in a table The header for a column of a table The header for a row of a table A menu item used to tear off and reattach its menu An object that represents an accessible terminal. (Since: 0.6) An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form. For widgets whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of textual information, see ATK_ROLE_STATIC. A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state A bar or palette usually composed of push buttons or toggle buttons An object that provides information about another object An object used to represent hierarchical information to the user An object capable of expanding and collapsing rows as well as showing multiple columns of data. (Since: 0.7) The object contains some Accessible information, but its role is not known An object usually used in a scroll pane A top level window with no title or border. An object that serves as a document header. (Since: 1.1.1) An object that serves as a document footer. (Since: 1.1.1) An object which is contains a paragraph of text content. (Since: 1.1.1) An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1) The object is an application object, which may contain `Role::Frame` objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. (Since: 1.1.4) 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: 1.3) The object is an editable text object in a toolbar. (Since: 1.5) 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: 1.7.2) The object is a component whose textual content may be entered or modified by the user, provided `StateType::Editable` is present. (Since: 1.11) 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: 1.11) The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. (Since: 1.11) 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: 1.11) 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. The object is a containing instance which encapsulates a page of information. `Role::Page` is used in documents and content which support a paginated navigation model. (Since: 1.11) 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: 1.11) 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: 1.11) 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: 1.12.0) 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: 1.12.1) 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: 1.12.1) A row in a table. (Since: 2.1.0) An object that represents an element of a tree. (Since: 2.1.0) A document frame which contains a spreadsheet. (Since: 2.1.0) A document frame which contains a presentation or slide content. (Since: 2.1.0) A document frame which contains textual content, such as found in a word processing application. (Since: 2.1.0) A document frame which contains HTML or other markup suitable for display in a web browser. (Since: 2.1.0) A document frame which contains email content to be displayed or composed either in plain text or HTML. (Since: 2.1.0) 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: 2.1.0) A non-collapsible list of choices the user can select from. (Since: 2.1.0) A group of related widgets. This group typically has a label. (Since: 2.1.0) 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: 2.1.0) A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. (Since: 2.1.0) An object designed to present a message to the user within an existing window. (Since: 2.1.0) A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. (Since: 2.7.3) A bar that serves as the title of a window or a dialog. (Since: 2.12) An object which contains a text section that is quoted from another source. (Since: 2.12) An object which represents an audio element. (Since: 2.12) An object which represents a video element. (Since: 2.12) A definition of a term or concept. (Since: 2.12) A section of a page that consists of a composition that forms an independent part of a document, page, or site. Examples: A blog entry, a news story, a forum post. (Since: 2.12) A region of a web page intended as a navigational landmark. This is designed to allow Assistive Technologies to provide quick navigation among key regions within a document. (Since: 2.12) A text widget or container holding log content, such as chat history and error logs. In this role there is a relationship between the arrival of new items in the log and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points. (Since: 2.12) A container where non-essential information changes frequently. Common usages of marquee include stock tickers and ad banners. The primary difference between a marquee and a log is that logs usually have a meaningful order or sequence of important content changes. (Since: 2.12) A text widget or container that holds a mathematical expression. (Since: 2.12) A widget whose purpose is to display a rating, such as the number of stars associated with a song in a media player. Objects of this role should also implement AtkValue. (Since: 2.12) An object containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point. (Since: 2.12) An object that represents a list of term-value groups. A term-value group represents a individual description and consist of one or more names (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be more than one group with the same term name. (Since: 2.12) An object that represents a term or phrase with a corresponding definition. (Since: 2.12) An object that represents the description, definition or value of a term. (Since: 2.12) A generic non-container object whose purpose is to display a brief amount of information to the user and whose role is known by the implementor but lacks semantic value for the user. Examples in which `Role::Static` is appropriate include the message displayed in a message box and an image used as an alternative means to display text. `Role::Static` should not be applied to widgets which are traditionally interactive, objects which display a significant amount of content, or any object which has an accessible relation pointing to another object. Implementors should expose the displayed information through the accessible name of the object. If doing so seems inappropriate, it may indicate that a different role should be used. For labels which describe another widget, see `Role::Label`. For text views, see `Role::Text`. For generic containers, see `Role::Panel`. For objects whose role is not known by the implementor, see `Role::Unknown`. (Since: 2.16) An object that represents a mathematical fraction. (Since: 2.16) An object that represents a mathematical expression displayed with a radical. (Since: 2.16) An object that contains text that is displayed as a subscript. (Since: 2.16) An object that contains text that is displayed as a superscript. (Since: 2.16) An object that contains the text of a footnote. (Since: 2.26) Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers. (Since: 2.34) Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers. (Since: 2.34) not a valid role, used for finding end of the enumeration Specifies where an object should be placed on the screen when using scroll_to. Scroll the object vertically and horizontally to the top left corner of the window. Scroll the object vertically and horizontally to the bottom right corner of the window. Scroll the object vertically to the top edge of the window. Scroll the object vertically to the bottom edge of the window. Scroll the object vertically and horizontally to the left edge of the window. Scroll the object vertically and horizontally to the right edge of the window. Scroll the object vertically and horizontally so that as much as possible of the object becomes visible. The exact placement is determined by the application. Feature: `v2_30` `Selection` should be implemented by UI components with children which are exposed by `atk_object_ref_child` and `atk_object_get_n_children`, if the use of the parent UI component ordinarily involves selection of one or more of the objects corresponding to those `Object` children - for example, selectable lists. Note that other types of "selection" (for instance text selection) are accomplished a other ATK interfaces - `Selection` is limited to the selection/deselection of children. # Implements [`SelectionExt`](trait.SelectionExt.html) Trait containing all `Selection` methods. # Implementors [`NoOpObject`](struct.NoOpObject.html), [`Selection`](struct.Selection.html) Adds the specified accessible child of the object to the object's selection. ## `i` a `gint` specifying the child index. # Returns TRUE if success, FALSE otherwise. Clears the selection in the object so that no children in the object are selected. # Returns TRUE if success, FALSE otherwise. Gets the number of accessible children currently selected. Note: callers should not rely on `None` 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. # Returns a gint representing the number of items selected, or 0 if `self` does not implement this interface. Determines if the current child of this object is selected Note: callers should not rely on `None` 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. ## `i` a `gint` specifying the child index. # Returns a gboolean representing the specified child is selected, or 0 if `self` does not implement this interface. Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on `None` 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. ## `i` a `gint` specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). # Returns an `Object` representing the selected accessible, or `None` if `self` does not implement this interface. Removes the specified child of the object from the object's selection. ## `i` a `gint` specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child). # Returns TRUE if success, FALSE otherwise. Causes every child of the object to be selected if the object supports multiple selections. # Returns TRUE if success, FALSE otherwise. The "selection-changed" signal is emitted by an object which implements AtkSelection interface when the selection changes. Together with `Plug`, `Socket` provides the ability to embed accessibles from one process into another in a fashion that is transparent to assistive technologies. `Socket` works as the container of `Plug`, embedding it using the method `AtkSocketExt::embed`. Any accessible contained in the `Plug` will appear to the assistive technologies as being inside the application that created the `Socket`. The communication between a `Socket` and a `Plug` is done by the IPC layer of the accessibility framework, normally implemented by the D-Bus based implementation of AT-SPI (at-spi2). If that is the case, at-spi-atk2 is the responsible to implement the abstract methods `AtkPlugExt::get_id` and `AtkSocketExt::embed`, so an ATK implementor shouldn't reimplement them. The process that contains the `Plug` is responsible to send the ID returned by `atk_plug_id` to the process that contains the `Socket`, so it could call the method `AtkSocketExt::embed` in order to embed it. For the same reasons, an implementor doesn't need to implement `AtkObjectExt::get_n_accessible_children` and `AtkObjectExt::ref_accessible_child`. All the logic related to those functions will be implemented by the IPC layer. # Implements [`AtkSocketExt`](trait.AtkSocketExt.html), [`AtkObjectExt`](trait.AtkObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ComponentExt`](trait.ComponentExt.html) Trait containing all `Socket` methods. # Implementors [`Socket`](struct.Socket.html) Creates a new `Socket`. # Returns the newly created `Socket` instance Embeds the children of an `Plug` as the children of the `Socket`. The plug may be in the same process or in a different process. The class item used by this function should be filled in by the IPC layer (usually at-spi2-atk). The implementor of the AtkSocket should call this function and pass the id for the plug as returned by `AtkPlugExt::get_id`. It is the responsibility of the application to pass the plug id on to the process implementing the `Socket` as needed. ## `plug_id` the ID of an `Plug` Determines whether or not the socket has an embedded plug. # Returns TRUE if a plug is embedded in the socket An AtkStateSet is a read-only representation of the full set of `AtkStates` that apply to an object at a given time. This set is not meant to be modified, but rather created when `AtkObjectExt::ref_state_set`() is called. # Implements [`StateSetExt`](trait.StateSetExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `StateSet` methods. # Implementors [`StateSet`](struct.StateSet.html) Creates a new empty state set. # Returns a new `StateSet` Adds the state of the specified type to the state set if it is not already present. Note that because an `StateSet` 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 `AtkObjectExt::ref_state_set`. It should not be used to modify the existing state of an object. See also `AtkObjectExt::notify_state_change`. ## `type_` an `StateType` # Returns `true` if the state for `type_` is not already in `self`. Adds the states of the specified types to the state set. Note that because an `StateSet` is a read-only object, this method should be used to add states to a newly-created set which will then be returned by `AtkObjectExt::ref_state_set`. It should not be used to modify the existing state of an object. See also `AtkObjectExt::notify_state_change`. ## `types` an array of `StateType` ## `n_types` The number of elements in the array Constructs the intersection of the two sets, returning `None` if the intersection is empty. ## `compare_set` another `StateSet` # Returns a new `StateSet` which is the intersection of the two sets. Removes all states from the state set. Checks whether the state for the specified type is in the specified set. ## `type_` an `StateType` # Returns `true` if `type_` is the state type is in `self`. Checks whether the states for all the specified types are in the specified set. ## `types` an array of `StateType` ## `n_types` The number of elements in the array # Returns `true` if all the states for `type_` are in `self`. Checks whether the state set is empty, i.e. has no states set. # Returns `true` if `self` has no states set, otherwise `false` Constructs the union of the two sets. ## `compare_set` another `StateSet` # Returns a new `StateSet` which is the union of the two sets, returning `None` is empty. Removes the state for the specified type from the state set. Note that because an `StateSet` 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 `AtkObjectExt::ref_state_set`. It should not be used to modify the existing state of an object. See also `AtkObjectExt::notify_state_change`. ## `type_` an `AtkType` # Returns `true` if `type_` was the state type is in `self`. Constructs the exclusive-or of the two sets, returning `None` is empty. The set returned by this operation contains the states in exactly one of the two sets. ## `compare_set` another `StateSet` # Returns a new `StateSet` which contains the states which are in exactly one of the two sets. The possible types of states of an object Indicates an invalid state - probably an error condition. Indicates a window is currently the active window, or an object is the active subelement within a container or table. ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_STATE_ACTIVE is a means to indicate that an object which is not focusable and not selectable is the currently-active item within its parent container. Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code. Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed. Indicates this object is currently checked, for instance a checkbox is 'non-empty'. Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed) Indicates that this object can contain text, and that the user can change the textual contents of this object by editing those contents directly. For an object which is expected to be editable due to its type, but which cannot be edited due to the application or platform preventing the user from doing so, that object's `StateSet` should lack ATK_STATE_EDITABLE and should contain ATK_STATE_READ_ONLY. Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE Indicates this object allows progressive disclosure of its children Indicates this object its expanded - see ATK_STATE_EXPANDABLE above Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus Indicates this object currently has the keyboard focus Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful. Indicates this object is minimized and is represented only by an icon Indicates something must be done with this object before the user can interact with an object in a different window Indicates this (text) object can contain multiple lines of text Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections. Indicates this object paints every pixel within its rectangular region. Indicates this object is currently pressed. Indicates the size of this object is not fixed Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected Indicates this object is sensitive, e.g. to user interaction. STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, but may be found in the absence of STATE_ENABLED if the current visible state of the control is "disconnected" from the application state. In such cases, direct user interaction can often result in the object gaining STATE_SENSITIVE, for instance if a user makes an explicit selection using an object whose current state is ambiguous or undefined. `see` STATE_ENABLED, STATE_INDETERMINATE. Indicates this object, the object's parent, the object's parent's parent, and so on, are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose between this object and the top of the window stack. Indicates this (text) object can contain only a single line of text Indicates that the information returned for this object may no longer be synchronized with the application state. This is implied if the object has STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that the index associated with this object has changed since the user accessed the object (in lieu of "index-in-parent-changed" events). Indicates this object is transient, i.e. a snapshot which may not emit events when its state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no notification given when the cached data becomes obsolete. Indicates the orientation of this object is vertical Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. **note**: `StateType::Visible` is no guarantee that the object is actually unobscured on the screen, only that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the field of view, or having an ancestor container that has not yet made visible. A widget is potentially onscreen if it has both `StateType::Visible` and `StateType::Showing`. The absence of `StateType::Visible` and `StateType::Showing` is semantically equivalent to saying that an object is 'hidden'. See also `StateType::Truncated`, which applies if an object with `StateType::Visible` and `StateType::Showing` set lies within a viewport which means that its contents are clipped, e.g. a truncated spreadsheet cell or an image within a scrolling viewport. Mostly useful for screen-review and magnification algorithms. Indicates that "active-descendant-changed" event is sent when children become 'active' (i.e. are selected or navigated to onscreen). Used to prevent need to enumerate all children in very large containers, like tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. that the children should not, and need not, be enumerated by the client. Objects implementing this state are expected to provide relevant state notifications to listening clients, for instance notifications of visibility changes and activation of their contained child objects, without the client having previously requested references to those children. Indicates that the value, or some other quantifiable property, of this AtkObject cannot be fully determined. In the case of a large data set in which the total number of items in that set is unknown (e.g. 1 of 999+), implementors should expose the currently-known set size (999) along with this state. In the case of a check box, this state should be used to indicate that the check box is a tri-state check box which is currently neither checked nor unchecked. Indicates that an object is truncated, e.g. a text value in a speradsheet cell. Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface. Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input. Indicates that the object in question implements some form of ¨typeahead¨ or pre-selection behavior whereby entering the first character of one or more sub-elements causes those elements to scroll into view or become selected. Subsequent character input may narrow the selection further as long as one or more sub-elements match the string. This state is normally only useful and encountered on objects that implement Selection. In some cases the typeahead behavior may result in full or partial ¨completion¨ of the data in the input field, in which case these input events may trigger text-changed events from the AtkText interface. This state supplants `Role::Autocomplete`. Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from `StateType::Selectable`, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations. Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button. Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation. **note**: some applications, notably content viewers, may not be able to detect all kinds of animated content. Therefore the absence of this state should not be taken as definitive evidence that the object's visual representation is static; this state is advisory. Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited". Indicates this object has the potential to be checked, such as a checkbox or toggle-able table cell. `Since`: ATK-2.12 Indicates that the object has a popup context menu or sub-level menu which may or may not be showing. This means that activation renders conditional content. Note that ordinary tooltips are not considered popups in this context. `Since`: ATK-2.12 Indicates this object has a tooltip. `Since`: ATK-2.16 Indicates that a widget which is ENABLED and SENSITIVE has a value which can be read, but not modified, by the user. Note that this state should only be applied to widget types whose value is normally directly user modifiable, such as check boxes, radio buttons, spin buttons, text input fields, and combo boxes, as a means to convey that the expected interaction with that widget is not possible. When the expected interaction with a widget does not include modification by the user, as is the case with labels and containers, ATK_STATE_READ_ONLY should not be applied. See also ATK_STATE_EDITABLE. `Since`: ATK-2-16 Not a valid state, used for finding end of enumeration An interface whereby an object allows its backing content to be streamed to clients. Typical implementors would be images or icons, HTML content, or multimedia display/rendering widgets. Negotiation of content type is allowed. Clients may examine the backing data and transform, convert, or parse the content in order to present it in an alternate form to end-users. The AtkStreamableContent interface is particularly useful for saving, printing, or post-processing entire documents, or for persisting alternate views of a document. If document content itself is being serialized, stored, or converted, then use of the AtkStreamableContent interface can help address performance issues. Unlike most ATK interfaces, this interface is not strongly tied to the current user-agent view of the a particular document, but may in some cases give access to the underlying model data. # Implements [`StreamableContentExt`](trait.StreamableContentExt.html) Trait containing all `StreamableContent` methods. # Implementors [`StreamableContent`](struct.StreamableContent.html) Gets the character string of the specified mime type. The first mime type is at position 0, the second at position 1, and so on. ## `i` a gint representing the position of the mime type starting from 0 # Returns a gchar* representing the specified mime type; the caller should not free the character string. Gets the number of mime types supported by this object. # Returns a gint which is the number of mime types supported by the object. Gets the content in the specified mime type. ## `mime_type` a gchar* representing the mime type # Returns A `glib::IOChannel` which contains the content in the specified mime type. Get a string representing a URI in IETF standard format (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content may be streamed in the specified mime-type, if one is available. If mime_type is NULL, the URI for the default (and possibly only) mime-type is returned. Note that it is possible for get_uri to return NULL but for get_stream to work nonetheless, since not all GIOChannels connect to URIs. ## `mime_type` a gchar* representing the mime type, or NULL to request a URI for the default mime type. # Returns Returns a string representing a URI, or `None` if no corresponding URI can be constructed. `Table` should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple "columns". Individual elements of an `Table` are typically referred to as "cells". Those cells should implement the interface `TableCell`, but `Atk` doesn't require them to be direct children of the current `Table`. They can be grand-children, grand-grand-children etc. `Table` provides the API needed to get a individual cell based on the row and column numbers. Children of `Table` are frequently "lightweight" objects, that is, they may not have backing widgets in the host UI toolkit. They are therefore often transient. Since tables are often very complex, `Table` includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are `AtkObjects` which may implement other interfaces (`Text`, `Image`, etc.) as appropriate. `Table` summaries may themselves be (simplified) `AtkTables`, etc. Note for implementors: in the past, `Table` required that all the cells should be direct children of `Table`, and provided some index based methods to request the cells. The practice showed that that forcing made `Table` implementation complex, and hard to expose other kind of children, like rows or captions. Right now, index-based methods are deprecated. # Implements [`TableExt`](trait.TableExt.html), [`TableExtManual`](prelude/trait.TableExtManual.html) Trait containing all `Table` methods. # Implementors [`NoOpObject`](struct.NoOpObject.html), [`Table`](struct.Table.html) Adds the specified `column` to the selection. ## `column` a `gint` representing a column in `self` # Returns a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface. Adds the specified `row` to the selection. ## `row` a `gint` representing a row in `self` # Returns a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface. Gets the caption for the `self`. # Returns a AtkObject* representing the table caption, or `None` if value does not implement this interface. Gets a `gint` representing the column at the specified `index_`. # Deprecated Since 2.12. ## `index_` a `gint` representing an index in `self` # Returns a gint representing the column at the specified index, or -1 if the table does not implement this method. Gets the description text of the specified `column` in the table ## `column` a `gint` representing a column in `self` # Returns a gchar* representing the column description, or `None` if value does not implement this interface. Gets the number of columns occupied by the accessible object at the specified `row` and `column` in the `self`. ## `row` a `gint` representing a row in `self` ## `column` a `gint` representing a column in `self` # Returns a gint representing the column extent at specified position, or 0 if value does not implement this interface. Gets the column header of a specified column in an accessible table. ## `column` a `gint` representing a column in the table # Returns a AtkObject* representing the specified column header, or `None` if value does not implement this interface. Gets a `gint` representing the index at the specified `row` and `column`. # Deprecated Since 2.12. Use `Table::ref_at` in order to get the accessible that represents the cell at (`row`, `column`) ## `row` a `gint` representing a row in `self` ## `column` a `gint` representing a column in `self` # Returns a `gint` representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface. Gets the number of columns in the table. # Returns a gint representing the number of columns, or 0 if value does not implement this interface. Gets the number of rows in the table. # Returns a gint representing the number of rows, or 0 if value does not implement this interface. Gets a `gint` representing the row at the specified `index_`. # Deprecated since 2.12. ## `index_` a `gint` representing an index in `self` # Returns a gint representing the row at the specified index, or -1 if the table does not implement this method. Gets the description text of the specified row in the table ## `row` a `gint` representing a row in `self` # Returns a gchar* representing the row description, or `None` if value does not implement this interface. Gets the number of rows occupied by the accessible object at a specified `row` and `column` in the `self`. ## `row` a `gint` representing a row in `self` ## `column` a `gint` representing a column in `self` # Returns a gint representing the row extent at specified position, or 0 if value does not implement this interface. Gets the row header of a specified row in an accessible table. ## `row` a `gint` representing a row in the table # Returns a AtkObject* representing the specified row header, or `None` if value does not implement this interface. Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller. ## `selected` a `gint`** that is to contain the selected columns numbers # Returns a gint representing the number of selected columns, or `0` if value does not implement this interface. Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller. ## `selected` a `gint`** that is to contain the selected row numbers # Returns a gint representing the number of selected rows, or zero if value does not implement this interface. Gets the summary description of the table. # Returns a AtkObject* representing a summary description of the table, or zero if value does not implement this interface. Gets a boolean value indicating whether the specified `column` is selected ## `column` a `gint` representing a column in `self` # Returns a gboolean representing if the column is selected, or 0 if value does not implement this interface. Gets a boolean value indicating whether the specified `row` is selected ## `row` a `gint` representing a row in `self` # Returns a gboolean representing if the row is selected, or 0 if value does not implement this interface. Gets a boolean value indicating whether the accessible object at the specified `row` and `column` is selected ## `row` a `gint` representing a row in `self` ## `column` a `gint` representing a column in `self` # Returns a gboolean representing if the cell is selected, or 0 if value does not implement this interface. Get a reference to the table cell at `row`, `column`. This cell should implement the interface `TableCell` ## `row` a `gint` representing a row in `self` ## `column` a `gint` representing a column in `self` # Returns an `Object` representing the referred to accessible Adds the specified `column` to the selection. ## `column` a `gint` representing a column in `self` # Returns a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface. Removes the specified `row` from the selection. ## `row` a `gint` representing a row in `self` # Returns a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface. Sets the caption for the table. ## `caption` a `Object` representing the caption to set for `self` Sets the description text for the specified `column` of the `self`. ## `column` a `gint` representing a column in `self` ## `description` a `gchar` representing the description text to set for the specified `column` of the `self` Sets the specified column header to `header`. ## `column` a `gint` representing a column in `self` ## `header` an `Table` Sets the description text for the specified `row` of `self`. ## `row` a `gint` representing a row in `self` ## `description` a `gchar` representing the description text to set for the specified `row` of `self` Sets the specified row header to `header`. ## `row` a `gint` representing a row in `self` ## `header` an `Table` Sets the summary description of the table. ## `accessible` an `Object` representing the summary description to set for `self` The "column-deleted" signal is emitted by an object which implements the AtkTable interface when a column is deleted. ## `arg1` The index of the first column deleted. ## `arg2` The number of columns deleted. The "column-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted. ## `arg1` The index of the column inserted. ## `arg2` The number of colums inserted. The "column-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered. The "model-changed" signal is emitted by an object which implements the AtkTable interface when the model displayed by the table changes. The "row-deleted" signal is emitted by an object which implements the AtkTable interface when a row is deleted. ## `arg1` The index of the first row deleted. ## `arg2` The number of rows deleted. The "row-inserted" signal is emitted by an object which implements the AtkTable interface when a row is inserted. ## `arg1` The index of the first row inserted. ## `arg2` The number of rows inserted. The "row-reordered" signal is emitted by an object which implements the AtkTable interface when the rows are reordered. Being `Table` a component which present elements ordered via rows and columns, an `TableCell` is the interface which each of those elements, so "cells" should implement. See also `Table`. # Implements [`TableCellExt`](trait.TableCellExt.html), [`AtkObjectExt`](trait.AtkObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `TableCell` methods. # Implementors [`NoOpObject`](struct.NoOpObject.html), [`TableCell`](struct.TableCell.html) Returns the column headers as an array of cell accessibles. # Returns a GPtrArray of AtkObjects representing the column header cells. Returns the number of columns occupied by this cell accessible. # Returns a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method. Retrieves the tabular position of this cell. ## `row` the row of the given cell. ## `column` the column of the given cell. # Returns TRUE if successful; FALSE otherwise. 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. ## `row` the row index of the given cell. ## `column` the column index of the given cell. ## `row_span` the number of rows occupied by this cell. ## `column_span` the number of columns occupied by this cell. # Returns TRUE if successful; FALSE otherwise. Returns the row headers as an array of cell accessibles. # Returns a GPtrArray of AtkObjects representing the row header cells. Returns the number of rows occupied by this cell accessible. # Returns a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method. Returns a reference to the accessible of the containing table. # Returns the atk object for the containing table. `Text` should be implemented by `AtkObjects` on behalf of widgets that have text content which is either attributed or otherwise non-trivial. `AtkObjects` whose text content is simple, unattributed, and very brief may expose that content via `AtkObjectExt::get_name` instead; however if the text is editable, multi-line, typically longer than three or four words, attributed, selectable, or if the object already uses the 'name' ATK property for other information, the `Text` interface should be used to expose the text content. In the case of editable text content, `EditableText` (a subtype of the `Text` interface) should be implemented instead. `Text` provides not only traversal facilities and change notification for text content, but also caret tracking and glyph bounding box calculations. Note that the text strings are exposed as UTF-8, and are therefore potentially multi-byte, and caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures. # Implements [`TextExt`](trait.TextExt.html) Trait containing all `Text` methods. # Implementors [`NoOpObject`](struct.NoOpObject.html), [`Text`](struct.Text.html) Frees the memory associated with an array of AtkTextRange. It is assumed that the array was returned by the function atk_text_get_bounded_ranges and is NULL terminated. ## `ranges` A pointer to an array of `TextRange` which is to be freed. Adds a selection bounded by the specified offsets. ## `start_offset` the starting character offset of the selected region ## `end_offset` the offset of the first character after the selected region. # Returns `true` if successful, `false` otherwise Get the ranges of text in the specified bounding box. ## `rect` An AtkTextRectangle giving the dimensions of the bounding box. ## `coord_type` Specify whether coordinates are relative to the screen or widget window. ## `x_clip_type` Specify the horizontal clip type. ## `y_clip_type` Specify the vertical clip type. # Returns Array of AtkTextRange. The last element of the array returned by this function will be NULL. Gets the offset of the position of the caret (cursor). # Returns the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure. Gets the specified text. ## `offset` a character offset within `self` # Returns the character at `offset` or 0 in the case of failure. Gets the character count. # Returns the number of characters or -1 in case of failure. Get the bounding box containing the glyph representing the character at a particular text offset. ## `offset` The offset of the text character for which bounding information is required. ## `x` Pointer for the x coordinate of the bounding box ## `y` Pointer for the y coordinate of the bounding box ## `width` Pointer for the width of the bounding box ## `height` Pointer for the height of the bounding box ## `coords` specify whether coordinates are relative to the screen or widget window Creates an `AttributeSet` 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 an `AttributeSet` which contains the default text attributes for this `Text`. This `AttributeSet` should be freed by a call to `Attribute::set_free`. Gets the number of selected regions. # Returns The number of selected regions, or -1 in the case of failure. 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`. ## `x` screen x-position of character ## `y` screen y-position of character ## `coords` specify whether coordinates are relative to the screen or widget window # Returns the offset to the character which is located at the specified `x` and `y` coordinates of -1 in case of failure. Get the bounding box for text within the specified range. ## `start_offset` The offset of the first text character for which boundary information is required. ## `end_offset` The offset of the text character after the last character for which boundary information is required. ## `coord_type` Specify whether coordinates are relative to the screen or widget window. ## `rect` A pointer to a AtkTextRectangle which is filled in by this function. Creates an `AttributeSet` 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. ## `offset` the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location. ## `start_offset` the address to put the start offset of the range ## `end_offset` the address to put the end offset of the range # Returns an `AttributeSet` which contains the attributes explicitly set at `offset`. This `AttributeSet` should be freed by a call to `Attribute::set_free`. Gets the text from the specified selection. ## `selection_num` 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. ## `start_offset` passes back the starting character offset of the selected region ## `end_offset` passes back the ending character offset (offset immediately past) of the selected region # Returns a newly allocated string containing the selected text. Use `g_free` to free the returned string. Gets a portion of the text exposed through an `Text` 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. ## `offset` position ## `granularity` An `TextGranularity` ## `start_offset` the starting character offset of the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) ## `end_offset` the offset of the first character after the returned string, or -1 in the case of error (e.g. invalid offset, not implemented) # Returns a newly allocated string containing the text at the `offset` bounded by the specified `granularity`. Use `g_free` to free the returned string. Returns `None` if the offset is invalid or no implementation is available. Gets the specified text. ## `start_offset` a starting character offset within `self` ## `end_offset` an ending character offset within `self`, or -1 for the end of the string. # Returns a newly allocated string containing the text from `start_offset` up to, but not including `end_offset`. Use `g_free` to free the returned string. 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. # Deprecated This method is deprecated since ATK version 2.9.4. Please use `Text::get_string_at_offset` instead. ## `offset` position ## `boundary_type` An `TextBoundary` ## `start_offset` the starting character offset of the returned string ## `end_offset` the offset of the first character after the returned substring # Returns a newly allocated string containing the text at `offset` bounded by the specified `boundary_type`. Use `g_free` to free the returned string. Removes the specified selection. ## `selection_num` 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. # Returns `true` if successful, `false` otherwise Makes `self` visible on the screen by scrolling all necessary parents. Contrary to atk_text_set_position, this does not actually move `self` 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. Feature: `v2_32` ## `start_offset` start position ## `end_offset` end position, or -1 for the end of the string. ## `type_` specify where the object should be made visible. # Returns whether scrolling was successful. Makes an object visible on the screen at a given position by scrolling all necessary parents. Feature: `v2_32` ## `start_offset` start position ## `end_offset` end position, or -1 for the end of the string. ## `coords` specify whether coordinates are relative to the screen or to the parent object. ## `x` x-position where to scroll to ## `y` y-position where to scroll to # Returns whether scrolling was successful. Sets the caret (cursor) position to the specified `offset`. ## `offset` the character offset of the new caret position # Returns `true` if successful, `false` otherwise. Changes the start and end offset of the specified selection. ## `selection_num` 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. ## `start_offset` the new starting character offset of the selection ## `end_offset` the new end position of (e.g. offset immediately past) the selection # Returns `true` if successful, `false` otherwise The "text-attributes-changed" signal is emitted when the text attributes of the text of an object which implements AtkText changes. The "text-caret-moved" signal is emitted when the caret position of the text of an object which implements AtkText changes. ## `arg1` The new position of the text caret. 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. ## `arg1` The position (character offset) of the insertion. ## `arg2` The length (in characters) of text inserted. ## `arg3` The new text inserted 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. ## `arg1` The position (character offset) of the removal. ## `arg2` The length (in characters) of text removed. ## `arg3` The old text removed The "text-selection-changed" signal is emitted when the selected text of an object which implements AtkText changes. Describes the text attributes supported Invalid attribute, like bad spelling or grammar. The pixel width of the left margin The pixel width of the right margin The number of pixels that the text is indented Either "true" or "false" indicating whether text is visible or not Either "true" or "false" indicating whether text is editable or not Pixels of blank space to leave above each newline-terminated line. Pixels of blank space to leave below each newline-terminated line. Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph). "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character. Number of pixels that the characters are risen above the baseline "none", "single", "double", "low", or "error" "true" or "false" whether the text is strikethrough The size of the characters in points. eg: 10 The scale of the characters. The value is a string representation of a double The weight of the characters. The language used The font family name The background color. The value is an RGB value of the format "`u`,`u`,`u`" The foreground color. The value is an RGB value of the format "`u`,`u`,`u`" "true" if a ``GdkBitmap`` is set for stippling the background color. "true" if a ``GdkBitmap`` is set for stippling the foreground color. The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char". The direction of the text, if set. Values are "none", "ltr" or "rtl" The justification of the text, if set. Values are "left", "right", "center" or "fill" The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded" The capitalization variant of the text, if set. Values are "normal" or "small_caps" The slant style of the text, if set. Values are "normal", "oblique" or "italic" not a valid text attribute, used for finding end of enumeration Text boundary types used for specifying boundaries for regions of text. This enumeration is deprecated since 2.9.4 and should not be used. Use AtkTextGranularity with `Text::get_string_at_offset` instead. Boundary is the boundary between characters (including non-printing characters) Boundary is the start (i.e. first character) of a word. Boundary is the end (i.e. last character) of a word. Boundary is the first character in a sentence. 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. Boundary is the initial character of the content or a character immediately following a newline, linefeed, or return character. Boundary is the linefeed, or return character. Describes the type of clipping required. No clipping to be done Text clipped by min coordinate is omitted Text clipped by max coordinate is omitted Only text fully within mix/max bound is retained Text granularity types used for specifying the granularity of the region of text we are interested in. Granularity is defined by the boundaries between characters (including non-printing characters) 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. 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. 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. 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. A structure used to describe a text range. A set of ATK utility functions which are used to support event registration of various types, and obtaining the 'root' accessible of a process and information about the current ATK implementation and toolkit version. # Implements [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) `Value` should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have `Object` representations which implement `Value` on the component's behalf. `AtKValues` may be read-only, in which case attempts to alter the value return would fail. `` `` In addition to providing the current value, implementors can optionally provide an end-user-consumable textual description associated with this value. This description should be included when the numeric value fails to convey the full, on-screen representation seen by users. `` `` `` A password strength meter whose value changes as the user types their new password. Red is used for values less than 4.0, yellow for values between 4.0 and 7.0, and green for values greater than 7.0. In this instance, value text should be provided by the implementor. Appropriate value text would be "weak", "acceptable," and "strong" respectively. `` A level bar whose value changes to reflect the battery charge. The color remains the same regardless of the charge and there is no on-screen text reflecting the fullness of the battery. In this case, because the position within the bar is the only indication the user has of the current charge, value text should not be provided by the implementor. `` `` Implementors should bear in mind that assistive technologies will likely prefer the value text provided over the numeric value when presenting a widget's value. As a result, strings not intended for end users should not be exposed in the value text, and strings which are exposed should be localized. In the case of widgets which display value text on screen, for instance through a separate label in close proximity to the value-displaying widget, it is still expected that implementors will expose the value text using the above API. `` `` `Value` should NOT be implemented for widgets whose displayed value is not reflective of a meaningful amount. For instance, a progress pulse indicator whose value alternates between 0.0 and 1.0 to indicate that some process is still taking place should not implement `Value` because the current value does not reflect progress towards completion. `` `` `` `` `` In addition to providing the minimum and maximum values, implementors can optionally provide details about subranges associated with the widget. These details should be provided by the implementor when both of the following are communicated visually to the end user: `` `` ``The existence of distinct ranges such as "weak", "acceptable", and "strong" indicated by color, bar tick marks, and/or on-screen text.`` ``Where the current value stands within a given subrange, for instance illustrating progression from very "weak" towards nearly "acceptable" through changes in shade and/or position on the bar within the "weak" subrange.`` `` `` If both of the above do not apply to the widget, it should be sufficient to expose the numeric value, along with the value text if appropriate, to make the widget accessible. `` `` `` If providing subrange details is deemed necessary, all possible values of the widget are expected to fall within one of the subranges defined by the implementor. `` `` `` `` `` Because value text and subrange descriptors are human-consumable, implementors are expected to provide localized strings which can be directly presented to end users via their assistive technology. In order to simplify this for implementors, implementors can use `ValueType::get_localized_name` with the following already-localized constants for commonly-needed values can be used: `` `` ``ATK_VALUE_VERY_WEAK`` ``ATK_VALUE_WEAK`` ``ATK_VALUE_ACCEPTABLE`` ``ATK_VALUE_STRONG`` ``ATK_VALUE_VERY_STRONG`` ``ATK_VALUE_VERY_LOW`` ``ATK_VALUE_LOW`` ``ATK_VALUE_MEDIUM`` ``ATK_VALUE_HIGH`` ``ATK_VALUE_VERY_HIGH`` ``ATK_VALUE_VERY_BAD`` ``ATK_VALUE_BAD`` ``ATK_VALUE_GOOD`` ``ATK_VALUE_VERY_GOOD`` ``ATK_VALUE_BEST`` ``ATK_VALUE_SUBSUBOPTIMAL`` ``ATK_VALUE_SUBOPTIMAL`` ``ATK_VALUE_OPTIMAL`` `` `` Proposals for additional constants, along with their use cases, should be submitted to the GNOME Accessibility Team. `` `` `` `` 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. `` `` # Implements [`ValueExt`](trait.ValueExt.html) Trait containing all `Value` methods. # Implementors [`NoOpObject`](struct.NoOpObject.html), [`Value`](struct.Value.html) Gets the value of this object. # Deprecated Since 2.12. Use `Value::get_value_and_text` instead. ## `value` a `gobject::Value` representing the current accessible value Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. # Returns the minimum increment by which the value of this object may be changed. zero if undefined. Gets the maximum value of this object. # Deprecated Since 2.12. Use `Value::get_range` instead. ## `value` a `gobject::Value` representing the maximum accessible value Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform. # Deprecated Since 2.12. Use `Value::get_increment` instead. ## `value` a `gobject::Value` representing the minimum increment by which the accessible value may be changed Gets the minimum value of this object. # Deprecated Since 2.12. Use `Value::get_range` instead. ## `value` a `gobject::Value` representing the minimum accessible value Gets the range of this object. # Returns a newly allocated `Range` that represents the minimum, maximum and descriptor (if available) of `self`. NULL if that range is not defined. Gets the list of subranges defined for this object. See `Value` introduction for examples of subranges and when to expose them. # Returns an `glib::SList` of `Range` which each of the subranges defined for this object. Free the returns list with `glib::SList::free`. Gets the current value and the human readable text alternative of `self`. `text` is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available. ## `value` address of `gdouble` to put the current value of `self` ## `text` address of `gchar` to put the human readable text alternative for `value` Sets the value of this object. # Deprecated Since 2.12. Use `Value::set_value` instead. ## `value` a `gobject::Value` which is the desired new accessible value. # Returns `true` if new value is successfully set, `false` otherwise. 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 `Value::value-changed` signal emission. Note for implementors: the deprecated `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. ## `new_value` a double which is the desired new accessible value. 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". ## `value` the new value in a numerical form. ## `text` human readable text alternative (also called description) of this object. NULL if not available. Default types for a given value. Those are defined in order to easily get localized strings to describe a given value or a given subrange, using `ValueType::get_localized_name`. `Window` should be implemented by the UI elements that represent a top-level window, such as the main window of an application or dialog. # Implements [`AtkWindowExt`](trait.AtkWindowExt.html), [`AtkObjectExt`](trait.AtkObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html) Trait containing all `Window` methods. # Implementors [`NoOpObject`](struct.NoOpObject.html), [`Window`](struct.Window.html) The signal `Window::activate` is emitted when a window becomes the active window of the application or session. The signal `Window::create` is emitted when a new window is created. The signal `Window::deactivate` is emitted when a window is no longer the active window of the application or session. The signal `Window::destroy` is emitted when a window is destroyed. The signal `Window::maximize` is emitted when a window is maximized. The signal `Window::minimize` is emitted when a window is minimized. The signal `Window::move` is emitted when a window is moved. The signal `Window::resize` is emitted when a window is resized. The signal `Window::restore` is emitted when a window is restored.