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
|
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XSubDocument.idl,v $
*
* $Revision: 1.2 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
************************************************************************/
#ifndef __com_sun_star_sdb_XSubDocument_idl__
#define __com_sun_star_sdb_XSubDocument_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#include <com/sun/star/lang/XComponent.idl>
//=============================================================================
module com { module sun { module star { module sdb {
//=============================================================================
/** allows operating on a sub document of an <type>OfficeDatabaseDocument</type>
@since OOo 3.1
*/
interface XSubDocument
{
/** opens the sub document
<p>Note that opening the document means it is displayed in an own top-level frame
on the desktop.</p>
@return
the sub document, usually an <type scope="com::sun::star::frame">XModel</type>,
or an <type scope="com::sun::star::frame">XController</type> if the sub document
does not have an own model.
@raises ::com::sun::star::lang::WrappedTargetException
if an error occurs during opening the document
*/
::com::sun::star::lang::XComponent
open()
raises( ::com::sun::star::lang::WrappedTargetException );
/** opens the sub document in design mode
@return
the sub document, usually an <type scope="com::sun::star::frame">XModel</type>,
or an <type scope="com::sun::star::frame">XController</type> if the sub document
does not have an own model.
@raises ::com::sun::star::lang::WrappedTargetException
if an error occurs during opening the document
*/
::com::sun::star::lang::XComponent
openDesign()
raises( ::com::sun::star::lang::WrappedTargetException );
/** stores the sub document, if it had previously been opened in either mode
@raises ::com::sun::star::lang::WrappedTargetException
if an error occurs during storing the document
*/
void store()
raises( ::com::sun::star::lang::WrappedTargetException );
/** closes the sub document, if it had previously been opened in either mode
@return <TRUE/> if and only if the document could be closed, <FALSE/> otherwise,
e.g. if the closing has been vetoed by the user.
@raises ::com::sun::star::lang::WrappedTargetException
if an error occurs during closing the document
*/
boolean close()
raises( ::com::sun::star::lang::WrappedTargetException );
};
//=============================================================================
}; }; }; };
//=============================================================================
#endif
|
