vcl/source/window/menuwindow.hxx

   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 #pragma once
  21
  22 #include <sal/types.h>
  23 #include <vcl/event.hxx>
  24
  25 class HelpEvent;
  26 class Image;
  27 class Menu;
  28 class MenuBar;
  29 namespace tools { class Rectangle; }
  30 namespace vcl { class Window; }
  31
  32 /** Common ancestor for MenuFloatingWindow and MenuBarWindow.
  33
  34 The menu can be a floating window, or a menu bar.  Even though this has
  35 'Window' in the name, it is not derived from the VCL's Window class, as the
  36 MenuFloatingWindow's or MenuBarWindow's already are VCL Windows.
  37
  38 TODO: move here stuff that was a mentioned previously when there was no
  39 common class for MenuFloatingWindow and MenuBarWindow:
  40
  41 // a basic class for both (due to pActivePopup, Timer,...) would be nice,
  42 // but a container class should have been created then, as they
  43 // would be derived from different windows
  44 // In most functions we would have to create exceptions for
  45 // menubar, popupmenu, hence we made two classes
  46
  47 */
  48 class MenuWindow
  49 {
  50 protected:
  51     /// Show the appropriate help tooltip.
  52     static bool ImplHandleHelpEvent(vcl::Window* pMenuWindow, Menu const * pMenu, sal_uInt16 nHighlightedItem,
  53             const HelpEvent& rHEvt, const tools::Rectangle &rHighlightRect);
  54 };
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */