offapi/com/sun/star/frame/XFrames.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: XFrames.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_XFrames_idl__
  31 #define __com_sun_star_frame_XFrames_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexAccess_idl__
  34 #include <com/sun/star/container/XIndexAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XFrame_idl__
  38 #include <com/sun/star/frame/XFrame.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module frame {
  45
  46 //=============================================================================
  47 /** manages and creates frames.
  48
  49     <p>
  50     Frames may contain other frames (by implementing an <type>XFrames</type>
  51     interface) and may be contained in other frames.
  52     </p>
  53
  54     @see XFrame
  55     @see Frame
  56  */
  57 published interface XFrames: com::sun::star::container::XIndexAccess
  58 {
  59     //-------------------------------------------------------------------------
  60     /** appends the specified <type>Frame</type> to the list of sub-frames.
  61
  62         @param xFrame
  63             new frame for inserting into this container
  64      */
  65     void append( [in] XFrame xFrame );
  66
  67     //-------------------------------------------------------------------------
  68     /** provides access to the list of all currently existing
  69         frames inside this container and her sub frames
  70
  71         @param nSearchFlags
  72             use combinations of <type>FrameSearchFlag</type> to specify which
  73             frames should be found
  74
  75         @return
  76             all frames of this container and all available frames of the whole frame tree
  77             which match search parameter <var>SearchFlags</var>
  78      */
  79     sequence< XFrame > queryFrames( [in] long nSearchFlags );
  80
  81     //-------------------------------------------------------------------------
  82     /** removes the frame from its container.
  83
  84         <p>
  85         Note:
  86         <ul>
  87             <li>The method <method>XComponent::dispose()</method> is not called implicitly
  88                 by this method.</li>
  89             <li>The creator attribute of the frame must be reset by the caller of
  90                 this method.</li>
  91         </ul>
  92         </p>
  93
  94         @param xFrame
  95             frame which should be removed from this container
  96     */
  97     void remove( [in] XFrame xFrame );
  98
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif