summaryrefslogtreecommitdiff
path: root/simplegui.mod/doc/commands.html
diff options
context:
space:
mode:
Diffstat (limited to 'simplegui.mod/doc/commands.html')
-rw-r--r--simplegui.mod/doc/commands.html9
1 files changed, 6 insertions, 3 deletions
diff --git a/simplegui.mod/doc/commands.html b/simplegui.mod/doc/commands.html
index c66334a..56b78b5 100644
--- a/simplegui.mod/doc/commands.html
+++ b/simplegui.mod/doc/commands.html
@@ -6,11 +6,12 @@
<body>
<h1>Function Reference</h1>
<p><div id=GUINotify class=ref>
-<div class=rootdoc><font class=token>Function GUINotify( s:String )</font> Displays a notification alert with the supplied string.</div><div class=indent></div><br></div><br>
+<div class=rootdoc><font class=token>Function GUINotify( s:String, i:TImage=Null )</font> Displays a notification alert with the supplied string.</div><div class=indent><p>The string <b>s</b> can be split into multiple lines using the '|' character. If <b>i</b> is not null then this image is drawn as a mouse cursor.</div><br></div><br>
<p><div id=GUIYesNo class=ref>
-<div class=rootdoc><font class=token>Function GUIYesNo:Int( s:String )</font> Displays a yes/no alert with the supplied string.</div><div class=indent><p><b>Returns:</b> True if Yes selected, otherwise False.</div><br></div><br>
+<div class=rootdoc><font class=token>Function GUIYesNo:Int( s:String, i:TImage=Null )</font> Displays a yes/no alert with the supplied string.</div><div class=indent><p><b>Returns:</b> True if Yes selected, otherwise False.<p>The string <b>s</b> can be split into multiple lines using the '|' character. If <b>i</b> is not null then this image is drawn as a mouse cursor.</div><br></div><br>
<p><div id=GUIMenu class=ref>
-<div class=rootdoc><font class=token>Function GUIMenu( title:String, options:String[],x,y )</font> Displays a pop-up menu.</div><div class=indent><p><b>Returns:</b> The index of the selected option, -1 for none.<p><b>title</b> is the menu title, <b>options</b> the options to display and <b>x</b> and <b>y</b> specify its position,.</div><br></div><br>
+<div class=rootdoc><font class=token>Function GUIMenu( title:String, options:String[], x:Int, y:Int, i:TImage=Null )</font> Displays a pop-up menu.</div><div class=indent><p><b>Returns:</b> The index of the selected option, -1 for none.<p><b>title</b> is the menu title, <b>options</b> the options to display and <b>x</b> and <b>y</b> specify its position.
+If <b>i</b> is not null then this image is drawn as a mouse cursor.</div><br></div><br>
<h1>Type Reference</h1>
<p><div id=TGUIFont class=ref>
<div class=rootdoc><font class=token>Type TGUIFont</font> Defines the <b>TBitmapFont</b> to be used by the GUI.</div><div class=indent></div><br><p><div id=font>
@@ -83,6 +84,8 @@
<div class=rootdoc><font class=token>Method Register( w:TWidget )</font> Register a widget.</div><div class=indent><p>Widgets call this themselves.</div><br></div><br>
<p><div id=Clear>
<div class=rootdoc><font class=token>Method Clear()</font> Remove all widgets.</div><div class=indent></div><br></div><br>
+<p><div id=SetEnable>
+<div class=rootdoc><font class=token>Method SetEnable( state:Int )</font> Sets the enable state of all widgets.</div><div class=indent><p>If <b>state</b> is true then all widgets are enabled, otherwise all widgets are disabled</div><br></div><br>
<p><div id=SetFocus>
<div class=rootdoc><font class=token>Method SetFocus( w:TWidget )</font> Sets the keyboard focus to the supplied widget. Pass null for no focus.</div><div class=indent></div><br></div><br>
<p><div id=GetFocus>