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

   1 /*****************************************************************************
   2  * ctrl_button.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
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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 #include "../src/anim_bitmap.hpp"
  31
  32 class GenericBitmap;
  33 class CmdGeneric;
  34
  35
  36 /// Base class for button controls
  37 class CtrlButton: public CtrlGeneric, public Observer<AnimBitmap, void*>
  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         /// Images of the button in the different states
  72         AnimBitmap m_imgUp, m_imgOver, m_imgDown;
  73         /// Current image
  74         AnimBitmap *m_pImg;
  75
  76         /// Callback objects
  77         DEFINE_CALLBACK( CtrlButton, UpOverDownOver )
  78         DEFINE_CALLBACK( CtrlButton, DownOverUpOver )
  79         DEFINE_CALLBACK( CtrlButton, DownOverDown )
  80         DEFINE_CALLBACK( CtrlButton, DownDownOver )
  81         DEFINE_CALLBACK( CtrlButton, UpOverUp )
  82         DEFINE_CALLBACK( CtrlButton, UpUpOver )
  83         DEFINE_CALLBACK( CtrlButton, DownUp )
  84         DEFINE_CALLBACK( CtrlButton, UpHidden )
  85         DEFINE_CALLBACK( CtrlButton, HiddenUp )
  86
  87         /// Change the current image
  88         void setImage( AnimBitmap *pImg );
  89
  90         /// Method called when an animated bitmap changes
  91         virtual void onUpdate( Subject<AnimBitmap, void*> &rBitmap, void* );
  92 };
  93
  94
  95 #endif