SColorMap

Hilfsklasse zur Umwandlung von Farben in SStrings und umgekehrt. [Mehr ...]

Vererbung

Basisklassen(n)   abgeleitete Klassen
  SMapStringToNum
SColorMap  

Attribute

 

Operationen

public:

Name Parameter Rückgabewert Beschreibung
init void Lädt die 16 Grundfarben in die Map.
rgbFromHtmlString const SString& htmlText COLORREF Wandelt einen HTML-Farbstring (#RRGGBB) in den zugehörigen Farbwert um.
rgbFromName const SString& name COLORREF Wandelt einen Farbnamen in den zugehörigen Wert um.
rgbFromParameterString const SString& parameter,
const SString& trennzeichen=",
"
COLORREF Wandelt eine Zeichenkette der Form RRR,GGG,BBB in den zugehörigen Farbwert um.
rgbFromString const SString& text COLORREF Wandelt eine Zeichenkette in den zugehörigen Farbwert um.
rgbToHtml int rgb SString Wandelt einen Farbwert in einen HTML-Farbstring um.

Detailbeschreibung SColorMap

Hilfsklasse zur Umwandlung von Farben in SStrings und umgekehrt.


Von dieser Klasse existiert ein globales Objekt 'globalColorMap' das an jeder Stelle einer SVL-Anwendung benutzt werden kann.
Das Objekt wird mit den 16 Standardfarben vorinitialisiert. Erweiterungen der bekannten Farbnamen sind möglich. Sie können einfach mit 'add(..)' in die Map aufgenomen werden. Dabei ist zu beachten, das jeder Farbname durch ',' eingeschlossen ist z.B.: add(",black,schwarz,noir,",RGB(0,0,0)). Jeder Farbe können mehrere Farbnamen zugewiesen werden. Bei Doppelt vergebenen Farbnamen wird immer der zuerst erfasste verwendet. Das obige Beispiel kann natürlich auch auf 3 Einträge verteilt werden.

Funktionsbeschreibungen

init() void

Lädt die 16 Grundfarben in die Map.

Alle vorher vorhandenen Einträge werden entfernt.

rgbFromHtmlString(const SString& htmlText) COLORREF

Wandelt einen HTML-Farbstring (#RRGGBB) in den zugehörigen Farbwert um.

Parameter:

htmlText HTML-Farbstring

Rückgabe:

COLORREF Farbwert der Zeichenkette

rgbFromName(const SString& name) COLORREF

Wandelt einen Farbnamen in den zugehörigen Wert um.

Parameter:

name Farbname

Rückgabe:

COLORREF Farbwert

rgbFromParameterString(const SString& parameter, const SString& trennzeichen=",") COLORREF

Wandelt eine Zeichenkette der Form RRR,GGG,BBB in den zugehörigen Farbwert um.

Bei der Angabe der Farben nach dem RGB-Schema sind Zahlenwerte von 0 bis 255 gültig.

Parameter:

parameter Zeichenkette, die den Farbwert als RGB-Schema enthält.
trennzeichen Das Trennzeichen zwischen den drei Werten (auch mehrere Zeichen möglich).

Rückgabe:

COLORREF Farbwert der Zeichenkette

rgbFromString(const SString& text) COLORREF

Wandelt eine Zeichenkette in den zugehörigen Farbwert um.

Diese Funktion sollt in jedem Fall zur Umwandlung herangezogen werden.
Es werden je nach dem 1. Zeichen die Funktionen rgbFromName(), rgb FromParameterString() oder rgbFromHtmlString() verwendet.

Parameter:

text umzuwandelnde Zeichenkette

Rückgabe:

COLORREF Farbwert der Zeichenkette oder SDEV_NOCOLOR im Fehlerfall.

rgbToHtml(int rgb) SString

Wandelt einen Farbwert in einen HTML-Farbstring um.

Parameter:

rgb Farbwert

Rückgabe:

SString HTML-Farbstring