offapi/com/sun/star/text/TextGraphicObject.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: TextGraphicObject.idl,v $
  10  * $Revision: 1.12.122.1 $
  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 #ifndef __com_sun_star_text_TextGraphicObject_idl__
  31 #define __com_sun_star_text_TextGraphicObject_idl__
  32
  33 #ifndef __com_sun_star_text_BaseFrame_idl__
  34 #include <com/sun/star/text/BaseFrame.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_GraphicCrop_idl__
  38 #include <com/sun/star/text/GraphicCrop.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_PointSequenceSequence_idl__
  42 #include <com/sun/star/drawing/PointSequenceSequence.idl>
  43 #endif
  44 #ifndef __com_sun_star_drawing_ColorMode_idl__
  45 #include <com/sun/star/drawing/ColorMode.idl>
  46 #endif
  47 #ifndef __com_sun_star_container_XIndexContainer_idl__
  48 #include <com/sun/star/container/XIndexContainer.idl>
  49 #endif
  50 #ifndef __com_sun_star_graphic_XGraphic_idl__
  51 #include <com/sun/star/graphic/XGraphic.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module text {
  57
  58 //=============================================================================
  59
  60 /** specifies a graphic which can be embedded in <type>Text</type>.
  61  */
  62 published service TextGraphicObject
  63 {
  64     /** contains the definition of interfaces and properties that are supported by text frames,
  65      graphic objects and embeddedobjects.
  66      */
  67     service BaseFrame;
  68     //-------------------------------------------------------------------------
  69     /** returns the client-side image map if one is assigned to the object.
  70      */
  71     [property] com::sun::star::container::XIndexContainer ImageMap;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** determines if the content is protected against changes from the user interface.
  76      */
  77     [property] boolean ContentProtected;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** determines if the text wraps around the contour of the object.
  82      */
  83     [property] boolean SurroundContour;
  84     //-------------------------------------------------------------------------
  85
  86     /** the text flows only around the contour of the object.
  87      */
  88     [property] boolean ContourOutside;
  89     //-------------------------------------------------------------------------
  90     /** contains the contour of the object as PolyPolygon.
  91      */
  92     [optional, property] com::sun::star::drawing::PointSequenceSequence ContourPolyPolygon;
  93     //-------------------------------------------------------------------------
  94     //-------------------------------------------------------------------------
  95
  96     /** contains the cropping of the object.@see GraphicCrop
  97      */
  98     [property] com::sun::star::text::GraphicCrop GraphicCrop;
  99
 100     //-------------------------------------------------------------------------
 101     /** determines if the object is horizontally mirrored on even pages.
 102      */
 103     [property] boolean HoriMirroredOnEvenPages;
 104      //-------------------------------------------------------------------------
 105     /** determines if the object is horizontally mirrored on odd pages.
 106      */
 107     [property] boolean HoriMirroredOnOddPages;
 108     //-------------------------------------------------------------------------
 109     //-------------------------------------------------------------------------
 110     /** determines if the object is mirrored vertically.
 111      */
 112     [property] boolean VertMirrored;
 113
 114     /** contains the URL of the background graphic of the object
 115      */
 116     [property] string GraphicURL;
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** contains the name of the filter of the background graphic of the object.
 121      */
 122     [property] string GraphicFilter;
 123
 124     //-------------------------------------------------------------------------
 125     /** contains the original size of the bitmap in the graphic object.
 126      */
 127     [property] com::sun::star::awt::Size ActualSize;
 128     //-------------------------------------------------------------------------
 129     /** changes the display of the luminance.
 130          It contains percentage values between -100 and +100.
 131      */
 132     [property] short AdjustLuminance;
 133     //-------------------------------------------------------------------------
 134     /** changes the display of contrast.
 135          It contains percentage values between -100 and +100.
 136      */
 137     [property] short AdjustContrast;
 138     //-------------------------------------------------------------------------
 139     /** changes the display of the red color channel.
 140          It contains percentage values between -100 and +100.
 141      */
 142     [property] short AdjustRed;
 143     //-------------------------------------------------------------------------
 144     /** changes the display of the green color channel.
 145          It contains percentage values between -100 and +100.
 146      */
 147     [property] short AdjustGreen;
 148     //-------------------------------------------------------------------------
 149     /** changes the display of the blue color channel.
 150          It contains percentage values between -100 and +100.
 151      */
 152     [property] short AdjustBlue;
 153     //-------------------------------------------------------------------------
 154     /** determins the gamma value of the graphic.
 155      */
 156     [property] double Gamma;
 157     //-------------------------------------------------------------------------
 158     /** determins if the graphic is display in inverted colors.
 159          It contains percentage values between -100 and +100.
 160      */
 161     [property] boolean GraphicIsInverted;
 162     //-------------------------------------------------------------------------
 163     /** .
 164          It contains percentage values between -100 and +100.
 165      */
 166     [property] short Transparency;
 167     //-------------------------------------------------------------------------
 168     /** contains the ColorMode as <type scope="com::sun::star::drawing">ColorMode</type>.
 169      */
 170     [property] com::sun::star::drawing::ColorMode  GraphicColorMode;
 171     //-------------------------------------------------------------------------
 172     /** contains the graphic.
 173      */
 174     [optional, property] com::sun::star::graphic::XGraphic    Graphic;
 175
 176 };
 177
 178 //=============================================================================
 179
 180 }; }; }; };
 181
 182 #endif