Universal Bible API 1.0.2011.1274

UniversalBibleAPI.IBibleModul Interface Reference

Interface, welches alle konkreten Universal Bible API Module implementieren müssen. More...

Inheritance diagram for UniversalBibleAPI.IBibleModul:
UniversalBibleAPI.OsisBible UniversalBibleAPI.SwordBible UniversalBibleAPI.VplBible UniversalBibleAPI.ZefaniaBible

List of all members.

Public Member Functions

void Connect (string PathToBibleModul)
 
Parameters:
PathToBibleModulEin Datei zur Moduldatei

bool HasVersRef (string SingleVersRef)
 Bestimmt, ob das Modul einen bestimmten Vers enthält.
void ParseQuery (string BibleQuery)
 
Parameters:
BibleQueryEine Bibelabfrage wie Gen 1,1-5; Mat 2,2

void NextVerse ()
 Liefert den naechsten Vers des Module dabei werden Kapitel und Buchgrenzen des Modules beachtet.
void PreviousVerse ()
 Liefert den vorherigen Vers des Modules dabei werden Kapitel und Buchgrenzen des Modules beachtet.
void NextChapter ()
 Liefert die Verse des naechsten Kapitels.
void PreviousChapter ()
 Liefert die Verse des vorherigen Kapitels unter Beachtung der Buchgrenzen.
void NextBook ()
 Liefert die Verse des ersten verfuegbaren Kapitels des naechsten Buches.
void PreviousBook ()
 Liefert die Verse des ersten verfuegbaren Kapitels des vorherigen Buches.
bool IsOnEnd ()
 Das Module ist am Ende angelangt.
bool IsOnStart ()
 Das Modul ist am Anfang.
List< CurrentContentKeyGetAllVerses ()
 Liefert alle Verse des Modules zurück.
void ConvertTo (IBibleModul ModulToConvert)
 Konvertiert ein übergebenes IBibleModul.

Properties

IFilter MyFilter [get, set]
 Setz den Filter fuer das Modul.
string ModuleName [get, set]
 Setzt und liest den Namen des Modules.
string ModulePath [get]
 Gibt den Pfad zum Modul zurück.

Events

EventHandler
< ModulConnectedEventArgs
OnConnected
 Dieses Ereignis wird ausgelöst, wenn das Modul für Abfragen seines Inhaltes initialisiert ist.
EventHandler< ParseEventArgsOnQueryFinished

Detailed Description

Interface, welches alle konkreten Universal Bible API Module implementieren müssen.

Definition at line 82 of file IBibleModul.cs.


Member Function Documentation

void UniversalBibleAPI.IBibleModul.Connect ( string  PathToBibleModul)

Parameters:
PathToBibleModulEin Datei zur Moduldatei

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

void UniversalBibleAPI.IBibleModul.ConvertTo ( IBibleModul  ModulToConvert)

Konvertiert ein übergebenes IBibleModul.

Parameters:
ModulToConvertDas Modul, welches konvertiert werden soll.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

List<CurrentContentKey> UniversalBibleAPI.IBibleModul.GetAllVerses ( )

Liefert alle Verse des Modules zurück.

Returns:
Liste der Vers ContentKeys

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

bool UniversalBibleAPI.IBibleModul.HasVersRef ( string  SingleVersRef)

Bestimmt, ob das Modul einen bestimmten Vers enthält.

Parameters:
SingleVersDer Vers z.B. Offb 2,5
Returns:
true wenn der Vers im Modul enthalten ist; andernfalls, false.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

bool UniversalBibleAPI.IBibleModul.IsOnEnd ( )

Das Module ist am Ende angelangt.

Returns:
true, wenn der letzte Vers erreicht ist

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

bool UniversalBibleAPI.IBibleModul.IsOnStart ( )

Das Modul ist am Anfang.

Returns:
true, wenn der erste Vers erreicht ist

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

void UniversalBibleAPI.IBibleModul.NextBook ( )

Liefert die Verse des ersten verfuegbaren Kapitels des naechsten Buches.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

void UniversalBibleAPI.IBibleModul.NextChapter ( )
void UniversalBibleAPI.IBibleModul.NextVerse ( )

Liefert den naechsten Vers des Module dabei werden Kapitel und Buchgrenzen des Modules beachtet.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

void UniversalBibleAPI.IBibleModul.ParseQuery ( string  BibleQuery)

Parameters:
BibleQueryEine Bibelabfrage wie Gen 1,1-5; Mat 2,2

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

void UniversalBibleAPI.IBibleModul.PreviousBook ( )

Liefert die Verse des ersten verfuegbaren Kapitels des vorherigen Buches.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

void UniversalBibleAPI.IBibleModul.PreviousChapter ( )

Liefert die Verse des vorherigen Kapitels unter Beachtung der Buchgrenzen.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

void UniversalBibleAPI.IBibleModul.PreviousVerse ( )

Liefert den vorherigen Vers des Modules dabei werden Kapitel und Buchgrenzen des Modules beachtet.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.


Property Documentation

string UniversalBibleAPI.IBibleModul.ModuleName [get, set]

Setzt und liest den Namen des Modules.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

Definition at line 150 of file IBibleModul.cs.

string UniversalBibleAPI.IBibleModul.ModulePath [get]

Gibt den Pfad zum Modul zurück.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

Definition at line 154 of file IBibleModul.cs.

IFilter UniversalBibleAPI.IBibleModul.MyFilter [get, set]

Setz den Filter fuer das Modul.

Ein Filter zur Bearbeitung des Textinhaltes.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

Definition at line 98 of file IBibleModul.cs.


Event Documentation

EventHandler<ModulConnectedEventArgs> UniversalBibleAPI.IBibleModul.OnConnected

Dieses Ereignis wird ausgelöst, wenn das Modul für Abfragen seines Inhaltes initialisiert ist.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

Definition at line 88 of file IBibleModul.cs.

EventHandler<ParseEventArgs> UniversalBibleAPI.IBibleModul.OnQueryFinished

Diese Ereignis wird bei beendeter Abfrage ausgelöst und liefert eine Liste mit den Contentkeys zurück, welche die Anwendung zur Darstellung des Ergebnises verwenden kann.

Implemented in UniversalBibleAPI.OsisBible, UniversalBibleAPI.SwordBible, UniversalBibleAPI.VplBible, and UniversalBibleAPI.ZefaniaBible.

Definition at line 93 of file IBibleModul.cs.


The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Enumerations Properties Events