NoOpObject

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

this
this(gobject.object.ObjectG obj)

Provides a default (non-functioning stub) #AtkObject. Application maintainers should not use this method.

Mixed In Members

From mixin ActionT!()

doAction
bool doAction(int i)

Perform the specified action on the object.

getDescription
string getDescription(int i)

Returns a description of the specified action of the object.

getKeybinding
string getKeybinding(int i)

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".

getLocalizedName
string getLocalizedName(int i)

Returns the localized name of the specified action of the object.

getNActions
int getNActions()

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.

getName
string getName(int i)

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.

setDescription
bool setDescription(int i, string desc)

Sets a description of the specified action of the object.

From mixin ComponentT!()

contains
bool contains(int x, int y, atk.types.CoordType coordType)

Checks whether the specified point is within the extent of the component.

getAlpha
double getAlpha()

Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

getExtents
void getExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Gets the rectangle which gives the extent of the component.

getLayer
atk.types.Layer getLayer()

Gets the layer of the component.

getMdiZorder
int getMdiZorder()

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.

getPosition
void getPosition(int x, int y, atk.types.CoordType coordType)

Gets the position of component in the form of a point specifying component's top-left corner.

getSize
void getSize(int width, int height)

Gets the size of the component in terms of width and height.

grabFocus
bool grabFocus()

Grabs focus for this component.

refAccessibleAtPoint
atk.object.ObjectAtk refAccessibleAtPoint(int x, int y, atk.types.CoordType coordType)

Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.

removeFocusHandler
void removeFocusHandler(uint handlerId)

Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).

scrollTo
bool scrollTo(atk.types.ScrollType type)

Makes component visible on the screen by scrolling all necessary parents.

scrollToPoint
bool scrollToPoint(atk.types.CoordType coords, int x, int y)

Move the top-left of component to a given position of the screen by scrolling all necessary parents.

setExtents
bool setExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Sets the extents of component.

setPosition
bool setPosition(int x, int y, atk.types.CoordType coordType)

Sets the position of component.

setSize
bool setSize(int width, int height)

Set the size of the component in terms of width and height.

connectBoundsChanged
ulong connectBoundsChanged(T callback, Flag!"After" after)

Connect to BoundsChanged signal.

From mixin DocumentT!()

getAttributeValue
string getAttributeValue(string attributeName)

Retrieves the value of the given attribute_name inside document.

getCurrentPageNumber
int getCurrentPageNumber()

Retrieves the current page number inside document.

getDocument
void* getDocument()

Gets a [xlib.types.void*] 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.

getDocumentType
string getDocumentType()

Gets a string indicating the document type.

getLocale
string getLocale()

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.

getPageCount
int getPageCount()

Retrieves the total number of pages inside document.

setAttributeValue
bool setAttributeValue(string attributeName, string attributeValue)

Sets the value for the given attribute_name inside document.

connectDocumentAttributeChanged
ulong connectDocumentAttributeChanged(T callback, Flag!"After" after)

Connect to DocumentAttributeChanged signal.

connectLoadComplete
ulong connectLoadComplete(T callback, Flag!"After" after)

Connect to LoadComplete signal.

connectLoadStopped
ulong connectLoadStopped(T callback, Flag!"After" after)

Connect to LoadStopped signal.

connectPageChanged
ulong connectPageChanged(T callback, Flag!"After" after)

Connect to PageChanged signal.

connectReload
ulong connectReload(T callback, Flag!"After" after)

Connect to Reload signal.

From mixin EditableTextT!()

copyText
void copyText(int startPos, int endPos)

Copy text from start_pos up to, but not including end_pos to the clipboard.

cutText
void cutText(int startPos, int endPos)

Copy text from start_pos up to, but not including end_pos to the clipboard and then delete from the widget.

deleteText
void deleteText(int startPos, int endPos)

Delete text start_pos up to, but not including end_pos.

insertText
void insertText(string string_, int length, int position)

Insert text at a given position.

pasteText
void pasteText(int position)

Paste text from clipboard to specified position.

setTextContents
void setTextContents(string string_)

Set text contents of text.

From mixin HypertextT!()

getLink
atk.hyperlink.Hyperlink getLink(int linkIndex)

Gets the link in this hypertext document at index link_index

getLinkIndex
int getLinkIndex(int charIndex)

