<html> <head> <title>Interface XVisualObject</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="XVisualObject-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">embed</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 XVisualObject</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>represents common visualisation functionality for embedded objects. </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="#setVisualAreaSize">setVisualAreaSize</a></td> <td class="imsum_right">sets the size of object's visual area. </td> </tr> <tr> <td class="imsum_left"><a href="#getVisualAreaSize">getVisualAreaSize</a></td> <td class="imsum_right">gets the size of object's visual area. </td> </tr> <tr> <td class="imsum_left"><a href="#getPreferredVisualRepresentation">getPreferredVisualRepresentation</a></td> <td class="imsum_right">retrieves visual representation of the object in preferable format. </td> </tr> <tr> <td class="imsum_left"><a href="#getMapUnit">getMapUnit</a></td> <td class="imsum_right">retrieves map mode the object communicates in. </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="setVisualAreaSize" class="membertitle">setVisualAreaSize</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>setVisualAreaSize</b>(</td> <td valign="top">[in] hyper</td> <td valign="bottom"> nAspect,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a></td> <td valign="bottom"> aSize )</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>,<br> <a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the size of object's visual area. </dd> <dd><p> The size must be provided in logical units according to map mode the object communicates in. </p> <p> If an object is inplace- or ui-active the method must not initiate repainting itself. </p> </dd> <dt><b>Parameter nAspect</b></dt> <dd>the aspect specifying the form of object representation can take values from <a href="Aspects.html">Aspects</a> constant set </dd> <dt><b>Parameter aSize</b></dt> <dd>the new size of the visual area @thrown ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::WrongStateException the object is in wrong state </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::uno::Exception the object failed to resize </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getVisualAreaSize" class="membertitle">getVisualAreaSize</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="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a></td> </tr> <tr> <td valign="top"><b>getVisualAreaSize</b>(</td> <td valign="top">[in] hyper</td> <td valign="bottom"> nAspect )</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>,<br> <a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the size of object's visual area. </dd> <dd><p> The size must be provided in logical units according to map mode the object communicates in. </p> </dd> <dt><b>Parameter nAspect</b></dt> <dd>the aspect specifying the form of object representation can take values from <a href="Aspects.html">Aspects</a> constant set </dd> <dt><b>Returns</b></dt> <dd>the size of visual area @thrown ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::WrongStateException the object is in wrong state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPreferredVisualRepresentation" class="membertitle">getPreferredVisualRepresentation</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="VisualRepresentation.html">VisualRepresentation</a></td> </tr> <tr> <td valign="top"><b>getPreferredVisualRepresentation</b>(</td> <td valign="top">[in] hyper</td> <td valign="bottom"> nAspect )</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>,<br> <a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves visual representation of the object in preferable format. </dd> <dd><p> If the object persistance entry contains cached visual representation then it can be retrieved by using this method even in loaded state. </p> </dd> <dt><b>Parameter nAspect</b></dt> <dd>the aspect the representation is requested for </dd> <dt><b>Returns</b></dt> <dd>the visual representation of the object in the default format and the format </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException one of arguments is illegal </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::WrongStateException the object is in wrong state </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::uno::Exception in case of problems </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getMapUnit" class="membertitle">getMapUnit</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>getMapUnit</b>(</td> <td valign="top">[in] hyper</td> <td valign="bottom"> nAspect )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves map mode the object communicates in. </dd> <dt><b>Parameter nAspect</b></dt> <dd>the aspect the map mode is requested for </dd> <dt><b>Returns</b></dt> <dd>the map mode the object communicates in, it can take values from <a href="EmbedMapUnits.html">EmbedMapUnits</a> constant </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::WrongStateException the object is in wrong state </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::uno::Exception in case of problems </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
>
3049
