Snowflake v.0.1.5
Befehlsindex

Vorliegend ist eine Beschreibung der Befehle, die es in der Snowflake-GUI gibt.

Variablenliste

NextCtrl	Die Control-Nummer des nächsten Steuerelementes, das erstellt wird.

ActiveCtrl	Die Control-Nummer des aktivierten Steuerelementes.

DefaultCtrl	Falls Editboxen verwendet werden: die Control-Nummer des Buttons, der durch Drücken der Eingabe-Taste ausgelöst werden soll.

Focus	Nach GetInp/GetKey$: Gibt den Namen/die Caption des 
	Steuerelementes zurück, das der Benutzer ausgewählt hat.

Keyb	Nach GetInp/GetKey$: Gibt die Taste zurück, die der Benutzer zuletzt gedrückt hat.

Choice	Nach MenuInt$: Gibt die Auswahl zurück, die der Benutzer getätigt hat.

ShortKeys	Kommagetrennte Auflistung (String) von Tastencodes, die GetInp beenden. Die ShortKeys sind vor jeden Aufruf von GetInp zu setzen. Werden keine speziellen Kurztasten verwendet, soll ShortKeys vor dem Aufruf von GetInp auf "" gesetzt werden. Die Tastencodes lassen sich ermitteln, indem man in einem Snowflake-Textfeld die Taste drückt. Beispielsweise bedeutet der Tastencode #104 die Tastenkombination Alt + F1.

Beispiel

Das folgende Beispiel setzt das aktive Control auf den Button „Starten“ der als nächstes erstellt wird. Durch NextControl wird auf das nächste Control verwiesen, das erstellt wird. Der Button gehört zur Steuerelentegruppe „main“.

ActiveCtrl = NextCtrl
Button „main“, „Starten“, 50,50

AddIcon

Fügt ein Symbol zu einer Symbolliste hinzu. (Mit ->IconList erstellt man die Symbolliste)

sName$	Der Name der Symbolliste
Index	Der Index des Eintrages (erforderlich: muss grösser als 0 sein!)
	Wichtig: Es dürfen keine Lücken in der Indexfolge entstehen!
sIconFile 	Der Dateiname des Symbols
SDescription	Die Beschreibung des Symbols

SUB AddIcon (sName$, Index, sIconFile AS STRING, sDescription AS STRING)

Button

Erstellt ein Button-Steuerelement

sGroup$	Die Steuerelementgruppe
Caption$	Die Caption
x, y 	Die Koordinaten

SUB Button (sGroup$, caption$, x, y)

CheckBox

Erstellt ein Checkbox-Steuerelement.

sGroup$	Die Steuerelementegruppe 
Caption$	Die Caption
x, y	Die Koordinaten
value	Der Wert (True oder False)

SUB CheckBox (sGroup$, caption$, x, y, value)

CloseFrame

Schliesst einen Frame. Mit dem Schliessen des Frames werden alle Steuerelemente der angegebenen Steuerelementegruppe aus dem Speicher entfernt (ersetzt ClearCtrls). Zusätzlich wird mit CloseFrame der alte Bildschirminhalt wiederhergestellt, der vor dem Zeichnen des Frames vorhanden war.

sGroup$	Die Steuerelementegruppe ("" = alle), mit welcher der Frame erstellt wurde.

SUB CloseFrame(sGroup$)

ClearCtrls

Entfernt Steuerelemente aus dem Speicher 

sGroup$	Die Steuerelementegruppe ("" = alle) 

SUB ClearCtrls (sGroup$)

ClearList

 Löscht die Einträge einer beliebigen Liste (Symbolliste, Listbox, Ressource) 

sName$	Der Name der Liste

SUB ClearList (sName$)

CLW

Löscht den Bildschirm und zeichnet auf Wunsch die Exitbox und Uhr. Setzen Sie die Variable zShowTimeExitBox auf False (0), um die Zeit und ExitBox nicht anzuzeigen.

sGroup$	Die Steuerelementgruppe, zu dem die ExitBox gehören wird.

SUB CLW (sGroup$)

Dialog

Gibt eine Meldung auf dem Bildschirm aus, die der Benutzer mit OK bestätigen muss.

Text	Der auszugebende Text.

SUB Dialog (text AS STRING)

DrawCtrls

Zeichnet die Controls

sGroup$	Die Steuerelementgruppe ("" = alle)

SUB DrawCtrls(sGroup$)

Echo

Gibt ein Text auf dem Bildschirm aus. Berücksichtigt dabei die Bereichs-begrenzungen Left, Top, Right und Down, die zuvor durch einen Rahmen (Frame) gesetzt wurden.

SUB Echo (text AS STRING)

EchoXY

Schreibt einen Text ohne Berücksichtigung der Bereichsbegrenzungen und ohne Zeilenumbruch! Siehe auch ->Echo.

Text	Text
x, y	Die Position

SUB EchoXY (x, y, text AS STRING)

Editbox

Erstellt ein Editbox-Steuerelement

sGroup$	Die Steuerelementgruppe
sName$	Der Name der Editbox
x,y	Die Koordinaten
iAnzahlSpalten	Anzahl Spalten
iAnzahlZeilen	Anzahl Zeilen 
iMaxZeichen	Maximale Anzahl einzugebender Zeichen (0=höchstmögliches)

SUB Editbox (sGroup$, sName$, x, y, iAnzahlSpalten, iAnzahlZeilen, iMaxZeichen)

exists% Funktion

Prüft, ob eine MSDOS-Datei existiert.
Gibt TRUE zurück falls die Datei existiert, andernfalls FALSE.

FilePath$	Der MSDOS-Dateipfad

FUNCTION exists% (FilePath$)

ExitBox

Erstellt eine Exit-Box

sGroup$	Die Steuerelement-Gruppe
sName$	Der Name der Exit-Box
x,y	Die Position

SUB ExitBox (sGroup$, x, y)

Frame
 
Erstellt einen Bereichsrahmen (Register). Der Textbereich wird auf diesen Rahmen eingeschränkt.

sGroup$	Die Steuerelementgruppe, zu welcher der Rahmen gehören wird... Caption$	Die Bezeichnung des Rahmens
x1, y1, x2, y2	Die Koordinaten des Fensters

Tipp: Sie können die ersten vier Parameter auf 0 setzen, um ein Register für den ganzen Bildschirm zu machen.
Wichtig: Eine Exitbox wird automatisch erstellt, ausser wenn sGroup$ = ““; dann wird keine Exitbox erstellt.

SUB Frame (sGroup$, caption$, x1, y1, x2, y2)

FullScreen

Ermöglicht die Ausgabe von Text mit Echo im Vollbildschirm-Modus.
Führen Sie FullScreen aus, wenn Sie Text ausserhalb des zuletzt erstellten Rahmenfensters (Frame) ausgeben wollen.

SUB FullScreen

GetInp

Wartet auf Benutzereingaben unter berücksichtigung der LaOS-Steuerelemente

sGroup$	Die Steuerelement-Gruppe, welche explizit gehandelt werden soll
	"" = alle Steuerelemente
Wichtig: Nur Steuerelemente die zu dieser Gruppe gehören, sind aktivierbar.

SUB GetInp (sGroup$)

GetString

Liest einen String eines beliebigen Objektes aus (siehe auch ->PutString)

Objekt	Der Name des Objektes, dessen String herausgelesen werden soll
Text	Rückgabewert: Der String des Objektes

SUB GetString (objekt AS STRING, text AS STRING)

GetValue

Liest den Wert eines beliebigen Steuerelementes aus (siehe auch ->PutValue) 

Objekt	Der Name des Objektes, dessen Wert herausgelesen werden soll
Wert		Rückgabewert: 
	Der Wert des Steuerelementes 

SUB GetValue(objekt AS STRING, wert)

IconList

Erstellt ein Symbollisten-Steuerelement
Die Symbole werden mit AddIcon hinzugefügt.

sGroup$	Die Steuerelemente-Gruppe
sName$	Der Name der Symbolliste
Caption$	Die Überschrift der Symbolleiste
x,y,x2,y2		Die Position des Rahmens, innerhalb dessen sich die Symbole         befinden werden.
iScrollBars	True: Die Symbolliste wird mit Scrollbars und Rahmen angezeigt.
iExitBox	True: Exitbox wird angezeigt

SUB IconList (sGroup$, sName$, caption$, x, y, x2, y2, iScrollBars, iExitbox)

Label

Erstellt ein Text-Label

x,y,x2,y2	Der Bereich, innerhalb dessen der Text ausgegeben wird.
Text	Der auszugebende Text
Alignment	Ausrichtung des Textes (0 = links, 1 = Mitte, 2 = rechts) 
BgColor	Die Hintergrundfarbe des Labels

SUB Label (x, y, x2, y2, text AS STRING, Alignment, bgColor)

ListAdd

Füllt eine zuvor erstellte ListBox mit dem Text und dem Standardwert

