/*************************************************************************
 *
 *  $RCSfile: XFrames.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:05:25 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_XFrames_idl__
#define __com_sun_star_frame_XFrames_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_frame_XFrame_idl__
#include <com/sun/star/frame/XFrame.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** manages and creates frames.

    <p>
    Frames may contain other frames (by implementing an <type>XFrames</type>
	interface) and may be contained in other frames.
    </p>

    @see XFrame
    @see Frame
 */
interface XFrames: com::sun::star::container::XIndexAccess
{
	//-------------------------------------------------------------------------
    /** appends the specified <type>Frame</type> to the list of sub-frames.

        @param xFrame
            new frame for inserting into this container
	 */
    void append( [in] XFrame xFrame );

	//-------------------------------------------------------------------------
    /** provides access to the list of all currently existing
        frames inside this container and her sub frames

        @param nSearchFlags
            use combinations of <type>FrameSearchFlag</type> to specify which
            frames should be found

        @return
            all frames of this container and all available frames of the whole frame tree
            which match search parameter <var>SearchFlags</var>
	 */
    sequence< XFrame > queryFrames( [in] long nSearchFlags );

	//-------------------------------------------------------------------------
	/** removes the frame from its container.

        <p>
        Note:
        <ul>
            <li>The method <method>XComponent::dispose()</method> is not called implicitly
                by this method.</li>
            <li>The creator attribute of the frame must be reset by the caller of
                this method.</li>
        </ul>
        </p>

        @param xFrame
            frame which should be removed from this container
	*/
    void remove( [in] XFrame xFrame );

};

//=============================================================================

}; }; }; };

#endif
