OldSchoolHack GUI
Öffentliche Methoden | Aufstellung aller Elemente
OSHGui::Misc::TextHelper Klassenreferenz

Öffentliche Methoden

 TextHelper (const std::shared_ptr< Drawing::IFont > &font)
 
void SetFont (const std::shared_ptr< Drawing::IFont > &font)
 
void SetText (const AnsiString &text)
 
void Append (const AnsiChar character)
 
void Append (const AnsiString &text)
 
void Insert (int position, const AnsiChar character)
 
void Insert (int position, const AnsiString &text)
 
void Clear ()
 
void Remove (int index, int length=1)
 
int GetLength () const
 
const AnsiString & GetText () const
 
const Drawing::SizeGetSize () const
 
void RefreshSize ()
 
Drawing::Point GetCharacterPosition (int index, bool trailing=false) const
 
Drawing::Size GetStringWidth (int index, int size=-1) const
 
int GetClosestCharacterIndex (const Drawing::Point &position) const
 

Ausführliche Beschreibung

Verwaltet eine Zeichenkette und deren Ausmaße.

Beschreibung der Konstruktoren und Destruktoren

OSHGui::Misc::TextHelper::TextHelper ( const std::shared_ptr< Drawing::IFont > &  font)

Erstellt ein TextHelper-Objekt mit der entsprechenden Schriftart.

Parameter
font

Dokumentation der Elementfunktionen

void OSHGui::Misc::TextHelper::Append ( const AnsiChar  character)

Hängt das Zeichen an den Text an.

Parameter
character
void OSHGui::Misc::TextHelper::Append ( const AnsiString &  text)

Hängt die Zeichenkette an den Text an.

Parameter
text
void OSHGui::Misc::TextHelper::Clear ( )

Löscht den kompletten Text.

Drawing::Point OSHGui::Misc::TextHelper::GetCharacterPosition ( int  index,
bool  trailing = false 
) const

Gibt die Position des Zeichens an der entsprechenden Stelle zurück.

Parameter
index
trailinglinker Rand des Zeichens / rechter Rand des Zeichens
Rückgabe
position
int OSHGui::Misc::TextHelper::GetClosestCharacterIndex ( const Drawing::Point position) const

Gibt den Index des Zeichens zurück, das der Position am nächsten steht.

Parameter
position
Rückgabe
index
int OSHGui::Misc::TextHelper::GetLength ( ) const

Ruft die Länge der Zeichenkette ab.

Rückgabe
length
const Drawing::Size & OSHGui::Misc::TextHelper::GetSize ( ) const

Ruft die Maße der Zeichenkette in Pixel ab.

Rückgabe
size
Drawing::Size OSHGui::Misc::TextHelper::GetStringWidth ( int  index,
int  size = -1 
) const

Gibt die Weite eines Teilstrings zurück.

Parameter
indexder Startindex
sizedie Länge der Zeichenkette. -1 = bis zum Ende (default: -1)
Rückgabe
die Größe
const AnsiString & OSHGui::Misc::TextHelper::GetText ( ) const

Ruft die Zeichenkette ab.

Rückgabe
text
void OSHGui::Misc::TextHelper::Insert ( int  position,
const AnsiChar  character 
)

Fügt das Zeichen an der entsprechenden Position im Text ein.

Parameter
position
character
void OSHGui::Misc::TextHelper::Insert ( int  position,
const AnsiString &  text 
)

Fügt die Zeichenkette an der entsprechenden Position im Text ein.

Parameter
position
text
void OSHGui::Misc::TextHelper::RefreshSize ( )

Berechnet die Maße neu.

void OSHGui::Misc::TextHelper::Remove ( int  index,
int  length = 1 
)

Löscht das Zeichen an der entsprechenden Stelle.

Parameter
indexdie Stelle ab der gelöscht werden soll
lengthAnzahl der zu löschenden Zeichen (default: 1)
void OSHGui::Misc::TextHelper::SetFont ( const std::shared_ptr< Drawing::IFont > &  font)

Legt die Schriftart fest.

Parameter
fontdarf nicht 0 sein
void OSHGui::Misc::TextHelper::SetText ( const AnsiString &  text)

Legt den Text fest.

Parameter
text