git.sesse.net Git - vlc/blob - modules/gui/skins2/src/tooltip.hpp

   1 /*****************************************************************************
   2  * tooltip.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef TOOLTIP_HPP
  26 #define TOOLTIP_HPP
  27
  28 #include "../utils/var_text.hpp"
  29 #include "../commands/cmd_generic.hpp"
  30
  31 class GenericFont;
  32 class OSTooltip;
  33 class OSTimer;
  34 class OSGraphics;
  35 class UString;
  36
  37
  38 class Tooltip: public SkinObject, public Observer<VarText>
  39 {
  40 public:
  41     /// Create a tooltip with the given font and delay (in milliseconds)
  42     Tooltip( intf_thread_t *pIntf, const GenericFont &rFont, int delay );
  43
  44     virtual ~Tooltip();
  45
  46     /// Draw the tooltip and show it after the delay
  47     void show();
  48
  49     /// Hide the tooltip and cancel the timer if a tooltip is waiting for
  50     /// display
  51     void hide();
  52
  53 private:
  54     /// Font
  55     const GenericFont &m_rFont;
  56     /// Delay before popping the tooltip
  57     int m_delay;
  58     /// Timer to wait before showing the tooltip
  59     OSTimer *m_pTimer;
  60     /// OS specific tooltip window
  61     OSTooltip *m_pOsTooltip;
  62     /// Image of the tooltip
  63     OSGraphics *m_pImage;
  64     /// Position of the tooltip
  65     int m_xPos, m_yPos;
  66
  67     /// Method called when the observed variable is modified
  68     virtual void onUpdate( Subject<VarText> &rVariable, void * );
  69
  70     /// Display text of the tooltip
  71     void displayText( const UString &rText );
  72
  73     /// Build m_pImage with the given text
  74     void makeImage( const UString &rText );
  75
  76     /// Callback to show the tooltip window
  77     DEFINE_CALLBACK( Tooltip, Show );
  78 };
  79
  80
  81 #endif