offapi/com/sun/star/graphic/GraphicObject.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_GraphicObject_idl
  21 #define com_sun_star_graphic_GraphicObject_idl
  22
  23 #include <com/sun/star/graphic/XGraphicObject.idl>
  24
  25 module com { module sun { module star { module graphic
  26 {
  27 /** The <code>GraphicObject</code> service can be used to create XGraphicObject instances.
  28
  29     <p>XGraphicObject objects are accessible using GraphicObject scheme URLs like
  30     <code>vnd.sun.star.GraphicObject:10000000000001940000012FB99807BD</code>.
  31     As long as at least one instance of XGraphicObject with a particular UniqueID exists,
  32     the associated image/graphic is available.</p>
  33
  34     @see GraphicObject
  35     @see GraphicProvider
  36     @see MediaProperties
  37 */
  38
  39 service GraphicObject : XGraphicObject
  40 {
  41     /** Creates an GraphicObject
  42     */
  43     create();
  44
  45     /** Creates an GraphicObject with <code>uniqueId</code>
  46         @param uniqueId
  47             If another XGraphicObject with <code>uniqueId</code> exists, this GraphicObject
  48             is populated with the other GraphicObject's data.
  49     */
  50     createWithId( [in] string uniqueId );
  51 };
  52
  53 } ; } ; } ; } ;
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */