<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::Component Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1Component.html">Accessibility::Component</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Accessibility::Component Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::Component" -->
<p><code>import "<a class="el" href="Accessibility__Component_8idl_source.html">Accessibility_Component.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a487a33398ba2c96d219854139da2da61">contains</a> (in long x, in long y, in short coord_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a78b6fe141a86d5b0732f08bfd3b1baa3">getAccessibleAtPoint</a> (in long x, in long y, in short coord_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structAccessibility_1_1BoundingBox.html">BoundingBox</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#ae496a3fed83f06ccc2fb452a89e6b05d">getExtents</a> (in short coord_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a27935020d26a2c064a00b902d4d76d8d">getPosition</a> (out long x, out long y, in short coord_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a2ba2c84dd4bd8d7084529760a9c7cbe5">getSize</a> (out long width, out long height)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAccessibility.html#a7124e9eb652382b3272b353c446764a3">ComponentLayer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#aa8bcf6380b9686f01d107b27e8d079de">getLayer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a29b6de3d02833803a4ef03f1c1339a27">getMDIZOrder</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a416e477ce975e1dbfc83ab44f62aafd8">grabFocus</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a1faf328e7030b32ba22b6e9ca2b06bdc">registerFocusHandler</a> (in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> handler)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#ab602a842722a87f40b2100debd2e81a6">deregisterFocusHandler</a> (in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> handler)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Component.html#a4e0285e4dd23783129c81dcb1dd7e36b">getAlpha</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="interfaceAccessibility_1_1Component.html">Component</a> interface is implemented by objects which occupy on-screen space, e.g. objects which have onscreen visual representations. The methods in <a class="el" href="interfaceAccessibility_1_1Component.html">Component</a> allow clients to identify where the objects lie in the onscreen coordinate system, their relative size, stacking order, and position. It also provides a mechanism whereby keyboard focus may be transferred to specific user interface elements programmatically. This is a 2D API, coordinates of 3D objects are projected into the 2-dimensional screen view for purposes of this interface.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>the meaning and defined values of the <code>short</code> <code>coord_type</code> parameter used by some <a class="el" href="interfaceAccessibility_1_1Component.html">Component</a> methods is as follows: <ul>
<li>0 indicates coord_type_xy_screen, coordinates are relative to the display screen, in pixels. </li>
<li>1 indicates coord_type_xy_window, coordinates are relative to the current toplevel window, in pixels.</li>
</ul>
</dd>
<dd>
Events emitted by <a class="el" href="interfaceAccessibility_1_1Component.html">Component</a> instances include: <ul>
<li><code>"object:bounds-changed"</code> </li>
<li><code>"object:visible-data-changed"</code> </li>
</ul>
</dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a487a33398ba2c96d219854139da2da61"></a><!-- doxytag: member="Accessibility::Component::contains" ref="a487a33398ba2c96d219854139da2da61" args="(in long x, in long y, in short coord_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Component::contains </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in short </td>
<td class="paramname"> <em>coord_type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified point lies within the Component's bounding box, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ab602a842722a87f40b2100debd2e81a6"></a><!-- doxytag: member="Accessibility::Component::deregisterFocusHandler" ref="ab602a842722a87f40b2100debd2e81a6" args="(in EventListener handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Component::deregisterFocusHandler </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> </td>
<td class="paramname"> <em>handler</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request that an <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> registered via registerFocusHandler no longer be notified when this object receives keyboard focus. </p>
</div>
</div>
<a class="anchor" id="a78b6fe141a86d5b0732f08bfd3b1baa3"></a><!-- doxytag: member="Accessibility::Component::getAccessibleAtPoint" ref="a78b6fe141a86d5b0732f08bfd3b1baa3" args="(in long x, in long y, in short coord_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> Accessibility::Component::getAccessibleAtPoint </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in short </td>
<td class="paramname"> <em>coord_type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> child whose bounding box contains the specified point. </dd></dl>
</div>
</div>
<a class="anchor" id="a4e0285e4dd23783129c81dcb1dd7e36b"></a><!-- doxytag: member="Accessibility::Component::getAlpha" ref="a4e0285e4dd23783129c81dcb1dd7e36b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Accessibility::Component::getAlpha </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain the alpha value of the component. An alpha value of 1.0 or greater indicates that the object is fully opaque, and an alpha value of 0.0 indicates that the object is fully transparent. Negative alpha values have no defined meaning at this time.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>alpha values are used in conjunction with Z-order calculations to determine whether an object wholly or partially obscures another object's visual intersection, in the event that their bounds intersect.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="namespaceAccessibility.html#ae820646a33b95416ad4d0ce3587035bea5aa0b84f7b07e031ecd2fa37c871cda9">STATE_OPAQUE</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>AT-SPI 1.7.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae496a3fed83f06ccc2fb452a89e6b05d"></a><!-- doxytag: member="Accessibility::Component::getExtents" ref="ae496a3fed83f06ccc2fb452a89e6b05d" args="(in short coord_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structAccessibility_1_1BoundingBox.html">BoundingBox</a> Accessibility::Component::getExtents </td>
<td>(</td>
<td class="paramtype">in short </td>
<td class="paramname"> <em>coord_type</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain the Component's bounding box, in pixels, relative to the specified coordinate system. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="structAccessibility_1_1BoundingBox.html">BoundingBox</a> which entirely contains the object's onscreen visual representation. </dd></dl>
</div>
</div>
<a class="anchor" id="aa8bcf6380b9686f01d107b27e8d079de"></a><!-- doxytag: member="Accessibility::Component::getLayer" ref="aa8bcf6380b9686f01d107b27e8d079de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#a7124e9eb652382b3272b353c446764a3">ComponentLayer</a> Accessibility::Component::getLayer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the ComponentLayer in which this object resides. </dd></dl>
</div>
</div>
<a class="anchor" id="a29b6de3d02833803a4ef03f1c1339a27"></a><!-- doxytag: member="Accessibility::Component::getMDIZOrder" ref="a29b6de3d02833803a4ef03f1c1339a27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short Accessibility::Component::getMDIZOrder </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain the relative stacking order (i.e. 'Z' order) of an object. Larger values indicate that an object is on "top" of the stack, therefore objects with smaller MDIZOrder may be obscured by objects with a larger MDIZOrder, but not vice-versa. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>only relevant for objects in LAYER_MDI or LAYER_WINDOW </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an integer indicating the object's place in the stacking order. </dd></dl>
</div>
</div>
<a class="anchor" id="a27935020d26a2c064a00b902d4d76d8d"></a><!-- doxytag: member="Accessibility::Component::getPosition" ref="a27935020d26a2c064a00b902d4d76d8d" args="(out long x, out long y, in short coord_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Component::getPosition </td>
<td>(</td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in short </td>
<td class="paramname"> <em>coord_type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain the position of the current component in the coordinate system specified by <code>coord_type</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>coord_type</em> </td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>an out parameter which will be back-filled with the returned x coordinate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>an out parameter which will be back-filled with the returned y coordinate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2ba2c84dd4bd8d7084529760a9c7cbe5"></a><!-- doxytag: member="Accessibility::Component::getSize" ref="a2ba2c84dd4bd8d7084529760a9c7cbe5" args="(out long width, out long height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Component::getSize </td>
<td>(</td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>height</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain the size, in the coordinate system specified by <code>coord_type</code>, of the rectangular area which fully contains the object's visual representation, without accounting for viewport clipping. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>the object's horizontal extents in the specified coordinate system. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>the object's vertical extents in the specified coordinate system. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a416e477ce975e1dbfc83ab44f62aafd8"></a><!-- doxytag: member="Accessibility::Component::grabFocus" ref="a416e477ce975e1dbfc83ab44f62aafd8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Component::grabFocus </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request that the object obtain keyboard focus.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if keyboard focus was successfully transferred to the <a class="el" href="interfaceAccessibility_1_1Component.html">Component</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a1faf328e7030b32ba22b6e9ca2b06bdc"></a><!-- doxytag: member="Accessibility::Component::registerFocusHandler" ref="a1faf328e7030b32ba22b6e9ca2b06bdc" args="(in EventListener handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Component::registerFocusHandler </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> </td>
<td class="paramname"> <em>handler</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register an <a class="el" href="interfaceAccessibility_1_1EventListener.html">EventListener</a> for notification when this object receives keyboard focus. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>you probably want to register for ¨focus:¨ events via <a class="el" href="interfaceAccessibility_1_1Registry.html#adbb76f310f6cbeb67a56b5b5f54cc438">Registry::registerGlobalEventListener</a> instead. </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Component_8idl_source.html">Accessibility_Component.idl</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
