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

   1 /*****************************************************************************
   2  * ctrl_text.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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #ifndef CTRL_TEXT_HPP
  26 #define CTRL_TEXT_HPP
  27
  28 #include "ctrl_generic.hpp"
  29 #include "../utils/fsm.hpp"
  30 #include "../utils/observer.hpp"
  31 #include <string>
  32
  33 class GenericFont;
  34 class GenericBitmap;
  35 class OSTimer;
  36 class UString;
  37 class VarText;
  38
  39
  40 /// Class for control text
  41 class CtrlText: public CtrlGeneric, public Observer<VarText>
  42 {
  43     public:
  44         /// Create a text control with the optional given color
  45         CtrlText( intf_thread_t *pIntf, VarText &rVariable,
  46                   const GenericFont &rFont, const UString &rHelp,
  47                   uint32_t color, VarBool *pVisible );
  48         virtual ~CtrlText();
  49
  50         /// Handle an event
  51         virtual void handleEvent( EvtGeneric &rEvent );
  52
  53         /// Check whether coordinates are inside the control
  54         virtual bool mouseOver( int x, int y ) const;
  55
  56         /// Draw the control on the given graphics
  57         virtual void draw( OSGraphics &rImage, int xDest, int yDest );
  58
  59         /// Set the text of the control, with an optional color
  60         /// This takes effect immediatly
  61         void setText( const UString &rText, uint32_t color = 0xFFFFFFFF );
  62
  63         /// Get the type of control (custom RTTI)
  64         virtual string getType() const { return "text"; }
  65
  66     private:
  67         /// Finite state machine of the control
  68         FSM m_fsm;
  69         /// Variable associated to the control
  70         VarText &m_rVariable;
  71         /// Callback objects
  72         Callback m_cmdToManual;
  73         Callback m_cmdManualMoving;
  74         Callback m_cmdManualStill;
  75         Callback m_cmdMove;
  76         /// The last received event
  77         EvtGeneric *m_pEvt;
  78         /// Font used to render the text
  79         const GenericFont &m_rFont;
  80         /// Color of the text
  81         uint32_t m_color;
  82         /// Image of the text
  83         GenericBitmap *m_pImg;
  84         /// Image of the text, repeated twice and with some blank between;
  85         /// useful to display a 'circular' moving text...
  86         GenericBitmap *m_pImgDouble;
  87         /// Current image (should always be equal to m_pImg or m_pImgDouble)
  88         GenericBitmap *m_pCurrImg;
  89         /// Position of the left side of the moving text
  90         int m_xPos;
  91         /// Offset between the mouse pointer and the left side of the
  92         /// moving text
  93         int m_xOffset;
  94          /// Timer to move the text
  95         OSTimer *m_pTimer;
  96
  97         /// Callback functions
  98         static void transToManual( SkinObject *pCtrl );
  99         static void transManualMoving( SkinObject *pCtrl );
 100         static void transManualStill( SkinObject *pCtrl );
 101         static void transMove( SkinObject *pCtrl );
 102         /// Callback for the timer
 103         static void updateText( SkinObject *pCtrl );
 104
 105         /// Method called when the observed variable is modified
 106         virtual void onUpdate( Subject<VarText> &rVariable );
 107
 108         /// Display the text on the control
 109         void displayText( const UString &rText );
 110
 111         /// Helper function to set the position in the correct interval
 112         void adjust( int &position );
 113
 114         /// Update the behaviour of the text whenever the control size changes
 115         virtual void onChangePosition();
 116 };
 117
 118
 119 #endif