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 :: graphic ::

interface XGraphicProvider
Description
This interface acts as the main interface to handle graphic content. It is used to load graphics, store graphics and to get information about unloaded graphics

Methods' Summary
queryGraphicDescriptor Calling this method returns a ::com::sun::star::beans::XPropertySet interface that gives access to the properties of the unloaded graphic  
queryGraphic Calling this method returns a XGraphic interface that holds the graphic content after loading the graphic  
storeGraphic Store the graphic content, represented through the XGraphic interface at the specified location  
Methods' Details
queryGraphicDescriptor
::com::sun::star::beans::XPropertySet
queryGraphicDescriptor( [in] ::com::sun::star::beans::PropertyValues  MediaProperties )
raises( ::com::sun::star::io::IOException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException );

Description
Calling this method returns a ::com::sun::star::beans::XPropertySet interface that gives access to the properties of the unloaded graphic

In most cases, this method will be used to query the mime type of the graphic and, in the case of pixel graphics, the resulting size after loading

Parameter MediaProperties
A sequence of property values to describe the location of the graphic, for which the attributes should be returned
Returns
A ::com::sun::star::beans::XPropertySet interface to get access to the different graphic properties
See also
MediaProperties, GraphicDescriptor, ::com::sun::star::beans::PropertyValues
queryGraphic
XGraphic
queryGraphic( [in] ::com::sun::star::beans::PropertyValues  MediaProperties )
raises( ::com::sun::star::io::IOException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException );

Description
Calling this method returns a XGraphic interface that holds the graphic content after loading the graphic
Parameter MediaProperties
A sequence of property values to describe the location of the graphic from which the graphic is to be loaded
Returns
The XGraphic interface
See also
MediaProperties, XGraphic, ::com::sun::star::beans::PropertyValues
storeGraphic
void
storeGraphic( [in] XGraphic  Graphic,
[in] ::com::sun::star::beans::PropertyValues  MediaProperties )
raises( ::com::sun::star::io::IOException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException );

Description
Store the graphic content, represented through the XGraphic interface at the specified location
Parameter Graphic
The graphic that should be stored
Parameter MediaProperties
A sequence of property values to describe the destination location of the graphic
See also
XGraphic, MediaProperties, ::com::sun::star::beans::PropertyValues
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.