<html> <head> <title>Service AccessibleParagraphView</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="AccessibleParagraphView-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">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub">Properties' Summary</td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub">Properties' 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">service AccessibleParagraphView</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The accessible view of a paragraph fragment. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <hr> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleContext.html">XAccessibleContext</a></td> <td class="imsum_right"><p>This interface gives access to a paragraph fragment that is at least partially visible on the screen. A paragraph fragment is the portion of a paragraph that is displayed on a single page or a in a single column. (<a href="#XAccessibleContext">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleComponent.html">XAccessibleComponent</a></td> <td class="imsum_right"><p>This interface describes the graphical representation of a paragraph fragment. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleEditableText.html">XAccessibleEditableText</a></td> <td class="imsum_right"><p>This interface gives access to a paragraph fragment's text. The text contains the paragraph's editable text as well as generated text, like chapter numbers, hyphens or fields. Characters of generated text contribute to the text's character indexing. However, it is not possible to set the caret or start a selection within generated text. (<a href="#XAccessibleEditableText">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleText.html">XAccessibleText</a></td> <td class="imsum_right"><p>This interface is a subset of ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleEditableText.html">XAccessibleEditableText</a> and gives access to a paragraph fragment's text in a read-only mode. The text contains the paragraph's text (changeable as well as generated text, like chapter numbers, hyphens or fields). Characters of generated text contribute to the text's character indexing. (<a href="#XAccessibleText">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleSelection.html">XAccessibleSelection</a></td> <td class="imsum_right"><p>This interface is for selecting the paragraph's children. Multi selection is supported only for children that are multi selectable in the GUI, too. (<a href="#XAccessibleSelection">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleEventBroadcaster.html">XAccessibleEventBroadcaster</a></td> <td class="imsum_right"><p>This is the interface for listeners. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleTextAttributes.html">XAccessibleTextAttributes</a></td> <td class="imsum_right"><p>This interface gives access to the default attributes of a paragraph and to the run attributes of a certain character in a paragraph (<a href="#XAccessibleTextAttributes">details</a>)</p> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAccessibleContext" class="membertitle">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleContext.html">XAccessibleContext</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface gives access to a paragraph fragment that is at least partially visible on the screen. A paragraph fragment is the portion of a paragraph that is displayed on a single page or a in a single column. </dd> <dd><ul> <li>The parent returned by <method scope="::com::sun::star::accessibility" >XAccessibleContext::getAccessibleParent</method> is the accessible view of a text document (in this case the paragraph is contained in a page body) or the accessible view of a header, footer, footnote, endnote, table cell, text frame, page or shape.</li> <li>The children returned by <method scope="::com::sun::star::accessibility" >XAccessibleContext::getAccessibleChild</method> are the graphics, text boxes and OLE objects that are bound <em>as</em> character within the paragraph. Graphics, text boxes and OLE objects that are bound to the paragraph or <em>to</em> a character within the paragraph are not children of the paragraph fragment but of the document view itself.</li> <li>The role is either <b>AccessibleRole::PARAGRAPH</b> or <b>AccessibleRole::HEADING</b>. The later one is returned if the paragraph's style is contained in the chapter numbering of a text document. <li>The name is "paragraph" or "heading" (or the equivalent term in application's language) with a number appended. <li>The description contains the term "paragraph" (or the equivalent term in application's language) and the first sentence of the paragraph. <li>There are no relations. <li>The following states are supported by the ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleStateSet.html">XAccessibleStateSet</a> returned by <method scope="::com::sun::star::accessibility" >XAccessibleContext::getAccessibleStateSet</method>. <ul> <li><b>AccessibleStateType::DEFUNC</b> (indicates that the document window has been closed or the paragraph fragment is not existing any longer). <li><b>AccessibleStateType::EDITABLE</b> <li><b>AccessibleStateType::ENABLED</b> (always contained) <li><b>AccessibleStateType::MULTILINE</b> (always contained) <li><b>AccessibleStateType::MULTISELECTABLE</b> (always contained) <li><b>AccessibleStateType::OPAQUE</b> <li><b>AccessibleStateType::SHOWING</b> <li><b>AccessibleStateType::VISIBLE</b> <li><b>AccessibleStateType::FOCUSED</b> </ul> <li>Depending of the application's region setting, the locale is the western, asian or complex language of the paragraph. </ul> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAccessibleComponent" class="membertitle">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleComponent.html">XAccessibleComponent</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface describes the graphical representation of a paragraph fragment. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAccessibleEditableText" class="membertitle">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleEditableText.html">XAccessibleEditableText</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This interface gives access to a paragraph fragment's text. The text contains the paragraph's editable text as well as generated text, like chapter numbers, hyphens or fields. Characters of generated text contribute to the text's character indexing. However, it is not possible to set the caret or start a selection within generated text. </dd> <dd><p>For text frames, graphics, etc. that are bound as character some text is generated that contains the objects description. <p>The attributes (or properties) returned by <method scope="::com::sun::star::accessibility" >XAccessibleText::getCharacterAttributes</method> are a sub set of the properties described by the service ::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/CharacterProperties.html">CharacterProperties</a>. For properties that have asian and complex counterparts, the value that is visible is returned. This can be in fact the western, asian or complex value. Its not possible to change the value of any property by using <method scope="::com::sun::star::accessibility" >XAccessibleEditableText::setAttributes</method>. <p><em>TODO: If there is a demand, some attributes might be added that tells whether the character at a certain index is editable or generated. </em> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAccessibleText" class="membertitle">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleText.html">XAccessibleText</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface is a subset of ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleEditableText.html">XAccessibleEditableText</a> and gives access to a paragraph fragment's text in a read-only mode. The text contains the paragraph's text (changeable as well as generated text, like chapter numbers, hyphens or fields). Characters of generated text contribute to the text's character indexing. </dd> <dd><p>For text frames, graphics, etc. that are bound as character some text is generated that contains the objects description. <p>The attributes (or properties) returned by <method scope="::com::sun::star::accessibility" >XAccessibleText::getCharacterAttributes</method> are a sub set of the properties described by the service ::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/CharacterProperties.html">CharacterProperties</a>. For properties that have asian and complex counterparts, the value that is visible is returned. This can be in fact the western, asian or complex value. <p><em>TODO: If there is a demand, some attributes might be added that tells whether the character at a certain index is changeable or generated. </em> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAccessibleSelection" class="membertitle">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleSelection.html">XAccessibleSelection</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This interface is for selecting the paragraph's children. Multi selection is supported only for children that are multi selectable in the GUI, too. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAccessibleEventBroadcaster" class="membertitle">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleEventBroadcaster.html">XAccessibleEventBroadcaster</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This is the interface for listeners. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAccessibleTextAttributes" class="membertitle">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleTextAttributes.html">XAccessibleTextAttributes</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This interface gives access to the default attributes of a paragraph and to the run attributes of a certain character in a paragraph </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0.4</dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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>