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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFramesSupplier.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XFramesSupplier_idl__
  31 #define __com_sun_star_frame_XFramesSupplier_idl__
  32
  33 #ifndef __com_sun_star_frame_XFrame_idl__
  34 #include <com/sun/star/frame/XFrame.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module frame {
  40
  41  published interface XFrames;
  42
  43 //=============================================================================
  44 /** provides access to sub frames of current one
  45
  46     @see XFrames
  47  */
  48 published interface XFramesSupplier: XFrame
  49 {
  50     //-------------------------------------------------------------------------
  51     /** provides access to this container and to all other <type>XFramesSupplier</type>
  52         which are available from this node of frame tree
  53
  54         @returns
  55             the collection of frames which is represented by
  56             a <type>FramesContainer</type>.
  57      */
  58     XFrames getFrames();
  59
  60     //-------------------------------------------------------------------------
  61     /** gets the current active frame of this container
  62         (not of any other available supplier)
  63
  64         <p>
  65         This may be the frame itself. The active frame is defined as
  66         the frame which contains (recursively) the window with the focus.
  67         If no window within the frame contains the focus, this method
  68         returns the last frame which had the focus. If no containing
  69         window ever had the focus, the first frame within this frame is
  70         returned.
  71         </p>
  72
  73         @returns
  74             the <type>Frame</type> which is active within this frame.
  75      */
  76     XFrame getActiveFrame();
  77
  78     //-------------------------------------------------------------------------
  79     /** is called on activation of a direct sub-frame.
  80
  81         <p>
  82         This method is only allowed to be called by a sub-frame according to
  83         <member>XFrame::activate()</member> or <member>XFramesSupplier::setActiveFrame()</member>.
  84         After this call <member>XFramesSupplier::getActiveFrame()</member> will return the
  85         frame specified by <var>Frame</var>.
  86         </p>
  87
  88         <p>
  89         In general this method first calls the method <member>XFramesSupplier::setActiveFrame()</member>
  90         at the creator frame with <var>this</var> as the current argument. Then it broadcasts
  91         the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>.
  92         </p>
  93
  94         <p>
  95         Note: Given parameter <var>Frame</var> must already exist inside the container
  96         (e.g., inserted by using <member>XFrames::append()</member>)
  97         </p>
  98
  99         @param Frame
 100             the new active child frame inside this container
 101     */
 102     void setActiveFrame( [in] XFrame Frame );
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; };
 108
 109 #endif