xref: /aoo42x/main/offapi/com/sun/star/awt/XTopWindow.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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