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