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