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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef com_sun_star_graphic_XGraphicObject_idl
  21 #define com_sun_star_graphic_XGraphicObject_idl
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com { module sun { module star { module graphic
  26 {
  27 interface XGraphic;
  28 /** <code>XGraphicObject</code> objects represent in-memory image and graphic
  29     objects.
  30
  31     <p>Such objects are accessible using GraphicObject scheme URLs like
  32     <ul>
  33         <li>vnd.sun.star.GraphicObject:10000000000001940000012FB99807BD</li>
  34     </ul>
  35     The numeric portion of the url is formed from #UniqueID.
  36     As long as at least one instance of <code>XGraphicObject</code> with a particular UniqueID exists,
  37     the associated image/graphic is available.</p>
  38
  39     @see XGraphicObject
  40     @see GraphicProvider
  41     @see MediaProperties
  42 */
  43
  44 interface XGraphicObject : ::com::sun::star::uno::XInterface
  45 {
  46     /** is the associated image/graphic for this object.
  47     */
  48     [attribute ] XGraphic Graphic;
  49
  50     /** is the id that can be used to form the <code>vnd.sun.star.GraphicObject</code> url to address this object.
  51     */
  52     [attribute, readonly ] string UniqueID;
  53 };
  54
  55 } ; } ; } ; } ;
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */