Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

unpublished interface XFlatParagraph
Base Interfaces
XFlatParagraphXTextMarkup

XTextMarkup
(referenced interface's summary:)
provides functionality to markup text.
Usage Restrictions
not published
Description
provides functionality to ...
Since
OOo 3.0

Methods' Summary
getText get the content of the paragraph  
isModified check whether the content has been modified  
setChecked change the 'checked' flag of the respective text node, i.e., mark the text node as 'processed'  
isChecked returns whether the respective text node has already been processed  
getLanguageOfText get the language of the specific text  
getPrimaryLanguageOfText get the single most probable language of the specific text, especially after getLanguageOfText fails  
changeText replace the specific text with new text.  
changeAttributes replace the attributes of the specific text with the given set of attributes.  
getLanguagePortions get a list of indexes that separate each two different languages  
Methods' Details
getText
string
getText();

Description
get the content of the paragraph
Returns
the content of the paragraph.
isModified
boolean
isModified();

Description
check whether the content has been modified
Returns
true if the content has been modified, false otherwise.
setChecked
void
setChecked( [in] long  nType,
[in] boolean  bVal );

Description
change the 'checked' flag of the respective text node, i.e., mark the text node as 'processed'
Parameter nType
type, see TextMarkupType.
Parameter bVal
true the respective text node has been processed false the respective text node needs to be processed again later
isChecked
boolean
isChecked( [in] long  nType );

Description
returns whether the respective text node has already been processed
Parameter nType
type, see TextMarkupType.
Returns
true if the respective text node has been checked false otherwise.
getLanguageOfText
::com::sun::star::lang::Locale
getLanguageOfText( [in] long  nPos,
[in] long  nLen )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
get the language of the specific text
Parameter nPos
start index of the text.
Parameter nLen
the length of the text.
Returns
the locale for the language identified. If no language could be identified, the locale will be empty.
Throws
IllegalArgumentException when any argument is wrong.
getPrimaryLanguageOfText
::com::sun::star::lang::Locale
getPrimaryLanguageOfText( [in] long  nPos,
[in] long  nLen )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
get the single most probable language of the specific text, especially after getLanguageOfText fails
Parameter nPos
start index of the text.
Parameter nLen
the length of the text.
Returns
the locale for the language identified.
Throws
IllegalArgumentException when any argument is wrong.
changeText
void
changeText( [in] long  nPos,
[in] long  nLen,
[in] string  aNewText,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aAttributes )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
replace the specific text with new text.
Parameter nPos
start index of the text.
Parameter nLen
the length of the text.
Parameter nNewText
new text.
Parameter aAttributes
the given set of attributes e.g. Language
Throws
IllegalArgumentException when any argument is wrong.
changeAttributes
void
changeAttributes( [in] long  nPos,
[in] long  nLen,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aAttributes )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
replace the attributes of the specific text with the given set of attributes.
Parameter nPos
start index of the text.
Parameter nLen
the length of the text.
Parameter aAttributes
the given set of attributes e.g. Language.
Throws
IllegalArgumentException when any argument is wrong.
getLanguagePortions
sequence< long >
getLanguagePortions();

Description
get a list of indexes that separate each two different languages
Returns
a list of indices.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.