Updated August 2011
This is a collection of extended parameters and options. The exact structure layout is defined in the definition file noted at the bottom of the table, which should be included in applications using XTEXT.
By convention in this document, we refer to the sub-fields within the txtctl structure with names preceded by the prefix txc' (e.g. txc'ctlno).
|
Symbol |
Type |
I/O |
Description |
|
txc'bcolor |
B,4 |
in |
Background (window) color. See txc'fcolor. |
|
txc'bprotclr |
B,4 |
in |
Background protected color. See txc'protrows. |
|
txc'ctlid |
B,2 |
out |
Control ID (overall A-Shell AUI control list). |
|
B,1 |
in/out |
Specifies control to use. | |
|
txc'delctlid |
B,4 |
in |
ID of control to delete on entrance (life sign). This functions exactly like the analogous XTR'DELCTLID parameter in XTREE, which see for important notes. |
|
B,2 |
in |
Format of output (dst). | |
|
B,2 |
in |
Format of input (src). | |
|
B,4 |
in |
Foreground (text) color. | |
|
B,2 |
in |
1's indicate which flags to update | |
|
txc'flags# |
B,4 |
in |
Various low-level flags; see TXF#_xxx in XTEXT.DEF. |
|
B,4 |
in |
1's enable FKEY to be send to app (exitcode). | |
|
B,4 |
in |
1's enable FKEY to be sent to control. | |
|
txc'fontattr |
B,4 |
in |
Expresses font attributes in the same way as does fontattr in AUI_CONTROL. |
|
S,32 |
in |
Font typeface. | |
|
B,2 |
in |
Font point size. | |
|
B,4 |
in |
Foreground protected text color. | |
|
txc'hflagmask |
B,2 |
in |
Bitmap controlling interpretation of the txc'flags# fields; ; same concept as for txc'flagmask. |
|
txc'hflags# |
B,4 |
in |
HTML flags. See TXFH1_xxx and TXFH2_xxx in XTEXT.DEF for bit flag definitions. Note that most options require that the source document format as well as the destination (see txc'docfmt'src and txc'docfmt'dst) have the TXFF_HTML flag set —i.e. they may not work when converting from one document type to another. Also, see the Comments under txc'docfmt'dst for important notes relating to the TXF_PRINTFIEW and TXF_FITVIEW flags. |
|
S,40 |
in |
ctlname or parentname>ctlname | |
|
S,11 |
in |
Click code. | |
|
B,2 |
in |
Maximum bytes allowed (0 = unlimited). | |
|
txc'maxrows |
B,2 |
in |
Optional row count limit. If specified, a warning dialog will display when the limit is exceeded (as soon as it happens, periodically, and on exit). Text of dialog can be customized via SBRMSG.xxx 023,002 and 023,003. |
|
txc'menumask1, txc'menumask2 |
B,4 |
in |
TXC'MENUMASK1 and TXC'MENUMASK2 allow individual items and groups of menus to be removed when the TXF_MENU and TXF_POPUP flags are used. See TXMF1_xxx and TXMF2_xxx in XTEXT.DEF for the bit flag definitions. |
|
txc'mgnbottom* |
B,2 |
in |
Bottom margin (twips). Mainly of interest in TXF_PRINTVIEW mode. |
|
txc'mgnfooter* |
B,2 |
in |
Footer margin (twips). Mainly of interest in TXF_PRINTVIEW mode. |
|
txc'mgnheader* |
B,2 |
in |
Header margin (twips). Mainly of interest in TXF_PRINTVIEW mode. |
|
txc'mgnleft |
B,2 |
in |
Left margin (twips). Mainly of interest in TXF_PRINTVIEW mode. |
|
txc'mgnright |
B,2 |
in |
Right margin (twips). Mainly of interest in TXF_PRINTVIEW mode. |
|
txc'mgntop |
B,2 |
in |
Top margin (twips). Mainly of interest in TXF_PRINTVIEW mode. |
|
txc'modified |
B,1 |
out |
Non-zero if text buffer modified. |
|
txc'orient* |
B,2 |
in |
Orientation (0=dflt, 1=port, 2=land). Mainly of interest in TXF_PRINTVIEW mode. |
|
B,4 |
out |
Number of bytes output. | |
|
B,4 |
out |
Number of lines output (or to be output). | |
|
txc'overflow |
B,1 |
out |
Non-zero if text too big for dst param. |
|
txc'papersize* |
B,2 |
in |
Paper size (see DMPAPER_xxx). Mainly of interest in TXF_PRINTVIEW mode. |
|
txc'parentid |
B,2 |
in |
ID of parent of control (e.g. a dialog): 0 for a normal child control on the main window. |
|
B,4 |
in |
Rows to protect (-1 = all, -2 all but last). | |
|
B,4 |
in/out |
Position in buffer to start next save (or -1 to restart a previously incomplete save operation from the beginning). | |
|
txc'sflags |
B,2 |
in |
Search flags |
|
txc'srchkey |
S,30 |
in |
String to search for |
|
txc'timeout |
B,4 |
in |
Milliseconds until timeout. The timer gets reset on keystrokes and on mouse activity within the control. If the timer expires, XTEXT will return EXITCODE=11 (like INFLD and XTREE) and any editing changes will be saved. |
|
B,4 |
in |
1's remove object from toolbar (see TXTB_xxx). | |
|
B,2 |
in |
Width in characters for word wrap. | |
|
txc'xcol |
B,2 |
in/out |
Cursor column on exit and optionally on entrance (base 1) See TXF_POSCUR |
|
txc'xcuroffset |
B,4 |
in/out |
Absolute cursor position on exit and optionally on entrance. (base 0) |
|
txc'xrow |
B,4 |
in/out |
Cursor row on exit and optionally on entrance (base 1). See TXF_POSCUR |
|
Definition file: XTEXT.MAP | |||
* Note: Prior to A-Shell 1149 of May 2009, the (original) size of TXTCTL was 256, so it may be that existing applications or functions have a 256 byte limit which would make the fields marked with an asterisk invisible. For the same reason, if using XTEXT from ATE, both server and client would need to be at 5.1.1149 or higher in order for all the new fields to work.