offapi/com/sun/star/awt/XTopWindow.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTopWindow.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XTopWindow_idl__
  31 #define __com_sun_star_awt_XTopWindow_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XTopWindowListener_idl__
  38 #include <com/sun/star/awt/XTopWindowListener.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_XMenuBar_idl__
  42 #include <com/sun/star/awt/XMenuBar.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** manages the functionality specific for a top window.
  53  */
  54 published interface XTopWindow: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** adds the specified top window listener to receive window events from
  59         this window.
  60      */
  61     [oneway] void addTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener );
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** removes the specified top window listener so that it no longer
  66         receives window events from this window.
  67      */
  68     [oneway] void removeTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** places this window at the top of the stacking order and
  73         shows it in front of any other windows.
  74      */
  75     [oneway] void toFront();
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** places this window at the bottom of the stacking order and
  80         makes the corresponding adjustment to other visible windows.
  81      */
  82     [oneway] void toBack();
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** sets a menu bar.
  87      */
  88     [oneway] void setMenuBar( [in] com::sun::star::awt::XMenuBar xMenu );
  89
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif