git.sesse.net Git - vlc/blob - modules/gui/skins/controls/text.h

   1 /*****************************************************************************
   2  * text.h: Text control
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN
   5  * $Id: text.h,v 1.2 2003/04/17 13:08:02 karibu Exp $
   6  *
   7  * Authors: Olivier Teulière <ipkiss@via.ecp.fr>
   8  *          Emmanuel Puig    <karibu@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,
  23  * USA.
  24  *****************************************************************************/
  25
  26
  27 #ifndef VLC_SKIN_CONTROL_TEXT
  28 #define VLC_SKIN_CONTROL_TEXT
  29
  30 //--- GENERAL ---------------------------------------------------------------
  31 #include <string>
  32 using namespace std;
  33
  34 //---------------------------------------------------------------------------
  35 class Event;
  36 class BitmapBank;
  37 class Graphics;
  38 class Window;
  39 class Region;
  40 class Font;
  41
  42 //---------------------------------------------------------------------------
  43 class ControlText : public GenericControl
  44 {
  45     private:
  46         // Scrolling parameters
  47         bool     Scroll;
  48         int      TextWidth;
  49         int      TextLeft;
  50         int      ScrollSpace;
  51         bool     Selected;
  52         int      SelectedX;
  53         int      MouseX;
  54         int      MouseY;
  55         bool     PauseScroll;
  56
  57         // Initial parameters
  58         bool     InitScroll;
  59         int      InitLeft;
  60         int      InitWidth;
  61
  62         // General parameters
  63         string   Text;
  64         int      Align;
  65         Font    *TextFont;
  66         string   FontName;
  67         list<string> DisplayList;
  68         list<string>::const_iterator Display;
  69         Region   *TextClipRgn;
  70
  71         // Internal methods
  72         void SetSize();
  73         void SetScrolling();
  74         void StartScrolling();
  75         void StopScrolling();
  76
  77     public:
  78         // Constructor
  79         ControlText( string id, bool visible, int x, int y, string text,
  80             string font, int align, int width, string display,
  81             bool scroll, int scrollspace, string help,  Window *Parent );
  82
  83         // initialization
  84         virtual void Init();
  85         virtual bool ProcessEvent( Event *evt );
  86
  87         // Destructor
  88         ~ControlText();
  89
  90         // Draw control
  91         virtual void Draw( int x, int y, int w, int h, Graphics *dest );
  92
  93         // Mouse events
  94         virtual bool MouseUp( int x, int y, int button );
  95         virtual bool MouseDown( int x, int y, int button );
  96         virtual bool MouseMove( int x, int y, int button );
  97         virtual bool MouseOver( int x, int y );
  98         virtual bool MouseDblClick( int x, int y, int button );
  99
 100         // Move control
 101         virtual void MoveRelative( int xOff, int yOff );
 102
 103         // Set text
 104         void SetText( const string newText );
 105
 106         // Keep on scrolling
 107         void DoScroll();
 108
 109         // Getters
 110         bool GetSelected() { return Selected; };
 111         bool IsScrolling() { return Scroll; };
 112 };
 113 //---------------------------------------------------------------------------
 114
 115 #endif