leper
74c420f658
Lots of code style fixes: * type [*&]varname -> type[*&] varname * else if (...) -> else if (...) * Spaces around some ops. * i++ -> ++i. * switch-case style fixes. * Indentation fixes. * Removing some commented out code. * include header sorting * Changed multiple pointer var declarations to be one per line. * Removed strange spaces in some places. * Changed some include header guards to be consistent with the rest of the codebase. * Use UNUSED() instead of UNUSED2(). Some small code fixes: * Using .find() instead of .count() == 0. * !.empty() instead of .size() == 0. * Range-based for loops. * Making some member functions const by small changes. * Adds GetScrollBarPos(idx) const for this. * Using early returns/continues in some places. * Uses size_t for some loops in CList and COList. * Removes unused heading element (not attribute) from COList. * Use ENSURE in one case where some custom code did something similar. * Made some parameters const ptrs/refs. * Change removal loop in GUItext.cpp to erase-unique. * Made some static things const. * Allow iterating over children of IGUIObject with range-based for loops by exposing begin() and end() (rename from ChildrenIt{Begin,End}()) and use it. Comments: * Comment COList. * Update a few comments. * Remove useless or duplicated comments. This was SVN commit r16931.
107 lines
2.5 KiB
C++
107 lines
2.5 KiB
C++
/* Copyright (C) 2015 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
GUI Object Base - Text Owner
|
|
|
|
--Overview--
|
|
|
|
Interface class that enhance the IGUIObject with
|
|
cached CGUIStrings. This class is not at all needed,
|
|
and many controls that will use CGUIStrings might
|
|
not use this, but does help for regular usage such
|
|
as a text-box, a button, a radio button etc.
|
|
|
|
--More info--
|
|
|
|
Check GUI.h
|
|
|
|
*/
|
|
|
|
#ifndef INCLUDED_IGUITEXTOWNER
|
|
#define INCLUDED_IGUITEXTOWNER
|
|
|
|
#include "GUI.h"
|
|
|
|
/**
|
|
* Framework for handling Output text.
|
|
*
|
|
* @see IGUIObject
|
|
*/
|
|
class IGUITextOwner : virtual public IGUIObject
|
|
{
|
|
public:
|
|
IGUITextOwner();
|
|
virtual ~IGUITextOwner();
|
|
|
|
/**
|
|
* Adds a text object.
|
|
*/
|
|
void AddText(SGUIText* text);
|
|
|
|
/**
|
|
* @see IGUIObject#HandleMessage()
|
|
*/
|
|
virtual void HandleMessage(SGUIMessage& Message);
|
|
|
|
/**
|
|
* @see IGUIObject#UpdateCachedSize()
|
|
*/
|
|
virtual void UpdateCachedSize();
|
|
|
|
/**
|
|
* Draws the Text.
|
|
*
|
|
* @param index Index value of text. Mostly this will be 0
|
|
* @param color
|
|
* @param pos Position
|
|
* @param z Z value
|
|
* @param clipping Clipping rectangle, don't even add a parameter
|
|
* to get no clipping.
|
|
*/
|
|
virtual void DrawText(size_t index, const CColor& color, const CPos& pos, float z, const CRect& clipping = CRect());
|
|
|
|
/**
|
|
* Test if mouse position is over an icon
|
|
*/
|
|
virtual bool MouseOverIcon();
|
|
|
|
protected:
|
|
|
|
/**
|
|
* Setup texts. Functions that sets up all texts when changes have been made.
|
|
*/
|
|
virtual void SetupText() = 0;
|
|
|
|
/**
|
|
* Whether the cached text is currently valid (if not then SetupText will be called by Draw)
|
|
*/
|
|
bool m_GeneratedTextsValid;
|
|
|
|
/**
|
|
* Texts that are generated and ready to be rendered.
|
|
*/
|
|
std::vector<SGUIText*> m_GeneratedTexts;
|
|
|
|
/**
|
|
* Calculate the position for the text, based on the alignment.
|
|
*/
|
|
void CalculateTextPosition(CRect& ObjSize, CPos& TextPos, SGUIText& Text);
|
|
};
|
|
|
|
#endif // INCLUDED_IGUITEXTOWNER
|