xref: /trunk/main/offapi/com/sun/star/text/TextGraphicObject.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_TextGraphicObject_idl__
28#define __com_sun_star_text_TextGraphicObject_idl__
29
30#ifndef __com_sun_star_text_BaseFrame_idl__
31#include <com/sun/star/text/BaseFrame.idl>
32#endif
33
34#ifndef __com_sun_star_text_GraphicCrop_idl__
35#include <com/sun/star/text/GraphicCrop.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_PointSequenceSequence_idl__
39#include <com/sun/star/drawing/PointSequenceSequence.idl>
40#endif
41#ifndef __com_sun_star_drawing_ColorMode_idl__
42#include <com/sun/star/drawing/ColorMode.idl>
43#endif
44#ifndef __com_sun_star_container_XIndexContainer_idl__
45#include <com/sun/star/container/XIndexContainer.idl>
46#endif
47#ifndef __com_sun_star_graphic_XGraphic_idl__
48#include <com/sun/star/graphic/XGraphic.idl>
49#endif
50
51//=============================================================================
52
53 module com {  module sun {  module star {  module text {
54
55//=============================================================================
56
57/** specifies a graphic which can be embedded in <type>Text</type>.
58 */
59published service TextGraphicObject
60{
61    /** contains the definition of interfaces and properties that are supported by text frames,
62     graphic objects and embeddedobjects.
63     */
64    service BaseFrame;
65    //-------------------------------------------------------------------------
66    /** returns the client-side image map if one is assigned to the object.
67     */
68    [property] com::sun::star::container::XIndexContainer ImageMap;
69
70    //-------------------------------------------------------------------------
71
72    /** determines if the content is protected against changes from the user interface.
73     */
74    [property] boolean ContentProtected;
75
76    //-------------------------------------------------------------------------
77
78    /** determines if the text wraps around the contour of the object.
79     */
80    [property] boolean SurroundContour;
81    //-------------------------------------------------------------------------
82
83    /** the text flows only around the contour of the object.
84     */
85    [property] boolean ContourOutside;
86    //-------------------------------------------------------------------------
87    /** contains the contour of the object as PolyPolygon.
88     */
89    [optional, property] com::sun::star::drawing::PointSequenceSequence ContourPolyPolygon;
90    //-------------------------------------------------------------------------
91    //-------------------------------------------------------------------------
92
93    /** contains the cropping of the object.@see GraphicCrop
94     */
95    [property] com::sun::star::text::GraphicCrop GraphicCrop;
96
97    //-------------------------------------------------------------------------
98    /** determines if the object is horizontally mirrored on even pages.
99     */
100    [property] boolean HoriMirroredOnEvenPages;
101    //-------------------------------------------------------------------------
102    /** determines if the object is horizontally mirrored on odd pages.
103     */
104    [property] boolean HoriMirroredOnOddPages;
105    //-------------------------------------------------------------------------
106    //-------------------------------------------------------------------------
107    /** determines if the object is mirrored vertically.
108     */
109    [property] boolean VertMirrored;
110
111    /** contains the URL of the background graphic of the object
112     */
113    [property] string GraphicURL;
114
115    //-------------------------------------------------------------------------
116
117    /** contains the name of the filter of the background graphic of the object.
118     */
119    [property] string GraphicFilter;
120
121    //-------------------------------------------------------------------------
122    /** contains the original size of the bitmap in the graphic object.
123     */
124    [property] com::sun::star::awt::Size ActualSize;
125    //-------------------------------------------------------------------------
126    /** changes the display of the luminance.
127        It contains percentage values between -100 and +100.
128     */
129    [property] short AdjustLuminance;
130    //-------------------------------------------------------------------------
131    /** changes the display of contrast.
132        It contains percentage values between -100 and +100.
133     */
134    [property] short AdjustContrast;
135    //-------------------------------------------------------------------------
136    /** changes the display of the red color channel.
137        It contains percentage values between -100 and +100.
138     */
139    [property] short AdjustRed;
140    //-------------------------------------------------------------------------
141    /** changes the display of the green color channel.
142        It contains percentage values between -100 and +100.
143     */
144    [property] short AdjustGreen;
145    //-------------------------------------------------------------------------
146    /** changes the display of the blue color channel.
147        It contains percentage values between -100 and +100.
148     */
149    [property] short AdjustBlue;
150    //-------------------------------------------------------------------------
151    /** determins the gamma value of the graphic.
152     */
153    [property] double Gamma;
154    //-------------------------------------------------------------------------
155    /** determins if the graphic is display in inverted colors.
156        It contains percentage values between -100 and +100.
157     */
158    [property] boolean GraphicIsInverted;
159    //-------------------------------------------------------------------------
160    /** .
161        It contains percentage values between -100 and +100.
162     */
163    [property] short Transparency;
164    //-------------------------------------------------------------------------
165    /** contains the ColorMode as <type scope="com::sun::star::drawing">ColorMode</type>.
166     */
167    [property] com::sun::star::drawing::ColorMode  GraphicColorMode;
168    //-------------------------------------------------------------------------
169    /** contains the graphic.
170     */
171    [optional, property] com::sun::star::graphic::XGraphic    Graphic;
172
173};
174
175//=============================================================================
176
177}; }; }; };
178
179#endif
180