offapi/com/sun/star/graphic/XGraphic.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 module com { module sun { module star { module graphic
  21 {
  22
  23 /** This interface acts as a container for the loaded graphic.
  24
  25     <p>The interface itself can be retrieved by using the appropriate
  26     methods of XGraphicProvider interface.
  27     XGraphicProvider also offers a method to store
  28     the graphic content at a specific location</p>
  29
  30     <p>To render the graphic content onto a specific device, you
  31     have to create a XGraphicRenderer interface and pass
  32     this interface appropriately</p>
  33
  34     @see XGraphicProvider
  35     @see XGraphicRenderer
  36   */
  37 published interface XGraphic : ::com::sun::star::uno::XInterface
  38 {
  39     /** Get the type of the contained graphic
  40
  41         @returns
  42             The type of the contained graphic
  43
  44         @see GraphicType
  45     */
  46     byte getType();
  47 };
  48
  49 } ; } ; } ; } ;
  50
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */