Siegfried Locale Library Entwicklerhandbuch

Kurzreferenz

Alphabetisch sortierte Kurzreferenz aller sfliblocale.so Libraryfunktionen.

AppID()

Kennung der Texte für Anwendung ermitteln.
Aufruf: const char *add_id;
app_id = AppID();
Parameter: -
Returns: app_id Zeiger auf Kennung.
Bemerkung: Jede Anwendung vergibt eine Kennung die in allen Sprachdateien der Anwendung gespeichert wird. Damit kann sichergestellt werden das nur die Sprachdateien geladen werden die auch zu der Anwendung gehören.

GetInstance()

Zugriff auf "locale"/Text-Daten ermöglichen.
Aufruf: SFLocale *lang;
lang = SFLocale::GetInstance();
Parameter: -
Returns: lang Zeiger auf Instanz der Klasse SFLocale.
Bemerkung: Während des kompletten Laufs einer Anwendung wird immer mit derselben Instanz gearbeitet. Die Klasse SFLocale erzeugt immer nur genau eine Instanz der Klasse (sog. Singelton Entwurfsmuster).

Language()

Sprache ermitteln; Landeskennung (Name) der aktuelle geladenen Sprache ermitteln.
Aufruf: const char *land;
land = Language();
Parameter: -
Returns: land Zeiger auf Länderkennung (z.B. "Deutsch", "English")
Bemerkung: -

SetAppID(const char *app_id)

Identifizierungskennung für Sprachdateien setzen.
Aufruf: const char *app_id = "siegfried backup locale";
SetAppID(app_id);
Parameter: app_id Zeiger auf Kennung
Returns: -
Bemerkung: Jede Anwendung vergibt eine Kennung die in allen Sprachdateien der Anwendung gespeichert wird. Damit kann sichergestellt werden das nur die Sprachdateien geladen werden die auch zu der Anwendung gehören. Die Kennung wird an sinnvollsten beim Start der Anwendung gesetzt (auf jeden Fall vor SetLanguage). Die Kennung wird beim Laden von Sprachdaten (SetLanguage) ausgewertet. Stimmt beim Laden von Sprachdateien die ID der Sprachdatei und die gesetzte nicht überein, wird die Datei zurückgewiesen.

SetDefaultText(const char *mText[], int32 n, const char *name)

Vorgabetext und -sprache setzen.
Aufruf: const char *mText[SF_LAST_ID] = { ...};
inst32 n = SF_LAST_ID;
const char *name = "English";
SetDefaultText(mText, n, name);
Parameter: mText Tabelle mit Vorgabetexten
n Anzahl der Tabellenzeilen
name Name der Sprache
Returns: -
Bemerkung: -

SetLanguage(BDirectory *folder, const char *language)

Sprache setzen. Text für die jeweilige Sprache laden.
Aufruf: BDirectory *folder = new BDirectory(...);
const char *language = "Deutsch";
long ret;
ret = SetLanguage(folder, language);
Parameter: folder Zeiger auf das Verzeichnis in dem sich die Sprachdateien befinden.
language Name bzw. Attribut ("sf:language") der Sprache.
Returns: ret 0 = alles OK
1 = Fehler: Datei konnte nicht gelesen werden
2 = Fehler: keine Sprachdatei
3 = Fehler: falsche Sprachdatei (AppID nicht korrekt)
4 = Fehler: Datei enthält keine Länderkennung
5 = Fehler: ungültiges Verzeichnis
Bemerkung: -

SetLanguage(BEntry *folder, const char *language)

Sprache setzen. Text für die jeweilige Sprache laden.
Aufruf: BEntry *folder = new BEntry(...);
const char *language = "Deutsch";
long ret;
ret = SetLanguage(folder, language);
Parameter: folder Zeiger auf das Verzeichnis in dem sich die Sprachdateien befinden.
language Name bzw. Attribut ("sf:language") der Sprache.
Returns: ret 0 = alles OK
1 = Fehler: Datei konnte nicht gelesen werden
2 = Fehler: keine Sprachdatei
3 = Fehler: falsche Sprachdatei (AppID nicht korrekt)
4 = Fehler: Datei enthält keine Länderkennung
5 = Fehler: ungültiges Verzeichnis
Bemerkung: -

SetLanguage(BPath *folder, const char *language)

Sprache setzen. Text für die jeweilige Sprache laden.
Aufruf: BPath *folder = new BPath(...);
const char *language = "Deutsch";
long ret;
ret = SetLanguage(folder, language);
Parameter: folder Zeiger auf das Verzeichnis in dem sich die Sprachdateien befinden.
language Name bzw. Attribut ("sf:language") der Sprache.
Returns: ret 0 = alles OK
1 = Fehler: Datei konnte nicht gelesen werden
2 = Fehler: keine Sprachdatei
3 = Fehler: falsche Sprachdatei (AppID nicht korrekt)
4 = Fehler: Datei enthält keine Länderkennung
5 = Fehler: ungültiges Verzeichnis
Bemerkung: -

SetLanguage(const char *folder, const char *language)

Sprache setzen. Text für die jeweilige Sprache laden.
Aufruf: const char *folder = "...";
const char *language = "Deutsch";
long ret;
ret = SetLanguage(folder, language);
Parameter: folder Zeiger auf das Verzeichnis in dem sich die Sprachdateien befinden.
language Name bzw. Attribut ("sf:language") der Sprache.
Returns: ret 0 = alles OK
1 = Fehler: Datei konnte nicht gelesen werden
2 = Fehler: keine Sprachdatei
3 = Fehler: falsche Sprachdatei (AppID nicht korrekt)
4 = Fehler: Datei enthält keine Länderkennung
5 = Fehler: ungültiges Verzeichnis
Bemerkung: -

SetLanguage(entry_ref *folder, const char *language)

Sprache setzen. Text für die jeweilige Sprache laden.
Aufruf: entry_ref *folder = ...;
const char *language = "Deutsch";
long ret;
ret = SetLanguage(folder, language);
Parameter: folder Zeiger auf das Verzeichnis in dem sich die Sprachdateien befinden.
language Name bzw. Attribut ("sf:language") der Sprache.
Returns: ret 0 = alles OK
1 = Fehler: Datei konnte nicht gelesen werden
2 = Fehler: keine Sprachdatei
3 = Fehler: falsche Sprachdatei (AppID nicht korrekt)
4 = Fehler: Datei enthält keine Länderkennung
5 = Fehler: ungültiges Verzeichnis
Bemerkung: -

Text(int32 id)

Text aus ID-Nummer ermitteln.
Aufruf: const char *text;
int32 id = SF_OK;
text = Text(id);
Parameter: id Identifikationsnummer des Text. (0 <= id < SF_LAST_ID)
Returns: text Zeiger auf gewünschten Text.
NULL, wenn Text nicht vorhanden ist.
Bemerkung: Ist die ID nicht vorhanden wird versucht den Text aus dem Vorgabetext (mit SetDefaultText gesetzt) zu ermitteln. Schlägt auch dies fehl wird NULL zurückgeliefert.