blob: 3bb22eca07b6d0065e48762b350d6e802ea086db (
plain)
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: XFrames.idl,v $
* $Revision: 1.9 $
*
* 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_frame_XFrames_idl__
#define __com_sun_star_frame_XFrames_idl__
#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif
#ifndef __com_sun_star_frame_XFrame_idl__
#include <com/sun/star/frame/XFrame.idl>
#endif
//=============================================================================
module com { module sun { module star { module frame {
//=============================================================================
/** manages and creates frames.
<p>
Frames may contain other frames (by implementing an <type>XFrames</type>
interface) and may be contained in other frames.
</p>
@see XFrame
@see Frame
*/
published interface XFrames: com::sun::star::container::XIndexAccess
{
//-------------------------------------------------------------------------
/** appends the specified <type>Frame</type> to the list of sub-frames.
@param xFrame
new frame for inserting into this container
*/
void append( [in] XFrame xFrame );
//-------------------------------------------------------------------------
/** provides access to the list of all currently existing
frames inside this container and her sub frames
@param nSearchFlags
use combinations of <type>FrameSearchFlag</type> to specify which
frames should be found
@return
all frames of this container and all available frames of the whole frame tree
which match search parameter <var>SearchFlags</var>
*/
sequence< XFrame > queryFrames( [in] long nSearchFlags );
//-------------------------------------------------------------------------
/** removes the frame from its container.
<p>
Note:
<ul>
<li>The method <method>XComponent::dispose()</method> is not called implicitly
by this method.</li>
<li>The creator attribute of the frame must be reset by the caller of
this method.</li>
</ul>
</p>
@param xFrame
frame which should be removed from this container
*/
void remove( [in] XFrame xFrame );
};
//=============================================================================
}; }; }; };
#endif
|
