Irrlicht 3D Engine
 
Loading...
Searching...
No Matches
IGUIStaticText.h
Go to the documentation of this file.
1// Copyright (C) 2002-2012 Nikolaus Gebhardt
2// This file is part of the "Irrlicht Engine".
3// For conditions of distribution and use, see copyright notice in irrlicht.h
4
5#ifndef __I_GUI_STATIC_TEXT_H_INCLUDED__
6#define __I_GUI_STATIC_TEXT_H_INCLUDED__
7
8#include "IGUIElement.h"
9#include "SColor.h"
10
11namespace irr
12{
13namespace gui
14{
15 class IGUIFont;
16
19 {
20 public:
21
23 IGUIStaticText(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
24 : IGUIElement(EGUIET_STATIC_TEXT, environment, parent, id, rectangle) {}
25
27
29 virtual void setOverrideFont(IGUIFont* font=0) = 0;
30
32
33 virtual IGUIFont* getOverrideFont(void) const = 0;
34
36
38 virtual IGUIFont* getActiveFont() const = 0;
39
41
48 virtual void setOverrideColor(video::SColor color) = 0;
49
51
52 virtual video::SColor getOverrideColor(void) const = 0;
53
55
58 virtual void enableOverrideColor(bool enable) = 0;
59
61
62 virtual bool isOverrideColorEnabled(void) const = 0;
63
65 virtual void setBackgroundColor(video::SColor color) = 0;
66
68 virtual void setDrawBackground(bool draw) = 0;
69
71
72 virtual video::SColor getBackgroundColor() const = 0;
73
75
76 virtual bool isDrawBackgroundEnabled() const = 0;
77
79 virtual void setDrawBorder(bool draw) = 0;
80
82
83 virtual bool isDrawBorderEnabled() const = 0;
84
86
90 virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical) = 0;
91
93
95 virtual void setWordWrap(bool enable) = 0;
96
98
99 virtual bool isWordWrapEnabled(void) const = 0;
100
102
105 virtual s32 getTextHeight() const = 0;
106
108
110 virtual s32 getTextWidth(void) const = 0;
111
113 virtual void setTextRestrainedInside(bool restrainedInside) = 0;
114
116 virtual bool isTextRestrainedInside() const = 0;
117
119
124 virtual void setRightToLeft(bool rtl) = 0;
125
127 virtual bool isRightToLeft() const = 0;
128 };
129
130
131} // end namespace gui
132} // end namespace irr
133
134#endif
135
Axis aligned bounding box in 3d dimensional space.
Definition aabbox3d.h:22
Base class of all GUI elements.
Definition IGUIElement.h:26
virtual void draw()
Draws the element and its children.
GUI Environment. Used as factory and manager of all other GUI elements.
Font interface.
Definition IGUIFont.h:40
Multi or single line text label.
virtual IGUIFont * getActiveFont() const =0
Get the font which is used right now for drawing.
virtual void setWordWrap(bool enable)=0
Enables or disables word wrap for using the static text as multiline text control.
virtual bool isWordWrapEnabled(void) const =0
Checks if word wrap is enabled.
virtual void setRightToLeft(bool rtl)=0
Set whether the string should be interpreted as right-to-left (RTL) text.
virtual void setDrawBorder(bool draw)=0
Sets whether to draw the border.
virtual bool isDrawBorderEnabled() const =0
Checks if border drawing is enabled.
virtual bool isOverrideColorEnabled(void) const =0
Checks if an override color is enabled.
virtual IGUIFont * getOverrideFont(void) const =0
Gets the override font (if any)
virtual video::SColor getBackgroundColor() const =0
Gets the background color.
virtual bool isRightToLeft() const =0
Checks whether the text in this element should be interpreted as right-to-left.
IGUIStaticText(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)
constructor
virtual s32 getTextHeight() const =0
Returns the height of the text in pixels when it is drawn.
virtual bool isTextRestrainedInside() const =0
Checks if the text in this label should be clipped if it goes outside bounds.
virtual video::SColor getOverrideColor(void) const =0
Gets the override color.
virtual void setOverrideColor(video::SColor color)=0
Sets another color for the text.
virtual void setTextRestrainedInside(bool restrainedInside)=0
Set whether the text in this label should be clipped if it goes outside bounds.
virtual bool isDrawBackgroundEnabled() const =0
Checks if background drawing is enabled.
virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical)=0
Sets text justification mode.
virtual s32 getTextWidth(void) const =0
Returns the width of the current text, in the current font.
virtual void enableOverrideColor(bool enable)=0
Sets if the static text should use the overide color or the color in the gui skin.
virtual void setOverrideFont(IGUIFont *font=0)=0
Sets another skin independent font.
virtual void setDrawBackground(bool draw)=0
Sets whether to draw the background.
virtual void setBackgroundColor(video::SColor color)=0
Sets another color for the background.
Class representing a 32 bit ARGB color.
Definition SColor.h:202
@ EGUIET_STATIC_TEXT
A static text (IGUIStaticText)
Everything in the Irrlicht Engine can be found in this namespace.
Definition aabbox3d.h:13
signed int s32
32 bit signed variable.
Definition irrTypes.h:66