Line data    Source code

       1              : /****************************************************************************/
       2              : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
       3              : // Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
       4              : // This program and the accompanying materials are made available under the
       5              : // terms of the Eclipse Public License 2.0 which is available at
       6              : // https://www.eclipse.org/legal/epl-2.0/
       7              : // This Source Code may also be made available under the following Secondary
       8              : // Licenses when the conditions for such availability set forth in the Eclipse
       9              : // Public License 2.0 are satisfied: GNU General Public License, version 2
      10              : // or later which is available at
      11              : // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
      12              : // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
      13              : /****************************************************************************/
      14              : /// @file    MFXMenuButtonTooltip.h
      15              : /// @author  Pablo Alvarez Lopez
      16              : /// @date    2022-07-27
      17              : ///
      18              : // MenuButton similar to FXMenuButton but with the possibility of showing tooltips
      19              : /****************************************************************************/
      20              : #pragma once
      21              : #include <config.h>
      22              : 
      23              : #include <string>
      24              : 
      25              : #include "fxheader.h"
      26              : #include "MFXStaticToolTip.h"
      27              : 
      28              : /**
      29              :  * @class MFXMenuButtonTooltip
      30              :  */
      31              : class MFXMenuButtonTooltip : public FXMenuButton {
      32              :     /// @brief fox declaration
      33            0 :     FXDECLARE(MFXMenuButtonTooltip)
      34              : 
      35              : public:
      36              :     /// @brief constructor (Exactly like the FXMenuButton constructor)
      37              :     MFXMenuButtonTooltip(FXComposite* p, MFXStaticToolTip* staticToolTip, const std::string& text, FXIcon* ic,
      38              :                          FXPopup* pup, FXObject* optionalTarget,
      39              :                          FXuint opts = JUSTIFY_NORMAL | ICON_BEFORE_TEXT | MENUBUTTON_DOWN,
      40              :                          FXint x = 0, FXint y = 0, FXint w = 0, FXint h = 0,
      41              :                          FXint pl = DEFAULT_PAD, FXint pr = DEFAULT_PAD, FXint pt = DEFAULT_PAD, FXint pb = DEFAULT_PAD);
      42              : 
      43              :     /// @brief destructor (Called automatically)
      44              :     ~MFXMenuButtonTooltip();
      45              : 
      46              :     /// @name FOX callbacks
      47              :     /// @{
      48              :     /// @brief called when mouse enter in MFXMenuButtonTooltip
      49              :     long onEnter(FXObject*, FXSelector, void*);
      50              : 
      51              :     /// @brief called when mouse leaves in MFXMenuButtonTooltip
      52              :     long onLeave(FXObject*, FXSelector, void*);
      53              : 
      54              :     /// @brief called when mouse motion in MFXMenuButtonTooltip
      55              :     long onMotion(FXObject*, FXSelector, void*);
      56              : 
      57              :     /// @brief called when left mouse button is press
      58              :     long onLeftBtnPress(FXObject*, FXSelector, void*);
      59              : 
      60              :     /// @brief called when key is press
      61              :     long onKeyPress(FXObject*, FXSelector, void*);
      62              : 
      63              :     /// @brief called when button is press
      64              :     long onCmdPost(FXObject*, FXSelector, void*);
      65              : 
      66              :     /// @}
      67              : 
      68              : protected:
      69              :     /// @brief FOX needs this
      70            0 :     FOX_CONSTRUCTOR(MFXMenuButtonTooltip)
      71              : 
      72              :     /// @brief static tooltip
      73              :     MFXStaticToolTip* myStaticToolTip = nullptr;
      74              : 
      75              :     /// @brief optional target
      76              :     FXObject* myOptionalTarget = nullptr;
      77              : 
      78              : private:
      79              :     /// @brief Invalidated copy constructor.
      80              :     MFXMenuButtonTooltip(const MFXMenuButtonTooltip&) = delete;
      81              : 
      82              :     /// @brief Invalidated assignment operator.
      83              :     MFXMenuButtonTooltip& operator=(const MFXMenuButtonTooltip&) = delete;
      84              : };