getObject.de
goConfig-Heimdall-der-Konfigurator

API

Heimdall goConfig - Basic Extension für Libre Office

Module in goConfig

Modul _Info

Enthält Projektinformationen, öffentliche Variablen und Konstanten.

Klassenmodul CfGResolver

Sprachpaket Multinational. Liefert Texte und Substitutionswerte.

Klassenmodul CfGProvider

Der Konfiguratoranbieter

Klassenmodul CfgSupplier

Verwaltet die Konfigurationsvariablen

Modul Configurator

Dialoginterface des Konfigurators

Modul Dialoge

Allgemeine Routinen der Dialogerzeugung

Modul Platform

Bietet Platforminformationen wie Betriebssystem, Dateipfadseparator etc.

Modul Services

Bietet verschieden Services wie Filepicker etc.

Modul Session

Liefert Sessioninformationen wie Username, und Libre Office Pfadangaben

stdFiles

Dateiverwalter

Modul _Info

Die Variablen haben allgemeine Gültigkeit und werden von mehreren Modulen genutzt .


Variablen / Konstanten

Public ConfiguratorActionSupport as Boolean

Steuert den Konfigurationsvorgang.

TRUE = Speichert die Variablen
FALSE = Lädt die Variablen

Public Dirsep as String

Dirseparator

Klassenmodul CfGResolver

Variablen / Konstanten

Const fn = "constants"

Festgelegter Dateiname ohne Dateiendung. Standard Datei der Konstanten ist "constants.goc". Die jeweiligen Spracherweiterungen erhalten als Dateiendung die des Länderkürzels.

Const pn = "config"

Festgelegter Dateipfadzusatz

Property Path

Dateipfad der Extension

Funktionen

getSubstitutionsValue( VALUENAME as String  , optional CAPTURE as String )

Name der Substitutionsvariablen, es kann ein Kapitel mit übergeben werden.

getResText(VALUENAME as String )

Liefert einen vordefinierten Text in der Standardsprache. Reservierte Wörter werden substituiert geliefert.

setResWord (VALUENAME as String , VALUE as String )

Setzt den Wert eines reservierten Wortes neu.

Klassenmodul CfGProvider

Der CfGProvider ist das Hauptbindeglied zwischen dem Konfigurator und dem Anwender. Er bildet die Brücke zu den Variablen der externen Datei.

Variablen/Konstanten


Public Const _On = 2

Schalter Create Modus on

Public Const _Out = 1

Schalter Create Modus out

Property File

Dateiname der User Konfigurationsdatei

Property Path

Pfad zur User Konfigurationsdatei

Property Pathdelimeter

Dateipfad Delimeter (Systemabhängig)

Property Dirseparator

Enthält den Dateipfadseparator (Systembedingt)

Property UserProfile

Enthältden Pfad der persönlichen Einstellungen

Property Lang

Enthält die von Libre Office gelieferte Standardsprache

Funktionen


doinit ( VALUENAME as String , VALUE as Variant)

VALUENAME = Der Name der Variablen die in der Konfigurationsdatei gespeichert ist oder wird.

VALUE = Die Variable selbst.

Rückgabe = Value

execute()

Startet Heimdall

dispose()

Setzt Heimdall zurück

getUserFolder()

Liefert den eindeutigen UserFolder. Der besteht aus dem UserProfile und dem AppName, so werden Kollisionen vermieden.

getPathByIdentifier ( IDENT as String)

Liefert den Pfad der Extension, die mit dem Bezeichner IDENT regisitriert ist.

getFolderPicker()

Liefert den Pfad des FolderPicker

getFilePicker()

Liefert den Dateinamen des FilePickers

getRegisterContent ( NODE as String , PROPNAME as String)

Liefert den Wert des Knotens aus der Libre Office Konfiguration. more

' Example1 zeigt das Standardkonstrukt der Initialisierungs-
' routine und die Behandlung der ausgelagerten Variablen.
' Heimdall erkennt um welchen Variablentyp es sich handelt.
' Der Provider (Heimdall) wird einmal vor, und einmal nach
' der Initialisierung ausgeführt.
'--------------------------------------------
Sub Example1( )
Dim oCfg As Object                        'Konfiguratorobjekt
Dim myPathName As String            'Komplette Pfadangabe
'--------------------------------------------
'Start

oCfg = CreateHeimdallConfigurator            'Provider erstellen


myPathName = oCfg.UserProfile                 'User Dateipfad
'--------------------------------------------
' Zur Identifizierung sollte die Datei in einem
' Ordner abgelegt werden, der eindeutig ist. Das kann der
' Name Ihrer Bibliothek, Makro oder Extension sein.
'--------------------------------------------
myPathName = myPathName & "\myExtension"
oCfg.path = myPathName
oCfg.File = "config.ini"

oCfg.execute()                ' 1. Start von Heimdall, lädt die Variablen

'----------------------------------------
'Hier werden Ihre Variablen initalisiert

Backgroundcolor = ocfg.doinit("Backgroundcolor" ,Backgroundcolor )
fontname             = ocfg.doinit("Fontname", fontname )
counter                = ocfg.doinit("Counter" , counter )
minimalversion    = ocfg.doinit("Minimalversion" ,minimalversion )


ocfg.execute()                ' 2. Start von Heimdall, speichert die Variablen


End Sub