gemrb/core/Label.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *
  19  */
  20
  21 /**
  22  * @file Label.h
  23  * Declares Label widget for displaying static texts
  24  * @author GemRB Developement Team
  25  */
  26
  27 #ifndef LABEL_H
  28 #define LABEL_H
  29
  30 #include "exports.h"
  31 #include "Control.h"
  32 #include "Font.h"
  33 #include "RGBAColor.h"
  34
  35 class Palette;
  36
  37 // !!! Keep these synchronized with GUIDefines.py !!!
  38 #define IE_GUI_LABEL_ON_PRESS      0x06000000
  39
  40 /**
  41  * @class Label
  42  * Label widget for displaying static texts in the GUI
  43  */
  44
  45 class GEM_EXPORT Label : public Control {
  46 public:
  47         Label(Font* font);
  48         ~Label();
  49         /** Draws the Control on the Output Display */
  50         void Draw(unsigned short x, unsigned short y);
  51         /** This function sets the actual Label Text */
  52         int SetText(const char* string, int pos = 0);
  53         /** Sets the Foreground Font Color */
  54         void SetColor(Color col, Color bac);
  55         /** Sets the Alignment of Text */
  56         void SetAlignment(unsigned char Alignment);
  57         /** Simply returns the pointer to the text, don't modify it! */
  58         const char* QueryText();
  59
  60         /** Mouse Button Down */
  61         void OnMouseUp(unsigned short x, unsigned short y, unsigned short Button,
  62                 unsigned short Mod);
  63         /** Set handler for specified event */
  64         bool SetEvent(int eventType, const char *handler);
  65         /** Use the RGB Color for the Font */
  66         bool useRGB;
  67         /** OnPress Scripted Event Function Name */
  68         EventHandler LabelOnPress;
  69 private: // Private attributes
  70         /** Text String Buffer */
  71         char* Buffer;
  72         /** Font for Text Writing */
  73         Font* font;
  74         /** Foreground & Background Colors */
  75         Palette* palette;
  76
  77         /** Alignment Variable */
  78         unsigned char Alignment;
  79 };
  80
  81 #endif