NoOpObject

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(AtkNoOpObject* atkNoOpObject, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this(ObjectG obj)

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

Members

Functions

getNoOpObjectStruct
AtkNoOpObject* getNoOpObjectStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

removeSelection
bool removeSelection(int i)

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

Mixins

__anonymous
mixin ActionT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin ComponentT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin DocumentT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin EditableTextT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin HypertextT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin ImageT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin SelectionT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin TableT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin TableCellT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin TextT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin ValueT!(AtkNoOpObject)
Undocumented in source.
__anonymous
mixin WindowT!(AtkNoOpObject)
Undocumented in source.

Static functions

getType
GType getType()

Variables

atkNoOpObject
AtkNoOpObject* atkNoOpObject;

the main Gtk struct

Inherited Members

From ObjectAtk

atkObject
AtkObject* atkObject;

the main Gtk struct

getObjectAtkStruct
AtkObject* getObjectAtkStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
addRelationship
bool addRelationship(AtkRelationType relationship, ObjectAtk target)

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

connectPropertyChangeHandler
uint connectPropertyChangeHandler(AtkPropertyChangeHandler* handler)

Calls @handler on property changes.

getAccessibleId
string getAccessibleId()

Gets the accessible id of the accessible.

getAttributes
AtkAttributeSet* getAttributes()

Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" #AtkAttributeSet properties.

getDescription
string getDescription()

Gets the accessible description of 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
AtkLayer 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
ObjectAtk getParent()

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

getRole
AtkRole 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(AtkState state, bool value)

Emits a state-change signal for the specified state.

peekParent
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
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
RelationSet refRelationSet()

Gets the #AtkRelationSet associated with the object.

refStateSet
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(AtkRelationType relationship, ObjectAtk target)

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

setAccessibleId
void setAccessibleId(string name)

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

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(ObjectAtk parent)

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

setRole
void setRole(AtkRole role)

Sets the role of the accessible.

addOnActiveDescendantChanged
gulong addOnActiveDescendantChanged(void delegate(ObjectAtk, ObjectAtk) dlg, ConnectFlags connectFlags)

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.

addOnChildrenChanged
gulong addOnChildrenChanged(void delegate(uint, ObjectAtk, ObjectAtk) dlg, ConnectFlags connectFlags)

The signal "children-changed" is emitted when a child is added or removed form an object. It supports two details: "add" and "remove"

addOnFocus
gulong addOnFocus(void delegate(bool, ObjectAtk) dlg, ConnectFlags connectFlags)

The signal "focus-event" is emitted when an object gained or lost focus.

addOnPropertyChange
gulong addOnPropertyChange(void delegate(void*, ObjectAtk) dlg, ConnectFlags connectFlags)

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.

addOnStateChange
gulong addOnStateChange(void delegate(string, bool, ObjectAtk) dlg, ConnectFlags connectFlags)

The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed.

addOnVisibleDataChanged
gulong addOnVisibleDataChanged(void delegate(ObjectAtk) dlg, ConnectFlags connectFlags)

The "visible-data-changed" signal is emitted when the visual appearance of the object changed.

roleForName
AtkRole roleForName(string name)

Get the #AtkRole type corresponding to a rolew name.

roleGetLocalizedName
string roleGetLocalizedName(AtkRole role)

Gets the localized description string describing the #AtkRole @role.

roleGetName
string roleGetName(AtkRole role)

Gets the description string describing the #AtkRole @role.

roleRegister
AtkRole roleRegister(string name)

Registers the role specified by @name. @name must be a meaningful name. So it should not be empty, or consisting on whitespaces.

From ActionIF

getActionStruct
AtkAction* getActionStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
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 ComponentIF

getComponentStruct
AtkComponent* getComponentStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
addFocusHandler
uint addFocusHandler(AtkFocusHandler 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

contains
bool contains(int x, int y, AtkCoordType 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, AtkCoordType coordType)

Gets the rectangle which gives the extent of the @component.

getLayer
AtkLayer 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, AtkCoordType 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
ObjectAtk refAccessibleAtPoint(int x, int y, AtkCoordType 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(AtkScrollType type)

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

scrollToPoint
bool scrollToPoint(AtkCoordType coords, int x, int y)

Makes an object visible on the screen at a given position by scrolling all necessary parents.

setExtents
bool setExtents(int x, int y, int width, int height, AtkCoordType coordType)

Sets the extents of @component.

setPosition
bool setPosition(int x, int y, AtkCoordType 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.

addOnBoundsChanged
gulong addOnBoundsChanged(void delegate(Rectangle, ComponentIF) dlg, ConnectFlags connectFlags)

The 'bounds-changed" signal is emitted when the bposition or size of the component changes.

From DocumentIF

getDocumentStruct
AtkDocument* getDocumentStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getAttributeValue
string getAttributeValue(string attributeName)

Retrieves the value of the given @attribute_name inside @document.

getAttributes
AtkAttributeSet* getAttributes()

Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

getCurrentPageNumber
int getCurrentPageNumber()

Retrieves the current page number inside @document.

getDocument
void* getDocument()

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.

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.

addOnLoadComplete
gulong addOnLoadComplete(void delegate(DocumentIF) dlg, ConnectFlags connectFlags)

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

addOnLoadStopped
gulong addOnLoadStopped(void delegate(DocumentIF) dlg, ConnectFlags connectFlags)

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.

addOnPageChanged
gulong addOnPageChanged(void delegate(int, DocumentIF) dlg, ConnectFlags connectFlags)

The 'page-changed' signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.

addOnReload
gulong addOnReload(void delegate(DocumentIF) dlg, ConnectFlags connectFlags)

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.

From EditableTextIF

getEditableTextStruct
AtkEditableText* getEditableTextStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
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.

setRunAttributes
bool setRunAttributes(AtkAttributeSet* attribSet, int startOffset, int endOffset)

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.

setTextContents
void setTextContents(string string_)

Set text contents of @text.

From HypertextIF

getHypertextStruct
AtkHypertext* getHypertextStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getLink
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.

addOnLinkSelected
gulong addOnLinkSelected(void delegate(int, HypertextIF) dlg, ConnectFlags connectFlags)

The "link-selected" signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected.

From ImageIF

getImageStruct
AtkImage* getImageStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
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, AtkCoordType 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 SelectionIF

getSelectionStruct
AtkSelection* getSelectionStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
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
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.

addOnSelectionChanged
gulong addOnSelectionChanged(void delegate(SelectionIF) dlg, ConnectFlags connectFlags)

The "selection-changed" signal is emitted by an object which implements AtkSelection interface when the selection changes.

From TableIF

getTableStruct
AtkTable* getTableStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
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
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
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
ObjectAtk getRowHeader(int row)

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

getSelectedColumns
int 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
int 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
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
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(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, 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, ObjectAtk header)

Sets the specified row header to @header.

setSummary
void setSummary(ObjectAtk accessible)

Sets the summary description of the table.

addOnColumnDeleted
gulong addOnColumnDeleted(void delegate(int, int, TableIF) dlg, ConnectFlags connectFlags)

The "column-deleted" signal is emitted by an object which implements the AtkTable interface when a column is deleted.

addOnColumnInserted
gulong addOnColumnInserted(void delegate(int, int, TableIF) dlg, ConnectFlags connectFlags)

The "column-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.

addOnColumnReordered
gulong addOnColumnReordered(void delegate(TableIF) dlg, ConnectFlags connectFlags)

The "column-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered.

addOnModelChanged
gulong addOnModelChanged(void delegate(TableIF) dlg, ConnectFlags connectFlags)

The "model-changed" signal is emitted by an object which implements the AtkTable interface when the model displayed by the table changes.

addOnRowDeleted
gulong addOnRowDeleted(void delegate(int, int, TableIF) dlg, ConnectFlags connectFlags)

The "row-deleted" signal is emitted by an object which implements the AtkTable interface when a row is deleted.

addOnRowInserted
gulong addOnRowInserted(void delegate(int, int, TableIF) dlg, ConnectFlags connectFlags)

The "row-inserted" signal is emitted by an object which implements the AtkTable interface when a row is inserted.

addOnRowReordered
gulong addOnRowReordered(void delegate(TableIF) dlg, ConnectFlags connectFlags)

The "row-reordered" signal is emitted by an object which implements the AtkTable interface when the rows are reordered.

From TableCellIF

getTableCellStruct
AtkTableCell* getTableCellStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getColumnHeaderCells
PtrArray 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
PtrArray 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
ObjectAtk getTable()

Returns a reference to the accessible of the containing table.

From TextIF

getTextStruct
AtkText* getTextStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
freeRanges
void freeRanges(TextRange[] ranges)

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.

addSelection
bool addSelection(int startOffset, int endOffset)

Adds a selection bounded by the specified offsets.

getBoundedRanges
TextRange[] getBoundedRanges(AtkTextRectangle* rect, AtkCoordType coordType, AtkTextClipType xClipType, AtkTextClipType 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, AtkCoordType coords)

Get the bounding box containing the glyph representing the character at a particular text offset.

getDefaultAttributes
AtkAttributeSet* getDefaultAttributes()

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.

getNSelections
int getNSelections()

Gets the number of selected regions.

getOffsetAtPoint
int getOffsetAtPoint(int x, int y, AtkCoordType 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, AtkCoordType coordType, AtkTextRectangle rect)

Get the bounding box for text within the specified range.

getRunAttributes
AtkAttributeSet* getRunAttributes(int offset, int startOffset, int endOffset)

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.

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

Gets the text from the specified selection.

getStringAtOffset
string getStringAtOffset(int offset, AtkTextGranularity 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, AtkTextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

getTextAtOffset
string getTextAtOffset(int offset, AtkTextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

getTextBeforeOffset
string getTextBeforeOffset(int offset, AtkTextBoundary boundaryType, int startOffset, int endOffset)

Gets the specified text.

removeSelection
bool removeSelection(int selectionNum)

Removes the specified selection.

scrollSubstringTo
bool scrollSubstringTo(int startOffset, int endOffset, AtkScrollType type)

Makes @text visible on the screen by scrolling all necessary parents.

scrollSubstringToPoint
bool scrollSubstringToPoint(int startOffset, int endOffset, AtkCoordType coords, int x, int y)

Makes an object visible on the screen at a given position 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.

addOnTextAttributesChanged
gulong addOnTextAttributesChanged(void delegate(TextIF) dlg, ConnectFlags connectFlags)

The "text-attributes-changed" signal is emitted when the text attributes of the text of an object which implements AtkText changes.

addOnTextCaretMoved
gulong addOnTextCaretMoved(void delegate(int, TextIF) dlg, ConnectFlags connectFlags)

The "text-caret-moved" signal is emitted when the caret position of the text of an object which implements AtkText changes.

addOnTextChanged
gulong addOnTextChanged(void delegate(int, int, TextIF) dlg, ConnectFlags connectFlags)

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.

addOnTextInsert
gulong addOnTextInsert(void delegate(int, int, string, TextIF) dlg, ConnectFlags connectFlags)

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.

addOnTextRemove
gulong addOnTextRemove(void delegate(int, int, string, TextIF) dlg, ConnectFlags connectFlags)

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.

addOnTextSelectionChanged
gulong addOnTextSelectionChanged(void delegate(TextIF) dlg, ConnectFlags connectFlags)

The "text-selection-changed" signal is emitted when the selected text of an object which implements AtkText changes.

attributeSetFree
void attributeSetFree(AtkAttributeSet* attribSet)

Frees the memory used by an #AtkAttributeSet, including all its #AtkAttributes.

attributeForName
AtkTextAttribute attributeForName(string name)

Get the #AtkTextAttribute type corresponding to a text attribute name.

attributeGetName
string attributeGetName(AtkTextAttribute attr)

Gets the name corresponding to the #AtkTextAttribute

attributeGetValue
string attributeGetValue(AtkTextAttribute attr, int index)

Gets the value for the index of the #AtkTextAttribute

attributeRegister
AtkTextAttribute attributeRegister(string name)

Associate @name with a new #AtkTextAttribute

From ValueIF

getValueStruct
AtkValue* getValueStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getCurrentValue
void getCurrentValue(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(Value value)

Gets the maximum value of this object.

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

Gets the minimum value of this object.

getRange
Range getRange()

Gets the range of this object.

getSubRanges
ListSG 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(Value value)

Sets the value of this object.

setValue
void setValue(double newValue)

Sets the value of this object.

addOnValueChanged
gulong addOnValueChanged(void delegate(double, string, ValueIF) dlg, ConnectFlags connectFlags)

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.

From WindowIF

getWindowStruct
AtkWindow* getWindowStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
addOnActivate
gulong addOnActivate(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::activate is emitted when a window becomes the active window of the application or session.

addOnCreate
gulong addOnCreate(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::create is emitted when a new window is created.

addOnDeactivate
gulong addOnDeactivate(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::deactivate is emitted when a window is no longer the active window of the application or session.

addOnDestroy
gulong addOnDestroy(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::destroy is emitted when a window is destroyed.

addOnMaximize
gulong addOnMaximize(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::maximize is emitted when a window is maximized.

addOnMinimize
gulong addOnMinimize(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::minimize is emitted when a window is minimized.

addOnMove
gulong addOnMove(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::move is emitted when a window is moved.

addOnResize
gulong addOnResize(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::resize is emitted when a window is resized.

addOnRestore
gulong addOnRestore(void delegate(WindowIF) dlg, ConnectFlags connectFlags)

The signal #AtkWindow::restore is emitted when a window is restored.

Meta