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

   1 /*****************************************************************************
   2  * tooltip.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN
   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
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #ifndef TOOLTIP_HPP
  26 #define TOOLTIP_HPP
  27
  28 #include "../utils/var_text.hpp"
  29
  30 class GenericFont;
  31 class OSTooltip;
  32 class OSTimer;
  33 class OSGraphics;
  34 class UString;
  35
  36
  37 class Tooltip: public SkinObject, public Observer<VarText>
  38 {
  39     public:
  40         /// Create a tooltip with the given font and delay (in milliseconds)
  41         Tooltip( intf_thread_t *pIntf, const GenericFont &rFont, int delay );
  42
  43         virtual ~Tooltip();
  44
  45         /// Draw the tooltip and show it after the delay
  46         void show();
  47
  48         /// Hide the tooltip and cancel the timer if a tooltip is waiting for
  49         /// display
  50         void hide();
  51
  52     private:
  53         /// Font
  54         const GenericFont &m_rFont;
  55         /// Delay before popping the tooltip
  56         int m_delay;
  57         /// Timer to wait before showing the tooltip
  58         OSTimer *m_pTimer;
  59         /// OS specific tooltip window
  60         OSTooltip *m_pOsTooltip;
  61         /// Image of the tooltip
  62         OSGraphics *m_pImage;
  63         /// Position of the tooltip
  64         int m_xPos, m_yPos;
  65
  66         /// Method called when the observed variable is modified
  67         virtual void onUpdate( Subject<VarText> &rVariable );
  68
  69         /// Display text of the tooltip
  70         void displayText( const UString &rText );
  71
  72         /// Build m_pImage with the given text
  73         void makeImage( const UString &rText );
  74
  75         /// Show the tooltip window
  76         static void doShow( SkinObject *pObj );
  77 };
  78
  79
  80 #endif