Click above to get retro games delivered to your door ever month!

Syntax

TBROWSER( [ aArray ] )

Purpose

Supercedes the endangered Artful function BROWSER(). Provides a generalised
browse window in which one or more columns are displayed.

Arguments

     aArray -- an optional array which if passed has the following
               structure:

     aArray[ 1 ] -- aCoords: an array of screen coordinates, which defaults
                    to { 5, 3, (5+number of records in scope), 76 }. To
                    lock the browser to a specific height, pass a row
                    number as aCoords[ 3 ]. To dynamically size the
                    browser, pass NIL as aCoords[ 1 ] or aCoords[ 3 ].

     aArray[ 2 ] -- aColumns: an optional array of "column objects" to
                    browse. NIL invokes automatic columns mode, and all
                    fields in the current table up to a maximum specified
                    in AA_TBROW.CH are used. Otherwise, aColumns must be an
                    array of arrays in which each subarray contains a field
                    expression, its header or NIL for a default header, a
                    picture, a colour definition, and a colour block.

     aArray[ 3 ] -- aScope: an optional value used to scope the list. It
                    may be NIL (no scope), a two-element array containing
                    low and high scope values (range lock), or a single
                    variable (i.e. parental key lock).

     aArray[ 4 ] -- aAlias: an optional array containing the the index
                    order to impose and the array to select.

     aArray[ 5 ] -- aBlock: either a code block or an array containing a
                    code block and a logical value. The logical value if
                    passed affects the way the code block is evaluated. The
                    default mechanism calls TBKEYS() to process keystrokes.
                    If a code block is passed, it may either replace or
                    abet the functionality of TBKEYS().

     aArray[ 6 ] -- an optional array of behaviour flags.

        aArray[ 6, 1 ] -- an eight-part colour specification string.

        aArray[ 6, 2 ] -- a colour specification used when drawing the
                          containing box.

        aArray[ 6, 3 ] -- window header; defaults to ALIAS()

        aArray[ 6, 4 ] -- a code block calling your box drawing routine;
                          defaults to BOXER()

        aArray[ 6, 5 ] -- a logical indicating whether to bubble the index
                          key fields to the front; defaults to .T.

        aArray[ 6, 6 ] -- a numeric indicating the number of columns to
                          freeze; defaults to 1

        aArray[ 6, 7 ] -- a logical toggling inclusion of a column to
                          display the record number; defaults to .F.

Setup

The file to be browsed must be open. (Other files may be referenced if they
are also open, and any required relationships are in place.)

Example

     ... < some code to open ORDERS and ORD_ITEM > ...

     SELECT ORD_ITEM
     TBROWSER( { { 6, 6, , MaxCol() - 6 }, ;
                 NIL, ;
                  ORDERS->Order_Num, ;
               } )

Returns

NIL.

Side Effects

Crash on unopened or unselected files, or bad array contents.

Artful Calls

BOXER()

Source File

AA_TRBROW.PRG