LibreOffice
LibreOffice 5.0 SDK API Reference
|
specifies a component which extends the com::sun::star::awt::UnoControlEditModel with capabilities to display and input formatted text. More...
import "RichTextControl.idl";
Public Attributes | |
boolean | HardLineBreaks |
specifies whether text should be automatically wrapped to fit into the control. More... | |
boolean | RichText |
specifies whether the control should display the text including all its formatting. More... | |
![]() | |
short | Align |
specifies the horizontal alignment of the text in the control. More... | |
boolean | AutoHScroll |
If set to true an horizontal scrollbar will be added automatically when needed. More... | |
boolean | AutoVScroll |
If set to true an vertical scrollbar will be added automatically when needed. More... | |
com::sun::star::util::Color | BackgroundColor |
specifies the background color (RGB) of the control. More... | |
short | Border |
specifies the border style of the control. More... | |
long | BorderColor |
specifies the color of the border, if present More... | |
short | EchoChar |
specifies the echo character for a password edit field. More... | |
boolean | Enabled |
determines whether the control is enabled or disabled. More... | |
com::sun::star::awt::FontDescriptor | FontDescriptor |
specifies the font attributes of the text in the control. More... | |
short | FontEmphasisMark |
specifies the com::sun::star::text::FontEmphasis value of the text in the control. More... | |
short | FontRelief |
specifies the com::sun::star::text::FontRelief value of the text in the control. More... | |
boolean | HardLineBreaks |
specifies if hard line breaks will be returned in the XTextComponent::getText() method. More... | |
string | HelpText |
specifies the help text of the control. More... | |
string | HelpURL |
specifies the help URL of the control. More... | |
boolean | HideInactiveSelection |
specifies whether the selection in the control should be hidden when the control is not active (focused). More... | |
boolean | HScroll |
specifies if the content of the control can be scrolled in the horizontal direction. More... | |
short | LineEndFormat |
specifies which line end type should be used for multi line text More... | |
short | MaxTextLen |
specifies the maximum character count. More... | |
boolean | MultiLine |
specifies that the control may have more than one line. More... | |
boolean | PaintTransparent |
specifies whether the control paints it background or not. More... | |
boolean | Printable |
specifies that the control will be printed with the document. More... | |
boolean | ReadOnly |
specifies that the content of the control cannot be modified by the user. More... | |
boolean | Tabstop |
specifies that the control can be reached with the TAB key. More... | |
string | Text |
specifies the text displayed in the control. More... | |
com::sun::star::util::Color | TextColor |
specifies the text color (RGB) of the control. More... | |
com::sun::star::util::Color | TextLineColor |
specifies the text line color (RGB) of the control. More... | |
boolean | VScroll |
specifies if the content of the control can be scrolled in the vertical direction. More... | |
short | WritingMode |
denotes the writing mode used in the control, as specified in the com::sun::star::text::WritingMode2 constants group. More... | |
com::sun::star::style::VerticalAlignment | VerticalAlign |
specifies the vertical alignment of the text in the control. More... | |
![]() | |
string | DefaultControl |
specifies the service name of the default control for this model. More... | |
![]() | |
short | ClassId |
specifies the ID for classification of the component. More... | |
short | TabIndex |
determines the relative taborder of the control associated with the model. More... | |
string | Tag |
used for additional information. More... | |
![]() | |
string | Name |
the name of the component. More... | |
Additional Inherited Members | |
![]() | |
interface | com::sun::star::awt::XControlModel |
interface | com::sun::star::lang::XComponent |
interface | com::sun::star::beans::XPropertySet |
interface | com::sun::star::beans::XMultiPropertySet |
interface | com::sun::star::io::XPersistObject |
interface | com::sun::star::util::XCloneable |
![]() | |
interface | com::sun::star::beans::XFastPropertySet |
This optional interface gives an efficient access to all properties at once or an ability to set more than one property at once. More... | |
interface | com::sun::star::beans::XPropertyState |
This optional interface gives access to the state of the properties, e.g. More... | |
![]() | |
interface | com::sun::star::text::XTextRange |
interface | com::sun::star::beans::XPropertySet |
interface | com::sun::star::beans::XPropertyState |
interface | com::sun::star::container::XContentEnumerationAccess |
![]() | |
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... | |
![]() | |
void | dispose () |
The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More... | |
void | addEventListener ([in] XEventListener xListener) |
adds an event listener to the object. More... | |
void | removeEventListener ([in] XEventListener aListener) |
removes an event listener from the listener list. More... | |
![]() | |
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValue ([in] string aPropertyName,[in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the value of the property with the specified name. More... | |
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
void | addPropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XPropertyChangeListener to the specified property. More... | |
void | removePropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XPropertyChangeListener from the listener list. More... | |
void | addVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
void | removeVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XVetoableChangeListener from the listener list. More... | |
![]() | |
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValues ([in] sequence< string > aPropertyNames,[in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the values to the properties with the specified names. More... | |
sequence< any > | getPropertyValues ([in] sequence< string > aPropertyNames) |
void | addPropertiesChangeListener ([in] sequence< string > aPropertyNames,[in] com::sun::star::beans::XPropertiesChangeListener xListener) |
adds an XPropertiesChangeListener to the specified property with the specified names. More... | |
void | removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener) |
removes an XPropertiesChangeListener from the listener list. More... | |
void | firePropertiesChangeEvent ([in] sequence< string > aPropertyNames,[in] com::sun::star::beans::XPropertiesChangeListener xListener) |
fires a sequence of PropertyChangeEvents to the specified listener. More... | |
![]() | |
string | getServiceName () |
gives the service name of the object More... | |
void | write ([in] com::sun::star::io::XObjectOutputStream OutStream) raises ( com::sun::star::io::IOException ) |
writes all the persistent data of the object to the stream. More... | |
void | read ([in] com::sun::star::io::XObjectInputStream InStream) raises ( com::sun::star::io::IOException ) |
reads all the persistent data of the object from the stream. More... | |
![]() | |
com::sun::star::util::XCloneable | createClone () |
creates a copy of the object. More... | |
![]() | |
com::sun::star::uno::XInterface | getParent () |
grants access to the object containing this content. More... | |
void | setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException ) |
sets the parent to this object. More... | |
![]() | |
string | getName () |
void | setName ([in] string aName) |
sets the programmatic name of the object. More... | |
![]() | |
XText | getText () |
XTextRange | getStart () |
XTextRange | getEnd () |
string | getString () |
void | setString ([in] string aString) |
the whole string of characters of this piece of text is replaced. More... | |
![]() | |
void | addProperty ([in] string Name,[in] short Attributes,[in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException ) |
adds a property to the object. More... | |
void | removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException ) |
removes a property from the object. More... | |
![]() | |
sequence < com::sun::star::beans::PropertyValue > | getPropertyValues () |
void | setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the values of given properties. More... | |
![]() | |
void | setFastPropertyValue ([in] long nHandle,[in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the value to the property with the specified name. More... | |
any | getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
![]() | |
com::sun::star::beans::PropertyState | getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
sequence < com::sun::star::beans::PropertyState > | getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
void | setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
Sets the property to default value. More... | |
any | getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
![]() | |
com::sun::star::container::XEnumeration | createContentEnumeration ([in] string aServiceName) |
sequence< string > | getAvailableServiceNames () |
![]() | |
long | Height |
specifies the height of the control. More... | |
string | Name |
specifies the name of the control. More... | |
string | PositionX |
specifies the horizontal position of the control. More... | |
string | PositionY |
specifies the vertical position of the control. More... | |
long | Step |
specifies the step of the control. More... | |
short | TabIndex |
specifies the tabindex of the control. More... | |
string | Tag |
specifies the tag of the control. More... | |
long | Width |
specifies the width of the control. More... | |
![]() | |
float | CharHeightAsian |
This value contains the height of the characters in point. More... | |
float | CharWeightAsian |
This property contains the value of the font weight. More... | |
string | CharFontNameAsian |
This property specifies the name of the font style. More... | |
string | CharFontStyleNameAsian |
This property contains the name of the font style. More... | |
short | CharFontFamilyAsian |
This property contains font family as specified in com.sun.star.awt.FontFamily . More... | |
short | CharFontCharSetAsian |
This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More... | |
short | CharFontPitchAsian |
This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More... | |
com::sun::star::awt::FontSlant | CharPostureAsian |
This property contains the value of the posture of the document. More... | |
com::sun::star::lang::Locale | CharLocaleAsian |
contains the value of the locale. More... | |
![]() | |
float | CharHeightComplex |
This value contains the height of the characters in point. More... | |
float | CharWeightComplex |
This property contains the value of the font weight. More... | |
string | CharFontNameComplex |
This property specifies the name of the font style. More... | |
string | CharFontStyleNameComplex |
This property contains the name of the font style. More... | |
short | CharFontFamilyComplex |
This property contains font family as specified in com.sun.star.awt.FontFamily . More... | |
short | CharFontCharSetComplex |
This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More... | |
short | CharFontPitchComplex |
This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More... | |
com::sun::star::awt::FontSlant | CharPostureComplex |
This property contains the value of the posture of the document. More... | |
com::sun::star::lang::Locale | CharLocaleComplex |
contains the value of the locale. More... | |
![]() | |
boolean | ParaIsHangingPunctuation |
determines if hanging punctuation is allowed. More... | |
boolean | ParaIsCharacterDistance |
determines if a distance between Asian text, western text or complex text is set. More... | |
boolean | ParaIsForbiddenRules |
determines if the rules for forbidden characters at the start or end of text lines are considered. More... | |
![]() | |
short | WritingMode |
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants More... | |
specifies a component which extends the com::sun::star::awt::UnoControlEditModel with capabilities to display and input formatted text.
service com::sun::star::text::TextRange |
specifies capabilities to provide rich text, as opposed to the simple text provided by the com::sun::star::awt::UnoControlEditModel
|
property |
specifies whether text should be automatically wrapped to fit into the control.
If set to TRUE
, users need to manually press the enter key to insert a line break. If set to FALSE
, text is automatically wrapped at the control border.
|
property |
specifies whether the control should display the text including all its formatting.
If this is set to FALSE
, the control will act as ordinary com::sun::star::awt::UnoControlEditModel.
If the property is set to TRUE
, the control will ignore the following properties: