Class
AtkNoOpObject
Description [src]
class Atk.NoOpObject : Atk.Object
implements Atk.Action, Atk.Component, Atk.Document, Atk.EditableText, Atk.Hypertext, Atk.Image, Atk.Selection, Atk.Table, Atk.TableCell, Atk.Text, Atk.Value, Atk.Window {
/* No available fields */
}An AtkObject which purports to implement all ATK interfaces.
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.
Constructors
atk_no_op_object_new
Provides a default (non-functioning stub) AtkObject.
Application maintainers should not use this method.
Instance methods
Methods inherited from AtkAction (7)
atk_action_do_action
Perform the specified action on the object.
atk_action_get_description
Returns a description of the specified action of the object.
atk_action_get_keybinding
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”.
atk_action_get_localized_name
Returns the localized name of the specified action of the object.
atk_action_get_n_actions
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.
atk_action_get_name
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.
atk_action_set_description
Sets a description of the specified action of the object.
Methods inherited from AtkComponent (16)
atk_component_add_focus_handler
Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again.
deprecated: 2.9.4
atk_component_contains
Checks whether the specified point is within the extent of the component.
atk_component_get_alpha
Returns the alpha value (i.e. the opacity) for this
component, on a scale from 0 (fully transparent) to 1.0
(fully opaque).
since: 1.12
atk_component_get_extents
Gets the rectangle which gives the extent of the component.
atk_component_get_layer
Gets the layer of the component.
atk_component_get_mdi_zorder
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.
atk_component_get_position
Gets the position of component in the form of
a point specifying component‘s top-left corner.
deprecated: Unknown
atk_component_get_size
Gets the size of the component in terms of width and height.
deprecated: Unknown
atk_component_grab_focus
Grabs focus for this component.
atk_component_ref_accessible_at_point
Gets a reference to the accessible child, if one exists, at the
coordinate point specified by x and y.
atk_component_remove_focus_handler
Remove the handler specified by handler_id from the list of
functions to be executed when this object receives focus events
(in or out).
deprecated: 2.9.4
atk_component_scroll_to
Makes component visible on the screen by scrolling all necessary parents.
since: 2.30
atk_component_scroll_to_point
Move the top-left of component to a given position of the screen by
scrolling all necessary parents.
since: 2.30
atk_component_set_extents
Sets the extents of component.
atk_component_set_position
Sets the position of component.
atk_component_set_size
Set the size of the component in terms of width and height.
Methods inherited from AtkDocument (10)
atk_document_get_attribute_value
Retrieves the value of the given attribute_name inside document.
since: 1.12
atk_document_get_attributes
Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.
since: 1.12
atk_document_get_current_page_number
Retrieves the current page number inside document.
since: 2.12
atk_document_get_document
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: Unknown
atk_document_get_document_type
Gets a string indicating the document type.
deprecated: Unknown
atk_document_get_locale
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, see atk_text_get_attributes and atk_image_get_image_locale.
deprecated: 2.7.90
atk_document_get_page_count
Retrieves the total number of pages inside document.
since: 2.12
atk_document_get_text_selections
Returns an array of AtkTextSelections within this document.
since: 2.52
atk_document_set_attribute_value
Sets the value for the given attribute_name inside document.
since: 1.12
atk_document_set_text_selections
Makes 1 or more selections within this document denoted by the given array of AtkTextSelections. Any existing physical selection (inside or outside this document) is replaced by the new selections. All objects within the given selection ranges must be descendants of this document. Otherwise FALSE will be returned.
since: 2.52
Methods inherited from AtkEditableText (7)
atk_editable_text_copy_text
Copy text from start_pos up to, but not including end_pos
to the clipboard.
atk_editable_text_cut_text
Copy text from start_pos up to, but not including end_pos
to the clipboard and then delete from the widget.
atk_editable_text_delete_text
Delete text start_pos up to, but not including end_pos.
atk_editable_text_insert_text
Insert text at a given position.
atk_editable_text_paste_text
Paste text from clipboard to specified position.
atk_editable_text_set_run_attributes
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.
atk_editable_text_set_text_contents
Set text contents of text.
Methods inherited from AtkHypertext (3)
atk_hypertext_get_link
Gets the link in this hypertext document at index
link_index.
atk_hypertext_get_link_index
Gets the index into the array of hyperlinks that is associated with
the character specified by char_index.
atk_hypertext_get_n_links
Gets the number of links within this hypertext document.
Methods inherited from AtkImage (5)
atk_image_get_image_description
Get a textual description of this image.
atk_image_get_image_locale
Retrieves the locale identifier associated to the AtkImage.
since: 1.12
atk_image_get_image_position
Gets the position of the image in the form of a point specifying the images top-left corner.
atk_image_get_image_size
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).
atk_image_set_image_description
Sets the textual description for this image.
Methods inherited from AtkSelection (7)
atk_selection_add_selection
Adds the specified accessible child of the object to the object’s selection.
atk_selection_clear_selection
Clears the selection in the object so that no children in the object are selected.
atk_selection_get_selection_count
Gets the number of accessible children currently selected.
Note: callers should not rely on NULL or on a zero value for
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
atk_selection_is_child_selected
Determines if the current child of this object is selected
Note: callers should not rely on NULL or on a zero value for
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
atk_selection_ref_selection
Gets a reference to the accessible object representing the specified
selected child of the object.
Note: callers should not rely on NULL or on a zero value for
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
atk_get_accessible_value() convenience method.
atk_selection_remove_selection
Removes the specified child of the object from the object’s selection.
atk_selection_select_all_selection
Causes every child of the object to be selected if the object supports multiple selections.
Methods inherited from AtkTableCell (7)
atk_table_cell_get_column_header_cells
Returns the column headers as an array of cell accessibles.
since: 2.12
atk_table_cell_get_column_span
Returns the number of columns occupied by this cell accessible.
since: 2.12
atk_table_cell_get_position
Retrieves the tabular position of this cell.
since: 2.12
atk_table_cell_get_row_column_span
Gets the row and column indexes and span of this cell accessible.
since: 2.12
atk_table_cell_get_row_header_cells
Returns the row headers as an array of cell accessibles.
since: 2.12
atk_table_cell_get_row_span
Returns the number of rows occupied by this cell accessible.
since: 2.12
atk_table_cell_get_table
Returns a reference to the accessible of the containing table.
since: 2.12
Methods inherited from AtkText (22)
atk_text_add_selection
Adds a selection bounded by the specified offsets.
atk_text_get_bounded_ranges
Get the ranges of text in the specified bounding box.
since: 1.3
atk_text_get_caret_offset
Gets the offset of the position of the caret (cursor).
atk_text_get_character_at_offset
Gets the specified text.
atk_text_get_character_count
Gets the character count.
atk_text_get_character_extents
If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1.
atk_text_get_default_attributes
Creates an AtkAttributeSet which consists of the default values of
attributes for the text. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be returned.
atk_text_get_n_selections
Gets the number of selected regions.
atk_text_get_offset_at_point
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.
atk_text_get_range_extents
Get the bounding box for text within the specified range.
since: 1.3
atk_text_get_run_attributes
Creates an AtkAttributeSet which consists of the attributes explicitly
set at the position offset in the text. start_offset and end_offset are
set to the start and end of the range around offset where the attributes are
invariant. Note that end_offset is the offset of the first character
after the range. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be returned.
atk_text_get_selection
Gets the text from the specified selection.
atk_text_get_string_at_offset
Gets a portion of the text exposed through an AtkText according to a given offset
and a specific granularity, along with the start and end offsets defining the
boundaries of such a portion of text.
since: 2.10
atk_text_get_text
Gets the specified text.
atk_text_get_text_after_offset
Gets the specified text.
deprecated: 2.9.3
atk_text_get_text_at_offset
Gets the specified text.
deprecated: Unknown
atk_text_get_text_before_offset
Gets the specified text.
deprecated: 2.9.3
atk_text_remove_selection
Removes the specified selection.
atk_text_scroll_substring_to
Makes a substring of text visible on the screen by scrolling all necessary parents.
since: 2.32
atk_text_scroll_substring_to_point
Move the top-left of a substring of text to a given position of the screen
by scrolling all necessary parents.
since: 2.32
atk_text_set_caret_offset
Sets the caret (cursor) position to the specified offset.
atk_text_set_selection
Changes the start and end offset of the specified selection.
Methods inherited from AtkValue (10)
atk_value_get_current_value
Gets the value of this object.
deprecated: Unknown
atk_value_get_increment
Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.
since: 2.12
atk_value_get_maximum_value
Gets the maximum value of this object.
deprecated: Unknown
atk_value_get_minimum_increment
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: Unknown since: 1.12
atk_value_get_minimum_value
Gets the minimum value of this object.
deprecated: Unknown
atk_value_get_range
Gets the range of this object.
since: 2.12
atk_value_get_sub_ranges
Gets the list of subranges defined for this object. See AtkValue
introduction for examples of subranges and when to expose them.
since: 2.12
atk_value_get_value_and_text
Gets the current value and the human readable text alternative of
obj. text is a newly created string, that must be freed by the
caller. Can be NULL if no descriptor is available.
since: 2.12
atk_value_set_current_value
Sets the value of this object.
deprecated: Unknown
atk_value_set_value
Sets the value of this object.
since: 2.12
Properties
Properties inherited from AtkObject (17)
Atk.Object:accessible-component-layer
Atk.Object:accessible-component-mdi-zorder
Atk.Object:accessible-description
Atk.Object:accessible-help-text
Atk.Object:accessible-hypertext-nlinks
Atk.Object:accessible-id
Atk.Object:accessible-name
Atk.Object:accessible-parent
Atk.Object:accessible-role
Atk.Object:accessible-table-caption
Table caption.
deprecated: Unknown
Atk.Object:accessible-table-caption-object
Atk.Object:accessible-table-column-description
Accessible table column description.
deprecated: Unknown
Atk.Object:accessible-table-column-header
Accessible table column header.
deprecated: Unknown
Atk.Object:accessible-table-row-description
Accessible table row description.
deprecated: Unknown
Atk.Object:accessible-table-row-header
Accessible table row header.
deprecated: Unknown
Atk.Object:accessible-table-summary
Atk.Object:accessible-value
Numeric value of this object, in case being and AtkValue.
deprecated: Unknown
Signals
Signals inherited from AtkObject (9)
AtkObject::active-descendant-changed
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.
AtkObject::announcement
The “announcement” signal can be emitted to pass an announcement on to be read by a screen reader.
since: 2.46
AtkObject::attribute-changed
The “attribute-changed” signal should be emitted when one of an object’s attributes changes.
since: 2.52
AtkObject::children-changed
The signal “children-changed” is emitted when a child is added or removed from an object. It supports two details: “add” and “remove”.
AtkObject::focus-event
The signal “focus-event” is emitted when an object gained or lost focus.
deprecated: 2.9.4
AtkObject::notification
The “notification” signal can be emitted to pass an announcement on to be read by a screen reader.
since: 2.50
AtkObject::property-change
The signal “property-change” is emitted when an object’s property
value changes. arg1 contains an AtkPropertyValues with the name
and the new value of the property whose value has changed. Note
that, as with GObject notify, getting this signal does not
guarantee that the value of the property has actually changed; it
may also be emitted when the setter of the property is called to
reinstate the previous value.
AtkObject::state-change
The “state-change” signal is emitted when an object’s state changes. The detail value identifies the state type which has changed.
AtkObject::visible-data-changed
The “visible-data-changed” signal is emitted when the visual appearance of the object changed.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Signals inherited from AtkComponent (1)
AtkComponent::bounds-changed
The ‘bounds-changed” signal is emitted when the position or size of the component changes.
Signals inherited from AtkDocument (5)
AtkDocument::document-attribute-changed
The “document-attribute-changed” signal should be emitted when there is a change to one of the document attributes returned by atk_document_get_attributes.
since: 2.52
AtkDocument::load-complete
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.).
AtkDocument::load-stopped
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.
AtkDocument::page-changed
The ‘page-changed’ signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.
since: 2.12
AtkDocument::reload
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.
Signals inherited from AtkHypertext (1)
AtkHypertext::link-selected
The “link-selected” signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected.
Signals inherited from AtkSelection (1)
AtkSelection::selection-changed
The “selection-changed” signal is emitted by an object which implements AtkSelection interface when the selection changes.
Signals inherited from AtkTable (7)
AtkTable::column-deleted
The “column-deleted” signal is emitted by an object which implements the AtkTable interface when a column is deleted.
AtkTable::column-inserted
The “column-inserted” signal is emitted by an object which implements the AtkTable interface when a column is inserted.
AtkTable::column-reordered
The “column-reordered” signal is emitted by an object which implements the AtkTable interface when the columns are reordered.
AtkTable::model-changed
The “model-changed” signal is emitted by an object which implements the AtkTable interface when the model displayed by the table changes.
AtkTable::row-deleted
The “row-deleted” signal is emitted by an object which implements the AtkTable interface when a row is deleted.
AtkTable::row-inserted
The “row-inserted” signal is emitted by an object which implements the AtkTable interface when a row is inserted.
AtkTable::row-reordered
The “row-reordered” signal is emitted by an object which implements the AtkTable interface when the rows are reordered.
Signals inherited from AtkText (6)
AtkText::text-attributes-changed
The “text-attributes-changed” signal is emitted when the text attributes of the text of an object which implements AtkText changes.
AtkText::text-caret-moved
The “text-caret-moved” signal is emitted when the caret position of the text of an object which implements AtkText changes.
AtkText::text-changed
The “text-changed” signal is emitted when the text of the object which implements the AtkText interface changes, This signal will have a detail which is either “insert” or “delete” which identifies whether the text change was an insertion or a deletion.
deprecated: 2.9.4
AtkText::text-insert
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.
AtkText::text-remove
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.
AtkText::text-selection-changed
The “text-selection-changed” signal is emitted when the selected text of an object which implements AtkText changes.
Signals inherited from AtkValue (1)
AtkValue::value-changed
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.
since: 2.12
Signals inherited from AtkWindow (9)
AtkWindow::activate
The signal AtkWindow::activate is emitted when a window
becomes the active window of the application or session.
since: 2.2
AtkWindow::create
The signal AtkWindow::create is emitted when a new window
is created.
since: 2.2
AtkWindow::deactivate
The signal AtkWindow::deactivate is emitted when a window is
no longer the active window of the application or session.
since: 2.2
AtkWindow::destroy
The signal AtkWindow::destroy is emitted when a window is destroyed.
since: 2.2
AtkWindow::maximize
The signal AtkWindow::maximize is emitted when a window
is maximized.
since: 2.2
AtkWindow::minimize
The signal AtkWindow::minimize is emitted when a window
is minimized.
since: 2.2
AtkWindow::move
The signal AtkWindow::move is emitted when a window
is moved.
since: 2.2
AtkWindow::resize
The signal AtkWindow::resize is emitted when a window
is resized.
since: 2.2
AtkWindow::restore
The signal AtkWindow::restore is emitted when a window
is restored.
since: 2.2