Gets the index into the array of hyperlinks that is associated with the character specified by char_index.

getNLinks
int getNLinks()

Gets the number of links within this hypertext document.

connectLinkSelected
ulong connectLinkSelected(T callback, Flag!"After" after)

Connect to LinkSelected signal.

From mixin ImageT!()

getImageDescription
string getImageDescription()

Get a textual description of this image.

getImageLocale
string getImageLocale()

Retrieves the locale identifier associated to the #AtkImage.

getImagePosition
void getImagePosition(int x, int y, atk.types.CoordType coordType)

Gets the position of the image in the form of a point specifying the images top-left corner.

getImageSize
void getImageSize(int width, int height)

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).

setImageDescription
bool setImageDescription(string description)

Sets the textual description for this image.

From mixin SelectionT!()

addSelection
bool addSelection(int i)

Adds the specified accessible child of the object to the object's selection.

clearSelection
bool clearSelection()

Clears the selection in the object so that no children in the object are selected.

getSelectionCount
int getSelectionCount()

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.

isChildSelected
bool isChildSelected(int i)

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.

refSelection
atk.object.ObjectAtk refSelection(int i)

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.

removeSelection
bool removeSelection(int i)

Removes the specified child of the object from the object's selection.

selectAllSelection
bool selectAllSelection()

Causes every child of the object to be selected if the object supports multiple selections.

connectSelectionChanged
ulong connectSelectionChanged(T callback, Flag!"After" after)

Connect to SelectionChanged signal.

From mixin TableT!()

addColumnSelection
bool addColumnSelection(int column)

Adds the specified column to the selection.

addRowSelection
bool addRowSelection(int row)

Adds the specified row to the selection.

getCaption
atk.object.ObjectAtk getCaption()

Gets the caption for the table.

getColumnAtIndex
int getColumnAtIndex(int index)

Gets a #gint representing the column at the specified index_.

getColumnDescription
string getColumnDescription(int column)

Gets the description text of the specified column in the table

getColumnExtentAt
int getColumnExtentAt(int row, int column)

Gets the number of columns occupied by the accessible object at the specified row and column in the table.

getColumnHeader
atk.object.ObjectAtk getColumnHeader(int column)

Gets the column header of a specified column in an accessible table.

getIndexAt
int getIndexAt(int row, int column)

Gets a #gint representing the index at the specified row and column.

getNColumns
int getNColumns()

Gets the number of columns in the table.

getNRows
int getNRows()

Gets the number of rows in the table.

getRowAtIndex
int getRowAtIndex(int index)

Gets a #gint representing the row at the specified index_.

getRowDescription
string getRowDescription(int row)

Gets the description text of the specified row in the table

getRowExtentAt
int getRowExtentAt(int row, int column)

Gets the number of rows occupied by the accessible object at a specified row and column in the table.

getRowHeader
atk.object.ObjectAtk getRowHeader(int row)

Gets the row header of a specified row in an accessible table.

getSelectedColumns
void getSelectedColumns(int[] selected)

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

getSelectedRows
void getSelectedRows(int[] selected)

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

getSummary
atk.object.ObjectAtk getSummary()

Gets the summary description of the table.

isColumnSelected
bool isColumnSelected(int column)

Gets a boolean value indicating whether the specified column is selected

isRowSelected
bool isRowSelected(int row)

Gets a boolean value indicating whether the specified row is selected

isSelected
bool isSelected(int row, int column)

Gets a boolean value indicating whether the accessible object at the specified row and column is selected

refAt
atk.object.ObjectAtk refAt(int row, int column)

Get a reference to the table cell at row, column. This cell should implement the interface #AtkTableCell

removeColumnSelection
bool removeColumnSelection(int column)

Adds the specified column to the selection.

removeRowSelection
bool removeRowSelection(int row)

Removes the specified row from the selection.

setCaption
void setCaption(atk.object.ObjectAtk caption)

Sets the caption for the table.

setColumnDescription
void setColumnDescription(int column, string description)

Sets the description text for the specified column of the table.

setColumnHeader
void setColumnHeader(int column, atk.object.ObjectAtk header)

Sets the specified column header to header.

setRowDescription
void setRowDescription(int row, string description)

Sets the description text for the specified row of table.

setRowHeader
void setRowHeader(int row, atk.object.ObjectAtk header)

Sets the specified row header to header.

