/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XTopWindow_idl__
#define __com_sun_star_awt_XTopWindow_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XTopWindowListener_idl__
#include <com/sun/star/awt/XTopWindowListener.idl>
#endif

#ifndef __com_sun_star_awt_XMenuBar_idl__
#include <com/sun/star/awt/XMenuBar.idl>
#endif


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

 module com {  module sun {  module star {  module awt {

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

/** manages the functionality specific for a top window.
 */
published interface XTopWindow: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** adds the specified top window listener to receive window events from
        this window.
     */
    [oneway] void addTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener );

    //-------------------------------------------------------------------------

    /** removes the specified top window listener so that it no longer
        receives window events from this window.
     */
    [oneway] void removeTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener );

    //-------------------------------------------------------------------------

    /** places this window at the top of the stacking order and
        shows it in front of any other windows.
     */
    [oneway] void toFront();

    //-------------------------------------------------------------------------

    /** places this window at the bottom of the stacking order and
        makes the corresponding adjustment to other visible windows.
     */
    [oneway] void toBack();

    //-------------------------------------------------------------------------

    /** sets a menu bar.
     */
    [oneway] void setMenuBar( [in] com::sun::star::awt::XMenuBar xMenu );

};

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

}; }; }; };

#endif
