ArborX


boxit

Longname: box it   Open the Documentation Legend
Released: not available 
Created: not available 
See also: addstr defstr wdb wmn wmse

Summary
An internal or debugging macro used by 3B2 to test elements, boxit is useful when writing scripts as a way of displaying the value of a particular variable or string on screen, rather than in the text with the @ macro.
Example extract

Displays the content of the ^hgt variable in a box on-screen.

 boxit ^hgt^

Syntax (SVNNA)
boxit  xpos:n?  ypos:n? string:b
xpos:n The initial x-position of the box in screen pixels, i.e. its distance from the left-hand edge of the screen.
ypos:n The initial y-position of the box in screen pixels, i.e. its distance from the top of the screen.
string:b The dialogue box string, text stream or variable to be displayed.

Like the wdb macro, boxit calls standard 3B2 dialogue box code. Instead of displaying a dialogue box, however, boxit simply displays the individual elements of the dialogue box without their surrounding border. Dialogue code can also be used to enhance your boxit display, take the following for example:

 boxit ^my_var%;60s

The above example uses the %;60s dialogue box syntax to create an ediatable field of 60 characters. For more information see the Dialogue Box chapter.

Unlike a dialogue box definition boxit does not affect the ^wdb variable. All the other rules for putting together 3B2 dialogue boxes apply when you use boxit.

As with dialogue boxes, extreme violations of the correct syntax may cause 3B2 to produce errors.
Example

Display a line from a dialogue box.

 boxit %2..1e[OK][Cancel]
Example

The example below display the contents of a string in a boxit. A string is a sequence or combination of numeric and or alphanumeric charcaters.

 boxit ^"string"^
Note the closing ^ at the end of the string to close the variable.

Since the boxit example provides no other exit methods, it will be necessary to quit the 'dialogue box' with either  Enter ,  Ctrl  +  A  or  Shift  +  Shift . A ~ (tilde) character could have been included, as in any dialogue box definition, to allow the user to exit using any key, as shown below:

 boxit ~^hgt^

The boxit macro can also be used to create toolbars such as the one shown below, the definition for which appears in sscr.3ad (string no.909):

Some characters will not be displayed by boxit, for example if you are setting an area name to a variable, e.g.: ^area1={myfiles}, this will be displayed by boxit as 'myfiles' but the characters are still present.

Document created on 08-Feb-2003 (revision 1)