Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: accessibility ::
interface XAccessibleEditableText
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XAccessibleText
          |
          +-XAccessibleEditableText
Description Implement this interface to give read and write access to a text representation. This interface is typically used in conjunction with the XAccessibleText interface and extents it about the ability to modify the text represented by that interface. Since version OpenOffice.org 1.1.1 Developers Guide 17.7.1 Accessibility - Using the Accessibility API - A Simple Screen Reader - Putting the Accessibility Interfaces to Work - XAccessibleEditableText

Methods' Summary
cutText | Copies the text range into the clipboard.
pasteText | Pastes text from the clipboard.
deleteText | Deletes a range of text.
insertText | Inserts text at the specified position.
replaceText | Replaces text.
setAttributes | Replaces the attributes of a text range by the given set of attributes.
setText | Replaces the whole text with the given text.

Methods' Details
cutText
boolean cutText( | [in] long [in] long raises( | nStartIndex, nEndIndex ) ::com::sun::star::lang::IndexOutOfBoundsException );
Description Copies the text range into the clipboard. The specified text between and including the two given indices is copied into the system clipboard and is deleted afterwards from the text represented by this object. This is equivalent to calling first XAccessibleText::copyText and then XAccessibleEditableText::deleteText with the given start and end indices. The text indices are interpreted like those in the XAccessibleText::getTextRange method. Parameter nStartIndex Start index of the text to moved into the clipboard. The valid range is 0..length. Parameter nEndIndex End index of the text to moved into the clipboard. The valid range is 0..length. Returns Returns a flag that indicates whether the operation has been executed successfully. Throws ::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid
pasteText
boolean pasteText( | [in] long raises( | nIndex ) ::com::sun::star::lang::IndexOutOfBoundsException );
Description 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 XAccessibleEditableText::insertText method. If the index is not valid then the system clipboard text is not inserted. Parameter nIndex Index at which to insert the text from the system clipboard into the text represented by this object. The valid range is 0..length. Returns Returns a flag that indicates whether the operation has been executed successfully. Throws ::com::sun::star::lang::IndexOutOfBoundsException if the index is invalid
deleteText
boolean deleteText( | [in] long [in] long raises( | nStartIndex, nEndIndex ) ::com::sun::star::lang::IndexOutOfBoundsException );
Description Deletes a range of text. The text between and including the two given indices is deleted from the text represented by this object. The text indices are interpreted like those in the XAccessibleText::getTextRange method. Parameter nStartIndex Start index of the text to be deleted. The valid range is 0..length. Parameter nEndIndex End index of the text to be deleted. The valid range is 0..length. Returns Returns a flag that indicates whether the operation has been executed successfully. Throws ::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid
insertText
boolean insertText( | [in] string [in] long raises( | sText, nIndex ) ::com::sun::star::lang::IndexOutOfBoundsException );
Description Inserts text at the specified position. The specified string is inserted at the given index into the text represented by this object. Parameter sText Text that is inserted. Parameter nIndex Index at which to insert the text. The valid range is 0..length. Returns Returns a flag that indicates whether the operation has been executed successfully. Throws ::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid
replaceText
boolean replaceText( | [in] long [in] long [in] string raises( | nStartIndex, nEndIndex, sReplacement ) ::com::sun::star::lang::IndexOutOfBoundsException );
Description Replaces text. The text between the two given indices is replaced by the specified replacement string. This method is equivalent to calling first XAccessibleEditableText::deleteText with the two indices and afterwards calling XAccessibleEditableText::insertText with the replacement text and the start index. The text indices are interpreted like those in the XAccessibleText::getTextRange method. Parameter nStartIndex Start index of the text to be replaced. The valid range is 0..length. Parameter nEndIndex Start index of the text to be replaced. The valid range is 0..length. Parameter sReplacement The Text that replaces the text between the given indices. Returns Returns a flag that indicates whether the operation has been executed successfully. Throws ::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid
setAttributes
boolean setAttributes( | [in] long [in] long [in] sequence< ::com::sun::star::beans::PropertyValue > raises( | nStartIndex, nEndIndex, aAttributeSet ) ::com::sun::star::lang::IndexOutOfBoundsException );
Description Replaces the attributes of a text range by the given set of attributes. Sets the attributes for the text between and including the two given indices to those given. The old attributes of this text portion are replaced by the new list of attributes. The text indices are interpreted like those in the XAccessibleText::getTextRange method. Parameter nStartIndex Start index of the text whose attributes are modified. The valid range is 0..length. Parameter nEndIndex Start index of the text whose attributes are modified. The valid range is 0..length. Parameter aAttributeSet Set of attributes that replaces the old list of attributes of the specified text portion. Returns Returns a flag that indicates whether the operation has been executed successfully. Throws ::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid
setText
boolean setText( | [in] string | sText );
Description Replaces the whole text with the given text. The text content of this object is set to the given string. Parameter sText The new text that replaces the old text. Returns Returns a flag that indicates whether the operation has been executed successfully.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.