sName$	Der Name der Listbox, der beim Erstellen der Listbox angegeben wurde Index	Der Index des Eintrages (erforderlich: muss grösser als 0 sein!)
  	Wichtig: Es dürfen keine Lücken in der Indexfolge entstehen! 
Text	Der Text
Value	Der Wert (True oder False)

SUB ListAdd (sName$, Index, text AS STRING, value)

ListBox

Erstellt ein Listbox-Steuerelement
Die Liste muss anschliessend mit ListAdd gefüllt werden.
Mit ListDeleteItem können Listeneinträge entfernt werden.

sGroup$	Die Steuerelementegruppe
sName$	Der Name der Listbox (wird für ListAdd und ListDeleteItem 
	verwendet) 
x, y, x2, y	Die Koordinaten der Listbox
WithCheckBoxes	True = Die Listbox wird mit Checkboxen angezeigt

SUB ListBox (sGroup$, sName$, x, y, x2, y2, WithCheckBoxes)

Main

In der Sub Main kannst du dein Programm hineinschreiben. Die Sub Main ist die Startprozedur jeder Snowflake-Anwendung!

SUB Main

Menu

Erstellt ein neuer Menu-Punkt

sGroup$	Die Steuerelement-Gruppe
Caption$	Die Caption des Menüs

SUB Menu (sGroup$, caption$)

MenuInt$ Funktion

Zeigt ein DropDown-Menü an für das aktivierte Menü-Steuerelement, oder, falls kein Menü aktiviert ist,
ein PopUp-Menü (Kontextmenü) an der aktuellen Mausposition.

Items	Die Einträge, getrennt mit einem beliebigen Zeichen
Trennzeichen$	Das Zeichen, das im Parameter Items für das Trennen der einzelnen Einträge verwendet wird.

Rückgabewert:	Der Eintrag, der angewählt wurde. Falls der Benutzer das Menü
	abgebrochen hat, wird "" zurückgegeben.

Tipp:	In der Variable Choice steht nach Aufruf von MenuInt$ die Nummer
	des vom Benutzer gewählten Eintrages.

FUNCTION MenuInt$ (Items AS STRING, Trennzeichen$)

MouseClicker

Erstellt ein MouseClicker-Steuerelement.
Wenn der Benutzer mit der Maus auf den Bereich des MouseClickers klickt, so wird GetInp beendet und der Focus ist auf den Namen dieses MouseClickers gesetzt. Wahlweise kann der MouseClicker visuell, das heisst mit Schatten, oder unsichtbar dargestellt werden.

sGroup$	Die Steuerelementgruppe
sName$	Der Name des Clickers 
x, y, x2, y2	Die Koordinaten
sSimulateKey	Die Taste, die zurückgegeben werden soll (keyb), wenn der Benutzer auf den Bereich klickt.
IWithShadow	Wenn True:
	Der Bereich wird schattiert, wenn der Benutzer auf
  	diesen klickt.

SUB MouseClicker (sGroup$, sName$, x, y, x2, y2, sSimulateKey AS STRING, iWithShadow)

ProgressBar

Zeigt eine Fortschrittsleiste an.

text$ 	Der Text, der angezeigt werden soll (nur beim ersten mal
	anzugeben, sonst flimmert der Bildschirm)
Stat	Der Status: Eine Fliesskomma-Zahl von 0 bis 1. 0 = 0% fertig,
	1 = 100% fertig.

SUB ProgressBar (text$, Stat AS SINGLE)

PutString

Speichert einen String zu einem beliebigen Objekt (siehe auch ->GetString)

Objekt	Der Name des Objektes
Text	Der Text

SUB PutString (objekt AS STRING, text AS STRING)

PutValue

Speichert einen Wert zu einem existierenden Steuerelement
(siehe auch ->GetValue)

objekt	Der Name des Objektes
wert	Der Wert, der dem Objekt zugewiesen werden soll.

SUB PutValue (objekt AS STRING, wert)

RadioButton

Erstellt ein RadioButton-Steuerelement

sGroup$	Die Steuerelementgruppe Caption$ = Die Caption
x, y	Die Koordinaten
value	Der Wert (True oder False)

SUB RadioButton (sGroup$, caption$, x, y, value)

RaisePopUpMenu

Wird ausgeführt, wenn auf einem unterstützten Steuerelement die rechte Maustaste gedrückt wurde.
Tipp: Mit ->MenuInt kann nun ein PopUpMenü angezeigt werden!

SUB RaisePopUpMenu (iCtrl)

RaiseScroll

Event: Wird ausgeführt, wenn der Benutzer mit der ScrollBar gescrollt hat. Für die ScrollBar und SliderBar-Controls

ICtrl	Die ControlNr der Scroll- oder Sliderbar 
name$	Der Name der Scroll- oder Sliderbar

SUB RaiseScroll (iCtrl, name$)

RaiseToolTipText

Wird ausgeführt, wenn die Maus auf einem Control ruht. Hier können Sie Tooltiptexte für ihre Controls erfassen! iCtrl Die ControlNr, des Controls, auf dessen die Maus ruht.

SUB RaiseToolTipText (iCtrl)

RestoreScreen

Holt den im ruhigen Bildaufbaumodus aufgebaute Bildschirm in den Vordergrund. Das Bild wird dadurch angezeigt.
Verwenden Sie SilentScreen, um den ruhigen Bildaufbaumodus zu aktivieren. ->SilentScreen

SUB RestoreScreen

SaveScreen

Speichert den aktuellen Bildschirminhalt ab, um ihn danach mit ->RestoreScreen wieder anzeigen zu können. Verwenden Sie diesen Befehl,
 wenn Sie Aufgaben erledigen wollen und später wieder zum ursprünglichen Bildschirm zurückwechseln wollen.

SUB SaveScreen

ScrollBar

Erstellt ein Scrollbar-Steuerelement

sGroup$	die Steuerelementgruppe 
sName$	Der Name der Scrollbar 
x,y	Die Koordinaten
w	Die Breite der Scrollbar (Width)
•	oder – 
h	Die Höhe der Scrollbar (Height) 
Min	Das Minimum des Scrollbar-Wertes
Max	Das Maximum des Scrollbar-Wertes
stp	Der Schritt: Die Grösse einer Bewegung der Scrollbar...
iCtrl	Die ControlNr des Controls, auf dieses sich die Scrollbar bezieht. 

Wichtig: Nur entweder w oder h auf einen Wert höher 0 setzen! Je nach dem, welcher Wert angegeben ist, so wird die Scrollbar
vertikal oder horizontal angezeigt.

SUB ScrollBar (sGroup$, sName$, x, y, w, h, Min, Max, stp, iCtrl)

ShortCut

Erstellt einen Shortcut. Wenn der Benutzer diese Kurztaste drückt,
wird GetInp beendet.

sGroup$	Die Steuerelementgruppe
skey$	Die Taste
iCtrl	Das Control, an dies der Shortcut gebunden ist. (0 = ungebunden)
 
SUB ShortCut (sGroup$, skey$, iCtrl)

ShowPicture

Zeigt ein beliebiges Bild an.
Unterstützt werden die folgenden Formate:

*.LDS (LaOS Draw Script)
*.LSB (LaOS LDS Symbole)
*.AGI (Agi Bitmap)
 
xx,yy	Die Koordinaten geben an, wo das Bild gezeichnet wird. 
SFileName	Der Dateiname der Grafik

SUB ShowPicture (xx, yy, sFileName AS STRING)

SilentScreen

Schaltet in den ruhigen Bildaufbaumodus.
Kann dazu verwendet werden, den Grafikaufbau im Hintergrund durchzuführen. Der Benutzer kann dann dem Aufbau nicht mehr zusehen. Um die aufgebaute Grafik schlussendlich anzuzeigen, verwenden Sie bitte ->RestoreScreen

SUB SilentScreen

StatusBar

Zeigt ein Statustext in der Statusbar an

Text$	Der Text der angezeigt werden soll.

SUB StatusBar (text$)

TimeLock

Zeigt die Festplatte auf dem Bildschirm an, damit der Benutzer weiss, dass gearbeitet wird.

Modus:
1	beschäftigt
2	unbeschäftigt

SUB TimeLock (Modus)

zReplace

Ersetzt im text$ den Ausdruck find$ durch den Ausdruck replce$

SUB zReplace (text$, find$, replce$)

zSetMouseCursor

Legt die Datei für den zukünftigen Mousecursor fest.

sCursor$	Der Cursor der Maus (*.cur-Datei im LaOS-Hauptverzeichnis) 

Wichtig: Ein Mauscursor hat folgende Abmessung: Maximal 15*24 Pixels

SUB zSetMouseCursor (sCursor$)

zSetOrigPalette

Setzt die originale Farbpalette.

SUB zSetOrigPalette

zToolTipText 

Ruft ein Tooltiptext auf
Text$	Der Text, der erscheinen soll...

Tipp: In der SUB RaiseToolTipText kann für ihre Controls ein Tooltiptext hinzugefügt werden.

SUB zToolTipText (text$)