popupremove - Function

remove popup help from a GUI

Synopsis
popupremove(ag, mxlevels) include "popuphelp.g"

Description
popupremove Is a function which deletes any popuphelp (if present) from the specified agent, and sets the agent to False after having done it. Using it is necessary if, e.g., you want to zero the agent in a whenever: timing problems could crash the system if popuphelp is present and lingering somewhere.

The function works recursively, if fields in the argument are records.

Arguments

ag	agent which should be removed (possibly recursively)
	Allowed:	agent
	Default:	F
mxlevels	max. recursion level
	Allowed:	Int
	Default:	8

Returns
T

Example

include 'popuphelp.g';
private := [=];
private.f := frame(height=100);
private.f.a := frame(private.f);
private.f.a.b := button(private.f.a);
popupmenu(private.f);  # to add a ? menu button (if wanted)
popuphelp(private.f.a.b, 'Press the button, and make this a long text');
private.l := listbox(private.f);
private.l->insert('AAA'); private.l->insert('BBB');
private.l.helpfct := function(name, index) {
    # Only need name here.
    return spaste('Your cursor is near ', name);
}
popuphelp(private.l, private.l.helpfct);
whenever private.f.a.b->press do {
    popupremove(private.f.a);
}

Next: popupmenu - Function Up: guiutils - Module Previous: popuphelp - Function Contents Index

	Package	display
	Module	guiutils