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

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