offapi/com/sun/star/graphic/XGraphic.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: XGraphic.idl,v $
  10  * $Revision: 1.5 $
  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_XGraphic_idl
  32 #define com_sun_star_graphic_XGraphic_idl
  33
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #include <com/sun/star/graphic/GraphicType.idl>
  36
  37 module com { module sun { module star { module graphic
  38 {
  39
  40 /** This interface acts as a container for the loaded graphic.
  41
  42     <p>The interface itself can be retrieved by using the appropriate
  43     methods of <type>XGraphicProvider</type> interface.
  44     <type>XGraphicProvider</type> also offers a method to store
  45     the graphic content at a specific location</p>
  46
  47     <p>To render the graphic content onto a specific device, you
  48     have to create a <type>XGraphicRenderer</type> interface and pass
  49     this interface appropriately</p>
  50
  51     @see XGraphicProvider
  52     @see XGraphicRenderer
  53   */
  54 published interface XGraphic : ::com::sun::star::uno::XInterface
  55 {
  56     /** Get the type of the contained graphic
  57
  58         @returns
  59             The type of the contained graphic
  60
  61         @see GraphicType
  62     */
  63     byte getType();
  64 };
  65
  66 } ; } ; } ; } ;
  67
  68 #endif