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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XTopWindow_idl__
  20 #define __com_sun_star_awt_XTopWindow_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XTopWindowListener.idl>
  25
  26 #include <com/sun/star/awt/XMenuBar.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module awt {
  31
  32
  33 /** manages the functionality specific for a top window.
  34  */
  35 published interface XTopWindow: com::sun::star::uno::XInterface
  36 {
  37
  38     /** adds the specified top window listener to receive window events from
  39         this window.
  40      */
  41     void addTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener );
  42
  43
  44     /** removes the specified top window listener so that it no longer
  45         receives window events from this window.
  46      */
  47     void removeTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener );
  48
  49
  50     /** places this window at the top of the stacking order and
  51         shows it in front of any other windows.
  52      */
  53     void toFront();
  54
  55
  56     /** places this window at the bottom of the stacking order and
  57         makes the corresponding adjustment to other visible windows.
  58      */
  59     void toBack();
  60
  61
  62     /** sets a menu bar.
  63      */
  64     void setMenuBar( [in] com::sun::star::awt::XMenuBar xMenu );
  65
  66 };
  67
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */