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, int w, int h )
 154 {
 155     rect clip( xDest, yDest, w, h );
 156     const Position *pPos = getPosition();
 157     if( m_pCurrImg )
 158     {
 159         // Compute the dimensions to draw
 160         int width = min( m_pCurrImg->getWidth() + m_xPos,
 161                          getPosition()->getWidth() );
 162         int height = min( m_pCurrImg->getHeight(), getPosition()->getHeight() );
 163         // Draw the current image
 164         if( width > 0 && height > 0 )
 165         {
 166             int offset = 0;
 167             if( m_alignment == kLeft )
 168             {
 169                 // We align to the left
 170                 offset = 0;
 171             }
 172             else if( m_alignment == kRight &&
 173                      width < getPosition()->getWidth() )
 174
 175             {
 176                 // The text is shorter than the width of the control, so we
 177                 // can align it to the right
 178                 offset = getPosition()->getWidth() - width;
 179             }
 180             else if( m_alignment == kCenter &&
 181                      width < getPosition()->getWidth() )
 182             {
 183                 // The text is shorter than the width of the control, so we
 184                 // can center it
 185                 offset = (getPosition()->getWidth() - width) / 2;
 186             }
 187             rect region( pPos->getLeft() + offset,
 188                          pPos->getTop(), width, height );
 189             rect inter;
 190             if( rect::intersect( region, clip, &inter ) )
 191                 rImage.drawBitmap( *m_pCurrImg, -m_xPos + inter.x - region.x,
 192                                    inter.y - region.y,
 193                                    inter.x, inter.y,
 194                                    inter.width, inter.height, true );
 195         }
 196     }
 197 }
 198
 199
 200 void CtrlText::setText( const UString &rText, uint32_t color )
 201 {
 202     // Change the color
 203     if( color != 0xFFFFFFFF )
 204     {
 205         m_color = color;
 206     }
 207
 208     // Change the text
 209     m_rVariable.set( rText );
 210 }
 211
 212
 213 void CtrlText::onUpdate( Subject<VarText> &rVariable, void* arg )
 214 {
 215     if( isVisible() )
 216     {
 217         displayText( m_rVariable.get() );
 218         notifyLayout( getPosition()->getWidth(), getPosition()->getHeight() );
 219     }
 220 }
 221
 222
 223 void CtrlText::onUpdate( Subject<VarBool> &rVariable, void *arg  )
 224 {
 225     // Visibility changed
 226     if( &rVariable == m_pVisible )
 227     {
 228         if( isVisible() )
 229         {
 230             displayText( m_rVariable.get() );
 231             notifyLayout( getPosition()->getWidth(), getPosition()->getHeight() );
 232         }
 233         else
 234         {
 235             notifyLayout();
 236         }
 237     }
 238 }
 239
 240
 241 void CtrlText::displayText( const UString &rText )
 242 {
 243     // Create the images ('normal' and 'double') from the text
 244     // 'Normal' image
 245     delete m_pImg;
 246     m_pImg = m_rFont.drawString( rText, m_color );
 247     if( !m_pImg )
 248     {
 249         return;
 250     }
 251     // 'Double' image
 252     const UString doubleStringWithSep = rText + SEPARATOR_STRING + rText;
 253     delete m_pImgDouble;
 254     m_pImgDouble = m_rFont.drawString( doubleStringWithSep, m_color );
 255
 256     // Update the current image used, as if the control size had changed
 257     onPositionChange();
 258
 259     if( m_alignment == kRight && getPosition() &&
 260         getPosition()->getWidth() < m_pImg->getWidth() )
 261     {
 262         m_xPos = getPosition()->getWidth() - m_pImg->getWidth();
 263     }
 264     else if( m_alignment == kCenter && getPosition() &&
 265              getPosition()->getWidth() < m_pImg->getWidth() )
 266     {
 267         m_xPos = (getPosition()->getWidth() - m_pImg->getWidth()) / 2;
 268     }
 269     else
 270     {
 271         m_xPos = 0;
 272     }
 273
 274     if( getPosition() )
 275     {
 276         // If the control was in the moving state, check if the scrolling is
 277         // still necessary
 278         const string &rState = m_fsm.getState();
 279         if( rState == "moving" || rState == "outMoving" )
 280         {
 281             if( m_pImg && m_pImg->getWidth() >= getPosition()->getWidth() )
 282             {
 283                 m_pCurrImg = m_pImgDouble;
 284                 m_pTimer->start( MOVING_TEXT_DELAY, false );
 285             }
 286             else
 287             {
 288                 m_pTimer->stop();
 289             }
 290         }
 291     }
 292 }
 293
 294
 295 void CtrlText::onPositionChange()
 296 {
 297     if( m_pImg && getPosition() )
 298     {
 299         if( m_pImg->getWidth() < getPosition()->getWidth() )
 300         {
 301             m_pCurrImg = m_pImg;
 302
 303             // When the control becomes wide enough for the text to display,
 304             // make sure to stop any scrolling effect
 305             m_pTimer->stop();
 306             m_xPos = 0;
 307         }
 308         else
 309         {
 310             m_pCurrImg = m_pImgDouble;
 311         }
 312     }
 313     else
 314     {
 315         // m_pImg is a better default value than m_pImgDouble, but anyway we
 316         // don't care because the control is never drawn without position :)
 317         m_pCurrImg = m_pImg;
 318     }
 319 }
 320
 321
 322 void CtrlText::onResize()
 323 {
 324     onPositionChange();
 325 }
 326
 327
 328 void CtrlText::CmdToManual::execute()
 329 {
 330     EvtMouse *pEvtMouse = (EvtMouse*)m_pParent->m_pEvt;
 331
 332     // Compute the offset
 333     m_pParent->m_xOffset = pEvtMouse->getXPos() - m_pParent->m_xPos;
 334
 335     m_pParent->m_pTimer->stop();
 336     m_pParent->captureMouse();
 337 }
 338
 339
 340 void CtrlText::CmdManualMoving::execute()
 341 {
 342     m_pParent->releaseMouse();
 343
 344     // Start the automatic movement, but only if the text is wider than the
 345     // control and if the control can scroll (either in manual or automatic
 346     // mode)
 347     if( m_pParent->m_pImg &&
 348         m_pParent->m_pImg->getWidth() >= m_pParent->getPosition()->getWidth() )
 349     {
 350         // The current image may have been set incorrectly in displayText(), so
 351         // set the correct value
 352         m_pParent->m_pCurrImg = m_pParent->m_pImgDouble;
 353
 354         m_pParent->m_pTimer->start( MOVING_TEXT_DELAY, false );
 355     }
 356 }
 357
 358
 359 void CtrlText::CmdManualStill::execute()
 360 {
 361     m_pParent->releaseMouse();
 362 }
 363
 364
 365 void CtrlText::CmdMove::execute()
 366 {
 367     EvtMouse *pEvtMouse = (EvtMouse*)m_pParent->m_pEvt;
 368
 369     // Do nothing if the text fits in the control
 370     if( m_pParent->m_pImg &&
 371         m_pParent->m_pImg->getWidth() >= m_pParent->getPosition()->getWidth() )
 372     {
 373         // The current image may have been set incorrectly in displayText(), so
 374         // we set the correct value
 375         m_pParent->m_pCurrImg = m_pParent->m_pImgDouble;
 376
 377         // Compute the new position of the left side, and make sure it is
 378         // in the correct range
 379         m_pParent->m_xPos = (pEvtMouse->getXPos() - m_pParent->m_xOffset);
 380         m_pParent->adjust( m_pParent->m_xPos );
 381
 382         m_pParent->notifyLayout( m_pParent->getPosition()->getWidth(),
 383                                  m_pParent->getPosition()->getHeight() );
 384     }
 385 }
 386
 387
 388 void CtrlText::CmdUpdateText::execute()
 389 {
 390     m_pParent->m_xPos -= MOVING_TEXT_STEP;
 391     m_pParent->adjust( m_pParent->m_xPos );
 392
 393     m_pParent->notifyLayout( m_pParent->getPosition()->getWidth(),
 394                              m_pParent->getPosition()->getHeight() );
 395 }
 396
 397
 398 void CtrlText::adjust( int &position )
 399 {
 400     // {m_pImgDouble->getWidth() - m_pImg->getWidth()} is the period of the
 401     // bitmap; remember that the string used to generate m_pImgDouble is of the
 402     // form: "foo  foo", the number of spaces being a parameter
 403     if( !m_pImg )
 404     {
 405         return;
 406     }
 407     position %= m_pImgDouble->getWidth() - m_pImg->getWidth();
 408     if( position > 0 )
 409     {
 410         position -= m_pImgDouble->getWidth() - m_pImg->getWidth();
 411     }
 412 }
 413