LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XInplaceObject Interface Referencepublished

represents common functionality for inplace embedded objects. More...

import"XInplaceObject.idl";

Inheritance diagram for XInplaceObject:
XInterface

Public Member Functions

void setObjectRectangles ([in] ::com::sun::star::awt::Rectangle aPosRect, [in] ::com::sun::star::awt::Rectangle aClipRect) raises ( ::com::sun::star::embed::WrongStateException, ::com::sun::star::uno::Exception )
 sets the visible part of the inplace object. More...
 
void enableModeless ([in] boolean bEnable) raises ( ::com::sun::star::embed::WrongStateException, ::com::sun::star::uno::Exception )
 enables or disables modeless dialogs of the object. More...
 
void translateAccelerators ([in] sequence< ::com::sun::star::awt::KeyEvent > aKeys) raises ( ::com::sun::star::embed::WrongStateException )
 provides accelerator table the container wants to use during inplace editing. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

represents common functionality for inplace embedded objects.

Member Function Documentation

◆ enableModeless()

void enableModeless ( [in] boolean  bEnable)
raises ( ::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception
)

enables or disables modeless dialogs of the object.

In case container wants 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.

Parameters
bEnableTRUE to enable object modeless FALSE to disable it
Exceptions
com::sun::star::embed::WrongStateExceptionthe object is in wrong state
com::sun::star::uno::Exceptionin case of other problems

◆ setObjectRectangles()

void setObjectRectangles ( [in] ::com::sun::star::awt::Rectangle  aPosRect,
[in] ::com::sun::star::awt::Rectangle  aClipRect 
)
raises ( ::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception
)

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.

Parameters
aPosRectspecifies a new position rectangle
aClipRectspecifies a new clip rectangle
Exceptions
com::sun::star::embed::WrongStateExceptionthe object is in invalid state
com::sun::star::uno::Exceptionin case of other problems

◆ translateAccelerators()

void translateAccelerators ( [in] sequence< ::com::sun::star::awt::KeyEvent aKeys)
raises (::com::sun::star::embed::WrongStateException
)

provides accelerator table the container wants to use during inplace editing.

Returns
an accelerator table from container
Exceptions
com::sun::star::embed::WrongStateExceptionthe object is in unexpected state

The documentation for this interface was generated from the following file: