xref: /aoo42x/main/offapi/com/sun/star/frame/XFrames.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_frame_XFrames_idl__
24cdf0e10cSrcweir#define __com_sun_star_frame_XFrames_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__
27cdf0e10cSrcweir#include <com/sun/star/container/XIndexAccess.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_frame_XFrame_idl__
31cdf0e10cSrcweir#include <com/sun/star/frame/XFrame.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweir module com {  module sun {  module star {  module frame {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir/** manages and creates frames.
41cdf0e10cSrcweir
42cdf0e10cSrcweir    <p>
43cdf0e10cSrcweir    Frames may contain other frames (by implementing an <type>XFrames</type>
44cdf0e10cSrcweir	interface) and may be contained in other frames.
45cdf0e10cSrcweir    </p>
46cdf0e10cSrcweir
47cdf0e10cSrcweir    @see XFrame
48cdf0e10cSrcweir    @see Frame
49cdf0e10cSrcweir */
50cdf0e10cSrcweirpublished interface XFrames: com::sun::star::container::XIndexAccess
51cdf0e10cSrcweir{
52cdf0e10cSrcweir	//-------------------------------------------------------------------------
53cdf0e10cSrcweir    /** appends the specified <type>Frame</type> to the list of sub-frames.
54cdf0e10cSrcweir
55cdf0e10cSrcweir        @param xFrame
56cdf0e10cSrcweir            new frame for inserting into this container
57cdf0e10cSrcweir	 */
58cdf0e10cSrcweir    void append( [in] XFrame xFrame );
59cdf0e10cSrcweir
60cdf0e10cSrcweir	//-------------------------------------------------------------------------
61cdf0e10cSrcweir    /** provides access to the list of all currently existing
62cdf0e10cSrcweir        frames inside this container and her sub frames
63cdf0e10cSrcweir
64cdf0e10cSrcweir        @param nSearchFlags
65cdf0e10cSrcweir            use combinations of <type>FrameSearchFlag</type> to specify which
66cdf0e10cSrcweir            frames should be found
67cdf0e10cSrcweir
68cdf0e10cSrcweir        @return
69cdf0e10cSrcweir            all frames of this container and all available frames of the whole frame tree
70cdf0e10cSrcweir            which match search parameter <var>SearchFlags</var>
71cdf0e10cSrcweir	 */
72cdf0e10cSrcweir    sequence< XFrame > queryFrames( [in] long nSearchFlags );
73cdf0e10cSrcweir
74cdf0e10cSrcweir	//-------------------------------------------------------------------------
75cdf0e10cSrcweir	/** removes the frame from its container.
76cdf0e10cSrcweir
77cdf0e10cSrcweir        <p>
78cdf0e10cSrcweir        Note:
79cdf0e10cSrcweir        <ul>
80cdf0e10cSrcweir            <li>The method <method>XComponent::dispose()</method> is not called implicitly
81cdf0e10cSrcweir                by this method.</li>
82cdf0e10cSrcweir            <li>The creator attribute of the frame must be reset by the caller of
83cdf0e10cSrcweir                this method.</li>
84cdf0e10cSrcweir        </ul>
85cdf0e10cSrcweir        </p>
86cdf0e10cSrcweir
87cdf0e10cSrcweir        @param xFrame
88cdf0e10cSrcweir            frame which should be removed from this container
89cdf0e10cSrcweir	*/
90cdf0e10cSrcweir    void remove( [in] XFrame xFrame );
91cdf0e10cSrcweir
92cdf0e10cSrcweir};
93cdf0e10cSrcweir
94cdf0e10cSrcweir//=============================================================================
95cdf0e10cSrcweir
96cdf0e10cSrcweir}; }; }; };
97cdf0e10cSrcweir
98cdf0e10cSrcweir#endif
99