sf::String

sf::String Class Reference

String defines a graphical 2D text, that can be drawn on screen. More...

#include <String.hpp>

Inheritance diagram for sf::String:

sf::Drawable List of all members.

Public Member Functions

 String (const std::string &Text, const std::string &Font="", float Size=32.f)
 Construct the string from a multibyte text.
 String (const std::wstring &Text=L"", const std::string &Font="", float Size=32.f)
 Construct the string from a unicode text.
void SetText (const std::string &Text)
 Set the text (from a multibyte string).
void SetText (const std::wstring &Text)
 Set the text (from a unicode string).
void SetFont (const std::string &Font)
 Set the font of the string.
void SetSize (float Size)
 Set the size of the string.
const std::wstring & GetUnicodeText () const
 Get the text (returns a unicode string).
std::string GetText () const
 Get the text (returns a multibyte string).
const std::string & GetFont () const
 Get the font used by the string.
float GetSize () const
 Get the size of the characters.
FloatRect GetRect () const
 Get the string rectangle on screen.
void SetLeft (float Left)
 Set the left position of the object.
void SetTop (float Top)
 Set the top position of the object.
void SetPosition (float Left, float Top)
 Set the position of the object.
void SetScaleX (float Scale)
 Set the horizontal scale of the object.
void SetScaleY (float Scale)
 Set the vertical scale of the object.
void SetScale (float ScaleX, float ScaleY)
 Set the scale of the object.
void SetRotation (float Rotation)
 Set the orientation of the object.
void SetRotationCenter (float X, float Y)
 Set the center of rotation, in coordinates relative to the object.
void SetColor (const Color &Col)
 Set the color of the object.
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object.
float GetLeft () const
 Get the left position of the object.
float GetTop () const
 Get the top position of the object.
float GetScaleX () const
 Get the horizontal scale of the object.
float GetScaleY () const
 Get the vertical scale of the object.
float GetRotation () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object.
void Scale (float FactorX, float FactorY)
 Scale the object.
void Rotate (float Angle)
 Rotate the object.

Static Public Member Functions

static void PreloadFont (const std::string &Font, float Size, std::wstring Charset=L"")
 Preload a bitmap font (otherwise, it is done the first time the font is drawn).

Protected Member Functions

virtual void Render (const RenderWindow &Window) const
 /see Drawable::Render

Detailed Description

String defines a graphical 2D text, that can be drawn on screen.

Definition at line 41 of file String.hpp.

Constructor & Destructor Documentation

sf::String::String ( const std::string &  Text,
const std::string &  Font = "",
float  Size = 32.f 
)

Construct the string from a multibyte text.

Parameters:
Text : Text assigned to the string ("" by default)
Font : Font used to draw the string ("" by default - use default font)
Size : Characters size, in pixels (32 by default)

sf::String::String ( const std::wstring &  Text = L"",
const std::string &  Font = "",
float  Size = 32.f 
)

Construct the string from a unicode text.

Parameters:
Text : Text assigned to the string ("" by default)
Font : Font used to draw the string ("" by default - use default font)
Size : Characters size, in pixels (32 by default)

Member Function Documentation

static void sf::String::PreloadFont ( const std::string &  Font,
float  Size,
std::wstring  Charset = L"" 
) [static]

Preload a bitmap font (otherwise, it is done the first time the font is drawn).

Parameters:
Font : Font to load
Size : Requested character size
Charset : Characters set to generate (empty by default - take the ASCII range [31, 255])

void sf::String::SetText ( const std::string &  Text  ) 

Set the text (from a multibyte string).

Parameters:
Text : New text

void sf::String::SetText ( const std::wstring &  Text  ) 

Set the text (from a unicode string).

Parameters:
Text : New text

void sf::String::SetFont ( const std::string &  Font  ) 

Set the font of the string.

Parameters:
Font : Font filename

void sf::String::SetSize ( float  Size  ) 

