git.sesse.net Git - vlc/blob - modules/gui/skins2/controls/ctrl_button.hpp

   1 /*****************************************************************************
   2  * ctrl_button.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN (Centrale Réseaux) and its contributors
   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 CTRL_BUTTON_HPP
  26 #define CTRL_BUTTON_HPP
  27
  28 #include "ctrl_generic.hpp"
  29 #include "../utils/fsm.hpp"
  30
  31 class GenericBitmap;
  32 class OSGraphics;
  33 class CmdGeneric;
  34
  35
  36 /// Base class for button controls
  37 class CtrlButton: public CtrlGeneric
  38 {
  39     public:
  40         /// Create a button with 3 images
  41         CtrlButton( intf_thread_t *pIntf, const GenericBitmap &rBmpUp,
  42                     const GenericBitmap &rBmpOver,
  43                     const GenericBitmap &rBmpDown,
  44                     CmdGeneric &rCommand, const UString &rTooltip,
  45                     const UString &rHelp, VarBool *pVisible );
  46
  47         virtual ~CtrlButton();
  48
  49         /// Handle an event
  50         virtual void handleEvent( EvtGeneric &rEvent );
  51
  52         /// Check whether coordinates are inside the control
  53         virtual bool mouseOver( int x, int y ) const;
  54
  55         /// Draw the control on the given graphics
  56         virtual void draw( OSGraphics &rImage, int xDest, int yDest );
  57
  58         /// Get the text of the tooltip
  59         virtual UString getTooltipText() const { return m_tooltip; }
  60
  61         /// Get the type of control (custom RTTI)
  62         virtual string getType() const { return "button"; }
  63
  64     private:
  65         /// Finite state machine of the control
  66         FSM m_fsm;
  67         /// Command triggered by the button
  68         CmdGeneric &m_rCommand;
  69         /// Tooltip text
  70         const UString m_tooltip;
  71         /// Callbacks objects
  72         Callback m_cmdUpOverDownOver;
  73         Callback m_cmdDownOverUpOver;
  74         Callback m_cmdDownOverDown;
  75         Callback m_cmdDownDownOver;
  76         Callback m_cmdUpOverUp;
  77         Callback m_cmdUpUpOver;
  78         Callback m_cmdDownUp;
  79         Callback m_cmdUpHidden;
  80         Callback m_cmdHiddenUp;
  81         /// Images of the button in the different states
  82         OSGraphics *m_pImgUp, *m_pImgOver, *m_pImgDown;
  83         /// Current image
  84         OSGraphics *m_pImg;
  85
  86         /// Callback functions
  87         static void transUpOverDownOver( SkinObject *pCtrl );
  88         static void transDownOverUpOver( SkinObject *pCtrl );
  89         static void transDownOverDown( SkinObject *pCtrl );
  90         static void transDownDownOver( SkinObject *pCtrl );
  91         static void transUpOverUp( SkinObject *pCtrl );
  92         static void transUpUpOver( SkinObject *pCtrl );
  93         static void transDownUp( SkinObject *pCtrl );
  94         static void transUpHidden( SkinObject *pCtrl );
  95         static void transHiddenUp( SkinObject *pCtrl );
  96 };
  97
  98
  99 #endif