Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 6983

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XFlatParagraph</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XFlatParagraph-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">text</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XFlatParagraph</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XFlatParagraph</strong>
&#x2517 <a href="XTextMarkup.html">XTextMarkup</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XTextMarkup.html">XTextMarkup</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>provides functionality to markup text.

 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>provides functionality to ...

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getText">getText</a></td>
<td class="imsum_right">get the content of the paragraph

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isModified">isModified</a></td>
<td class="imsum_right">check whether the content has been modified

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setChecked">setChecked</a></td>
<td class="imsum_right">change the 'checked' flag of the respective text node, i.e., mark the
 text node as 'processed'

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isChecked">isChecked</a></td>
<td class="imsum_right">returns whether the respective text node has already been processed

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getLanguageOfText">getLanguageOfText</a></td>
<td class="imsum_right">get the language of the specific text

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPrimaryLanguageOfText">getPrimaryLanguageOfText</a></td>
<td class="imsum_right">get the single most probable language of the specific text,
 especially after getLanguageOfText fails

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#changeText">changeText</a></td>
<td class="imsum_right">replace the specific text with new text.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#changeAttributes">changeAttributes</a></td>
<td class="imsum_right">replace the attributes of the specific text with the given set of attributes.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getLanguagePortions">getLanguagePortions</a></td>
<td class="imsum_right">get a list of indexes that separate each two different languages

 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getText" class="membertitle">getText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getText</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the content of the paragraph

 </dd>
<dt><b>Returns</b></dt>
<dd>the content of the paragraph.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isModified" class="membertitle">isModified</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isModified</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>check whether the content has been modified

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the content has been modified,
 <b>false</b> otherwise.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setChecked" class="membertitle">setChecked</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setChecked</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nType,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bVal );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>change the 'checked' flag of the respective text node, i.e., mark the
 text node as 'processed'

 </dd>
<dt><b>Parameter nType</b></dt>
<dd>type, see <a href="TextMarkupType.html">TextMarkupType</a>.

 </dd>
<dt><b>Parameter bVal</b></dt>
<dd><b>true</b> the respective text node has been processed
 <b>false</b> the respective text node needs to be processed again
 later
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isChecked" class="membertitle">isChecked</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isChecked</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nType );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns whether the respective text node has already been processed

 </dd>
<dt><b>Parameter nType</b></dt>
<dd>type, see <a href="TextMarkupType.html">TextMarkupType</a>.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the respective text node has been checked
 <b>false</b> otherwise.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getLanguageOfText" class="membertitle">getLanguageOfText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
</tr>
<tr>
<td valign="top"><b>getLanguageOfText</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPos,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nLen )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the language of the specific text

 </dd>
<dt><b>Parameter nPos</b></dt>
<dd>start index of the text.

 </dd>
<dt><b>Parameter nLen</b></dt>
<dd>the length of the text.

 </dd>
<dt><b>Returns</b></dt>
<dd>the locale for the language identified.
 If no language could be identified, the locale will be empty.

 </dd>
<dt><b>Throws</b></dt>
<dd>IllegalArgumentException
 when any argument is wrong.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPrimaryLanguageOfText" class="membertitle">getPrimaryLanguageOfText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
</tr>
<tr>
<td valign="top"><b>getPrimaryLanguageOfText</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPos,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nLen )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the single most probable language of the specific text,
 especially after getLanguageOfText fails

 </dd>
<dt><b>Parameter nPos</b></dt>
<dd>start index of the text.

 </dd>
<dt><b>Parameter nLen</b></dt>
<dd>the length of the text.

 </dd>
<dt><b>Returns</b></dt>
<dd>the locale for the language identified.

 </dd>
<dt><b>Throws</b></dt>
<dd>IllegalArgumentException
 when any argument is wrong.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="changeText" class="membertitle">changeText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>changeText</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPos,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nLen,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aNewText,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;aAttributes )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>replace the specific text with new text.

 </dd>
<dt><b>Parameter nPos</b></dt>
<dd>start index of the text.

 </dd>
<dt><b>Parameter nLen</b></dt>
<dd>the length of the text.

 </dd>
<dt><b>Parameter nNewText</b></dt>
<dd>new text.

 </dd>
<dt><b>Parameter aAttributes</b></dt>
<dd>the given set of attributes e.g. Language

 </dd>
<dt><b>Throws</b></dt>
<dd>IllegalArgumentException
 when any argument is wrong.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="changeAttributes" class="membertitle">changeAttributes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>changeAttributes</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nPos,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nLen,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;aAttributes )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>replace the attributes of the specific text with the given set of attributes.

 </dd>
<dt><b>Parameter nPos</b></dt>
<dd>start index of the text.

 </dd>
<dt><b>Parameter nLen</b></dt>
<dd>the length of the text.

 </dd>
<dt><b>Parameter aAttributes</b></dt>
<dd>the given set of attributes e.g. Language.

 </dd>
<dt><b>Throws</b></dt>
<dd>IllegalArgumentException
 when any argument is wrong.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getLanguagePortions" class="membertitle">getLanguagePortions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; long &gt;</td>
</tr>
<tr>
<td valign="top"><b>getLanguagePortions</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get a list of indexes that separate each two different languages

 </dd>
<dt><b>Returns</b></dt>
<dd>a list of indices.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>