Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 2479

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Service AccessibleShape</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="AccessibleShape-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">Included Services</td>
<td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td>
<td class="navisub">Properties' Summary</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">drawing</a> :: </p>
</td>
</tr>
<tr>
<td class="title">service AccessibleShape</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>The <a href="AccessibleShape.html">AccessibleShape</a> service is implemented by UNO shapes to
 provide accessibility information that describe the shapes' features.
 A UNO shape is any object that implements the <a href="XShape.html">XShape</a> interface.

 </dd>
<dd><p>The content of a draw page is modeled as tree of accessible shapes
 and accessible text paragraphs. The root of this (sub-)tree is the
 accessible draw document view. An accessible shape implements either
 this service or one of the 'derived' services
 <a href="AccessibleGraphicShape.html">AccessibleGraphicShape</a> or <a href="AccessibleOLEShape.html">AccessibleOLEShape</a>.
 See the section Children in the description of the
 ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleContext.html">XAccessibleContext</a> interface support for more details.</p>

 <p>There are two services that extend this one: the
 <a href="AccessibleGraphicShape.html">AccessibleGraphicShape</a> and the
 <a href="AccessibleOLEShape.html">AccessibleOLEShape</a> services provide additional interfaces.
 See there for details.</p>

 <p>A shape object is either fully or partially visible on the screen or
 has set the <b>AccessibleStateType::DEFUNC</b> state to indicate that it is no longer
 actively supported by its parent.</p>

 <p>Each shape object that has not set the DEFUNC state has a valid
 parent. That is either the containing draw page or a group shape or a
 3D scene object.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 1.1.2</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessible.html">XAccessible</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>Base interface for being accessible. It gives access to the 
 ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleContext.html">XAccessibleContext</a>
 interface.
 </dd>
</dl>
</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"><dl>
<dt><b>Description</b></dt>
<dd>Give access to the structural information of a shape.

 </dd>
<dd><p>You can access the following information for the shape being made
 accessible:
 <ul>
 <li>Role: The role of all shapes is <b>AccessibleRole::SHAPE</b>.</li>
 <li>Name: The name of a shape is its localized type name.</li>
 <li>Description: Descriptions are localized and start with the
 shape's type and style. After that follow some properties that
 differ from the defaults with respect to the style.
 <li>Children: The children of a shape are either other accessible
 shapes or accessible text paragraphs. Only group shapes, 3D scene
 shapes, and OLE shapes may contain other shapes as children.
 Some of the shapes may have text paragraphs as (additional)
 children. See ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/AccessibleParagraphView.html">AccessibleParagraphView</a> for details of
 how this text is represented.</li>
 <li>Parent: The parent is either the document view as represented by
 <a href="AccessibleDrawDocumentView.html">AccessibleDrawDocumentView</a> or a group shape, 3D
 scene shape, or OLE shape.</li>
 <li>Relations: Are set and maintained from the outside. See the
 service description of the object that has accessible shapes as
 children for details.</li>
 <li>States: The states supported by this service are: 
 <ul>
 <li><p><b>AccessibleStateType::DEFUNC</b> is set if an accessible
 shape is not visible but still existent for some reason.
 This should not really happen and is a sign that someone,
 e.g. an AT-Tool holds references to such a shape. The
 reason for this is that either the owner of the accessible
 shape did not remove it from its list of children or that
 the AT-Tool does not care for the events indicating
 this.</p>
 <p>Usually an object that has the <b>AccessibleStateType::DEFUNC</b> state set has already
 been disposed and subsequent calls to this object result in
 ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a> 
 exceptions.</p>
 <p>If this state is set then no other of the states below is
 set. This is also true for the states that are otherwise
 allways set (which makes 'allways' more of a sort of
 'normally').</p></li> 
 <li><b>AccessibleStateType::EDITABLE</b></li> is always set.
 This state is interpreted to mean that not only text but
 also other, graphical, properties of a shape can be modified.
 <li><b>AccessibleStateType::ENABLED</b> is always set.</li>
 <li><b>AccessibleStateType::FOCUSABLE</b> is always set.</li>
 <li><b>AccessibleStateType::FOCUSED</b> is set according to
 whether the shape currently has the focus.</li>
 <li><b>AccessibleStateType::MULTI_LINE</b> is set if a shape 
 supports the ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleText.html">XAccessibleText</a> interface.</li>
 <li><b>AccessibleStateType::OPAQUE</b> is set for certain shapes 
 with certain attributes like for a filled rectangle.</li>
 <li><b>AccessibleStateType::RESIZABLE</b> is always set.</li>
 <li><b>AccessibleStateType::SELECTABLE</b> is always set.</li>
 <li><b>AccessibleStateType::SELECTED</b> is set according to
 whether the shape is currently selected.</li>
 <li><b>AccessibleStateType::SHOWING</b> is always set.</li>
 <li><b>AccessibleStateType::VISIBLE</b> is always set.</li>
 </ul>
 <li>Locale: The shape returns the locale of its parent.</li>
 <li>Property change listeners: Property change listeners that are 
 registered with a shape are informed of the usual events.</li>
 </ul>
 </dd>
</dl>
</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"><dl>
<dt><b>Description</b></dt>
<dd>Give access to the graphical representation of a shape.

 </dd>
<dd><p>The bounding box returned by the <method
        scope="::com::sun::star::accessibility" 
        >XAccessibleComponent::getBounds</method> function returns the
 shape's bounding box clipped at its parent's bounding box</p>

 <p>An accessible shape tries as best as it can to return proper
 values for calls to the
 <method scope="::com::sun::star::accessibility"
        >XAccessibleExtendedComponent::getForeground</method> and 
 <method scope="::com::sun::star::accessibility"
        >XAccessibleExtendedComponent::getBackground</method> functions.
 If the shape is painted with a uniform and non-transparent color
 then the returned colors may differ from the ones visible on the
 screen.</p>

 <p>Key bindings are not supported at the moment</p>
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessibleExtendedComponent.html">XAccessibleExtendedComponent</a></td>
<td class="imsum_right"><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Give extended access to the graphical representation of a shape.
 
 </dd>
<dd><p>The functions <method
        scope="::com::sun::star::accessibility" 
        >XAccessibleExtendedComponent::getFont</method>,
 <method scope="::com::sun::star::accessibility"
        >XAccessibleExtendedComponent::getTitledBorderText</method>, and
 <method scope="::com::sun::star::accessibility"
        >XAccessibleExtendedComponent::getToolTipText</method> are not
 supported and return empty references respectively empty
 strings.</p>

 <p>The support of this interface is optional to reduce overhead in
 case that no text is displayed and color information can not be
 determined with an acceptable cost.</p>
 </dd>
</dl>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

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

</html>