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_drawing_GenericDrawingDocument_idl__
28#define __com_sun_star_drawing_GenericDrawingDocument_idl__
29
30#ifndef __com_sun_star_drawing_XDrawPageDuplicator_idl__
31#include <com/sun/star/drawing/XDrawPageDuplicator.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_XDrawPagesSupplier_idl__
35#include <com/sun/star/drawing/XDrawPagesSupplier.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_XMasterPagesSupplier_idl__
39#include <com/sun/star/drawing/XMasterPagesSupplier.idl>
40#endif
41
42#ifndef __com_sun_star_drawing_XLayerSupplier_idl__
43#include <com/sun/star/drawing/XLayerSupplier.idl>
44#endif
45
46#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
47#include <com/sun/star/lang/XMultiServiceFactory.idl>
48#endif
49
50#ifndef __com_sun_star_beans_XPropertySet_idl__
51#include <com/sun/star/beans/XPropertySet.idl>
52#endif
53
54#ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__
55#include <com/sun/star/style/XStyleFamiliesSupplier.idl>
56#endif
57
58#ifndef __com_sun_star_lang_Locale_idl__
59#include <com/sun/star/lang/Locale.idl>
60#endif
61
62#ifndef __com_sun_star_awt_Rectangle_idl__
63#include <com/sun/star/awt/Rectangle.idl>
64#endif
65
66#ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
67#include <com/sun/star/i18n/XForbiddenCharacters.idl>
68#endif
69
70#ifndef __com_sun_star_document_OfficeDocument_idl__
71#include <com/sun/star/document/OfficeDocument.idl>
72#endif
73
74//=============================================================================
75
76 module com {  module sun {  module star {  module drawing {
77
78//=============================================================================
79
80/** specifies a document which consists of multiple pages
81    with drawings.
82
83    <p>Because its function is needed more then once, its defined as generic one.</p>
84 */
85published service GenericDrawingDocument
86{
87    /** this base service describes storing and printing */
88    service com::sun::star::document::OfficeDocument;
89
90    /** this factory lets you create various services that are
91        used inside a drawing document
92
93        <p>The following services are <type>Shape</type>s.
94        They are created by the documents factory and must
95        be inserted into a <type>DrawPage</type> or <type>MasterPage</type>
96        of this document.
97
98        <ul>
99            <li><type>RectangleShape</type></li>
100            <li><type>EllipseShape</type></li>
101            <li><type>ControlShape</type></li>
102            <li><type>ConnectorShape</type></li>
103            <li><type>MeasureShape</type></li>
104            <li><type>LineShape</type></li>
105            <li><type>PolyPolygonShape</type></li>
106            <li><type>PolyLineShape</type></li>
107            <li><type>OpenBezierShape</type></li>
108            <li><type>ClosedBezierShape</type></li>
109            <li><type>GraphicObjectShape</type></li>
110            <li><type>GroupShape</type></li>
111            <li><type>TextShape</type></li>
112            <li><type>OLE2Shape</type></li>
113            <li><type>PageShape</type></li>
114            <li><type>CaptionShape</type></li>
115            <li><type>PluginShape</type></li>
116            <li><type>AppletShape</type></li>
117        </ul>
118
119        <p>The following services are all <type scope="com::sun::star::text">TextField</type>
120        and can be inserted into text as <type scope="com::sun::star::text">TextContent</type>.
121
122        <ul>
123            <li><member scope="com::sun::star::text">TextField::DateTime</member></li>
124            <li><member scope="com::sun::star::text">TextField::URL</member></li>
125            <li><member scope="com::sun::star::text">TextField::PageNumber</member></li>
126            <li><member scope="com::sun::star::text">TextField::PageCount</member></li>
127            <li><member scope="com::sun::star::text">TextField::SheetName</member></li>
128            <li><member scope="com::sun::star::text">TextField::FileName</member></li>
129            <li><member scope="com::sun::star::text">TextField::DocInfo.Title</member></li>
130            <li><member scope="com::sun::star::text">TextField::Author</member></li>
131            <li><member scope="com::sun::star::text">TextField::Measure</member></li>
132        </ul>
133
134        <p>The following services gives access to resources used inside the document
135        and let you add new resources.
136
137        <ul>
138            <li><type scope="com::sun::star::drawing">DashTable</type></li>
139            <li><type scope="com::sun::star::drawing">GradientTable</type></li>
140            <li><type scope="com::sun::star::drawing">HatchTable</type></li>
141            <li><type scope="com::sun::star::drawing">BitmapTable</type></li>
142            <li><type scope="com::sun::star::drawing">TransparencyGradientTable</type></li>
143            <li><type scope="com::sun::star::drawing">MarkerTable</type></li>
144        </ul>
145
146        <p>The following service can be set at the <code>Numbering</code> property
147        inside a <type scope="com::sun::star::style">ParagraphProperties</type>
148
149        <ul>
150            <li><type scope="com::sun::star::text">NumberingRules</type></li>
151        </ul>
152
153        <p>The following services can be used for a <type scope="com::sun::star::image">ImageMap</type>
154        inside the document.
155
156        <br>A <type scope="com::sun::star::image">ImageMap</type> can be obtained from a
157        <type>GraphicObjectShape</type>
158
159        <ul>
160            <li><type scope="com::sun::star::image">ImageMapRectangleObject</type></li>
161            <li><type scope="com::sun::star::image">ImageMapCircleObject</type></li>
162            <li><type scope="com::sun::star::image">ImageMapPolygonObject</type></li>
163        </ul>
164
165        <p>The following services lets you access the drawing property defaults
166        of a document.
167
168        <ul>
169            <li><type scope="com::sun::star::drawing">Defaults</type></li>
170        </ul>
171    */
172    interface com::sun::star::lang::XMultiServiceFactory;
173
174    /** lets you access the properties of this service.
175     */
176    interface com::sun::star::beans::XPropertySet;
177
178    /** lets you duplicate pages inside this document.
179     */
180    interface com::sun::star::drawing::XDrawPageDuplicator;
181
182
183    /** provides an object that is implementing the service
184                <type>DrawPage</type>s. With this service you have access to the
185                <type>DrawPage</type>s inside a document.
186     */
187    interface com::sun::star::drawing::XDrawPagesSupplier;
188
189
190    /** returns an object that is implementing the service
191                <type>MasterPages</type>. With this service you have access to the
192                <type>MasterPage</type>s inside a document.
193     */
194    interface com::sun::star::drawing::XMasterPagesSupplier;
195
196
197    /** returns an object that is implementing the service
198                <type>LayerManager</type>. This service lets you manipulate the
199                <type>Layer</type>s of this document.
200     */
201    interface com::sun::star::drawing::XLayerSupplier;
202
203    /** This interface lets you access the styles contained in this document
204     */
205    interface com::sun::star::style::XStyleFamiliesSupplier;
206
207    //-------------------------------------------------------------------------
208
209    /** This property specifies the length between the default tab stops
210        inside text in this document in 1/100th mm.
211     */
212    [property] long TabStop;
213
214    //-------------------------------------------------------------------------
215
216    /** contains the identifier of the default locale of the document.
217     */
218    [property] com::sun::star::lang::Locale CharLocale;
219
220    //-------------------------------------------------------------------------
221
222    /** if this document is an ole client, this is the current visible area
223        in 100th mm
224    */
225    [property] com::sun::star::awt::Rectangle VisibleArea;
226
227    //-------------------------------------------------------------------------
228
229    /** This property gives the XForbiddenCharacters.
230     */
231    [readonly, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
232
233};
234
235//=============================================================================
236
237}; }; }; };
238
239#endif
240
241