1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*************************************************************************
*
* $RCSfile: OfficeDocument.idl,v $
*
* $Revision: 1.10 $
*
* last change: $Author: vg $ $Date: 2003-06-10 11:07:53 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_document_OfficeDocument_idl__
#define __com_sun_star_document_OfficeDocument_idl__
#ifndef __com_sun_star_frame_XModel_idl__
#include <com/sun/star/frame/XModel.idl>
#endif
#ifndef __com_sun_star_util_XModifiable_idl__
#include <com/sun/star/util/XModifiable.idl>
#endif
#ifndef __com_sun_star_frame_XStorable_idl__
#include <com/sun/star/frame/XStorable.idl>
#endif
#ifndef __com_sun_star_view_XPrintable_idl__
#include <com/sun/star/view/XPrintable.idl>
#endif
#ifndef __com_sun_star_view_XPrintJobBroadcaster_idl__
#include <com/sun/star/view/XPrintJobBroadcaster.idl>
#endif
#ifndef __com_sun_star_document_XEventBroadcaster_idl__
#include <com/sun/star/document/XEventBroadcaster.idl>
#endif
#ifndef __com_sun_star_document_XEventSupplier_idl__
#include <com/sun/star/document/XEventsSupplier.idl>
#endif
#ifndef __com_sun_star_document_XDocumentInfoSupplier_idl__
#include <com/sun/star/document/XDocumentInfoSupplier.idl>
#endif
#ifndef __com_sun_star_document_XViewDataSupplier_idl__
#include <com/sun/star/document/XViewDataSupplier.idl>
#endif
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
/** abstract service which specifies a storable and printable document
<p>
All major document-like components should support this service
instead of simple components which supports a <type scope="com::sun::star::frame">Controller</type>
or pure <type scope="com::sun::star::awt">XWindow</type> only.
</p>
@see com::sun::star::frame::Controller
*/
service OfficeDocument
{
//-------------------------------------------------------------------------
/** represents a component which is created from an URL and arguments
<p>
It is a representation of a resource in the sense that it was
created/loaded from the resource. The arguments are passed to the loader
to modify its behavior.
</p>
*/
interface com::sun::star::frame::XModel;
//-------------------------------------------------------------------------
/** a storable document should provide information about his modify state
<p>
With this interface it's possible too, to reset the modify state.
That can be neccessary to prevent code against problem during closing
of the document without saving any changes.
</p>
*/
interface com::sun::star::util::XModifiable;
//-------------------------------------------------------------------------
/** offers a simple way to store a component to an URL
<p>
This interface supports functionality
<ul>
<li>to make a copy of current component by saving it to another location</li>
<li>to commit made changes</li>
<li>to convert it by saving it by using suitable filter name.</li>
</ul>
</p>
*/
interface com::sun::star::frame::XStorable;
//-------------------------------------------------------------------------
/** offers a way to print a component
<p>
It's possible to specify wich printer should be used and of course
print the document on it.
</p>
*/
interface com::sun::star::view::XPrintable;
//-------------------------------------------------------------------------
/** makes it possible to register listeners which are called whenever
a document event occurs
*/
[optional] interface XEventBroadcaster;
//-------------------------------------------------------------------------
/** access to bound event handlers
*/
[optional] interface XEventsSupplier;
//-------------------------------------------------------------------------
/** document can provide a <type>DocumentInfo</type>
<p>
Instead of the <type>StandaloneDocumentInfo</type> service the <type>DocumentInfo</type>
will be available on an already opened document only.
</p>
*/
[optional] interface XDocumentInfoSupplier;
//-------------------------------------------------------------------------
/** access to some properties describing all open views to a document
*/
[optional] interface XViewDataSupplier;
//-------------------------------------------------------------------------
/** allows for getting information about a print job
@since #107627#
*/
[optional] interface com::sun::star::view::XPrintJobBroadcaster;
//-------------------------------------------------------------------------
/** controls the focus behaviour of the form controls in the document
<p>
If this flag is set to <TRUE/>, any view belonging to the document
should focus the first control in the document. With this, you may
control if your document works primarily as a form document.
</p>
*/
[property, optional] boolean AutomaticControlFocus;
//-------------------------------------------------------------------------
/** controls the initial (on-load) behavior of the form controls in the document
<p>
If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br>
If set to <FALSE/>, they will be alive (i.e., connected to the data source specified for the form
they belong to).<br>
With this, you may control if your document works primarily as a form document.
</p>
*/
[property, optional] boolean ApplyFormDesignMode;
};
//=============================================================================
}; }; }; };
#endif
|
