offapi/com/sun/star/frame/XFramesSupplier.idl

   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
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23  published interface XFrames;
  24
  25 /** provides access to sub frames of current one
  26
  27     @see XFrames
  28  */
  29 published interface XFramesSupplier: XFrame
  30 {
  31     /** provides access to this container and to all other XFramesSupplier
  32         which are available from this node of frame tree
  33
  34         @returns
  35             the collection of frames which is represented by
  36             a FramesContainer.
  37      */
  38     XFrames getFrames();
  39
  40     /** gets the current active frame of this container
  41         (not of any other available supplier)
  42
  43         <p>
  44         This may be the frame itself. The active frame is defined as
  45         the frame which contains (recursively) the window with the focus.
  46         If no window within the frame contains the focus, this method
  47         returns the last frame which had the focus. If no containing
  48         window ever had the focus, the first frame within this frame is
  49         returned.
  50         </p>
  51
  52         @returns
  53             the Frame which is active within this frame.
  54      */
  55     XFrame getActiveFrame();
  56
  57     /** is called on activation of a direct sub-frame.
  58
  59         <p>
  60         This method is only allowed to be called by a sub-frame according to
  61         XFrame::activate() or XFramesSupplier::setActiveFrame().
  62         After this call XFramesSupplier::getActiveFrame() will return the
  63         frame specified by <var>Frame</var>.
  64         </p>
  65
  66         <p>
  67         In general this method first calls the method XFramesSupplier::setActiveFrame()
  68         at the creator frame with <var>this</var> as the current argument. Then it broadcasts
  69         the FrameActionEvent FrameAction::FRAME_ACTIVATED.
  70         </p>
  71
  72         <p>
  73         Note: Given parameter <var>Frame</var> must already exist inside the container
  74         (e.g., inserted by using XFrames::append())
  75         </p>
  76
  77         @param Frame
  78             the new active child frame inside this container
  79     */
  80     void setActiveFrame( [in] XFrame Frame );
  81 };
  82
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */