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 XVisualObject
Description
represents common visualisation functionality for embedded objects.
Methods' Summary
setVisualAreaSize sets the size of object's visual area.  
getVisualAreaSize gets the size of object's visual area.  
getPreferredVisualRepresentation retrieves visual representation of the object in preferable format.  
getMapUnit retrieves map mode the object communicates in.  
Methods' Details
setVisualAreaSize
void
setVisualAreaSize( [in] hyper  nAspect,
[in] ::com::sun::star::awt::Size  aSize )
raises( ::com::sun::star::lang::IllegalArgumentException,
WrongStateException,
::com::sun::star::uno::Exception );
Description
sets the size of object's visual area.

The size must be provided in logical units according to map mode the object communicates in.

If an object is inplace- or ui-active the method must not initiate repainting itself.

Parameter nAspect
the aspect specifying the form of object representation. Can take values from Aspects constant set.
Parameter aSize
the new size of the visual area
Throws
::com::sun::star::lang::IllegalArgumentException one of arguments is illegal
Throws
::com::sun::star::embed::WrongStateException the object is in wrong state
Throws
::com::sun::star::uno::Exception the object failed to resize
getVisualAreaSize
::com::sun::star::awt::Size
getVisualAreaSize( [in] hyper  nAspect )
raises( ::com::sun::star::lang::IllegalArgumentException,
WrongStateException,
::com::sun::star::uno::Exception );
Description
gets the size of object's visual area.

The size must be provided in logical units according to map mode the object communicates in.

Parameter nAspect
the aspect specifying the form of object representation. Can take values from Aspects constant set.
Returns
the size of visual area
Throws
::com::sun::star::lang::IllegalArgumentException one of arguments is illegal
Throws
::com::sun::star::embed::WrongStateException the object is in wrong state
getPreferredVisualRepresentation
VisualRepresentation
getPreferredVisualRepresentation( [in] hyper  nAspect )
raises( ::com::sun::star::lang::IllegalArgumentException,
WrongStateException,
::com::sun::star::uno::Exception );
Description
retrieves visual representation of the object in preferable format.

If the object persistance entry contains cached visual representation then it can be retrieved by using this method even in loaded state.

Parameter nAspect
the aspect the representation is requested for. Can take values from Aspects constant set.
Returns
the visual representation of the object in the default format and the format
Throws
::com::sun::star::lang::IllegalArgumentException one of arguments is illegal
Throws
::com::sun::star::embed::WrongStateException the object is in wrong state
Throws
::com::sun::star::uno::Exception in case of problems
getMapUnit
long
getMapUnit( [in] hyper  nAspect )
raises( ::com::sun::star::uno::Exception );
Description
retrieves map mode the object communicates in.
Parameter nAspect
the aspect the map mode is requested for. Can take values from Aspects constant set.
Returns
the map mode the object communicates in, it can take values from EmbedMapUnits constant
Throws
::com::sun::star::embed::WrongStateException the object is in wrong state
Throws
::com::sun::star::uno::Exception in case of problems
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.