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

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