specifies accessibility support for an edit. More...

import"AccessibleEdit.idl";

Inheritance diagram for AccessibleEdit:

Exported Interfaces
interface	::com::sun::star::accessibility::XAccessibleContext
	This interface gives access to the structural information of an edit: More...

interface	::com::sun::star::accessibility::XAccessibleEventBroadcaster

interface	::com::sun::star::accessibility::XAccessibleComponent

interface	::com::sun::star::accessibility::XAccessibleExtendedComponent

interface	::com::sun::star::accessibility::XAccessibleText
	This interface gives read-only access to the text representation of an edit. More...

interface	::com::sun::star::accessibility::XAccessibleEditableText
	This interface extends the com::sun::star::accessibility::XAccessibleText interface and gives read and write access to the text representation of an edit. More...

Additional Inherited Members
Public Member Functions inherited from XAccessibleContext
hyper	getAccessibleChildCount ()
	Return the number of children. More...

XAccessible	getAccessibleChild ([in] hyper i) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Returns the i-th child of this object. More...

XAccessible	getAccessibleParent ()
	Returns the parent of this object. More...

hyper	getAccessibleIndexInParent ()
	Returns the index of this object in its accessible parent. More...

short	getAccessibleRole ()
	Returns the role of this object. More...

string	getAccessibleDescription ()
	Returns the object's description. More...

string	getAccessibleName ()
	Return the object's localized name. More...

XAccessibleRelationSet	getAccessibleRelationSet ()
	Returns the set of relations defined for this object. More...

hyper	getAccessibleStateSet ()
	Returns the set of states that are currently active for this object. More...

::com::sun::star::lang::Locale	getLocale () raises (IllegalAccessibleComponentStateException)
	Returns the locale of the component. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Public Member Functions inherited from XAccessibleEventBroadcaster
void	addAccessibleEventListener ([in] XAccessibleEventListener xListener)
	registers the given XAccessibleEventListener. More...

void	removeAccessibleEventListener ([in] XAccessibleEventListener xListener)
	unregisters the given XAccessibleEventListener. More...

Public Member Functions inherited from XAccessibleComponent
boolean	containsPoint ([in] ::com::sun::star::awt::Point Point)
	Tests whether the specified point lies within this object's bounds. More...

XAccessible	getAccessibleAtPoint ([in] ::com::sun::star::awt::Point Point)
	Returns the Accessible child that is rendered under the given point. More...

::com::sun::star::awt::Rectangle	getBounds ()
	Returns the bounding box of this object. More...

::com::sun::star::awt::Point	getLocation ()
	Returns the location of the upper left corner of the object's bounding box relative to the parent. More...

::com::sun::star::awt::Point	getLocationOnScreen ()
	Returns the location of the upper left corner of the object's bounding box in screen coordinates. More...

::com::sun::star::awt::Size	getSize ()
	Returns the size of this object's bounding box. More...

void	grabFocus ()
	Grabs the focus to this object. More...

::com::sun::star::util::Color	getForeground ()
	Returns the foreground color of this object. More...

::com::sun::star::util::Color	getBackground ()
	Returns the background color of this object. More...

Public Member Functions inherited from XAccessibleExtendedComponent
::com::sun::star::awt::XFont	getFont ()
	Returns the font of this object. More...

string	getTitledBorderText ()
	Returns the titled border text. More...

string	getToolTipText ()
	Returns the tool tip text of this object. More...

Public Member Functions inherited from XAccessibleText
long	getCaretPosition ()
	Return the position of the caret. More...

boolean	setCaretPosition ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Set the position of the caret. More...

char	getCharacter ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Return the character at the specified position. More...

sequence<::com::sun::star::beans::PropertyValue >	getCharacterAttributes ([in] long nIndex, [in] sequence< string > aRequestedAttributes) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::beans::UnknownPropertyException)
	Get the attribute set for the specified position. More...

::com::sun::star::awt::Rectangle	getCharacterBounds ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Return the bounding box of the specified position. More...

