<html> <head> <title>Interface XPresenterHelper</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="XPresenterHelper-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">drawing</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 XPresenterHelper</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>This interface is a collection of functions that are necessary to implement larger parts of the presenter screen as extension. The methods of this interface give access to services that can, at the moment, only implemented in the Office core, not in an extension. </dd> <dd><p>With time some, maybe all, methods can moved to other, better suited, interfaces.</p> </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="#createWindow">createWindow</a></td> <td class="imsum_right">Create a new window as child window of the given parent window. </td> </tr> <tr> <td class="imsum_left"><a href="#createSharedCanvas">createSharedCanvas</a></td> <td class="imsum_right">Create a new canvas for the given window. The new canvas is a wrapper around the given shared canvas. The wrapper only modifies the origin in all output and clipping methods. </td> </tr> <tr> <td class="imsum_left"><a href="#createCanvas">createCanvas</a></td> <td class="imsum_right">Create a new canvas for the given window. </td> </tr> <tr> <td class="imsum_left"><a href="#toTop">toTop</a></td> <td class="imsum_right">Move the specified window to the top of its stacking order. As a result the window will be painted over all its overlapping siblings. </td> </tr> <tr> <td class="imsum_left"><a href="#loadBitmap">loadBitmap</a></td> <td class="imsum_right">Load a bitmap from a file or other accessible resource that can be located via a URL. </td> </tr> <tr> <td class="imsum_left"><a href="#captureMouse">captureMouse</a></td> <td class="imsum_right">Capture the mouse so that no other window will receive mouse events. Note that this is a potentially dangerous method. Not calling releaseMouse eventually can lead to an unresponsive application. </td> </tr> <tr> <td class="imsum_left"><a href="#releaseMouse">releaseMouse</a></td> <td class="imsum_right">Release a previously captured mouse. </td> </tr> <tr> <td class="imsum_left"><a href="#getWindowExtentsRelative">getWindowExtentsRelative</a></td> <td class="imsum_right">Return the bounding box of the given child window relative to the direct or indirect parent window. </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="createWindow" class="membertitle">createWindow</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/XWindow.html">XWindow</a></td> </tr> <tr> <td valign="top"><b>createWindow</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xParentWindow,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bCreateSystemChildWindow,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bInitiallyVisible,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bEnableChildTransparentMode,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bEnableParentClip );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Create a new window as child window of the given parent window. </dd> <dt><b>Parameter xParentWindow</b></dt> <dd>The parent window of the new window. </dd> <dt><b>Parameter bCreateSystemChildWindow</b></dt> <dd>When <b>true</b> then the new window will be a system window that, in the context of the presenter screen, can not be painted over by other windows that lie behind it. </dd> <dt><b>Parameter bInitiallyVisible</b></dt> <dd>When <b>true</b> the new window will be visible from the start, i.e. a window listener will not receive a windowShown signal. </dd> <dt><b>Parameter bEnableChildTransparentMode</b></dt> <dd>When <b>true</b> the parent window is painted behind its child windows. This is one half of allowing child windows to be transparent. </dd> <dt><b>Parameter bEnableParentClip</b></dt> <dd>When <b>true</b> then the parent window is not clipped where its child windows are painted. This is the other half of allowing child windows to be transparent. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createSharedCanvas" class="membertitle">createSharedCanvas</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="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XCanvas.html">XCanvas</a></td> </tr> <tr> <td valign="top"><b>createSharedCanvas</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XSpriteCanvas.html">XSpriteCanvas</a></td> <td valign="bottom"> xUpdateCanvas,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xUpdateWindow,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XCanvas.html">XCanvas</a></td> <td valign="bottom"> xSharedCanvas,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xSharedWindow,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xWindow );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Create a new canvas for the given window. The new canvas is a wrapper around the given shared canvas. The wrapper only modifies the origin in all output and clipping methods. </dd> <dt><b>Parameter xUpdateCanvas</b></dt> <dd>This canvas is used to call updateScreen() on. May be <b>NULL</b> </dd> <dt><b>Parameter xUpdateWindow</b></dt> <dd>The window that belongs to the update canvas. May also be <b>NULL</b> (is expected to b <b>NULL</b> whenever xUpdateCanvas is.) </dd> <dt><b>Parameter xSharedCanvas</b></dt> <dd>The canvas that is shared by the wrapper. </dd> <dt><b>Parameter xSharedWindow</b></dt> <dd>The window of the shared canvas. This is used to determine the proper offset. </dd> <dt><b>Parameter xWindow</b></dt> <dd>The canvas is created for this window. Must not be <b>NULL</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createCanvas" class="membertitle">createCanvas</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="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XCanvas.html">XCanvas</a></td> </tr> <tr> <td valign="top"><b>createCanvas</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xWindow,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> nRequestedCanvasFeatureList,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sOptionalCanvasServiceName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Create a new canvas for the given window. </dd> <dt><b>Parameter xWindow</b></dt> <dd>The canvas is created for this window. Must not be <b>NULL</b> </dd> <dt><b>Parameter nRequestedCanvasFeatureList</b></dt> <dd>List of requested features that the new canvas should (has to) provide. Use only values from the <a href="CanvasFeature.html">CanvasFeature</a> constants group. </dd> <dt><b>Parameter sOptionalCanvasServiceName</b></dt> <dd>When an explicit service name is given then a new object of this service is created. This service name lets the caller select a specific canvas implementation, e.g. with or without hardware acceleration. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="toTop" class="membertitle">toTop</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>toTop</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xWindow );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Move the specified window to the top of its stacking order. As a result the window will be painted over all its overlapping siblings. </dd> <dt><b>Parameter xWindow</b></dt> <dd>This window will be moved to the top of its stacking order. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadBitmap" class="membertitle">loadBitmap</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="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XBitmap.html">XBitmap</a></td> </tr> <tr> <td valign="top"><b>loadBitmap</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sURL,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XCanvas.html">XCanvas</a></td> <td valign="bottom"> xCanvas );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Load a bitmap from a file or other accessible resource that can be located via a URL. </dd> <dt><b>Parameter sURL</b></dt> <dd>The URL of the bitmap. For a file URL the bitmap is loaded from the specified file. </dd> <dt><b>Parameter xCanvas</b></dt> <dd>The bitmap is created to be compatible, and possibly optimized, for this canvas. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="captureMouse" class="membertitle">captureMouse</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>captureMouse</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xWindow );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Capture the mouse so that no other window will receive mouse events. Note that this is a potentially dangerous method. Not calling releaseMouse eventually can lead to an unresponsive application. </dd> <dt><b>Parameter xWindow</b></dt> <dd>The window for which mouse events will be notified even when the mouse pointer moves outside the window or over other windows. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="releaseMouse" class="membertitle">releaseMouse</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>releaseMouse</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xWindow );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Release a previously captured mouse. </dd> <dt><b>Parameter xWindow</b></dt> <dd>The window from which the mouse will be released. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getWindowExtentsRelative" class="membertitle">getWindowExtentsRelative</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/Rectangle.html">Rectangle</a></td> </tr> <tr> <td valign="top"><b>getWindowExtentsRelative</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xChildWindow,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xParentWindow );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the bounding box of the given child window relative to the direct or indirect parent window. </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
>
2833