setSummary
void setSummary(atk.object.ObjectAtk accessible)

Sets the summary description of the table.

connectColumnDeleted
ulong connectColumnDeleted(T callback, Flag!"After" after)

Connect to ColumnDeleted signal.

connectColumnInserted
ulong connectColumnInserted(T callback, Flag!"After" after)

Connect to ColumnInserted signal.

connectColumnReordered
ulong connectColumnReordered(T callback, Flag!"After" after)

Connect to ColumnReordered signal.

connectModelChanged
ulong connectModelChanged(T callback, Flag!"After" after)

Connect to ModelChanged signal.

connectRowDeleted
ulong connectRowDeleted(T callback, Flag!"After" after)

Connect to RowDeleted signal.

connectRowInserted
ulong connectRowInserted(T callback, Flag!"After" after)

Connect to RowInserted signal.

connectRowReordered
ulong connectRowReordered(T callback, Flag!"After" after)

Connect to RowReordered signal.

From mixin TableCellT!()

getColumnHeaderCells
atk.object.ObjectAtk[] getColumnHeaderCells()

Returns the column headers as an array of cell accessibles.

getColumnSpan
int getColumnSpan()

Returns the number of columns occupied by this cell accessible.

getPosition
bool getPosition(int row, int column)

Retrieves the tabular position of this cell.

getRowColumnSpan
bool getRowColumnSpan(int row, int column, int rowSpan, int columnSpan)

Gets the row and column indexes and span of this cell accessible.

getRowHeaderCells
atk.object.ObjectAtk[] getRowHeaderCells()

Returns the row headers as an array of cell accessibles.

getRowSpan
int getRowSpan()

Returns the number of rows occupied by this cell accessible.

getTable
atk.object.ObjectAtk getTable()

Returns a reference to the accessible of the containing table.

From mixin TextT!()

addSelection
bool addSelection(int startOffset, int endOffset)

Adds a selection bounded by the specified offsets.

getBoundedRanges
atk.text_range.TextRange[] getBoundedRanges(atk.types.TextRectangle rect, atk.types.CoordType coordType, atk.types.TextClipType xClipType, atk.types.TextClipType yClipType)

Get the ranges of text in the specified bounding box.

getCaretOffset
int getCaretOffset()

Gets the offset of the position of the caret (cursor).

getCharacterAtOffset
dchar getCharacterAtOffset(int offset)

Gets the specified text.

getCharacterCount
int getCharacterCount()

Gets the character count.

getCharacterExtents
void getCharacterExtents(int offset, int x, int y, int width, int height, atk.types.CoordType coords)

If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1.

getNSelections
int getNSelections()

Gets the number of selected regions.

getOffsetAtPoint
int getOffsetAtPoint(int x, int y, atk.types.CoordType coords)

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.

getRangeExtents
void getRangeExtents(int startOffset, int endOffset, atk.types.CoordType coordType, atk.types.TextRectangle rect)

Get the bounding box for text within the specified range.

getSelection
string getSelection(int selectionNum, int startOffset, int endOffset)

Gets the text from the specified selection.

getStringAtOffset
string getStringAtOffset(int offset, atk.types.TextGranularity granularity, int startOffset, int endOffset)

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.

getText
string getText(int startOffset, int endOffset)

Gets the specified text.

