Functions |
Functions that create objects | ||||
Button | Checkmark | Label | MakeObj | |
MenuItem | NewObj | String | Text | |
ToggleButton | XNewObj | |||
Functions that create spacing objects | ||||
HBar | HFSpace | HSpace | HVSpace | |
HWSpace | VBar | VFSpace | VSpace | |
VWSpace | ||||
Functions that manipulate objects | ||||
Add | AppMessage | AppPushID | CoerceMethod | |
DandD | Dispose | DoMethod | GetAttr | |
Handle | KillNotify | MultiGetAttr | MultiSetAttr | |
NewHandle | Notify | PushMethod | Remove | |
Set | SetAttr | SetAttrs | SetClassAttrs | |
xget | ||||
Various | ||||
Child | MUIRequest | ParseText | RxMUIGetVar | |
RxMUISetVar | SetRxMUIStack | StripText | ||
Debug | ||||
GetRxMUIString | Help | RxMUIObjExists | RxMUIObjList | |
RxMUIOpt | ||||
Add |
||||||||||||||||
Adds an object. | ||||||||||||||||
Synopsis | ||||||||||||||||
res = Add(parent,child,before) <parent/V>,<child/V>,[pred/V] |
||||||||||||||||
Function | ||||||||||||||||
Adds child to parent. The rules are:
|
||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
||||||||||||||||
See | ||||||||||||||||
Remove() | ||||||||||||||||
Example | ||||||||||||||||
call DoMethod("group","InitChange") call Remove("old_obj") call Add("group","new_obj") call DoMethod("group","ExitChange") |
Index |
AppMessage |
||||||||||||||||
Instructs RxMUI to receive APPEVENT. | ||||||||||||||||
Synopsis | ||||||||||||||||
res = AppMessage(obj) <obj/V> |
||||||||||||||||
Function | ||||||||||||||||
Tells RxMUI you want to receive APPEVENT when an icon is dropped into obj. The rules are:
|
||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
||||||||||||||||
See | ||||||||||||||||
Object handling |
Index |
AppPushId |
||||||||||||
Returns an export key. | ||||||||||||
Synopsis | ||||||||||||
res = AppPushID(app) <app/V> |
||||||||||||
Function | ||||||||||||
This function returns a key ID to be used with PushMethod(). You pass it the name of an Application object and it will return a key string ID that can be exported to another ARexx macros and used with PushMethod(). The result is NOT of your interest: the only thing you can do is to match it with Null() to see if the function failed (may fail iff its argument is not an application). This is the mechanism used to control a RxMUI object outside the macro where it was created (remember that MUI in itself is monotask oriented and RxMUI is supposed to be SAFE):
|
||||||||||||
Inputs | ||||||||||||
|
||||||||||||
Result | ||||||||||||
|
||||||||||||
Example | ||||||||||||
let's suppose you created an application object and a text object named
"info":
|
||||||||||||
See | ||||||||||||
PushMethod() |
Index |
DandD |
||||||||||||||||||||
Instructs RxMUI to be prepared for drag and drop. | ||||||||||||||||||||
Synopsis | ||||||||||||||||||||
res = DandD(from,to,flags) <from/V>,<to/V>,[options] |
||||||||||||||||||||
Function | ||||||||||||||||||||
Tells RxMUI to install a drag and drop mechanism from from to to . options is one or more of:
If you don't specify AUTO, drag and drop must be handled by yourself in the macro. Look at the examples. |
||||||||||||||||||||
Inputs | ||||||||||||||||||||
|
||||||||||||||||||||
Result | ||||||||||||||||||||
|
||||||||||||||||||||
See | ||||||||||||||||||||
Object handling |
Index |
Dispose |
||||||||||||||||
Disposes an object. | ||||||||||||||||
Synopsis | ||||||||||||||||
res = Dispose(obj) <obj/V> |
||||||||||||||||
Function | ||||||||||||||||
Disposes an object. The rules are:
|
||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
Index |
DoMethod |
||||||||||||||||||||
Invokes a method. | ||||||||||||||||||||
Synopsis | ||||||||||||||||||||
res = DoMethod(obj,method,parms) <obj/V>,<method/V>,{parms} |
||||||||||||||||||||
Function | ||||||||||||||||||||
Invokes a method on an object. Any class defines the rules for its own methods. Note that the var RC will contain the real result from the method. It may be useful in some situation. |
||||||||||||||||||||
Inputs | ||||||||||||||||||||
|
||||||||||||||||||||
Result | ||||||||||||||||||||
|
||||||||||||||||||||
See | ||||||||||||||||||||
CoerceMethod() Methods |
Index |
CoerceMethod |
||||||||||||||||||||
Invokes a foreign method. | ||||||||||||||||||||
Synopsis | ||||||||||||||||||||
res = CoerceMethod(classObj,obj,method,parms) <classObj/V>,<obj/V>,<method/V>,{parms} |
||||||||||||||||||||
Function | ||||||||||||||||||||
Invokes the method method of the class of classObj on obj. | ||||||||||||||||||||
Inputs | ||||||||||||||||||||
|
||||||||||||||||||||
Result | ||||||||||||||||||||
|
||||||||||||||||||||
See | ||||||||||||||||||||
DoMethod() Methods |
Index |
PushMethod |
||||||||||||||||||||
Invokes a method on a foreign object. | ||||||||||||||||||||
Synopsis | ||||||||||||||||||||
res = PushMethod(keyID,obj,method,parms) <keyID>,<obj/V>,<method/V>,{parms} |
||||||||||||||||||||
Function | ||||||||||||||||||||
Invokes a method on a object outside the macro where it was created. | ||||||||||||||||||||
Inputs | ||||||||||||||||||||
|
||||||||||||||||||||
Result | ||||||||||||||||||||
|
||||||||||||||||||||
See | ||||||||||||||||||||
AppPushID() |
Index |
GetAttr |
||||||||||||||||||||
Reads an attribute. | ||||||||||||||||||||
Synopsis | ||||||||||||||||||||
res = GetAttr(obj,attr,var) <obj/V>,<attr/V>,<var/V> |
||||||||||||||||||||
Function | ||||||||||||||||||||
Reads the value of an attribute of an object. | ||||||||||||||||||||
Inputs | ||||||||||||||||||||
|
||||||||||||||||||||
Result | ||||||||||||||||||||
|
||||||||||||||||||||
Example | ||||||||||||||||||||
call GetAttr("string","contents","c") say c |
||||||||||||||||||||
See | ||||||||||||||||||||
MultiGetAttr() xget() |
Index |
xget |
|||||||
Reads an attribute. | |||||||
Synopsis | |||||||
value = xget(obj,attr) <obj/V>,<attr/V> |
|||||||
Function | |||||||
Reads an attribute of an object and returns its value. Warning: if the type of the attribute is String, the result is truncated to the first null char found. |
|||||||
Inputs | |||||||
|
|||||||
Result | |||||||
|
|||||||
Example | |||||||
say xget("string","contents") |
|||||||
See | |||||||
MultiGetAttr() GetAttr() |
Index |
Handle |
||||||||||||
Handles an Application object. | ||||||||||||
Synopsis | ||||||||||||
res = Handle(app,stem,signals) <app/V>,<stem/V>,[signals/N] |
||||||||||||
Function | ||||||||||||
Please, use this function sparely, because it uses many cpu time. Usually, you should
use NewHandle(), except when there is a very hard need to wait
for signals in the macro itself. I never had such a need. Handles the object app of class Application. Handling of applications in RxMUI is done via this function. The standard cycle to do that is: ctrl_c=2**12 s=0 do forever call handle("APP","H",s) do i=0 to h.num-1 if h.i="QUIT" then exit if h.i==... then ... end s=Wait(or(h.signals,ctrl_c)) if and(s,ctrl_c)~=0 then exit end Handle() writes in stem.num the number of the entries to be parsed and in stem.i i=0,...,stem.num-1 the name of the object. When stem.i is QUIT the application wants to exit and the user should exit from the macro or dispose the application. Otherwise stem.i is the name of an object that notified the application via a res = Notify(obj,attr,value,"APP","RETURNID") The cycle is very critical: if you do time consuming operation (ARexx is slow !!!) you should invoke the method INPUTBUFFERED on the application as in: ctrl_c=2**12 s=0 do forever call handle("APP","H",s) do i=0 to h.num-1 if h.i="QUIT" then exit if h.i=="GO" then do i=0 to 1000 say i call DoMethod("APP","INPUTBUFFERED") end end end s=Wait(or(h.signals,ctrl_c)) if and(s,ctrl_c)~=0 then exit end If you need to wait for other signals (e.g. for messages on a port) you can pass them to the rmh.library/Wait() function. |
||||||||||||
Inputs | ||||||||||||
|
||||||||||||
Result | ||||||||||||
|
||||||||||||
See | ||||||||||||
NewHandle() Object handling |
Index |
NewHandle |
|
Handles an Application object. | |
Synopsis | |
res = NewHandle(app,stem,signals) <app/V>,<stem/V>,[signals/N] |
|
Function | |
Handles the object app of class Application. Handling of applications in RxMUI is done via this function. The standard cycle to do that is: ctrl_c=2**12 do forever call NewHandle("APP","H",ctrl_c) if and(h.signals,ctrl_c)>0 then exit if h.EventFlag then select when h.event="QUIT" then exit when h.event==... then ... end end As you can see the difference with Handle() is that NewHandle() always returns just one event and waits internally for the signals. You should use Handle() only in the case you really have to wait for the signals in your code (e.g. you have to call rxsocket.library/WaitSelect() to wait for sockets events). NewHandle() reads from stem:
NewHandle() writes in stem: When stem.event is QUIT the application wants to exit and the user should exit from the macro or dispose the application. Otherwise stem.event is the name of an object that notified the application via a res = Notify(obj,attr,value,"APP","RETURNID") If you need to wait for other signals (e.g. for messages on a port) you can pass them in signals. |
|
Inputs | |
|
|
Result | |
res - 0 for success or >0 for failure | |
See | |
Handle() Object handling |
Index |
Notify |
||||||||||||||||||||||||
Adds a notification. | ||||||||||||||||||||||||
Synopsis | ||||||||||||||||||||||||
res = Notify(notifier,attr,value,target,method,parms) <notifier/V>,<attr/V>,<value/V>,<target/V>,<method/V>,{parms} |
||||||||||||||||||||||||
Function | ||||||||||||||||||||||||
Adds a notification from notifier to target triggered by attr when it changes to value invoking method on target with parms. | ||||||||||||||||||||||||
Inputs | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Result | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
See | ||||||||||||||||||||||||
Notification |
Index |
Help |
||||
Returns RxMUI functions help strings. | ||||
Synopsis | ||||
string = help(fun) <fun> |
||||
Function | ||||
Returns the help string associated with the function fun. The same string can be obtained with rxhelp. |
||||
Inputs | ||||
|
||||
Result | ||||
|
Index |
KillNotify |
||||||||||||
Kills notifications. | ||||||||||||
Synopsis | ||||||||||||
res = KillNotify(from,to) <from/V>,<to/V> |
||||||||||||
Function | ||||||||||||
Kills any notification from from to to. | ||||||||||||
Inputs | ||||||||||||
|
||||||||||||
Result | ||||||||||||
|
||||||||||||
See | ||||||||||||
Notification |
Index |
NewObj |
||||||||||||||||||||||||||||||||||||
Creates an object. | ||||||||||||||||||||||||||||||||||||
Synopsis | ||||||||||||||||||||||||||||||||||||
res = NewObj(className,objName,stem,freeChild) <class/V>,[name/O],[stem/V],[freeChild/N] |
||||||||||||||||||||||||||||||||||||
Function | ||||||||||||||||||||||||||||||||||||
Create an object of class class named name reading its attributes
from stem, if present, or name. freeChild makes NewObj() destroy all the internal buffers and resets child stems. Note that during object creation, all the objects defined in name itself or stem, if supplied, are created. |
||||||||||||||||||||||||||||||||||||
Inputs | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Result | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
See | ||||||||||||||||||||||||||||||||||||
Objects creation |
Index |
XNewObj |
||||||||||||||||||||||||||||||||||||
Creates an object. | ||||||||||||||||||||||||||||||||||||
Synopsis | ||||||||||||||||||||||||||||||||||||
name = XNewObj(className,objName,stem,freeChild) <class>,[name/O],[stem/V],[freeChild/N] |
||||||||||||||||||||||||||||||||||||
Function | ||||||||||||||||||||||||||||||||||||
Create an object of class class named name reading its attributes
from stem, if present, or name. freeChild makes XNewObj() destroy all the internal buffers and resets child stems. |
||||||||||||||||||||||||||||||||||||
Inputs | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Result | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
See | ||||||||||||||||||||||||||||||||||||
Objects creation |
Index |
Remove |
||||||||||||||||
Removes an object. | ||||||||||||||||
Synopsis | ||||||||||||||||
res = Remove(obj) <obj/V> |
||||||||||||||||
Function | ||||||||||||||||
Remove obj from its parent. The rules are:
|
||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
||||||||||||||||
See | ||||||||||||||||
Objects creation |
Index |
Set |
|||||||||||||||||||||||||
Writes the value of an attribute of an object. | |||||||||||||||||||||||||
Synopsis | |||||||||||||||||||||||||
res = set(obj,attr,value) <obj/V>,<attr/V>,<value>,[NoNotify/N] |
|||||||||||||||||||||||||
Function | |||||||||||||||||||||||||
Sets ONE attribute of ONE object. SetAttr() is a synonymous for set(). |
|||||||||||||||||||||||||
Inputs | |||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Result | |||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Example | |||||||||||||||||||||||||
call set("win","open",1) |
|||||||||||||||||||||||||
See | |||||||||||||||||||||||||
MultiSetAttrs() SetAttrs() SetClassAttrs() |
Index |
SetAttrs |
|||||||||||||||||||||||||
Sets many attributes of an object. | |||||||||||||||||||||||||
Synopsis | |||||||||||||||||||||||||
res = SetAttrs(obj,stem) <obj/V>,<stem/V> |
|||||||||||||||||||||||||
Function | |||||||||||||||||||||||||
Sets many attributes of an object at once. | |||||||||||||||||||||||||
Inputs | |||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Result | |||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Example | |||||||||||||||||||||||||
set.Disabled=1 set.Contents="I am disabled" call SetAttrs("string","set") |
|||||||||||||||||||||||||
See | |||||||||||||||||||||||||
MultiSetAttrs() set() SetClassAttrs() |
Index |
SetClassAttrs |
|||||||||||||||||||||||||||||
Sets many foreign attributes of an object. | |||||||||||||||||||||||||||||
Synopsis | |||||||||||||||||||||||||||||
res = SetAttrs(class,obj,stem) <class/V>,<obj/V>,<stem/V> |
|||||||||||||||||||||||||||||
Function | |||||||||||||||||||||||||||||
Sets many attributes of the class class of an object at once. | |||||||||||||||||||||||||||||
Inputs | |||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||
Result | |||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||
Example | |||||||||||||||||||||||||||||
set.Value=0 call SetAttrs("Slider","group","set") |
|||||||||||||||||||||||||||||
See | |||||||||||||||||||||||||||||
MultiSetAttrs() set() SetAttrs() |
Index |
MultiGetAttr |
||||||||||||||||
Reads the values of an attribute of many objects. | ||||||||||||||||
Synopsis | ||||||||||||||||
res = MultiGetAttr(stem) <stem/V> |
||||||||||||||||
Function | ||||||||||||||||
Reads the values of an attribute of many objects at once. | ||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
||||||||||||||||
Example | ||||||||||||||||
get.0="host"; get.0.attr="Contents" get.1="hostport"; get.1.attr="Integer" call MultiGetAttr("get") say get.0.value say get.1.value |
||||||||||||||||
See | ||||||||||||||||
GetAttr() xget() |
Index |
MultiSetAttr |
|||||||||||||||||||||||||
Writes an attribute of many objects. | |||||||||||||||||||||||||
Synopsis | |||||||||||||||||||||||||
res = MultiSetAttr(stem) <stem/V>,[NoNotify/N] |
|||||||||||||||||||||||||
Function | |||||||||||||||||||||||||
Writes an attribute of many objects at once. | |||||||||||||||||||||||||
Inputs | |||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Result | |||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Example | |||||||||||||||||||||||||
set.0="host"; set.0.attr="contents";set.0.value="www.amiga.org" set.1="hostport"; set.1.attr="integer"; set.1.value = 80 call MultiSetAttr("set") |
|||||||||||||||||||||||||
See | |||||||||||||||||||||||||
set() SetAttrs() |
Index |
Button |
||||||||
Creates a button. | ||||||||
Synopsis | ||||||||
oname = button(name,text) [name/O],[text]; |
||||||||
Function | ||||||||
Creates a button object named name with text as label. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
Text class |
Index |
ToggleButton |
||||||||||
Creates a toggle button. | ||||||||||
Synopsis | ||||||||||
oname = ToggleButton(name,text,selected) [name/O],[text],[selected/N] |
||||||||||
Function | ||||||||||
Creates a toggle button object named name with text as label in selected state. | ||||||||||
Inputs | ||||||||||
|
||||||||||
Result | ||||||||||
|
||||||||||
See | ||||||||||
Text class |
Index |
Checkmark |
||||||||||
Creates a checkmark. | ||||||||||
Synopsis | ||||||||||
oname = checkmark(name,selected) [name/O],[selected/N],[cchar] |
||||||||||
Function | ||||||||||
Creates a checkmark object named name in selected state. | ||||||||||
Inputs | ||||||||||
|
||||||||||
Result | ||||||||||
|
||||||||||
See | ||||||||||
Image class |
Index |
HBar |
||||||||
Creates a HBar. | ||||||||
Synopsis | ||||||||
oname = HBar(pixels) [pixels/N] |
||||||||
Function | ||||||||
Creates a HBar object. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
VBar |
||||||||
Creates a VBar. | ||||||||
Synopsis | ||||||||
oname = VBar(pixels) [pixels/N] |
||||||||
Function | ||||||||
Creates a VBar object. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
HSpace |
||||||||
Creates a horiz space. | ||||||||
Synopsis | ||||||||
oname = HSpace(pixels) [pixels/N] |
||||||||
Function | ||||||||
Creates a horiz rectangle object. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
HFSpace |
||||||||
Creates a horiz space. | ||||||||
Synopsis | ||||||||
oname = HFSpace(string) [string] |
||||||||
Function | ||||||||
Creates a horiz rectangle object with a fixed width as the width of the given string. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
VFSpace |
||||||||
Creates a vert space. | ||||||||
Synopsis | ||||||||
oname = VFSpace(string) [string] |
||||||||
Function | ||||||||
Creates a vert rectangle object with a fixed height as the height of the given string. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
VSpace |
||||||||
Creates a vert rectangle object. | ||||||||
Synopsis | ||||||||
oname = VSpace(pixels) [pixels/N] |
||||||||
Function | ||||||||
Creates a vert rectangle object. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
HVSpace |
||||||||
Creates a rectangle object. | ||||||||
Synopsis | ||||||||
oname = HVSpace(hpixels,vpixels) [hpixels/N],[vpixels/N] |
||||||||
Function | ||||||||
Creates a rectangle object. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
HWSpace |
||||||||
Creates a rectangle object. | ||||||||
Synopsis | ||||||||
oname = HWSpace(hpixels,vpixels) [weight/N] |
||||||||
Function | ||||||||
Creates a rectangle object. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
VWSpace |
||||||||
Creates a rectangle object. | ||||||||
Synopsis | ||||||||
oname = VWSpace(hpixels,vpixels) [weight/N] |
||||||||
Function | ||||||||
Creates a rectangle object. | ||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
MakeObj Rectangle class |
Index |
MenuItem |
||||||||||||||||
Create a menuitem | ||||||||||||||||
Synopsis | ||||||||||||||||
oname = MenuItem(name,title,shortcut,checked,checkit,enabled) [name/O],[title],[shortcut],[flags],[exclude/N] |
||||||||||||||||
Function | ||||||||||||||||
Creates a Menuitem object. title can be the special value "BAR" to create a bar. If no argument or just name is supplied, a bar is created. | ||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
||||||||||||||||
See | ||||||||||||||||
MakeObj Menu class |
Index |
Label |
||||||||
Creates a label. | ||||||||
Synopsis | ||||||||
oname = label(text,flags) <text>,[flags] |
||||||||
Function | ||||||||
Creates un unnamed label object. The text is right aligned by default. The char _ may be used to underline a char. flags is one or more of:
|
||||||||
Inputs | ||||||||
|
||||||||
Result | ||||||||
|
||||||||
See | ||||||||
Text class MakeObj() |
Index |
MakeObj |
||||||||||||||
Creates a MUI object. | ||||||||||||||
Synopsis | ||||||||||||||
oname = MakeObj(name,type,parms) [name/O],[type],{parms} |
||||||||||||||
Function | ||||||||||||||
Creates a MUI Object. Type can be one of:
|
||||||||||||||
Inputs | ||||||||||||||
|
||||||||||||||
Result | ||||||||||||||
|
||||||||||||||
Example | ||||||||||||||
|
Index |
String |
|||||||||||||
Creates a string. | |||||||||||||
Synopsis | |||||||||||||
oname = string(name,cchar,contents,max) [name/O],[cchar],[contents],[max/N] |
|||||||||||||
Function | |||||||||||||
Creates a string object. | |||||||||||||
Inputs | |||||||||||||
|
|||||||||||||
Result | |||||||||||||
|
|||||||||||||
See | |||||||||||||
MakeObj String class |
Index |
Text |
||||||||||||||||
Creates a text object. | ||||||||||||||||
Synopsis | ||||||||||||||||
oname = text(name,text,frame,background,preparse) [name/O],[text],[frame],[background],[preparse] |
||||||||||||||||
Function | ||||||||||||||||
Creates a text object. | ||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
||||||||||||||||
See | ||||||||||||||||
Text class |
Index |
ParseText |
||||
Parses text. | ||||
Synopsis | ||||
parsedtext = ParseText(text) <text> |
||||
Function | ||||
Parses a text, translating it to the MUI text engine format. Refer to the MUI text class autodoc. The changes made on text are:
To display:
Without this function the strings to pass as Contents attribute of Text class, as Text argument in Button() or as entry of a List object would be too complicated. |
||||
Inputs | ||||
|
||||
Result | ||||
|
Index |
StripText |
||||
Strip dangerous codes from text. | ||||
Synopsis | ||||
stripped = StripText(text) <text> |
||||
Function | ||||
Anytime you are going to set a Contents of a Text object or you are adding an entry to
a (N)List and so on, and the text comes from a non trustable source (e.g. from the
Internet), you should strip dangerous MUI Text Engine codes via this function. It will
return a clean text that may be used with no worries. Note that the function may not fail: if no mem is available it just returns an empty string. |
||||
Inputs | ||||
|
||||
Result | ||||
|
Index |
Child |
||||||||||
Defines a child. | ||||||||||
Synopsis | ||||||||||
call child(parent,name,class) <parent/V>,<name/V>,[class/O] |
||||||||||
Function | ||||||||||
To use at object specification phase.call child("G","S","STRING") just tells RxMUI to:
A often used form is as in call child("MPROJECT",Menuitem("MOPEN","Open","O")) |
||||||||||
Inputs | ||||||||||
|
||||||||||
Result | ||||||||||
none | ||||||||||
See | ||||||||||
NewObj() |
Index |
MUIRequest |
||||||||||||||||
Shows a requester. | ||||||||||||||||
Synopsis | ||||||||||||||||
res = MUIRequest(app,win,title,gadgets,text) [app/O],[win/O],[title],[gadgets],[text] |
||||||||||||||||
Function | ||||||||||||||||
Shows a MUI requester. This function is discouraged. Use it sparely, just to show errors and then exit. If you have to report messages to the user, you should better open a little window with a text (floattext) object and use it. |
||||||||||||||||
Inputs | ||||||||||||||||
|
||||||||||||||||
Result | ||||||||||||||||
|
Index |
SetRxMUIStack |
||||
Set RxMUI stack size. | ||||
Synopsis | ||||
call SetRxMUIStack(size) <size/N> |
||||
Function | ||||
Sets the RxMUI swap-stack size of the macro. Every RxMUI function is executed under a stack swap. Default stack size is 24k, but in certain situation with some object, e.g. with NListview, a very large stack is required. You can set the stack size with this function. RxMUI will allocate the new stack iff size is >16k bytes. If the stack can not be allocated error 3 is generated. |
||||
Inputs | ||||
|
||||
Result | ||||
none | ||||
Index |
GetRxMUIString |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns an error string. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Synopsis | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
res = GetRxMUIString(id) <id/N> |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Function | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The strings are read from the catalog rxmui.catalog if present. At this moment RxMUI errors code are:
If an error is returned the var RxMUIErr is set to something meaningful, if possible. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Inputs | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Result | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Index |
RxMUIOpt |
||||
Sets or reads RxMUI options. | ||||
Synopsis | ||||
res = RxMUIOpt(options) <options> |
||||
Function | ||||
options is one or more of:
When many objects are created via one single NewObj() call, if an object anywhere can not be created, all the created objects are disposed and NewObj() returns an error code. You have no way to know where the creation process stopped and the error was generated. During debugging of a macro is very useful to know exactly which object had problem and or where the problem appeared. Setting DebugMode makes RxMUI to remember the first error it discovered in NewObj(). Setting ShowErr make RxMUI to show a MUI requester with info inside. options may also be ASK in which case the string Note that everytime rxmui.library is load, it checks for the environment vars:
You might change them to have personal global defaults. |
||||
Inputs | ||||
|
||||
Result | ||||
|
Index |
RxMUIObjExists |
||||
Checks if an object exists. | ||||
Synopsis | ||||
res = RxMUIObjExists(obj) <obj/V> |
||||
Function | ||||
Checks if obj exists. | ||||
Inputs | ||||
|
||||
Result | ||||
|
Index |
RxMUIObjList |
||||
Returns the objects list. | ||||
Synopsis | ||||
res = RxMUIObjList(obj) [obj/V] |
||||
Function | ||||
Returns an object list string. For debugging porpoise. | ||||
Inputs | ||||
|
||||
Result | ||||
|
Index |
RxMUIGetVar |
||||
Gets a parent macro var. | ||||
Synopsis | ||||
value = RxMUIGetVar(var) <var/S> |
||||
Function | ||||
Many classes permit you to define a inline-macro function to be execute on some events. It is the case of Application/Inline method or Popstring/OpenFun attribute. In the macro you have no access to the vars of the parent macro, but you may still obtain the value of a var via this function. | ||||
Inputs | ||||
|
||||
Result | ||||
|
Index |
RxMUISetVar |
|||||||
Sets a parent macro var. | |||||||
Synopsis | |||||||
value = RxMUIGetVar(var,value) <var/S>,<value> |
|||||||
Function | |||||||
Many classes permit you to define a inline-macro function to be execute on some events. It is the case of Application/Inline method or Popstring/OpenFun attribute. In the macro you have no access to the vars of the parent macro, but you may still set the value of a var via this function. | |||||||
Inputs | |||||||
|
|||||||
Result | |||||||
|
Index |