A label which show text or image

#include <Label.hpp>

Inheritance diagram for sf::ui::Label:

Public Member Functions
	Label ()
	Creates an empty label. More...

	Label (sf::Texture const &image)
	Creates a label-image. More...

	Label (sf::Font const &font, sf::String const &text, int fontSize=35)
	Creates a text label. More...

virtual void	updateEvent (sf::Event const &event)
	Update the component each time an event has been polled. More...

virtual void	updateFixed (sf::Time delta)
	Update the component with the main loop's frequency Can be useful for animation, or time's needed stuff. More...

virtual const sf::String &	getText () const

virtual void	setText (sf::String const &text)
	Sets the text's string of the component Don't forget to set the font. More...

virtual const sf::Font *	getFont () const

virtual void	setFont (sf::Font const &font)
	Sets the font of the component's text. More...

virtual unsigned int	getFontSize () const

virtual void	setFontSize (unsigned int size)
	Set the font's size of the component. More...

virtual sf::Color	getFontColor () const

virtual void	setFontColor (sf::Color color)
	Sets the color's font of the text. More...

const sf::Texture *	getImage () const

void	setImage (sf::Texture const &image)
	Sets the label's image Similar to setTexture(sf::Texture const&) More...

virtual sf::Vector2f	getSize () const

void	updateSize ()
	Update the size of the component Call it when you update your texture after it was set, to recalculate the component's size with new texture loaded. More...

void	move (sf::Vector2f const &vector)
	Move the component. More...

void	move (float x, float y)
	Move the component. More...

const sf::Texture *	getTexture () const

void	setTexture (const sf::Texture &texture)
	Set the texture of the component. More...

const sf::Vector2f &	getPosition () const

void	setPosition (sf::Vector2f const &position)
	Set the component's position. More...

void	setPosition (float x, float y)
	Set the component's position. More...

void	addObserver (sf::ui::ComponentObserver *observer)
	Add an observer. More...

std::set < sf::ui::ComponentObserver * > ::const_iterator	getObserversBegin () const

std::set < sf::ui::ComponentObserver * > ::const_iterator	getObserversEnd () const

int	countObservers ()

void	removeObserver (sf::ui::ComponentObserver *observer)
	Remove the observer at the given index. More...

void	removeAllObservers ()
	Remove all the observers. More...

Protected Member Functions
virtual void	draw (sf::RenderTarget &target, sf::RenderStates states) const
	Draw the component to the render target. More...

virtual void	updateCoord ()
	Called when the component need update its geometry Inherit when you need to update some sprite. More...

void	triggerEvent (const sf::ui::ComponentEvent &event)
	Triggers the event and notify all observers. More...

Protected Attributes
sf::Text	m_text

sf::Sprite	m_sprite

sf::Texture const *	m_texture

std::set < sf::ui::ComponentObserver * >	m_observers

Detailed Description

A label which show text or image

.

Definition at line 29 of file Label.hpp.

Constructor & Destructor Documentation

sf::ui::Label::Label ( )

Creates an empty label.

sf::ui::Label::Label ( sf::Texture const & image )

Creates a label-image.

Parameters

image the label's image

sf::ui::Label::Label	(	sf::Font const &	font,
		sf::String const &	text,
		int	fontSize = `35`
	)

Creates a text label.

Parameters

font	the text's font
text	the text's string
fontSize	the fint's size

Member Function Documentation

void sf::ui::ComponentObservable::addObserver ( sf::ui::ComponentObserver * observer )

inherited

Add an observer.

int sf::ui::ComponentObservable::countObservers ( )

inherited

Returns: the number of observers

virtual void sf::ui::Label::draw	(	sf::RenderTarget &	target,
		sf::RenderStates	states
	)		const

protectedvirtual

Draw the component to the render target.

Reimplemented from sf::ui::Component.

virtual const sf::Font* sf::ui::Label::getFont ( ) const

virtual

Returns: the font of the component, if any returns null

Implements sf::ui::IText.

virtual sf::Color sf::ui::Label::getFontColor ( ) const

virtual

Returns: the font's color of the text

Implements sf::ui::IText.

