source/gui/CImage.h

   1 /* Copyright (C) 2009 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19 GUI Object - Image object
  20
  21 --Overview--
  22
  23         GUI Object for just drawing a sprite.
  24
  25 --More info--
  26
  27         Check GUI.h
  28
  29 */
  30
  31 #ifndef INCLUDED_CIMAGE
  32 #define INCLUDED_CIMAGE
  33
  34 //--------------------------------------------------------
  35 //  Includes / Compiler directives
  36 //--------------------------------------------------------
  37 #include "GUI.h"
  38
  39 //--------------------------------------------------------
  40 //  Macros
  41 //--------------------------------------------------------
  42
  43 //--------------------------------------------------------
  44 //  Types
  45 //--------------------------------------------------------
  46
  47 //--------------------------------------------------------
  48 //  Declarations
  49 //--------------------------------------------------------
  50
  51 /**
  52  * Object just for drawing a sprite. Like CText, without the
  53  * possibility to draw text.
  54  *
  55  * Created, because I've seen the user being indecisive about
  56  * what control to use in these situations. I've seen button
  57  * without functionality used, and that is a lot of unnecessary
  58  * overhead. That's why I thought I'd go with an intuitive
  59  * control.
  60  *
  61  * @see IGUIObject
  62  */
  63 class CImage : public IGUIObject
  64 {
  65         GUI_OBJECT(CImage)
  66
  67 public:
  68         CImage();
  69         virtual ~CImage();
  70
  71 protected:
  72         /**
  73          * Draws the Image
  74          */
  75         virtual void Draw();
  76 };
  77
  78 #endif