Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished interface XInplaceClient
Usage Restrictions
not published
Description
represents common functionality for inplace clients.

Methods' Summary
canInplaceActivate checks if the container can activate the object inplace.  
activatingInplace notifies container through the client that the object is to be inplace activated.  
activatingUI notifies container through the client that the object is to be UI-activated.  
deactivatedInplace notifies container through the client that the object is deactivated.  
deactivatedUI notifies container through the client that the object is UI-deactivated.  
getLayoutManager allows to retrieve the ::com::sun::star::frame::LayoutManager of the container.  
getInplaceDispatchProvider allows to retrieve the container's dispatch provider.  
getPlacement gets the inplace object position rectangle.  
getClipRectangle gets the inplace object clip rectangle.  
translateAccelerators provides accelerator table the object whants to use while it is inplace active.  
scrollObject scrolls the object.  
changedPlacement notifies the container that the position of the object is changed.  
Methods' Details
canInplaceActivate
boolean
canInplaceActivate();

Description
checks if the container can activate the object inplace.
Returns
true the container can activate the object inplace. false otherwise.
activatingInplace
void
activatingInplace()
raises( WrongStateException );

Description
notifies container through the client that the object is to be inplace activated.
Throws
com::sun::star::embed::WrongStateException the container is not ready for activation
activatingUI
void
activatingUI()
raises( WrongStateException );

Description
notifies container through the client that the object is to be UI-activated.
Throws
com::sun::star::embed::WrongStateException the container is not ready for activation
deactivatedInplace
void
deactivatedInplace()
raises( WrongStateException );

Description
notifies container through the client that the object is deactivated.
Throws
com::sun::star::embed::WrongStateException the container is not ready for deactivation
deactivatedUI
void
deactivatedUI()
raises( WrongStateException );

Description
notifies container through the client that the object is UI-deactivated.

After this notification the container can restore it's own UI and take focus.

Throws
com::sun::star::embed::WrongStateException the container is not ready for deactivation
getLayoutManager
::com::sun::star::frame::XLayoutManager
getLayoutManager()
raises( WrongStateException );

Description
allows to retrieve the ::com::sun::star::frame::LayoutManager of the container.
Returns
reference to object representing the ::com::sun::star::frame::LayoutManager of the container
Throws
com::sun::star::embed::WrongStateException the object is in unexpected state to make such request
getInplaceDispatchProvider
::com::sun::star::frame::XDispatchProvider
getInplaceDispatchProvider()
raises( WrongStateException );

Description
allows to retrieve the container's dispatch provider.
Returns
reference to object implementing the ::com::sun::star::frame::XDispatchProvider
Throws
com::sun::star::embed::WrongStateException the object is in unexpected state to make such request
getPlacement
::com::sun::star::awt::Rectangle
getPlacement()
raises( WrongStateException );

Description
gets the inplace object position rectangle.

The rectangle is provided in object's parent window coordinates in pixels. The intersection of position and clip rectangles specifies the visible part of the object. In case the position window has a size that is bigger than object's size, the object should either scale or deactivate.

Returns
specifies a new position rectangle
Throws
com::sun::star::embed::WrongStateException the object is in unexpected state to make such request
getClipRectangle
::com::sun::star::awt::Rectangle
getClipRectangle()
raises( WrongStateException );

Description
gets the inplace object clip rectangle.

The rectangle is provided in object's parent window coordinates in pixels. The intersection of position and clip rectangles specifies the visible part of the object.

Returns
specifies a new clip rectangle
Throws
com::sun::star::embed::WrongStateException the object is in unexpected state to make such request
translateAccelerators
void
translateAccelerators( [in] sequence< ::com::sun::star::awt::KeyEvent >  aKeys )
raises( WrongStateException );

Description
provides accelerator table the object whants to use while it is inplace active.
Parameter aKeys
an accelerator table from object
Throws
com::sun::star::embed::WrongStateException the object is in unexpected state
scrollObject
void
scrollObject( [in] ::com::sun::star::awt::Size  aOffset )
raises( WrongStateException );

Description
scrolls the object.
Parameter aOffset
scrolls the object to specified offset in pixels
Throws
com::sun::star::embed::WrongStateException the object is in unexpected state
changedPlacement
void
changedPlacement( [in] ::com::sun::star::awt::Rectangle  aPosRect )
raises( WrongStateException,
::com::sun::star::uno::Exception );

Description
notifies the container that the position of the object is changed.
Parameter aPosRect
specifies a new position rectangle
Throws
com::sun::star::embed::WrongStateException the object state is not correct
Throws
com::sun::star::uno::Exception in case of other problems
Top of Page

Apache Software Foundation

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

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