1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
2 // Copyright (C) 2016 Nathanaƫlle Courant
3 // Modified this class to work with EnrichedStrings too
4 // This file is part of the "Irrlicht Engine".
5 // For conditions of distribution and use, see copyright notice in irrlicht.h
9 #include "IrrCompileConfig.h"
10 #ifdef _IRR_COMPILE_WITH_GUI_
12 #include "IGUIStaticText.h"
19 #include "util/enriched_string.h"
21 #include <IGUIEnvironment.h>
30 const EGUI_ELEMENT_TYPE EGUIET_ENRICHED_STATIC_TEXT = (EGUI_ELEMENT_TYPE)(0x1000);
32 class StaticText : public IGUIStaticText
36 // StaticText is translated by EnrichedString.
37 // No need to use translate_string()
38 StaticText(const EnrichedString &text, bool border, IGUIEnvironment* environment,
39 IGUIElement* parent, s32 id, const core::rect<s32>& rectangle,
40 bool background = false);
43 virtual ~StaticText();
45 static irr::gui::IGUIStaticText *add(
46 irr::gui::IGUIEnvironment *guienv,
47 const EnrichedString &text,
48 const core::rect< s32 > &rectangle,
51 irr::gui::IGUIElement *parent = NULL,
53 bool fillBackground = false)
56 // parent is NULL, so we must find one, or we need not to drop
57 // result, but then there will be a memory leak.
59 // What Irrlicht does is to use guienv as a parent, but the problem
60 // is that guienv is here only an IGUIEnvironment, while it is a
61 // CGUIEnvironment in Irrlicht, which inherits from both IGUIElement
62 // and IGUIEnvironment.
64 // A solution would be to dynamic_cast guienv to a
65 // IGUIElement*, but Irrlicht is shipped without rtti support
66 // in some distributions, causing the dymanic_cast to segfault.
68 // Thus, to find the parent, we create a dummy StaticText and ask
69 // for its parent, and then remove it.
70 irr::gui::IGUIStaticText *dummy_text =
71 guienv->addStaticText(L"", rectangle, border, wordWrap,
72 parent, id, fillBackground);
73 parent = dummy_text->getParent();
76 irr::gui::IGUIStaticText *result = new irr::gui::StaticText(
77 text, border, guienv, parent,
78 id, rectangle, fillBackground);
80 result->setWordWrap(wordWrap);
85 static irr::gui::IGUIStaticText *add(
86 irr::gui::IGUIEnvironment *guienv,
88 const core::rect< s32 > &rectangle,
91 irr::gui::IGUIElement *parent = NULL,
93 bool fillBackground = false)
95 return add(guienv, EnrichedString(text), rectangle, border, wordWrap, parent,
99 //! draws the element and its children
102 //! Sets another skin independent font.
103 virtual void setOverrideFont(IGUIFont* font=0);
105 //! Gets the override font (if any)
106 virtual IGUIFont* getOverrideFont() const;
108 //! Get the font which is used right now for drawing
109 virtual IGUIFont* getActiveFont() const;
111 //! Sets another color for the text.
112 virtual void setOverrideColor(video::SColor color);
114 //! Sets another color for the background.
115 virtual void setBackgroundColor(video::SColor color);
117 //! Sets whether to draw the background
118 virtual void setDrawBackground(bool draw);
120 //! Gets the background color
121 virtual video::SColor getBackgroundColor() const;
123 //! Checks if background drawing is enabled
124 virtual bool isDrawBackgroundEnabled() const;
126 //! Sets whether to draw the border
127 virtual void setDrawBorder(bool draw);
129 //! Checks if border drawing is enabled
130 virtual bool isDrawBorderEnabled() const;
132 //! Sets alignment mode for text
133 virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical);
135 //! Gets the override color
136 virtual video::SColor getOverrideColor() const;
138 #if IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR > 8
139 //! Gets the currently used text color
140 virtual video::SColor getActiveColor() const;
143 //! Sets if the static text should use the overide color or the
144 //! color in the gui skin.
145 virtual void enableOverrideColor(bool enable);
147 //! Checks if an override color is enabled
148 virtual bool isOverrideColorEnabled() const;
150 //! Set whether the text in this label should be clipped if it goes outside bounds
151 virtual void setTextRestrainedInside(bool restrainedInside);
153 //! Checks if the text in this label should be clipped if it goes outside bounds
154 virtual bool isTextRestrainedInside() const;
156 //! Enables or disables word wrap for using the static text as
157 //! multiline text control.
158 virtual void setWordWrap(bool enable);
160 //! Checks if word wrap is enabled
161 virtual bool isWordWrapEnabled() const;
163 //! Sets the new caption of this element.
164 virtual void setText(const wchar_t* text);
166 //! Returns the height of the text in pixels when it is drawn.
167 virtual s32 getTextHeight() const;
169 //! Returns the width of the current text, in the current font
170 virtual s32 getTextWidth() const;
172 //! Updates the absolute position, splits text if word wrap is enabled
173 virtual void updateAbsolutePosition();
175 //! Set whether the string should be interpreted as right-to-left (RTL) text
176 /** \note This component does not implement the Unicode bidi standard, the
177 text of the component should be already RTL if you call this. The
178 main difference when RTL is enabled is that the linebreaks for multiline
179 elements are performed starting from the end.
181 virtual void setRightToLeft(bool rtl);
183 //! Checks if the text should be interpreted as right-to-left text
184 virtual bool isRightToLeft() const;
186 virtual bool hasType(EGUI_ELEMENT_TYPE t) const {
187 return (t == EGUIET_ENRICHED_STATIC_TEXT) || (t == EGUIET_STATIC_TEXT);
190 virtual bool hasType(EGUI_ELEMENT_TYPE t) {
191 return (t == EGUIET_ENRICHED_STATIC_TEXT) || (t == EGUIET_STATIC_TEXT);
194 void setText(const EnrichedString &text);
198 //! Breaks the single text line.
201 EGUI_ALIGNMENT HAlign, VAlign;
205 bool RestrainTextInside;
208 gui::IGUIFont* OverrideFont;
209 gui::IGUIFont* LastBreakFont; // stored because: if skin changes, line break must be recalculated.
211 EnrichedString ColoredText;
212 std::vector<EnrichedString> BrokenText;
216 } // end namespace gui
218 } // end namespace irr
220 inline void setStaticText(irr::gui::IGUIStaticText *static_text, const EnrichedString &text)
222 // dynamic_cast not possible due to some distributions shipped
223 // without rtti support in irrlicht
224 if (static_text->hasType(irr::gui::EGUIET_ENRICHED_STATIC_TEXT)) {
225 irr::gui::StaticText* stext = static_cast<irr::gui::StaticText*>(static_text);
226 stext->setText(text);
228 static_text->setText(text.c_str());
232 inline void setStaticText(irr::gui::IGUIStaticText *static_text, const wchar_t *text)
234 setStaticText(static_text, EnrichedString(text, static_text->getOverrideColor()));
237 #endif // _IRR_COMPILE_WITH_GUI_