Line data    Source code

       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             : 
      20             : #ifndef INCLUDED_VCL_SOURCE_WINDOW_MENUWINDOW_HXX
      21             : #define INCLUDED_VCL_SOURCE_WINDOW_MENUWINDOW_HXX
      22             : 
      23             : #include <sal/types.h>
      24             : #include <tools/link.hxx>
      25             : #include <tools/solar.h>
      26             : #include <vcl/event.hxx>
      27             : 
      28             : class HelpEvent;
      29             : class Image;
      30             : class Menu;
      31             : class MenuBar;
      32             : class Rectangle;
      33             : namespace vcl { class Window; }
      34             : 
      35             : /** Common ancestor for MenuFloatingWindow and MenuBarWindow.
      36             : 
      37             : The menu can be a floating window, or a menu bar.  Even though this has
      38             : 'Window' in the name, it is not derived from the VCL's Window class, as the
      39             : MenuFloatingWindow's or MenuBarWindow's already are VCL Windows.
      40             : 
      41             : TODO: move here stuff that was a mentioned previously when there was no
      42             : common class for MenuFloatingWindow and MenuBarWindow:
      43             : 
      44             : // a basic class for both (due to pActivePopup, Timer,...) would be nice,
      45             : // but a container class should have been created then, as they
      46             : // would be derived from different windows
      47             : // In most functions we would have to create exceptions for
      48             : // menubar, popupmenu, hence we made two classes
      49             : 
      50             : */
      51        3207 : class MenuWindow
      52             : {
      53             : public:
      54        3201 :     virtual ~MenuWindow() {}
      55             : 
      56             :     /// Show the appropriate help tooltip.
      57             :     static bool ImplHandleHelpEvent(vcl::Window* pMenuWindow, Menu* pMenu, sal_uInt16 nHighlightedItem,
      58             :             const HelpEvent& rHEvt, const Rectangle &rHighlightRect);
      59             : };
      60             : 
      61             : /// Interface for the MenuBarWindow functionality.
      62        3199 : class IMenuBarWindow : public MenuWindow
      63             : {
      64             : public:
      65        3193 :     virtual ~IMenuBarWindow() {}
      66             : 
      67             :     virtual sal_uLong GetFocusId() const = 0;
      68             :     virtual void SetFocusId(sal_uLong nId) = 0;
      69             : 
      70             :     virtual bool HandleKeyEvent(const KeyEvent& rKEvent, bool bFromMenu = true) = 0;
      71             :     virtual void LayoutChanged() = 0;
      72             :     virtual void PopupClosed(Menu* pMenu) = 0;
      73             :     virtual void ShowButtons(bool bClose, bool bFloat, bool bHide) = 0;
      74             : 
      75             :     virtual void ChangeHighlightItem(sal_uInt16 n, bool bSelectPopupEntry, bool bAllowRestoreFocus = true, bool bDefaultToDocument = true ) = 0;
      76             :     virtual sal_uInt16 GetHighlightedItem() const = 0;
      77             : 
      78             :     virtual void SetAutoPopup(bool bAuto) = 0;
      79             :     virtual void SetMenu(MenuBar* pMenu) = 0;
      80             :     virtual void SetHeight(long nHeight) = 0;
      81             :     virtual void KillActivePopup() = 0;
      82             : 
      83             :     /// Add an arbitrary button to the menubar that will appear next to the close button.
      84             :     virtual sal_uInt16 AddMenuBarButton(const Image&, const Link<>&, const OUString&, sal_uInt16 nPos) = 0;
      85             :     virtual void SetMenuBarButtonHighlightHdl(sal_uInt16 nId, const Link<>&) = 0;
      86             :     virtual Rectangle GetMenuBarButtonRectPixel(sal_uInt16 nId) = 0;
      87             :     virtual void RemoveMenuBarButton(sal_uInt16 nId) = 0;
      88             :     virtual bool HandleMenuButtonEvent(sal_uInt16 i_nButtonId) = 0;
      89             : };
      90             : 
      91             : #endif // INCLUDED_VCL_SOURCE_WINDOW_MENUWINDOW_HXX
      92             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */