xref: /AOO41X/main/offapi/com/sun/star/text/TextGraphicObject.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_TextGraphicObject_idl__
24#define __com_sun_star_text_TextGraphicObject_idl__
25
26#ifndef __com_sun_star_text_BaseFrame_idl__
27#include <com/sun/star/text/BaseFrame.idl>
28#endif
29
30#ifndef __com_sun_star_text_GraphicCrop_idl__
31#include <com/sun/star/text/GraphicCrop.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_PointSequenceSequence_idl__
35#include <com/sun/star/drawing/PointSequenceSequence.idl>
36#endif
37#ifndef __com_sun_star_drawing_ColorMode_idl__
38#include <com/sun/star/drawing/ColorMode.idl>
39#endif
40#ifndef __com_sun_star_container_XIndexContainer_idl__
41#include <com/sun/star/container/XIndexContainer.idl>
42#endif
43#ifndef __com_sun_star_graphic_XGraphic_idl__
44#include <com/sun/star/graphic/XGraphic.idl>
45#endif
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module text {
50
51//=============================================================================
52
53/** specifies a graphic which can be embedded in <type>Text</type>.
54 */
55published service TextGraphicObject
56{
57    /** contains the definition of interfaces and properties that are supported by text frames,
58     graphic objects and embeddedobjects.
59     */
60    service BaseFrame;
61    //-------------------------------------------------------------------------
62    /** returns the client-side image map if one is assigned to the object.
63     */
64    [property] com::sun::star::container::XIndexContainer ImageMap;
65
66    //-------------------------------------------------------------------------
67
68    /** determines if the content is protected against changes from the user interface.
69     */
70    [property] boolean ContentProtected;
71
72    //-------------------------------------------------------------------------
73
74    /** determines if the text wraps around the contour of the object.
75     */
76    [property] boolean SurroundContour;
77    //-------------------------------------------------------------------------
78
79    /** the text flows only around the contour of the object.
80     */
81    [property] boolean ContourOutside;
82    //-------------------------------------------------------------------------
83    /** contains the contour of the object as PolyPolygon.
84     */
85    [optional, property] com::sun::star::drawing::PointSequenceSequence ContourPolyPolygon;
86    //-------------------------------------------------------------------------
87    //-------------------------------------------------------------------------
88
89    /** contains the cropping of the object.@see GraphicCrop
90     */
91    [property] com::sun::star::text::GraphicCrop GraphicCrop;
92
93    //-------------------------------------------------------------------------
94    /** determines if the object is horizontally mirrored on even pages.
95     */
96    [property] boolean HoriMirroredOnEvenPages;
97    //-------------------------------------------------------------------------
98    /** determines if the object is horizontally mirrored on odd pages.
99     */
100    [property] boolean HoriMirroredOnOddPages;
101    //-------------------------------------------------------------------------
102    //-------------------------------------------------------------------------
103    /** determines if the object is mirrored vertically.
104     */
105    [property] boolean VertMirrored;
106
107    /** contains the URL of the background graphic of the object
108     */
109    [property] string GraphicURL;
110
111    //-------------------------------------------------------------------------
112
113    /** contains the name of the filter of the background graphic of the object.
114     */
115    [property] string GraphicFilter;
116
117    //-------------------------------------------------------------------------
118    /** contains the original size of the bitmap in the graphic object.
119     */
120    [property] com::sun::star::awt::Size ActualSize;
121    //-------------------------------------------------------------------------
122    /** changes the display of the luminance.
123        It contains percentage values between -100 and +100.
124     */
125    [property] short AdjustLuminance;
126    //-------------------------------------------------------------------------
127    /** changes the display of contrast.
128        It contains percentage values between -100 and +100.
129     */
130    [property] short AdjustContrast;
131    //-------------------------------------------------------------------------
132    /** changes the display of the red color channel.
133        It contains percentage values between -100 and +100.
134     */
135    [property] short AdjustRed;
136    //-------------------------------------------------------------------------
137    /** changes the display of the green color channel.
138        It contains percentage values between -100 and +100.
139     */
140    [property] short AdjustGreen;
141    //-------------------------------------------------------------------------
142    /** changes the display of the blue color channel.
143        It contains percentage values between -100 and +100.
144     */
145    [property] short AdjustBlue;
146    //-------------------------------------------------------------------------
147    /** determins the gamma value of the graphic.
148     */
149    [property] double Gamma;
150    //-------------------------------------------------------------------------
151    /** determins if the graphic is display in inverted colors.
152        It contains percentage values between -100 and +100.
153     */
154    [property] boolean GraphicIsInverted;
155    //-------------------------------------------------------------------------
156    /** .
157        It contains percentage values between -100 and +100.
158     */
159    [property] short Transparency;
160    //-------------------------------------------------------------------------
161    /** contains the ColorMode as <type scope="com::sun::star::drawing">ColorMode</type>.
162     */
163    [property] com::sun::star::drawing::ColorMode  GraphicColorMode;
164    //-------------------------------------------------------------------------
165    /** contains the graphic.
166     */
167    [optional, property] com::sun::star::graphic::XGraphic    Graphic;
168
169};
170
171//=============================================================================
172
173}; }; }; };
174
175#endif
176