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

   1 /*****************************************************************************
   2  * ctrl_text.cpp
   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 #include "ctrl_text.hpp"
  26 #include "../events/evt_generic.hpp"
  27 #include "../events/evt_mouse.hpp"
  28 #include "../src/generic_bitmap.hpp"
  29 #include "../src/generic_font.hpp"
  30 #include "../src/os_factory.hpp"
  31 #include "../src/os_graphics.hpp"
  32 #include "../src/os_timer.hpp"
  33 #include "../utils/position.hpp"
  34 #include "../utils/ustring.hpp"
  35 #include "../utils/var_text.hpp"
  36
  37
  38 #define MOVING_TEXT_STEP 1
  39 #define MOVING_TEXT_DELAY 30
  40 #define SEPARATOR_STRING "   "
  41
  42
  43 CtrlText::CtrlText( intf_thread_t *pIntf, VarText &rVariable,
  44                     const GenericFont &rFont, const UString &rHelp,
  45                     uint32_t color, VarBool *pVisible, Scrolling_t scrollMode,
  46                     Align_t alignment ):
  47     CtrlGeneric( pIntf, rHelp, pVisible ), m_fsm( pIntf ),
  48     m_rVariable( rVariable ), m_cmdToManual( this ),
  49     m_cmdManualMoving( this ), m_cmdManualStill( this ),
  50     m_cmdMove( this ), m_pEvt( NULL ), m_rFont( rFont ),
  51     m_color( color ), m_scrollMode( scrollMode ), m_alignment( alignment ),
  52     m_pImg( NULL ), m_pImgDouble( NULL ),
  53     m_pCurrImg( NULL ), m_xPos( 0 ), m_xOffset( 0 ),
  54     m_cmdUpdateText( this )
  55 {
  56     m_pTimer = OSFactory::instance( pIntf )->createOSTimer( m_cmdUpdateText );
  57
  58     // States
  59     m_fsm.addState( "still" );
  60     m_fsm.addState( "moving" );
  61     m_fsm.addState( "manual1" );
  62     m_fsm.addState( "manual2" );
  63     m_fsm.addState( "outStill" );
  64     m_fsm.addState( "outMoving" );
  65
  66     // Transitions
  67     m_fsm.addTransition( "still", "leave", "outStill" );
  68     m_fsm.addTransition( "outStill", "enter", "still" );
  69     if( m_scrollMode == kManual )
  70     {
  71         m_fsm.addTransition( "still", "mouse:left:down", "manual1",
  72                              &m_cmdToManual );
  73         m_fsm.addTransition( "manual1", "mouse:left:up", "still",
  74                              &m_cmdManualStill );
  75         m_fsm.addTransition( "manual1", "motion", "manual1", &m_cmdMove );
  76     }
  77     else if( m_scrollMode == kAutomatic )
  78     {
  79         m_fsm.addTransition( "still", "mouse:left:down", "manual1",
  80                              &m_cmdToManual );
  81         m_fsm.addTransition( "manual1", "mouse:left:up", "moving",
  82                              &m_cmdManualMoving );
  83         m_fsm.addTransition( "moving", "mouse:left:down", "manual2",
  84                              &m_cmdToManual );
  85         m_fsm.addTransition( "manual2", "mouse:left:up", "still",
  86                              &m_cmdManualStill );
  87         m_fsm.addTransition( "manual1", "motion", "manual1", &m_cmdMove );
  88         m_fsm.addTransition( "manual2", "motion", "manual2", &m_cmdMove );
  89         m_fsm.addTransition( "moving", "leave", "outMoving" );
  90         m_fsm.addTransition( "outMoving", "enter", "moving" );
  91     }
  92
  93     // Initial state
  94     m_fsm.setState( "outStill" );
  95
  96     // Observe the variable
  97     m_rVariable.addObserver( this );
  98
  99     // Set the text
 100     displayText( m_rVariable.get() );
 101 }
 102
 103
 104 CtrlText::~CtrlText()
 105 {
 106     m_rVariable.delObserver( this );
 107     delete m_pTimer;
 108     delete m_pImg;
 109     delete m_pImgDouble;
 110 }
 111
 112
 113 void CtrlText::handleEvent( EvtGeneric &rEvent )
 114 {
 115     // Save the event to use it in callbacks
 116     m_pEvt = &rEvent;
 117
 118     m_fsm.handleTransition( rEvent.getAsString() );
 119 }
 120
 121
 122 bool CtrlText::mouseOver( int x, int y ) const
 123 {
 124     if( m_pCurrImg )
 125     {
 126         // We have 3 different ways of deciding when to return true here:
 127         //  1) the mouse is exactly over the text (so if you click between two
 128         //     letters, the text control doesn't catch the event)
 129         //  2) the mouse is over the rectangle of the control
 130         //  3) the mouse is over the rectangle of the visible text
 131         // I don't know which one is the best...
 132 #if 0
 133         return( x >= 0 && x < getPosition()->getWidth()
 134              && m_pCurrImg->hit( x - m_xPos, y ) );
 135 #endif
 136 #if 1
 137         return( x >= 0 && x < getPosition()->getWidth()
 138              && y >= 0 && y < getPosition()->getHeight() );
 139 #endif
 140 #if 0
 141         return( x >= 0 && x < getPosition()->getWidth()
 142              && y >= 0 && y < getPosition()->getHeight()
 143              && x < m_pCurrImg->getWidth() && x < m_pCurrImg->getHeight() );
 144 #endif
 145     }
 146     else
 147     {
 148         return false;
 149     }
 150 }
 151
 152
 153 void CtrlText::draw( OSGraphics &rImage, int xDest, int yDest )
 154 {
 155     if( m_pCurrImg )
 156     {
 157         // Compute the dimensions to draw
 158         int width = min( m_pCurrImg->getWidth() + m_xPos,
 159                          getPosition()->getWidth() );
 160         int height = min( m_pCurrImg->getHeight(), getPosition()->getHeight() );
 161         // Draw the current image
 162         if( width > 0 && height > 0 )
 163         {
 164             int offset = 0;
 165             if( m_alignment == kLeft )
 166             {
 167                 // We align to the left
 168                 offset = 0;
 169             }
 170             else if( m_alignment == kRight &&
 171                      width < getPosition()->getWidth() )
 172
 173             {
 174                 // The text is shorter than the width of the control, so we
 175                 // can align it to the right
 176                 offset = getPosition()->getWidth() - width;
 177             }
 178             else if( m_alignment == kCenter &&
 179                      width < getPosition()->getWidth() )
 180             {
 181                     // The text is shorter than the width of the control, so we
 182                     // can center it
 183                 offset = (getPosition()->getWidth() - width) / 2;
 184             }
 185             rImage.drawBitmap( *m_pCurrImg, -m_xPos, 0, xDest + offset,
 186                                yDest, width, height, true );
 187         }
 188     }
 189 }
 190
 191
 192 void CtrlText::setText( const UString &rText, uint32_t color )
 193 {
 194     // Change the color
 195     if( color != 0xFFFFFFFF )
 196     {
 197         m_color = color;
 198     }
 199
 200     // Change the text
 201     m_rVariable.set( rText );
 202 }
 203
 204
 205 void CtrlText::onUpdate( Subject<VarText> &rVariable, void* arg )
 206 {
 207     if( isVisible() )
 208     {
 209         displayText( m_rVariable.get() );
 210     }
 211 }
 212
 213
 214 void CtrlText::displayText( const UString &rText )
 215 {
 216     // Create the images ('normal' and 'double') from the text
 217     // 'Normal' image
 218     delete m_pImg;
 219     m_pImg = m_rFont.drawString( rText, m_color );
 220     if( !m_pImg )
 221     {
 222         return;
 223     }
 224     // 'Double' image
 225     const UString doubleStringWithSep = rText + SEPARATOR_STRING + rText;
 226     delete m_pImgDouble;
 227     m_pImgDouble = m_rFont.drawString( doubleStringWithSep, m_color );
 228
 229     // Update the current image used, as if the control size had changed
 230     onPositionChange();
 231
 232     if( m_alignment == kRight && getPosition() &&
 233         getPosition()->getWidth() < m_pImg->getWidth() )
 234     {
 235         m_xPos = getPosition()->getWidth() - m_pImg->getWidth();
 236     }
 237     else if( m_alignment == kCenter && getPosition() &&
 238              getPosition()->getWidth() < m_pImg->getWidth() )
 239     {
 240         m_xPos = (getPosition()->getWidth() - m_pImg->getWidth()) / 2;
 241     }
 242     else
 243     {
 244         m_xPos = 0;
 245     }
 246
 247     if( getPosition() )
 248     {
 249         // If the control was in the moving state, check if the scrolling is
 250         // still necessary
 251         const string &rState = m_fsm.getState();
 252         if( rState == "moving" || rState == "outMoving" )
 253         {
 254             if( m_pImg && m_pImg->getWidth() >= getPosition()->getWidth() )
 255             {
 256                 m_pCurrImg = m_pImgDouble;
 257                 m_pTimer->start( MOVING_TEXT_DELAY, false );
 258             }
 259             else
 260             {
 261                 m_pTimer->stop();
 262             }
 263         }
 264         notifyLayout( getPosition()->getWidth(), getPosition()->getHeight() );
 265     }
 266 }
 267
 268
 269 void CtrlText::onPositionChange()
 270 {
 271     if( m_pImg && getPosition() )
 272     {
 273         if( m_pImg->getWidth() < getPosition()->getWidth() )
 274         {
 275             m_pCurrImg = m_pImg;
 276
 277             // When the control becomes wide enough for the text to display,
 278             // make sure to stop any scrolling effect
 279             m_pTimer->stop();
 280             m_xPos = 0;
 281         }
 282         else
 283         {
 284             m_pCurrImg = m_pImgDouble;
 285         }
 286     }
 287     else
 288     {
 289         // m_pImg is a better default value than m_pImgDouble, but anyway we
 290         // don't care because the control is never drawn without position :)
 291         m_pCurrImg = m_pImg;
 292     }
 293 }
 294
 295
 296 void CtrlText::onResize()
 297 {
 298     onPositionChange();
 299 }
 300
 301
 302 void CtrlText::CmdToManual::execute()
 303 {
 304     EvtMouse *pEvtMouse = (EvtMouse*)m_pParent->m_pEvt;
 305
 306     // Compute the offset
 307     m_pParent->m_xOffset = pEvtMouse->getXPos() - m_pParent->m_xPos;
 308
 309     m_pParent->m_pTimer->stop();
 310     m_pParent->captureMouse();
 311 }
 312
 313
 314 void CtrlText::CmdManualMoving::execute()
 315 {
 316     m_pParent->releaseMouse();
 317
 318     // Start the automatic movement, but only if the text is wider than the
 319     // control and if the control can scroll (either in manual or automatic
 320     // mode)
 321     if( m_pParent->m_pImg &&
 322         m_pParent->m_pImg->getWidth() >= m_pParent->getPosition()->getWidth() )
 323     {
 324         // The current image may have been set incorrectly in displayText(), so
 325         // set the correct value
 326         m_pParent->m_pCurrImg = m_pParent->m_pImgDouble;
 327
 328         m_pParent->m_pTimer->start( MOVING_TEXT_DELAY, false );
 329     }
 330 }
 331
 332
 333 void CtrlText::CmdManualStill::execute()
 334 {
 335     m_pParent->releaseMouse();
 336 }
 337
 338
 339 void CtrlText::CmdMove::execute()
 340 {
 341     EvtMouse *pEvtMouse = (EvtMouse*)m_pParent->m_pEvt;
 342
 343     // Do nothing if the text fits in the control
 344     if( m_pParent->m_pImg &&
 345         m_pParent->m_pImg->getWidth() >= m_pParent->getPosition()->getWidth() )
 346     {
 347         // The current image may have been set incorrectly in displayText(), so
 348         // we set the correct value
 349         m_pParent->m_pCurrImg = m_pParent->m_pImgDouble;
 350
 351         // Compute the new position of the left side, and make sure it is
 352         // in the correct range
 353         m_pParent->m_xPos = (pEvtMouse->getXPos() - m_pParent->m_xOffset);
 354         m_pParent->adjust( m_pParent->m_xPos );
 355
 356         m_pParent->notifyLayout( m_pParent->getPosition()->getWidth(),
 357                                  m_pParent->getPosition()->getHeight() );
 358     }
 359 }
 360
 361
 362 void CtrlText::CmdUpdateText::execute()
 363 {
 364     m_pParent->m_xPos -= MOVING_TEXT_STEP;
 365     m_pParent->adjust( m_pParent->m_xPos );
 366
 367     m_pParent->notifyLayout( m_pParent->getPosition()->getWidth(),
 368                              m_pParent->getPosition()->getHeight() );
 369 }
 370
 371
 372 void CtrlText::adjust( int &position )
 373 {
 374     // {m_pImgDouble->getWidth() - m_pImg->getWidth()} is the period of the
 375     // bitmap; remember that the string used to generate m_pImgDouble is of the
 376     // form: "foo  foo", the number of spaces being a parameter
 377     if( !m_pImg )
 378     {
 379         return;
 380     }
 381     position %= m_pImgDouble->getWidth() - m_pImg->getWidth();
 382     if( position > 0 )
 383     {
 384         position -= m_pImgDouble->getWidth() - m_pImg->getWidth();
 385     }
 386 }
 387