Line data    Source code

       1              : /****************************************************************************/
       2              : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
       3              : // Copyright (C) 2006-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    MFXStaticToolTip.h
      15              : /// @author  Pablo Alvarez Lopez
      16              : /// @date    May 2022
      17              : ///
      18              : //
      19              : /****************************************************************************/
      20              : 
      21              : #pragma once
      22              : #include <config.h>
      23              : 
      24              : #include "fxheader.h"
      25              : 
      26              : /// @brief MFXStaticToolTip (based on FXToolTip)
      27              : class MFXStaticToolTip : protected FXToolTip {
      28              :     /// @brief FOX declaration
      29            0 :     FXDECLARE(MFXStaticToolTip)
      30              : 
      31              : public:
      32              :     /// @brief constructor
      33              :     MFXStaticToolTip(FXApp* app);
      34              : 
      35              :     /// @brief destructor
      36              :     ~MFXStaticToolTip();
      37              : 
      38              :     /// @brief enable/disable static tooltip
      39              :     void enableStaticToolTip(const bool value);
      40              : 
      41              :     /// @brief check staticToolTip is enabled
      42              :     bool isStaticToolTipEnabled() const;
      43              : 
      44              :     /// @brief show static toolTip
      45              :     void showStaticToolTip(const FXString& toolTipText);
      46              : 
      47              :     /// @brief hide static toolTip
      48              :     void hideStaticToolTip();
      49              : 
      50              :     /// @name FOX callbacks
      51              :     /// @{
      52              :     /// @brief draw MFXStaticToolTip
      53              :     long onPaint(FXObject* obj, FXSelector sel, void* ptr);
      54              : 
      55              :     /// @brief called when tooltip is updated
      56              :     long onUpdate(FXObject* sender, FXSelector sel, void* ptr);
      57              : 
      58              :     /// @}
      59              : 
      60              : protected:
      61              :     /// @brief FOX need this
      62              :     MFXStaticToolTip();
      63              : 
      64              : private:
      65              :     /// @brief flag for enable/disable static tooltip
      66              :     bool myEnableStaticTooltip = true;
      67              : };