Neo2D::Gui::Label Class Reference

The Label class displays a string on the screen. More...

#include <Label.h>

Inheritance diagram for Neo2D::Gui::Label:

Public Member Functions
	Label (unsigned int x, unsigned int y, unsigned int width, unsigned int height, const char *label)
void	setAlignment (int mode)
	Changes the text alignment. More...
TEXT_ALIGN_MODES	getAlignment ()
	Returns the current align mode. More...
void	setFont (const char *file)
	Changes the font used to display text. More...
const char *	getFont ()
	Returns the path to the currently used font file. More...
Vector4	getColor ()
void	setColor (Vector4 color)
void	draw (Vector2 offset)
	Draws the widget to the canvas it belongs to. More...
void	draw ()
	Draws the widget to the canvas it belongs to. More...
void	update ()
	Updates the widget and calls the callback if necessary. More...
Public Member Functions inherited from Neo2D::Widget
	Widget (unsigned int x, unsigned int y, unsigned int width, unsigned int height, const char *label)
	Widget ()
void	setParent (Widget *w)
Widget *	getParent ()
float	getFontSize ()
void	setFontSize (float s)
void	setOffset (Vector2 offset)
Vector2	getOffset ()
void	setSize (unsigned int w, unsigned int h)
Vector2	getSize ()
void	setCallback (NEO_CALLBACK_FUNCTION func)
	Sets the callback. More...
void	setScriptCallback (const char *name)
void	setCallback (NEO_CALLBACK_FUNCTION func, long int data)
	Sets the callback and appends user data to it. More...
long int	getUserData ()
	Retrieves the user data that will be given to every callback call. More...
void	setUserData (long int data)
	Changes the user data that will be given to every callback call. More...
const char *	getLabel ()
	Gets the currently displayed label a C string. More...
void	setLabel (const char *l)
	Changes the current label of the widget. More...
void	setPosition (Vector2 pos)
	Changes the widget position. More...
Vector2	getPosition ()
	Retrieves the current position. More...
void	setRotation (float rot)
	Changes the widget rotation. More...
float	getRotation ()
	Retrieves the current rotation. More...
void	translate (Vector2 vec)
	Translates the object. More...
void	rotate (float value)
	Rotates the object. More...
void	doCallback ()
	Calls the callback with the user data as an argument. More...
bool	isVisible ()
	Returns if the widget is turned visible. More...
void	setVisible (bool v)
	Sets the visibility status. More...
void	setScale (Vector2 scale)
	setScale Scale this Widget More...
Vector2	getScale ()
void	setFlip (Vector2 flip)
	setFlip Flip this Widget More...
Vector2	getFlip ()
const char *	getStaticName ()
virtual bool	isMouseOver ()

Protected Attributes
OText *	m_labelText
TEXT_ALIGN_MODES	m_alignment
String	m_font
Vector4	m_color
Protected Attributes inherited from Neo2D::Widget
float	m_x
	The 2D coordinates of the widget. More...
float	m_y
float	m_rotation
	The rotation of the widget. More...
unsigned int	m_width
	The width and height of the widget. More...
unsigned int	m_height
std::string	m_label
	The label of the widget. More...
Vector2	m_offset
	The offset that was used for rendering in the last frame. More...
NEO_CALLBACK_FUNCTION	m_callback
	The callback that should be called. More...
String	m_callbackScript
long int	m_userData
	Some userdata that is given to the callback. More...
bool	m_visible
	Is the widget visible? More...
Vector2	m_scale
	The scale vector. More...
Vector2	m_flip
	The flip vector. More...
float	m_fontSize
Widget *	m_parent

Detailed Description

The Label class displays a string on the screen.

Author

Yannick Pflanzer

Constructor & Destructor Documentation

Neo2D::Gui::Label::Label ( unsigned int  x, unsigned int  y, unsigned int  width, unsigned int  height, const char *  label  )

inline

Member Function Documentation

void Neo2D::Gui::Label::draw ( Vector2  offset )

virtual

Draws the widget to the canvas it belongs to.

Parameters

offset

The offset to apply to the position. Used for emulating a camera.

See also

Canvas

Reimplemented from Neo2D::Widget.

void Neo2D::Gui::Label::draw ( )

inlinevirtual

Draws the widget to the canvas it belongs to.

See also

Canvas

draw(Vector2 offset)

Reimplemented from Neo2D::Widget.

TEXT_ALIGN_MODES Neo2D::Gui::Label::getAlignment ( )

inline

Returns the current align mode.

Returns

The align mode.

See also

setAlignment

Vector4 Neo2D::Gui::Label::getColor ( )

inline

const char* Neo2D::Gui::Label::getFont ( )

inline

Returns the path to the currently used font file.

Returns

The font file.

See also

setFont

void Neo2D::Gui::Label::setAlignment ( int  mode )

inline

Changes the text alignment.

Defaults to TEXT_ALIGN_LEFT.

Parameters

mode	The align mode.

void Neo2D::Gui::Label::setColor ( Vector4  color )

inline

void Neo2D::Gui::Label::setFont ( const char *  file )

inline

Changes the font used to display text.

The font file will be loaded in the first draw call and thus can't be changed for now. Defaults to "assets/default.ttf".

Parameters

file	The font file to load.

void Neo2D::Gui::Label::update ( )

virtual

Updates the widget and calls the callback if necessary.

Implements Neo2D::Widget.

Member Data Documentation

TEXT_ALIGN_MODES Neo2D::Gui::Label::m_alignment

protected

Vector4 Neo2D::Gui::Label::m_color

protected

String Neo2D::Gui::Label::m_font

protected

OText* Neo2D::Gui::Label::m_labelText

protected

---

The documentation for this class was generated from the following file:

• Label.h