Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

Accessibility::EditableText Interface Reference

Derived from interface Text, EditableText provides methods for modifying textual content of components which support editing. More...

import "Accessibility_EditableText.idl";

Inheritance diagram for Accessibility::EditableText:

Accessibility::Text List of all members.

Public Member Functions

boolean setTextContents (in string newContents)
 Replace the text contents with a new string, discarding the old contents.
boolean insertText (in long position, in string text, in long length)
 Insert new text contents into an existing text object at a given location, while retaining the old contents.
boolean setAttributes (in string attributes, in long startPos, in long endPos)
 Apply a particular set of attributes to a range of text.
void copyText (in long startPos, in long endPos)
 Copy a range of text into the system clipboard.
boolean cutText (in long startPos, in long endPos)
 Excise a range of text from a Text object, copying it into the system clipboard.
boolean deleteText (in long startPos, in long endPos)
 Excise a range of text from a Text object without copying it into the system clipboard.
boolean pasteText (in long position)
 Copy the text contents of the system clipboard, if any, into a Text object, inserting it at a particular character offset.
boolean insertTextWithAttributes (in long position, in string text, in long length, in AttributeSet attributes)
 Insert new text contents into an existing text object at a given location, with a specified set of text attributes, while retaining the old contents.
boolean setAttributeRun (in AttributeSet attributes, in long startPos, in long endPos, boolean replace)
 Apply a particular set of attributes to a range of text.
void unImplemented5 ()
 unImplemented:
void unImplemented6 ()
void unImplemented9 ()
void unImplemented10 ()

Detailed Description

Derived from interface Text, EditableText provides methods for modifying textual content of components which support editing.

EditableText also interacts with the system clipboard via copyText, cutText, and pasteText.

Note:
read-only instances of EditableText are possible; These may be instances of a general-purpose component type which are sometimes, but not always, user-editable, or may be components which are temporarily or circumstantially in a non-editable state.

Definition at line 39 of file Accessibility_EditableText.idl.


Member Function Documentation

boolean Accessibility::EditableText::setTextContents in string  newContents  ) 
 

Replace the text contents with a new string, discarding the old contents.

Parameters:
newContents a UTF-8 string with which the text object's contents will be replaced.
Returns:
True if the text content was successfully changed, False otherwise.

boolean Accessibility::EditableText::insertText in long  position,
in string  text,
in long  length
 

Insert new text contents into an existing text object at a given location, while retaining the old contents.

Parameters:
position the character offset into the Text implementor's content at which the new content will be inserted.
text a UTF-8 string of which length characters will be inserted into the text object's text buffer.
length the number of characters of text to insert. If the character count of text is less than or equal to length, the entire contents of text will be inserted.
Returns:
True if the text content was successfully inserted, False otherwise.

boolean Accessibility::EditableText::setAttributes in string  attributes,
in long  startPos,
in long  endPos
 

Apply a particular set of attributes to a range of text.

Note:
deprecated, use Text::setAttributeRun instead.
Returns:
True if the text attributes were successfully modified, False otherwise.

void Accessibility::EditableText::copyText in long  startPos,
in long  endPos
 

Copy a range of text into the system clipboard.

Parameters:
startPos the character offset of the first character in the range of text being copied.
endPos the offset of the first character past the end of the range of text being copied.

boolean Accessibility::EditableText::cutText in long  startPos,
in long  endPos
 

Excise a range of text from a Text object, copying it into the system clipboard.

Parameters:
startPos the character offset of the first character in the range of text being cut.
endPos the offset of the first character past the end of the range of text being cut.
Returns:
True if the text was successfully cut, False otherwise.

boolean Accessibility::EditableText::deleteText in long  startPos,
in long  endPos
 

Excise a range of text from a Text object without copying it into the system clipboard.

Parameters:
startPos the character offset of the first character in the range of text being deleted.
endPos the offset of the first character past the end of the range of text being deleted.
Returns:
True if the text was successfully deleted, False otherwise.

boolean Accessibility::EditableText::pasteText in long  position  ) 
 

Copy the text contents of the system clipboard, if any, into a Text object, inserting it at a particular character offset.

Parameters:
position the character offset before which the text will be inserted.
Returns:
True if the text was successfully pasted into the Text object, False otherwise.

boolean Accessibility::EditableText::insertTextWithAttributes in long  position,
in string  text,
in long  length,
in AttributeSet  attributes
 

Insert new text contents into an existing text object at a given location, with a specified set of text attributes, while retaining the old contents.

Parameters:
position the character offset into the Text implementor's content at which the new content will be inserted.
text a UTF-8 string of which length characters will be inserted into the text object's text buffer.
length the number of characters of text to insert. If the character count of text is less than or equal to length, the entire contents of text will be inserted.
attributes an AttributeSet specifying the textual/typographical attributes which are explicitly to be applied to the inserted text. Existing text attributes at the specified insertion offset will be added to these attributes except for attributes whose names appear in both attributes and the existing text attribute set at position, in which case the newly specified attributes will supercede the existing values over the range of the newly inserted text.
Returns:
True if the text content was successfully inserted, False otherwise.
Since:
AT-SPI 1.7.0

boolean Accessibility::EditableText::setAttributeRun in AttributeSet  attributes,
in long  startPos,
in long  endPos,
boolean  replace
 

Apply a particular set of attributes to a range of text.

Parameters:
attributes An AttributeSet specifying the attributes to be applied to the text range.
startPos the character offset of the first character in the text range whose attributes are being specified.
endPos the character offset of the first character past the end of the text range whose attributes are being specified.
replace If True, the specified attributes will replace all previously specified attributes over the range, even if they do not conflict with the specified AttributeSet; if False, the specified attributes are applied to the existing attributes, superceding any existing attributes of the same name.
Returns:
True if the text attributes were successfully modified, False otherwise.
Since:
AT-SPI 1.7.0

void Accessibility::EditableText::unImplemented5  ) 
 

unImplemented:

placeholders for future expansion. Note that these are named 'unimplemented5 and unimplemented6' to avoid conflict with placeholders from Accessibility::Text.

void Accessibility::EditableText::unImplemented6  ) 
 

void Accessibility::EditableText::unImplemented9  ) 
 

void Accessibility::EditableText::unImplemented10  ) 
 


The documentation for this interface was generated from the following file:
Generated on Fri Dec 2 15:20:46 2005 for AT_SPI_IDL by  doxygen 1.4.3