offapi/com/sun/star/graphic/XGraphicObject.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XGraphicObject.idl,v $
  10  * $Revision: 1.1.2.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef com_sun_star_graphic_XGraphicObject_idl
  32 #define com_sun_star_graphic_XGraphicObject_idl
  33
  34 #include <com/sun/star/uno/XInterface.idl>
  35
  36 module com { module sun { module star { module graphic
  37 {
  38 interface XGraphic;
  39 /** <code>XGraphicObject</code> objects represent in-memory image and graphic
  40     objects.
  41
  42     <p>Such objects are accessable using GraphicObject scheme urls like
  43     <ul>
  44         <li>vnd.sun.star.GraphicObject:10000000000001940000012FB99807BD</li>
  45     </ul>
  46     The numeric portion of the url is formed from <member>UniqueID</member>.
  47     As long as at least one instance of <code>XGraphicObject</code> with a particular UniqueID exists,
  48     the associated image/graphic is available.</p>
  49
  50     @see XGraphicObject
  51     @see GraphicProvider
  52     @see MediaProperties
  53 */
  54
  55 interface XGraphicObject : ::com::sun::star::uno::XInterface
  56 {
  57     /** is the associated image/graphic for this object.
  58     */
  59     [attribute ] XGraphic Graphic;
  60
  61     /** is the id that can be used to form the <code>vnd.sun.star.GraphicObject</code> url to address this object.
  62     */
  63     [attribute, readonly ] string UniqueID;
  64 };
  65
  66 } ; } ; } ; } ;
  67
  68 #endif