1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_frame_XFramesSupplier_idl__
20#define __com_sun_star_frame_XFramesSupplier_idl__
21
22#include <com/sun/star/frame/XFrame.idl>
23
24
25 module com {  module sun {  module star {  module frame {
26
27 published interface XFrames;
28
29/** provides access to sub frames of current one
30
31    @see XFrames
32 */
33published interface XFramesSupplier: XFrame
34{
35    /** provides access to this container and to all other XFramesSupplier
36        which are available from this node of frame tree
37
38        @returns
39            the collection of frames which is represented by
40            a FramesContainer.
41     */
42    XFrames getFrames();
43
44    /** gets the current active frame of this container
45        (not of any other available supplier)
46
47        <p>
48        This may be the frame itself. The active frame is defined as
49        the frame which contains (recursively) the window with the focus.
50        If no window within the frame contains the focus, this method
51        returns the last frame which had the focus. If no containing
52        window ever had the focus, the first frame within this frame is
53        returned.
54        </p>
55
56        @returns
57            the Frame which is active within this frame.
58     */
59    XFrame getActiveFrame();
60
61    /** is called on activation of a direct sub-frame.
62
63        <p>
64        This method is only allowed to be called by a sub-frame according to
65        XFrame::activate() or XFramesSupplier::setActiveFrame().
66        After this call XFramesSupplier::getActiveFrame() will return the
67        frame specified by <var>Frame</var>.
68        </p>
69
70        <p>
71        In general this method first calls the method XFramesSupplier::setActiveFrame()
72        at the creator frame with <var>this</var> as the current argument. Then it broadcasts
73        the FrameActionEvent FrameAction::FRAME_ACTIVATED.
74        </p>
75
76        <p>
77        Note: Given parameter <var>Frame</var> must already exist inside the container
78        (e.g., inserted by using XFrames::append())
79        </p>
80
81        @param Frame
82            the new active child frame inside this container
83    */
84    void setActiveFrame( [in] XFrame Frame );
85};
86
87
88}; }; }; };
89
90#endif
91
92/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
93