Set the size of the string.

Parameters:
Size : New size, in pixels

const std::wstring& sf::String::GetUnicodeText (  )  const

Get the text (returns a unicode string).

Returns:
Text

std::string sf::String::GetText (  )  const

Get the text (returns a multibyte string).

Returns:
Text

const std::string& sf::String::GetFont (  )  const

Get the font used by the string.

Returns:
Font name

float sf::String::GetSize (  )  const

Get the size of the characters.

Returns:
Size of the characters

FloatRect sf::String::GetRect (  )  const

Get the string rectangle on screen.

Returns:
Rectangle contaning the string in screen coordinates

virtual void sf::String::Render ( const RenderWindow &  Window  )  const [protected, virtual]

/see Drawable::Render

Implements sf::Drawable.

void sf::Drawable::SetLeft ( float  Left  )  [inherited]

Set the left position of the object.

Parameters:
Left : New left coordinate

void sf::Drawable::SetTop ( float  Top  )  [inherited]

Set the top position of the object.

Parameters:
Top : New top coordinate

void sf::Drawable::SetPosition ( float  Left,
float  Top 
) [inherited]

Set the position of the object.

Parameters:
Left : New left coordinate
Top : New top coordinate

void sf::Drawable::SetScaleX ( float  Scale  )  [inherited]

Set the horizontal scale of the object.

Parameters:
Scale : New scale (must be strictly positive)

void sf::Drawable::SetScaleY ( float  Scale  )  [inherited]

Set the vertical scale of the object.

Parameters:
Scale : New scale (must be strictly positive)

void sf::Drawable::SetScale ( float  ScaleX,
float  ScaleY 
) [inherited]

Set the scale of the object.

Parameters:
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)

void sf::Drawable::SetRotation ( float  Rotation  )  [inherited]

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

void sf::Drawable::SetRotationCenter ( float  X,
float  Y 
) [inherited]

Set the center of rotation, in coordinates relative to the object.

The default rotation center is (0, 0)

Parameters:
X : X coordinate of the center of rotation
Y : Y coordinate of the center of rotation

void sf::Drawable::SetColor ( const Color &  Col  )  [inherited]

Set the color of the object.

The default color is white

Parameters:
Col : New color

void sf::Drawable::SetBlendMode ( Blend::Mode  Mode  )  [inherited]

Set the blending mode for the object.

The default blend mode is Blend::Alpha

Parameters:
Mode : New blending mode

float sf::Drawable::GetLeft (  )  const [inherited]

Get the left position of the object.

Returns:
Current left position

float sf::Drawable::GetTop (  )  const [inherited]

Get the top position of the object.

Returns:
Current top position

float sf::Drawable::GetScaleX (  )  const [inherited]

Get the horizontal scale of the object.

Returns:
Current X scale factor (always positive)

float sf::Drawable::GetScaleY (  )  const [inherited]

Get the vertical scale of the object.

Returns:
Current Y scale factor (always positive)

float sf::Drawable::GetRotation (  )  const [inherited]

Get the orientation of the object.

Returns:
Current rotation, in degrees

const Color& sf::Drawable::GetColor (  )  const [inherited]

Get the color of the object.

Returns:
Current color

Blend::Mode sf::Drawable::GetBlendMode (  )  const [inherited]

Get the current blending mode.

Returns:
Current blending mode

void sf::Drawable::Move ( float  OffsetX,
float  OffsetY 
) [inherited]

Move the object.

Parameters:
OffsetX : Offset on the X axis
OffsetY : Offset on the Y axis

void sf::Drawable::Scale ( float  FactorX,
float  FactorY 
) [inherited]

Scale the object.

Parameters:
FactorX : Horizontal scaling factor (must be strictly positive)
FactorY : Vertical scaling factor (must be strictly positive)

void sf::Drawable::Rotate ( float  Angle  )  [inherited]

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

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