Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: awt ::

interface XTextComponent

Base Interface
com::sun::star::uno::XInterface

Description
gives access to the text of a text component and makes it possible to register event listeners.


Known Services which Export this Interface

com::sun::star::awt::UnoControlEdit specifies that UnoControlEdit implements an edit control based on UnoControl .

Methods' Summary

addTextListener registers a text event listener.
removeTextListener unregisters a text event listener.
setText sets the text of the text field.
insertText inserts text at the given position.
getText
getSelectedText
setSelection sets the user selection.
getSelection
isEditable
setEditable makes the text editable for the user or read-only.
setMaxTextLen sets the maximum text length.
getMaxTextLen

Methods' Details

addTextListener
 
[ oneway ] void
addTextListener(
[ in ] com::sun::star::awt::XTextListener l );

Description
registers a text event listener.
removeTextListener
 
[ oneway ] void
removeTextListener(
[ in ] com::sun::star::awt::XTextListener l );

Description
unregisters a text event listener.
setText
 
[ oneway ] void
setText(
[ in ] string aText );

Description
sets the text of the text field.
insertText
 
[ oneway ] void
insertText(
[ in ] com::sun::star::awt::Selection Sel,
[ in ] string Text );

Description
inserts text at the given position.
getText
 
string
getText();
Returns
the currently set text of this text component.
getSelectedText
 
string
getSelectedText();
Returns
the currently selected text.
setSelection
 
[ oneway ] void
setSelection(
[ in ] com::sun::star::awt::Selection aSelection );

Description
sets the user selection.
getSelection
 
com::sun::star::awt::Selection
getSelection();
Returns
the current user selection.
isEditable
 
boolean
isEditable();
Returns
whether the text is editable by the user.
setEditable
 
[ oneway ] void
setEditable(
[ in ] boolean bEditable );

Description
makes the text editable for the user or read-only.
setMaxTextLen
 
[ oneway ] void
setMaxTextLen(
[ in ] short nLen );

Description
sets the maximum text length.
getMaxTextLen
 
short
getMaxTextLen();
Returns
the currently set maximum text length.

Top of Page