IAccessibleEditableText Interface Reference

This interface gives write access to a text representation. More...

import "AccessibleEditableText.idl";

List of all members.

Public Member Functions

HRESULT copyText ([in] long startOffset,[in] long endOffset)
 Copies the text range into the clipboard.
HRESULT deleteText ([in] long startOffset,[in] long endOffset)
 Deletes a range of text.
HRESULT insertText ([in] long offset,[in] BSTR *text)
 Inserts text at the specified position.
HRESULT cutText ([in] long startOffset,[in] long endOffset)
 Deletes a range of text and copies it to the clipboard.
HRESULT pasteText ([in] long offset)
 Pastes text from the clipboard.
HRESULT replaceText ([in] long startOffset,[in] long endOffset,[in] BSTR *text)
 Replaces text.
HRESULT setAttributes ([in] long startOffset,[in] long endOffset,[in] BSTR *attributes)
 Replaces the attributes of a text range by the given set of attributes.


Detailed Description

This interface gives write access to a text representation.

This interface is typically used in conjunction with the IAccessibleText interface and complements that interface with the additional ability to modify text.

The substrings used with this interface are specified as follows: If startOffset is less than endOffset, the substring starts with the character at startOffset and ends with the character just before endOffset. If endOffset is lower than startOffset, the result is the same as a call with the two arguments exchanged. The whole text can be defined by passing the indices zero and IAccessibleText::nCharacters. If both indices have the same value, an empty string is defined.


Member Function Documentation

HRESULT IAccessibleEditableText::copyText [in] long  startOffset,
[in] long  endOffset
 

Copies the text range into the clipboard.

The specified text between the two given indices is copied into the system clipboard.

Parameters:
[in] startOffset Start index of the text to moved into the clipboard. The valid range is 0..length.
[in] endOffset End index of the text to moved into the clipboard. The valid range is 0..length.

HRESULT IAccessibleEditableText::cutText [in] long  startOffset,
[in] long  endOffset
 

Deletes a range of text and copies it to the clipboard.

The text between the two given indices is deleted from the text represented by this object and copied to the clipboard.

Parameters:
[in] startOffset Start index of the text to be deleted. The valid range is 0..length.
[in] endOffset End index of the text to be deleted. The valid range is 0..length.

HRESULT IAccessibleEditableText::deleteText [in] long  startOffset,
[in] long  endOffset
 

Deletes a range of text.

The text between and including the two given indices is deleted from the text represented by this object.

Parameters:
[in] startOffset Start index of the text to be deleted. The valid range is 0..length.
[in] endOffset End index of the text to be deleted. The valid range is 0..length.

HRESULT IAccessibleEditableText::insertText [in] long  offset,
[in] BSTR *  text
 

Inserts text at the specified position.

The specified string is inserted at the given index into the text represented by this object.

Parameters:
[in] offset Index at which to insert the text. The valid range is 0..length.
[in] text Text that is inserted.

HRESULT IAccessibleEditableText::pasteText [in] long  offset  ) 
 

Pastes text from the clipboard.

The text in the system clipboard is pasted into the text represented by this object at the given index. This method is similar to the IAccessibleEditableText::insertText method. If the index is not valid the system clipboard text is not inserted.

Parameters:
[in] offset Index at which to insert the text from the system clipboard into the text represented by this object. The valid range is 0..length.

HRESULT IAccessibleEditableText::replaceText [in] long  startOffset,
[in] long  endOffset,
[in] BSTR *  text
 

Replaces text.

The text between the two given indices is replaced by the specified replacement string. This method is equivalent to calling first IAccessibleEditableText::deleteText with the two indices and then calling IAccessibleEditableText::insertText with the replacement text at the start index.

Parameters:
[in] startOffset Start index of the text to be replaced. The valid range is 0..length.
[in] endOffset Start index of the text to be replaced. The valid range is 0..length.
[in] text The Text that replaces the text between the given indices.

HRESULT IAccessibleEditableText::setAttributes [in] long  startOffset,
[in] long  endOffset,
[in] BSTR *  attributes
 

Replaces the attributes of a text range by the given set of attributes.

Sets the attributes for the text between the two given indices. The old attributes are replaced by the new list of attributes.

Parameters:
[in] startOffset Start index of the text whose attributes are modified. The valid range is 0..length.
[in] endOffset Start index of the text whose attributes are modified. The valid range is 0..length.
[in] attributes Set of attributes that replaces the old list of attributes of the specified text portion.


The documentation for this interface was generated from the following file:
Generated on Mon Mar 26 17:38:26 2007 for IAccessible2 API by  doxygen 1.4.6-NO