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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_XFrames_idl__
  28 #define __com_sun_star_frame_XFrames_idl__
  29
  30 #ifndef __com_sun_star_container_XIndexAccess_idl__
  31 #include <com/sun/star/container/XIndexAccess.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_frame_XFrame_idl__
  35 #include <com/sun/star/frame/XFrame.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module frame {
  42
  43 //=============================================================================
  44 /** manages and creates frames.
  45
  46     <p>
  47     Frames may contain other frames (by implementing an <type>XFrames</type>
  48     interface) and may be contained in other frames.
  49     </p>
  50
  51     @see XFrame
  52     @see Frame
  53  */
  54 published interface XFrames: com::sun::star::container::XIndexAccess
  55 {
  56     //-------------------------------------------------------------------------
  57     /** appends the specified <type>Frame</type> to the list of sub-frames.
  58
  59         @param xFrame
  60             new frame for inserting into this container
  61      */
  62     void append( [in] XFrame xFrame );
  63
  64     //-------------------------------------------------------------------------
  65     /** provides access to the list of all currently existing
  66         frames inside this container and her sub frames
  67
  68         @param nSearchFlags
  69             use combinations of <type>FrameSearchFlag</type> to specify which
  70             frames should be found
  71
  72         @return
  73             all frames of this container and all available frames of the whole frame tree
  74             which match search parameter <var>SearchFlags</var>
  75      */
  76     sequence< XFrame > queryFrames( [in] long nSearchFlags );
  77
  78     //-------------------------------------------------------------------------
  79     /** removes the frame from its container.
  80
  81         <p>
  82         Note:
  83         <ul>
  84             <li>The method <method>XComponent::dispose()</method> is not called implicitly
  85                 by this method.</li>
  86             <li>The creator attribute of the frame must be reset by the caller of
  87                 this method.</li>
  88         </ul>
  89         </p>
  90
  91         @param xFrame
  92             frame which should be removed from this container
  93     */
  94     void remove( [in] XFrame xFrame );
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif