source/gui/CImage.h

   1 /* Copyright (C) 2015 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 #ifndef INCLUDED_CIMAGE
  19 #define INCLUDED_CIMAGE
  20
  21 #include "GUI.h"
  22
  23 /**
  24  * Object just for drawing a sprite. Like CText, without the
  25  * possibility to draw text.
  26  *
  27  * Created, because I've seen the user being indecisive about
  28  * what control to use in these situations. I've seen button
  29  * without functionality used, and that is a lot of unnecessary
  30  * overhead. That's why I thought I'd go with an intuitive
  31  * control.
  32  *
  33  * @see IGUIObject
  34  */
  35 class CImage : public IGUIObject
  36 {
  37         GUI_OBJECT(CImage)
  38
  39 public:
  40         CImage();
  41         virtual ~CImage();
  42
  43 protected:
  44         /**
  45          * Draws the Image
  46          */
  47         virtual void Draw();
  48 };
  49
  50 #endif // INCLUDED_CIMAGE