source/gui/SGUIIcon.h

   1 /* Copyright (C) 2021 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_SGUIICON
  19 #define INCLUDED_SGUIICON
  20
  21 #include "maths/Size2D.h"
  22 #include "ps/CStr.h"
  23
  24 /**
  25  * Icon, you create them in the XML file with root element <setup>.
  26  * You use them in text owned by different objects... Such as CText.
  27  */
  28 struct SGUIIcon
  29 {
  30         // This struct represents an immutable type, so ensure to avoid copying the strings.
  31         NONCOPYABLE(SGUIIcon);
  32         MOVABLE(SGUIIcon);
  33
  34         SGUIIcon() {}
  35
  36         // Sprite name of icon
  37         CStr m_SpriteName;
  38
  39         // Size
  40         CSize2D m_Size;
  41 };
  42
  43 #endif // INCLUDED_SGUIICON