:: com :: sun :: star :: drawing ::
|
unpublished |
interface XPresenterHelper |
|
|
|
- Usage Restrictions
- not published
- Description
- 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.
With time some, maybe all, methods can moved to other, better suited,
interfaces.
|
Methods' Summary |
createWindow |
Create a new window as child window of the given parent window.
|
createSharedCanvas |
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.
|
createCanvas |
Create a new canvas for the given window.
|
toTop |
Move the specified window to the top of its stacking order. As a
result the window will be painted over all its overlapping
siblings.
|
loadBitmap |
Load a bitmap from a file or other accessible resource that can be
located via a URL.
|
captureMouse |
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.
|
releaseMouse |
Release a previously captured mouse.
|
getWindowExtentsRelative |
Return the bounding box of the given child window relative to the
direct or indirect parent window.
|
Methods' Details |
createWindow
::com::sun::star::awt::XWindow |
createWindow( |
[in] ::com::sun::star::awt::XWindow |
xParentWindow, |
| [in] boolean |
bCreateSystemChildWindow, |
| [in] boolean |
bInitiallyVisible, |
| [in] boolean |
bEnableChildTransparentMode, |
| [in] boolean |
bEnableParentClip ); |
- Description
- Create a new window as child window of the given parent window.
- Parameter xParentWindow
- The parent window of the new window.
- Parameter bCreateSystemChildWindow
- When true 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.
- Parameter bInitiallyVisible
- When true the new window will be visible from the start,
i.e. a window listener will not receive a windowShown signal.
- Parameter bEnableChildTransparentMode
- When true the parent window is painted behind its child
windows. This is one half of allowing child windows to be
transparent.
- Parameter bEnableParentClip
- When true 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.
|
|
createSharedCanvas
- Description
- 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.
- Parameter xUpdateCanvas
- This canvas is used to call updateScreen() on. May be NULL
- Parameter xUpdateWindow
- The window that belongs to the update canvas. May also be
NULL (is expected to b NULL whenever xUpdateCanvas is.)
- Parameter xSharedCanvas
- The canvas that is shared by the wrapper.
- Parameter xSharedWindow
- The window of the shared canvas. This is used to determine the
proper offset.
- Parameter xWindow
- The canvas is created for this window. Must not be NULL
|
|
createCanvas
::com::sun::star::rendering::XCanvas |
createCanvas( |
[in] ::com::sun::star::awt::XWindow |
xWindow, |
| [in] short |
nRequestedCanvasFeatureList, |
| [in] string |
sOptionalCanvasServiceName ); |
- Description
- Create a new canvas for the given window.
- Parameter xWindow
- The canvas is created for this window. Must not be NULL
- Parameter nRequestedCanvasFeatureList
- List of requested features that the new canvas should (has to)
provide. Use only values from the CanvasFeature
constants group.
- Parameter sOptionalCanvasServiceName
- 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.
|
|
toTop
void |
toTop( |
[in] ::com::sun::star::awt::XWindow |
xWindow ); |
- Description
- Move the specified window to the top of its stacking order. As a
result the window will be painted over all its overlapping
siblings.
- Parameter xWindow
- This window will be moved to the top of its stacking order.
|
|
loadBitmap
- Description
- Load a bitmap from a file or other accessible resource that can be
located via a URL.
- Parameter sURL
- The URL of the bitmap. For a file URL the bitmap is loaded from
the specified file.
- Parameter xCanvas
- The bitmap is created to be compatible, and possibly optimized,
for this canvas.
|
|
captureMouse
void |
captureMouse( |
[in] ::com::sun::star::awt::XWindow |
xWindow ); |
- Description
- 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.
- Parameter xWindow
- The window for which mouse events will be notified even when the
mouse pointer moves outside the window or over other windows.
|
|
releaseMouse
void |
releaseMouse( |
[in] ::com::sun::star::awt::XWindow |
xWindow ); |
- Description
- Release a previously captured mouse.
- Parameter xWindow
- The window from which the mouse will be released.
|
|
getWindowExtentsRelative
::com::sun::star::awt::Rectangle |
getWindowExtentsRelative( |
[in] ::com::sun::star::awt::XWindow |
xChildWindow, |
| [in] ::com::sun::star::awt::XWindow |
xParentWindow ); |
- Description
- Return the bounding box of the given child window relative to the
direct or indirect parent window.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.