<html> <head> <title>Interface XAccessibleTextMarkup</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="XAccessibleTextMarkup-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">accessibility</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 XAccessibleTextMarkup</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XAccessibleTextMarkup</strong> ┗ <a href="XAccessibleText.html">XAccessibleText</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XAccessibleText.html">XAccessibleText</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Implement this interface to give read-only access to a 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>Implement this interface to expose the text markups of a text. </dd> <dd><p>The <a href="XAccessibleTextMarkup.html">XAccessibleTextMarkup</a> interface is the main interface to expose text markups in a text, typically of a text document, that are used to reference other (parts of) documents. For supporting the <a href="XAccessibleTextMarkup.html#getTextMarkupIndex">getTextMarkupIndex</a> method of this interface and other character related methods of the <a href="XAccessibleTextMarkup.html">XAccessibleTextMarkup</a> interface, it is necessary to also support the <a href="XAccessibleText.html">XAccessibleText</a> interface.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.0</dd> <dt><b>See also</b></dt> <dd><a href="XAccessibleText.html">XAccessibleText</a></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="#getTextMarkupCount">getTextMarkupCount</a></td> <td class="imsum_right">Returns the number of text markup of the given text markup type of a text. </td> </tr> <tr> <td class="imsum_left"><a href="#getTextMarkup">getTextMarkup</a></td> <td class="imsum_right">Returns the text segment of the text markup of the given index and of the given text mark type </td> </tr> <tr> <td class="imsum_left"><a href="#getTextMarkupAtIndex">getTextMarkupAtIndex</a></td> <td class="imsum_right">returns a sequence of the text segments of the text markups at the given character index and of the given text markup type. </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="getTextMarkupCount" class="membertitle">getTextMarkupCount</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">long</td> </tr> <tr> <td valign="top"><b>getTextMarkupCount</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> TextMarkupType )</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>Returns the number of text markup of the given text markup type of a text. </dd> <dd><p>Throws ::IllegalArgumentException, if given text markup type is out of valid range.</p> </dd> <dt><b>Parameter TextMarkupType</b></dt> <dd>This specifies the type of text markups, whose count should be returned - see ::TextMarkupType. </dd> <dt><b>Returns</b></dt> <dd>The number of text markup of the given text markup type. Returns 0 if there is no text markup. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTextMarkup" class="membertitle">getTextMarkup</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"><a href="TextSegment.html">TextSegment</a></td> </tr> <tr> <td valign="top"><b>getTextMarkup</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> TextMarkupIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> TextMarkupType )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a>,<br> ::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>Returns the text segment of the text markup of the given index and of the given text mark type </dd> <dd><p>Throws ::IndexOutOfBoundsException, if given index is out of valid range.</p> <p>Throws ::IllegalArgumentException, if given text markup type is out of valid range.</p> </dd> <dt><b>Parameter TextMarkupIndex</b></dt> <dd>This index specifies the text markup to return. </dd> <dt><b>Parameter TextMarkupType</b></dt> <dd>This specifies the type of the text markup to be returned - see ::TextMarkupType. </dd> <dt><b>Returns</b></dt> <dd>If the given index is in range [0..getTextMarkupCount(TextMarkupType)-1], the text segment - see <a href="TextSegment.html">TextSegment</a> - of the text markup of the given text markup type is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTextMarkupAtIndex" class="membertitle">getTextMarkupAtIndex</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< <a href="TextSegment.html">TextSegment</a> ></td> </tr> <tr> <td valign="top"><b>getTextMarkupAtIndex</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> CharIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> TextMarkupType )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a>,<br> ::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>returns a sequence of the text segments of the text markups at the given character index and of the given text markup type. </dd> <dd><p>Throws ::IndexOutOfBoundsException, if given character index is out of range [0..number of characters in the text).</p> <p>Throws ::IllegalArgumentException, if given text markup type is out of valid range.</p> </dd> <dt><b>Parameter CharIndex</b></dt> <dd>This index specifies the character index in the text. </dd> <dt><b>Parameter TextMarkupType</b></dt> <dd>This specifies the type of the text markups to be returned - see ::TextMarkupType. </dd> <dt><b>Returns</b></dt> <dd>If character index is in range [0..number of characters in the text-1], a seguence of <a href="TextSegment.html">TextSegment</a>s of the text markups at given character index of the given text markup type are returned. The sequence is empty, if no such text markup is found. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
641
