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