Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: embed ::

interface XInplaceObject
Description
represents common functionality for inplace embedded objects.
Methods' Summary
setObjectRectangles sets the visible part of the inplace object.  
enableModeless enables or disables modeless dialogs of the object.  
translateAccelerators provides accelerator table the container whants to use during inplace editing.  
Methods' Details
setObjectRectangles
void
setObjectRectangles( [in] ::com::sun::star::awt::Rectangle  aPosRect,
[in] ::com::sun::star::awt::Rectangle  aClipRect )
raises( WrongStateException,
::com::sun::star::uno::Exception );
Description
sets the visible part of the inplace object.

Both rectangles are provided in object's parent window coordinates in pixels. The intersection of rectangles specifies the visible part of the object. In case the position window has a size that is different from object's visual area size, the object should either scale or deactivate.

The method must activate object repainting.

Parameter aPosRect
specifies a new position rectangle
Parameter aClipRect
specifies a new clip rectangle
Throws
com::sun::star::embed::WrongStateException the object is in invalid state
Throws
com::sun::star::uno::Exception in case of other problems
enableModeless
void
enableModeless( [in] boolean  bEnable )
raises( WrongStateException,
::com::sun::star::uno::Exception );
Description
enables or disables modeless dialogs of the object.

In case contaner whants to show a modal dialog it should disable modeless of embedded object dialogs with this call. Later the same call can be used to enable it.

Parameter bEnable
true to enable object modeless false to disable it
Throws
com::sun::star::embed::WrongStateException the object is in wrong state
Throws
com::sun::star::uno::Exception in case of other problems
translateAccelerators
void
translateAccelerators( [in] sequence< ::com::sun::star::awt::KeyEvent >  aKeys )
raises( WrongStateException );
Description
provides accelerator table the container whants to use during inplace editing.
Returns
an accelerator table from container
Throws
com::sun::star::embed::WrongStateException the object is in unexpected state
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.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.