1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_frame_XFramesSupplier_idl__
24#define __com_sun_star_frame_XFramesSupplier_idl__
25
26#ifndef __com_sun_star_frame_XFrame_idl__
27#include <com/sun/star/frame/XFrame.idl>
28#endif
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module frame {
33
34 published interface XFrames;
35
36//=============================================================================
37/** provides access to sub frames of current one
38
39    @see XFrames
40 */
41published interface XFramesSupplier: XFrame
42{
43	//-------------------------------------------------------------------------
44    /** provides access to this container and to all other <type>XFramesSupplier</type>
45        which are available from this node of frame tree
46
47        @returns
48            the collection of frames which is represented by
49            a <type>FramesContainer</type>.
50	 */
51	XFrames getFrames();
52
53	//-------------------------------------------------------------------------
54    /** gets the current active frame of this container
55        (not of any other available supplier)
56
57        <p>
58        This may be the frame itself. The active frame is defined as
59        the frame which contains (recursively) the window with the focus.
60        If no window within the frame contains the focus, this method
61        returns the last frame which had the focus. If no containing
62        window ever had the focus, the first frame within this frame is
63        returned.
64        </p>
65
66        @returns
67            the <type>Frame</type> which is active within this frame.
68	 */
69	XFrame getActiveFrame();
70
71	//-------------------------------------------------------------------------
72	/**	is called on activation of a direct sub-frame.
73
74        <p>
75        This method is only allowed to be called by a sub-frame according to
76        <member>XFrame::activate()</member> or <member>XFramesSupplier::setActiveFrame()</member>.
77        After this call <member>XFramesSupplier::getActiveFrame()</member> will return the
78        frame specified by <var>Frame</var>.
79        </p>
80
81        <p>
82        In general this method first calls the method <member>XFramesSupplier::setActiveFrame()</member>
83        at the creator frame with <var>this</var> as the current argument. Then it broadcasts
84		the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>.
85        </p>
86
87        <p>
88        Note: Given parameter <var>Frame</var> must already exist inside the container
89        (e.g., inserted by using <member>XFrames::append()</member>)
90        </p>
91
92        @param Frame
93            the new active child frame inside this container
94	*/
95    void setActiveFrame( [in] XFrame Frame );
96};
97
98//=============================================================================
99
100}; }; }; };
101
102#endif
103