long	getCharacterCount ()
	Return the number of characters in the represented text. More...

long	getIndexAtPoint ([in] ::com::sun::star::awt::Point aPoint)
	Return the text position for the specified screen position. More...

string	getSelectedText ()
	Return the selected text. More...

long	getSelectionStart ()
	Return the position of the start of the selection. More...

long	getSelectionEnd ()
	Return the position of the end of the selection. More...

boolean	setSelection ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Set a new selection. More...

string	getText ()
	Return the whole text. More...

string	getTextRange ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Return the specified text range. More...

TextSegment	getTextAtIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
	Get a text portion around the given position. More...

TextSegment	getTextBeforeIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
	Get a text portion before the given position. More...

TextSegment	getTextBehindIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
	Get a text portion behind the given position. More...

boolean	copyText ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Copy the specified text into the clipboard. More...

boolean	scrollSubstringTo ([in] long nStartIndex, [in] long nEndIndex, [in] AccessibleScrollType aScrollType) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Scroll the specified text to make it visible on screen. More...

Public Member Functions inherited from XAccessibleEditableText
boolean	cutText ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Copies the text range into the clipboard. More...

boolean	pasteText ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Pastes text from the clipboard. More...

boolean	deleteText ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Deletes a range of text. More...

boolean	insertText ([in] string sText, [in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Inserts text at the specified position. More...

boolean	replaceText ([in] long nStartIndex, [in] long nEndIndex, [in] string sReplacement) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Replaces text. More...

boolean	setAttributes ([in] long nStartIndex, [in] long nEndIndex, [in] sequence<::com::sun::star::beans::PropertyValue > aAttributeSet) raises (::com::sun::star::lang::IndexOutOfBoundsException)
	Replaces the attributes of a text range by the given set of attributes. More...

boolean	setText ([in] string sText)
	Replaces the whole text with the given text. More...

Detailed Description

specifies accessibility support for an edit.

Since: OOo 1.1.2

Exported Interfaces

◆ ::com::sun::star::accessibility::XAccessibleComponent

interface ::com::sun::star::accessibility::XAccessibleComponent

◆ ::com::sun::star::accessibility::XAccessibleContext

interface ::com::sun::star::accessibility::XAccessibleContext

This interface gives access to the structural information of an edit:

Role: The role of an edit is com::sun::star::accessibility::AccessibleRole::TEXT. If the text content of the edit is password protected the role is com::sun::star::accessibility::AccessibleRole::PASSWORD_TEXT.
Name: If the relation of type com::sun::star::accessibility::AccessibleRelationType::LABELED_BY is set, the name of the edit is the localized label of the target object, otherwise there is no name.
Description: The description of an edit is its localized help text.
Children: There are no children.
Parent: The parent is the window that contains the edit.
Relations: The relations supported by this service are
- com::sun::star::accessibility::AccessibleRelationType::LABELED_BY is set if the object is labeled by one or more target objects.
States: The states supported by this service are
- com::sun::star::accessibility::AccessibleStateType::DEFUNC is set if the object has already been disposed and subsequent calls to this object result in com::sun::star::lang::DisposedException exceptions.
- com::sun::star::accessibility::AccessibleStateType::EDITABLE is set if the content of the object can be changed by the user.
- com::sun::star::accessibility::AccessibleStateType::ENABLED is set if the object is enabled.
- com::sun::star::accessibility::AccessibleStateType::FOCUSABLE is always set.
- com::sun::star::accessibility::AccessibleStateType::FOCUSED is set if the object currently has the keyboard focus.
- com::sun::star::accessibility::AccessibleStateType::SHOWING is set if the object is displayed on the screen.
- com::sun::star::accessibility::AccessibleStateType::VISIBLE is always set.

◆ ::com::sun::star::accessibility::XAccessibleEditableText

interface ::com::sun::star::accessibility::XAccessibleEditableText

This interface extends the com::sun::star::accessibility::XAccessibleText interface and gives read and write access to the text representation of an edit.