getTextAfterOffset
string getTextAfterOffset(int offset, atk.types.TextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

getTextAtOffset
string getTextAtOffset(int offset, atk.types.TextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

getTextBeforeOffset
string getTextBeforeOffset(int offset, atk.types.TextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

textRemoveSelection
bool textRemoveSelection(int selectionNum)

Removes the specified selection.

scrollSubstringTo
bool scrollSubstringTo(int startOffset, int endOffset, atk.types.ScrollType type)

Makes a substring of text visible on the screen by scrolling all necessary parents.

scrollSubstringToPoint
bool scrollSubstringToPoint(int startOffset, int endOffset, atk.types.CoordType coords, int x, int y)

Move the top-left of a substring of text to a given position of the screen by scrolling all necessary parents.

setCaretOffset
bool setCaretOffset(int offset)

Sets the caret (cursor) position to the specified offset.

setSelection
bool setSelection(int selectionNum, int startOffset, int endOffset)

Changes the start and end offset of the specified selection.

connectTextAttributesChanged
ulong connectTextAttributesChanged(T callback, Flag!"After" after)

Connect to TextAttributesChanged signal.

connectTextCaretMoved
ulong connectTextCaretMoved(T callback, Flag!"After" after)

Connect to TextCaretMoved signal.

connectTextChanged
ulong connectTextChanged(string detail, T callback, Flag!"After" after)

Connect to TextChanged signal.

connectTextInsert
ulong connectTextInsert(string detail, T callback, Flag!"After" after)

Connect to TextInsert signal.

connectTextRemove
ulong connectTextRemove(string detail, T callback, Flag!"After" after)

Connect to TextRemove signal.

connectTextSelectionChanged
ulong connectTextSelectionChanged(T callback, Flag!"After" after)

Connect to TextSelectionChanged signal.

From mixin ValueT!()

getCurrentValue
void getCurrentValue(gobject.value.Value value)

Gets the value of this object.

getIncrement
double getIncrement()

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.

getMaximumValue
void getMaximumValue(gobject.value.Value value)

Gets the maximum value of this object.

getMinimumIncrement
void getMinimumIncrement(gobject.value.Value 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.

getMinimumValue
void getMinimumValue(gobject.value.Value value)

Gets the minimum value of this object.

getRange
atk.range.Range getRange()

Gets the range of this object.

getSubRanges
atk.range.Range[] getSubRanges()

Gets the list of subranges defined for this object. See #AtkValue introduction for examples of subranges and when to expose them.

getValueAndText
void getValueAndText(double value, string 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.

setCurrentValue
bool setCurrentValue(gobject.value.Value value)

Sets the value of this object.

setValue
void setValue(double newValue)

Sets the value of this object.

connectValueChanged
ulong connectValueChanged(T callback, Flag!"After" after)

Connect to ValueChanged signal.

From mixin WindowT!()

connectActivate
ulong connectActivate(T callback, Flag!"After" after)

Connect to Activate signal.

connectCreate
ulong connectCreate(T callback, Flag!"After" after)

Connect to Create signal.

connectDeactivate
ulong connectDeactivate(T callback, Flag!"After" after)

Connect to Deactivate signal.

connectDestroy
ulong connectDestroy(T callback, Flag!"After" after)

Connect to Destroy signal.

connectMaximize
ulong connectMaximize(T callback, Flag!"After" after)

Connect to Maximize signal.

connectMinimize
ulong connectMinimize(T callback, Flag!"After" after)

Connect to Minimize signal.

connectMove
ulong connectMove(T callback, Flag!"After" after)

Connect to Move signal.

connectResize
ulong connectResize(T callback, Flag!"After" after)

Connect to Resize signal.

connectRestore
ulong connectRestore(T callback, Flag!"After" after)

Connect to Restore signal.

Inherited Members

From ObjectAtk

addRelationship
bool addRelationship(atk.types.RelationType relationship, atk.object.ObjectAtk target)

Adds a relationship of the specified type with the specified target.

getAccessibleId
string getAccessibleId()

Gets the accessible id of the accessible.

getDescription
string getDescription()

Gets the accessible description of the accessible.

getHelpText
string getHelpText()

Gets the help text associated with the accessible.

getIndexInParent
int getIndexInParent()

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

getLayer
atk.types.Layer getLayer()

Gets the layer of the accessible.

getMdiZorder
int getMdiZorder()

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

getNAccessibleChildren
int getNAccessibleChildren()

Gets the number of accessible children of the accessible.

getName
string getName()

Gets the accessible name of the accessible.

getObjectLocale
string getObjectLocale()

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.

getParent
atk.object.ObjectAtk getParent()

Gets the accessible parent of the accessible. By default this is the one assigned with atk.object.ObjectAtk.setParent, but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk.object.ObjectAtk.setParent, and will return it with this method.

getRole
atk.types.Role getRole()

Gets the role of the accessible.

initialize
void initialize(void* data)

This function is called when implementing subclasses of #AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of #AtkObject

notifyStateChange
void notifyStateChange(atk.types.State state, bool value)

Emits a state-change signal for the specified state.

peekParent
atk.object.ObjectAtk peekParent()

Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns null.

refAccessibleChild
atk.object.ObjectAtk refAccessibleChild(int i)

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.

refRelationSet
atk.relation_set.RelationSet refRelationSet()

Gets the #AtkRelationSet associated with the object.

refStateSet
atk.state_set.StateSet refStateSet()

Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.

removePropertyChangeHandler
void removePropertyChangeHandler(uint handlerId)

Removes a property change handler.

removeRelationship
bool removeRelationship(atk.types.RelationType relationship, atk.object.ObjectAtk target)

Removes a relationship of the specified type with the specified target.

setAccessibleId
void setAccessibleId(string id)

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.

setDescription
void setDescription(string description)

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 "".

setHelpText
void setHelpText(string helpText)

Sets the help text associated with the accessible. This can be used to expose context-sensitive information to help a user understand how to interact with the object.

setName
void setName(string name)

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 "".

setParent
void setParent(atk.object.ObjectAtk parent)

Sets the accessible parent of the accessible. parent can be NULL.

setRole
void setRole(atk.types.Role role)

Sets the role of the accessible.

connectActiveDescendantChanged
ulong connectActiveDescendantChanged(string detail, T callback, Flag!"After" after)

Connect to ActiveDescendantChanged signal.

connectAnnouncement
ulong connectAnnouncement(T callback, Flag!"After" after)

Connect to Announcement signal.

connectAttributeChanged
ulong connectAttributeChanged(T callback, Flag!"After" after)

Connect to AttributeChanged signal.

connectChildrenChanged
ulong connectChildrenChanged(string detail, T callback, Flag!"After" after)

Connect to ChildrenChanged signal.

connectFocusEvent
ulong connectFocusEvent(T callback, Flag!"After" after)

Connect to FocusEvent signal.

connectNotification
ulong connectNotification(T callback, Flag!"After" after)

Connect to Notification signal.

connectPropertyChange
ulong connectPropertyChange(string detail, T callback, Flag!"After" after)

Connect to PropertyChange signal.

connectStateChange
ulong connectStateChange(string detail, T callback, Flag!"After" after)

Connect to StateChange signal.

connectVisibleDataChanged
ulong connectVisibleDataChanged(T callback, Flag!"After" after)

Connect to VisibleDataChanged signal.

From Action

doAction
bool doAction(int i)

Perform the specified action on the object.

getDescription
string getDescription(int i)

Returns a description of the specified action of the object.

getKeybinding
string getKeybinding(int i)

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".

getLocalizedName
string getLocalizedName(int i)

Returns the localized name of the specified action of the object.

getNActions
int getNActions()

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.

getName
string getName(int i)

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.

setDescription
bool setDescription(int i, string desc)

Sets a description of the specified action of the object.

From Component

contains
bool contains(int x, int y, atk.types.CoordType coordType)

Checks whether the specified point is within the extent of the component.

getAlpha
double getAlpha()

Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

getExtents
void getExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Gets the rectangle which gives the extent of the component.

getLayer
atk.types.Layer getLayer()

Gets the layer of the component.

getMdiZorder
int getMdiZorder()

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.

getPosition
void getPosition(int x, int y, atk.types.CoordType coordType)

Gets the position of component in the form of a point specifying component's top-left corner.

getSize
void getSize(int width, int height)

Gets the size of the component in terms of width and height.

grabFocus
bool grabFocus()

Grabs focus for this component.

refAccessibleAtPoint
atk.object.ObjectAtk refAccessibleAtPoint(int x, int y, atk.types.CoordType coordType)

Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.

removeFocusHandler
void removeFocusHandler(uint handlerId)

Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).

scrollTo
bool scrollTo(atk.types.ScrollType type)

Makes component visible on the screen by scrolling all necessary parents.

scrollToPoint
bool scrollToPoint(atk.types.CoordType coords, int x, int y)

Move the top-left of component to a given position of the screen by scrolling all necessary parents.

setExtents
bool setExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Sets the extents of component.

setPosition
bool setPosition(int x, int y, atk.types.CoordType coordType)

Sets the position of component.

setSize
bool setSize(int width, int height)

Set the size of the component in terms of width and height.

connectBoundsChanged
ulong connectBoundsChanged(T callback, Flag!"After" after)

Connect to BoundsChanged signal.

From Document

getAttributeValue
string getAttributeValue(string attributeName)

Retrieves the value of the given attribute_name inside document.

getCurrentPageNumber
int getCurrentPageNumber()

Retrieves the current page number inside document.

getDocument
void* getDocument()

Gets a [xlib.types.void*] 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.

getDocumentType
string getDocumentType()

Gets a string indicating the document type.

getLocale
string getLocale()

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.

getPageCount
int getPageCount()

Retrieves the total number of pages inside document.

setAttributeValue
bool setAttributeValue(string attributeName, string attributeValue)

Sets the value for the given attribute_name inside document.

connectDocumentAttributeChanged
ulong connectDocumentAttributeChanged(T callback, Flag!"After" after)

Connect to DocumentAttributeChanged signal.

connectLoadComplete
ulong connectLoadComplete(T callback, Flag!"After" after)

Connect to LoadComplete signal.

connectLoadStopped
ulong connectLoadStopped(T callback, Flag!"After" after)

Connect to LoadStopped signal.

connectPageChanged
ulong connectPageChanged(T callback, Flag!"After" after)

Connect to PageChanged signal.

connectReload
ulong connectReload(T callback, Flag!"After" after)

Connect to Reload signal.

From EditableText

copyText
void copyText(int startPos, int endPos)

Copy text from start_pos up to, but not including end_pos to the clipboard.

cutText
void cutText(int startPos, int endPos)

Copy text from start_pos up to, but not including end_pos to the clipboard and then delete from the widget.

deleteText
void deleteText(int startPos, int endPos)

Delete text start_pos up to, but not including end_pos.

insertText
void insertText(string string_, int length, int position)

Insert text at a given position.

pasteText
void pasteText(int position)

Paste text from clipboard to specified position.

setTextContents
void setTextContents(string string_)

Set text contents of text.

From Hypertext

getLink
atk.hyperlink.Hyperlink getLink(int linkIndex)

Gets the link in this hypertext document at index link_index

getLinkIndex
int getLinkIndex(int charIndex)

Gets the index into the array of hyperlinks that is associated with the character specified by char_index.

getNLinks
int getNLinks()

Gets the number of links within this hypertext document.

connectLinkSelected
ulong connectLinkSelected(T callback, Flag!"After" after)

Connect to LinkSelected signal.

From Image

getImageDescription
string getImageDescription()

Get a textual description of this image.

getImageLocale
string getImageLocale()

Retrieves the locale identifier associated to the #AtkImage.

getImagePosition
void getImagePosition(int x, int y, atk.types.CoordType coordType)

Gets the position of the image in the form of a point specifying the images top-left corner.

getImageSize
void getImageSize(int width, int height)

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).

setImageDescription
bool setImageDescription(string description)

Sets the textual description for this image.

From Selection

addSelection
bool addSelection(int i)

Adds the specified accessible child of the object to the object's selection.

clearSelection
bool clearSelection()

Clears the selection in the object so that no children in the object are selected.

getSelectionCount
int getSelectionCount()

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.

isChildSelected
bool isChildSelected(int i)

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.

refSelection
atk.object.ObjectAtk refSelection(int i)

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.

removeSelection
bool removeSelection(int i)

Removes the specified child of the object from the object's selection.

selectAllSelection
bool selectAllSelection()

Causes every child of the object to be selected if the object supports multiple selections.

connectSelectionChanged
ulong connectSelectionChanged(T callback, Flag!"After" after)

Connect to SelectionChanged signal.

From Table

addColumnSelection
bool addColumnSelection(int column)

Adds the specified column to the selection.

addRowSelection
bool addRowSelection(int row)

Adds the specified row to the selection.

getCaption
atk.object.ObjectAtk getCaption()

Gets the caption for the table.

getColumnAtIndex
int getColumnAtIndex(int index)

Gets a #gint representing the column at the specified index_.

getColumnDescription
string getColumnDescription(int column)

Gets the description text of the specified column in the table

getColumnExtentAt
int getColumnExtentAt(int row, int column)

Gets the number of columns occupied by the accessible object at the specified row and column in the table.

getColumnHeader
atk.object.ObjectAtk getColumnHeader(int column)

Gets the column header of a specified column in an accessible table.

getIndexAt
int getIndexAt(int row, int column)

Gets a #gint representing the index at the specified row and column.

getNColumns
int getNColumns()

Gets the number of columns in the table.

getNRows
int getNRows()

Gets the number of rows in the table.

getRowAtIndex
int getRowAtIndex(int index)

Gets a #gint representing the row at the specified index_.

getRowDescription
string getRowDescription(int row)

Gets the description text of the specified row in the table

getRowExtentAt
int getRowExtentAt(int row, int column)

Gets the number of rows occupied by the accessible object at a specified row and column in the table.

getRowHeader
atk.object.ObjectAtk getRowHeader(int row)

Gets the row header of a specified row in an accessible table.

getSelectedColumns
void getSelectedColumns(int[] selected)

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

getSelectedRows
void getSelectedRows(int[] selected)

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

getSummary
atk.object.ObjectAtk getSummary()

Gets the summary description of the table.

isColumnSelected
bool isColumnSelected(int column)

Gets a boolean value indicating whether the specified column is selected

isRowSelected
bool isRowSelected(int row)

Gets a boolean value indicating whether the specified row is selected

isSelected
bool isSelected(int row, int column)

Gets a boolean value indicating whether the accessible object at the specified row and column is selected

refAt
atk.object.ObjectAtk refAt(int row, int column)

Get a reference to the table cell at row, column. This cell should implement the interface #AtkTableCell

removeColumnSelection
bool removeColumnSelection(int column)

Adds the specified column to the selection.

removeRowSelection
bool removeRowSelection(int row)

Removes the specified row from the selection.

setCaption
void setCaption(atk.object.ObjectAtk caption)

Sets the caption for the table.

setColumnDescription
void setColumnDescription(int column, string description)

Sets the description text for the specified column of the table.

setColumnHeader
void setColumnHeader(int column, atk.object.ObjectAtk header)

Sets the specified column header to header.

setRowDescription
void setRowDescription(int row, string description)

Sets the description text for the specified row of table.

setRowHeader
void setRowHeader(int row, atk.object.ObjectAtk header)

Sets the specified row header to header.

setSummary
void setSummary(atk.object.ObjectAtk accessible)

Sets the summary description of the table.

connectColumnDeleted
ulong connectColumnDeleted(T callback, Flag!"After" after)

Connect to ColumnDeleted signal.

connectColumnInserted
ulong connectColumnInserted(T callback, Flag!"After" after)

Connect to ColumnInserted signal.

connectColumnReordered
ulong connectColumnReordered(T callback, Flag!"After" after)

Connect to ColumnReordered signal.

connectModelChanged
ulong connectModelChanged(T callback, Flag!"After" after)

Connect to ModelChanged signal.

connectRowDeleted
ulong connectRowDeleted(T callback, Flag!"After" after)

Connect to RowDeleted signal.

connectRowInserted
ulong connectRowInserted(T callback, Flag!"After" after)

Connect to RowInserted signal.

connectRowReordered
ulong connectRowReordered(T callback, Flag!"After" after)

Connect to RowReordered signal.

From TableCell

getColumnHeaderCells
atk.object.ObjectAtk[] getColumnHeaderCells()

Returns the column headers as an array of cell accessibles.

getColumnSpan
int getColumnSpan()

Returns the number of columns occupied by this cell accessible.

getPosition
bool getPosition(int row, int column)

Retrieves the tabular position of this cell.

getRowColumnSpan
bool getRowColumnSpan(int row, int column, int rowSpan, int columnSpan)

Gets the row and column indexes and span of this cell accessible.

getRowHeaderCells
atk.object.ObjectAtk[] getRowHeaderCells()

Returns the row headers as an array of cell accessibles.

getRowSpan
int getRowSpan()

Returns the number of rows occupied by this cell accessible.

getTable
atk.object.ObjectAtk getTable()

Returns a reference to the accessible of the containing table.

From Text

addSelection
bool addSelection(int startOffset, int endOffset)

Adds a selection bounded by the specified offsets.

getBoundedRanges
atk.text_range.TextRange[] getBoundedRanges(atk.types.TextRectangle rect, atk.types.CoordType coordType, atk.types.TextClipType xClipType, atk.types.TextClipType yClipType)

Get the ranges of text in the specified bounding box.

getCaretOffset
int getCaretOffset()

Gets the offset of the position of the caret (cursor).

getCharacterAtOffset
dchar getCharacterAtOffset(int offset)

Gets the specified text.

getCharacterCount
int getCharacterCount()

Gets the character count.

getCharacterExtents
void getCharacterExtents(int offset, int x, int y, int width, int height, atk.types.CoordType coords)

If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1.

getNSelections
int getNSelections()

Gets the number of selected regions.

getOffsetAtPoint
int getOffsetAtPoint(int x, int y, atk.types.CoordType coords)

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.

getRangeExtents
void getRangeExtents(int startOffset, int endOffset, atk.types.CoordType coordType, atk.types.TextRectangle rect)

Get the bounding box for text within the specified range.

getSelection
string getSelection(int selectionNum, int startOffset, int endOffset)

Gets the text from the specified selection.

getStringAtOffset
string getStringAtOffset(int offset, atk.types.TextGranularity granularity, int startOffset, int endOffset)

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.

getText
string getText(int startOffset, int endOffset)

Gets the specified text.

getTextAfterOffset
string getTextAfterOffset(int offset, atk.types.TextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

getTextAtOffset
string getTextAtOffset(int offset, atk.types.TextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

getTextBeforeOffset
string getTextBeforeOffset(int offset, atk.types.TextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

textRemoveSelection
bool textRemoveSelection(int selectionNum)

Removes the specified selection.

scrollSubstringTo
bool scrollSubstringTo(int startOffset, int endOffset, atk.types.ScrollType type)

Makes a substring of text visible on the screen by scrolling all necessary parents.

scrollSubstringToPoint
bool scrollSubstringToPoint(int startOffset, int endOffset, atk.types.CoordType coords, int x, int y)

Move the top-left of a substring of text to a given position of the screen by scrolling all necessary parents.

setCaretOffset
bool setCaretOffset(int offset)

Sets the caret (cursor) position to the specified offset.

setSelection
bool setSelection(int selectionNum, int startOffset, int endOffset)

Changes the start and end offset of the specified selection.

connectTextAttributesChanged
ulong connectTextAttributesChanged(T callback, Flag!"After" after)

Connect to TextAttributesChanged signal.

connectTextCaretMoved
ulong connectTextCaretMoved(T callback, Flag!"After" after)

Connect to TextCaretMoved signal.

connectTextChanged
ulong connectTextChanged(string detail, T callback, Flag!"After" after)

Connect to TextChanged signal.

connectTextInsert
ulong connectTextInsert(string detail, T callback, Flag!"After" after)

Connect to TextInsert signal.

connectTextRemove
ulong connectTextRemove(string detail, T callback, Flag!"After" after)

Connect to TextRemove signal.

connectTextSelectionChanged
ulong connectTextSelectionChanged(T callback, Flag!"After" after)

Connect to TextSelectionChanged signal.

From Value

getCurrentValue
void getCurrentValue(gobject.value.Value value)

Gets the value of this object.

getIncrement
double getIncrement()

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.

getMaximumValue
void getMaximumValue(gobject.value.Value value)

Gets the maximum value of this object.

getMinimumIncrement
void getMinimumIncrement(gobject.value.Value 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.

getMinimumValue
void getMinimumValue(gobject.value.Value value)

Gets the minimum value of this object.

getRange
atk.range.Range getRange()

Gets the range of this object.

getSubRanges
atk.range.Range[] getSubRanges()

Gets the list of subranges defined for this object. See #AtkValue introduction for examples of subranges and when to expose them.

getValueAndText
void getValueAndText(double value, string 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.

setCurrentValue
bool setCurrentValue(gobject.value.Value value)

Sets the value of this object.

setValue
void setValue(double newValue)

Sets the value of this object.

connectValueChanged
ulong connectValueChanged(T callback, Flag!"After" after)

Connect to ValueChanged signal.

From Window

connectActivate
ulong connectActivate(T callback, Flag!"After" after)

Connect to Activate signal.

connectCreate
ulong connectCreate(T callback, Flag!"After" after)

Connect to Create signal.

connectDeactivate
ulong connectDeactivate(T callback, Flag!"After" after)

Connect to Deactivate signal.

connectDestroy
ulong connectDestroy(T callback, Flag!"After" after)

Connect to Destroy signal.

connectMaximize
ulong connectMaximize(T callback, Flag!"After" after)

Connect to Maximize signal.

connectMinimize
ulong connectMinimize(T callback, Flag!"After" after)

Connect to Minimize signal.

connectMove
ulong connectMove(T callback, Flag!"After" after)

Connect to Move signal.

connectResize
ulong connectResize(T callback, Flag!"After" after)

Connect to Resize signal.

connectRestore
ulong connectRestore(T callback, Flag!"After" after)

Connect to Restore signal.