virtual unsigned int sf::ui::Label::getFontSize ( ) const

virtual

Returns: the font's size of the component

Implements sf::ui::IText.

const sf::Texture* sf::ui::Label::getImage ( ) const

Returns: the label's image or null Similar to getTexture()

std::set<sf::ui::ComponentObserver*>::const_iterator sf::ui::ComponentObservable::getObserversBegin ( ) const

inherited

Returns: the begin of the observers' iterator

std::set<sf::ui::ComponentObserver*>::const_iterator sf::ui::ComponentObservable::getObserversEnd ( ) const

inherited

Returns: the end of the observers' iterator

const sf::Vector2f& sf::ui::Component::getPosition ( ) const

inherited

Returns: the position of the component

virtual sf::Vector2f sf::ui::Label::getSize ( ) const

virtual

Returns: the size of the label

Reimplemented from sf::ui::Component.

virtual const sf::String& sf::ui::Label::getText ( ) const

virtual

Returns: the text's string

Implements sf::ui::IText.

const sf::Texture* sf::ui::Component::getTexture ( ) const

inherited

Returns: the texture of the component

void sf::ui::Component::move ( sf::Vector2f const & vector )

inherited

Move the component.

Parameters

vector the move's vector

void sf::ui::Component::move	(	float	x,
		float	y
	)

inherited

Move the component.

Parameters

x	the x movement
y	the y movement

void sf::ui::ComponentObservable::removeAllObservers ( )

inherited

Remove all the observers.

void sf::ui::ComponentObservable::removeObserver ( sf::ui::ComponentObserver * observer )

inherited

Remove the observer at the given index.

Parameters

observer the observer to remove

virtual void sf::ui::Label::setFont ( sf::Font const & font )

virtual

Sets the font of the component's text.

Implements sf::ui::IText.

virtual void sf::ui::Label::setFontColor ( sf::Color color )

virtual

Sets the color's font of the text.

Parameters

color the text's color

Implements sf::ui::IText.

virtual void sf::ui::Label::setFontSize ( unsigned int size )

virtual

Set the font's size of the component.

Parameters

size	the font's size

Implements sf::ui::IText.

void sf::ui::Label::setImage ( sf::Texture const & image )

Sets the label's image Similar to setTexture(sf::Texture const&)

void sf::ui::Component::setPosition ( sf::Vector2f const & position )

inherited

Set the component's position.

Parameters

position - the position vector

void sf::ui::Component::setPosition	(	float	x,
		float	y
	)

inherited

Set the component's position.

Parameters

x	- the x coordinate
y	- the y coordinate

virtual void sf::ui::Label::setText ( sf::String const & text )

virtual

Sets the text's string of the component Don't forget to set the font.

Parameters

text	the new string of the component

Implements sf::ui::IText.

void sf::ui::Component::setTexture ( const sf::Texture & texture )

inherited

Set the texture of the component.

void sf::ui::ComponentObservable::triggerEvent ( const sf::ui::ComponentEvent & event )

protectedinherited

Triggers the event and notify all observers.

Parameters

event - the event to push

virtual void sf::ui::Label::updateCoord ( )

protectedvirtual

Called when the component need update its geometry Inherit when you need to update some sprite.

Reimplemented from sf::ui::Component.

virtual void sf::ui::Label::updateEvent ( sf::Event const & event )

virtual

Update the component each time an event has been polled.

Parameters

event the window's event polled

Implements sf::ui::Component.

virtual void sf::ui::Label::updateFixed ( sf::Time delta )

virtual

Update the component with the main loop's frequency Can be useful for animation, or time's needed stuff.

Parameters

delta - the time between this update and the last

Implements sf::ui::Component.

void sf::ui::Component::updateSize ( )

inherited

Update the size of the component Call it when you update your texture after it was set, to recalculate the component's size with new texture loaded.

Example:

sf::Texture texture;
sf::Label label(texture); // Now label has a pointer to texture, moreover its size is (0;0)
texture.loadFromFile("texture.png"); // New texture loaded, and so its size has changed
label.updateSize(); // Tell label that it have to change its size, and calculate it with the updated texture's size

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

Label.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation