offapi/com/sun/star/text/TextGraphicObject.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 #ifndef __com_sun_star_text_TextGraphicObject_idl__
  20 #define __com_sun_star_text_TextGraphicObject_idl__
  21
  22 #include <com/sun/star/text/BaseFrame.idl>
  23 #include <com/sun/star/text/GraphicCrop.idl>
  24 #include <com/sun/star/drawing/PointSequenceSequence.idl>
  25 #include <com/sun/star/drawing/ColorMode.idl>
  26 #include <com/sun/star/container/XIndexContainer.idl>
  27 #include <com/sun/star/graphic/XGraphic.idl>
  28
  29
  30  module com {  module sun {  module star {  module text {
  31
  32
  33 /** specifies a graphic which can be embedded in Text.
  34  */
  35 published service TextGraphicObject
  36 {
  37     /** contains the definition of interfaces and properties that are supported by text frames,
  38      graphic objects and embedded objects.
  39      */
  40     service BaseFrame;
  41     /** returns the client-side image map if one is assigned to the object.
  42      */
  43     [property] com::sun::star::container::XIndexContainer ImageMap;
  44
  45
  46     /** determines if the content is protected against changes from the user interface.
  47      */
  48     [property] boolean ContentProtected;
  49
  50
  51     /** determines if the text wraps around the contour of the object.
  52      */
  53     [property] boolean SurroundContour;
  54
  55     /** the text flows only around the contour of the object.
  56      */
  57     [property] boolean ContourOutside;
  58     /** contains the contour of the object as PolyPolygon.
  59      */
  60     [optional, property] com::sun::star::drawing::PointSequenceSequence ContourPolyPolygon;
  61
  62     /** contains the cropping of the object.@see GraphicCrop
  63      */
  64     [property] com::sun::star::text::GraphicCrop GraphicCrop;
  65
  66     /** determines if the object is horizontally mirrored on even pages.
  67      */
  68     [property] boolean HoriMirroredOnEvenPages;
  69     /** determines if the object is horizontally mirrored on odd pages.
  70      */
  71     [property] boolean HoriMirroredOnOddPages;
  72     /** determines if the object is mirrored vertically.
  73      */
  74     [property] boolean VertMirrored;
  75
  76     /** contains the URL of the background graphic of the object
  77      */
  78     [property] string GraphicURL;
  79
  80
  81     /** contains the name of the filter of the background graphic of the object.
  82      */
  83     [property] string GraphicFilter;
  84
  85     /** contains the original size of the bitmap in the graphic object.
  86      */
  87     [property] com::sun::star::awt::Size ActualSize;
  88     /** changes the display of the luminance.
  89          It contains percentage values between -100 and +100.
  90      */
  91     [property] short AdjustLuminance;
  92     /** changes the display of contrast.
  93          It contains percentage values between -100 and +100.
  94      */
  95     [property] short AdjustContrast;
  96     /** changes the display of the red color channel.
  97          It contains percentage values between -100 and +100.
  98      */
  99     [property] short AdjustRed;
 100     /** changes the display of the green color channel.
 101          It contains percentage values between -100 and +100.
 102      */
 103     [property] short AdjustGreen;
 104     /** changes the display of the blue color channel.
 105          It contains percentage values between -100 and +100.
 106      */
 107     [property] short AdjustBlue;
 108     /** determines the gamma value of the graphic.
 109      */
 110     [property] double Gamma;
 111     /** determines if the graphic is display in inverted colors.
 112          It contains percentage values between -100 and +100.
 113      */
 114     [property] boolean GraphicIsInverted;
 115
 116     /** contains percentage values between -100 and +100.
 117      */
 118     [property] short Transparency;
 119     /** contains the ColorMode as com::sun::star::drawing::ColorMode.
 120      */
 121     [property] com::sun::star::drawing::ColorMode  GraphicColorMode;
 122     /** contains the graphic.
 123      */
 124     [optional, property] com::sun::star::graphic::XGraphic    Graphic;
 125
 126 };
 127
 128
 129 }; }; }; };
 130
 131 #endif
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */