INTEGRATION: CWS graphicapi (1.1.2); FILE ADDED

2004/05/26 13:26:16 ka 1.1.2.2: added documentation
2004/05/19 14:49:59 ka 1.1.2.1: initial revision

1 files changed, 153 insertions, 0 deletions

diff --git a/offapi/com/sun/star/graphic/XGraphicProvider.idl b/offapi/com/sun/star/graphic/XGraphicProvider.idl
new file mode 100755
index 000000000000..a630c072f0cc
--- /dev/null
+++ b/offapi/com/sun/star/graphic/XGraphicProvider.idl
@@ -0,0 +1,153 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XGraphicProvider.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2004-06-11 09:36:20 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef com_sun_star_graphic_XGraphicProvider_idl
+#define com_sun_star_graphic_XGraphicProvider_idl
+
+#include <com/sun/star/io/XInputStream.idl>
+#include <com/sun/star/io/XOutputStream.idl>
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/lang/WrappedTargetException.idl>
+#include <com/sun/star/beans/PropertyValues.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
+
+module com { module sun { module star { module graphic
+{
+
+/** 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
+  */
+interface XGraphicProvider : ::com::sun::star::uno::XInterface
+{
+    /** Calling this method returns a
+        <type scope="com::sun::star::beans">XPropertySet</type>
+        interface that gives access to the properties of the
+        unloaded graphic
+
+        <p>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</p>
+
+        @param MediaProperties
+            A sequence of property values to describe the location
+            of the graphic, for which the attributes should be returned
+
+        @returns
+            A <type scope="com::sun::star::beans">XPropertySet</type> interface
+            to get access to the different graphic properties
+
+        @see MediaProperties
+        @see GraphicDescriptor
+        @see com::sun::star::beans::PropertyValues
+    */
+    ::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 );
+
+
+
+    /** Calling this method returns a <type>XGraphic</type> interface
+        that holds the graphic content after loading the graphic
+
+        @param MediaProperties
+            A sequence of property values to describe the location
+            of the graphic from which the graphic is to be loaded
+
+        @returns
+            The <type>XGraphic</type> interface
+
+        @see MediaProperties
+        @see XGraphic
+        @see com::sun::star::beans::PropertyValues
+    */
+    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 );
+
+    /** Store the graphic content, represented through the <type>XGraphic</type>
+        interface at the specified location
+
+        @param Graphic
+            The graphic that should be stored
+
+        @param MediaProperties
+            A sequence of property values to describe the destination
+            location of the graphic
+
+        @see XGraphic
+        @see MediaProperties
+        @see com::sun::star::beans::PropertyValues
+    */
+    void        storeGraphic( [in] ::com::sun::star::graphic::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 );
+};
+
+} ; } ; } ; } ;
+
+#endif