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

 twRAGetBrowse()
 ----------------------------------------------------------------------------

     Obtain a reference to the current browse object created under the
     TSDWIN twRABrowse() function. This function is useful when
     operating on the current browse with an ActionKey function.

     An important benefit from using twRABrowse() is that
     twRAGetBrowse() gives you access to the entire cargo structure of
     the browse. If you delete or add elements to the array, there are
     some things you should do in order that the browse continues to
     work as expected. You must change the internals to reflect the new
     element number, for instance, when using scroll bars to allow the
     button position to be updated correctly.  See tw_NtxPos().

     When using actionkeys or mouse hot spots, it is very common to
     obtain a reference to the browse with twRAGetBrowse() and modify
     the browse behaviour from outside. This cargo structure is
     provided in order that the programmer has complete control over
     the browse structure at all times, even when the browse is active.

     An example might be to use a PreRun block to define column
     ColorBlocks or use a different title  color for the browse than
     the default text colour, eg.,

     bPreRun := {|x,y| twTitle( "Title", "n/w",
                                   "T", "C" ),;
                  x := twRAGetBrowse(), ;
                  y := x:GETCOLUMN( 2 ),;
                  y:colorblock := {|| { 5, 2 } },;
                  x:ColPos := 1 }


     NOTE: Some of the settings in the above example may be set up in
           the column definition.

        Browse Cargo Structures:

               Browse Cargo

     oRA:cargo[ 1 ]                      oRA:cargo[ 6 ][ 1 ]
        Allow Edits                         Horizontal Scroll Bar
        .RAEdit                                     Top
                                            .RAHBarTop
     oRA:cargo[ 2 ]
        Width of Frozen Columns          oRA:cargo[ 6 ][ 2 ]
        .RAFrozenWidth                      Horizontal Scroll Bar
                                                    Left
     oRA:cargo[ 3 ]                         .RAHBarLeft
        Current Array Element
        .RACurrent                       oRA:cargo[ 6 ][ 3 ]
                                            Horizontal Scroll Bar
     oRA:cargo[ 4 ]                                 Bottom
         Length of the array                .RAHBarBottom
         .RALength
                                         oRA:cargo[ 6 ][ 4 ]
     oRA:cargo[ 5 ]                         Horizontal Scroll Bar
        Vertical Scroll Bar                         Right
        .RAVScrollBar                       .RAHBarRight

     oRA:cargo[ 5 ][ 1 ]                 oRA:cargo[ 6 ][ 5 ]
        Vertical Scroll Bar                 Horizontal Scroll Bar
               Top                                  Top
        .RAVBarTop                          .RAHBarColor

     oRA:cargo[ 5 ][ 2 ]                 oRA:cargo[ 6 ][ 6 ]
        Vertical Scroll Bar                 Horizontal Scroll Bar
               Left                                 Position
        .RAVBarLeft                         .RAHBarPos

     oRA:cargo[ 5 ][ 3 ]                 oRA:cargo[ 6 ][ 7 ]
        Vertical Scroll Bar                 Horizontal Scroll Bar
               Bottom                               Orientation
        .RAVBarBottom                       .RAHBarOrient

     oRA:cargo[ 5 ][ 4 ]                 oRA:cargo[ 6 ][ 8 ]
        Vertical Scroll Bar                 Horizontal Handle for
               Right                                Mouse Hot Spot
        .RAVBarRight                        .RAHBarHot

     oRA:cargo[ 5 ][ 5 ]                 oRA:cargo[ 7 ]
        Vertical Scroll Bar                 {} Width to end of column
               Colour                       .RATotWidth
        .RAVBarColor
                                         oRA:cargo[ 8 ]
     oRA:cargo[ 5 ][ 6 ]                    Header Depth
        Vertical Scroll Bar                 .RAHeadDepth
               Position
        .RAVBarPos                       oRA:cargo[ 9 ]
                                            Allow Mouse
     oRA:cargo[ 5 ][ 7 ]                    .RAMouse
        Vertical Scroll Bar
               Orientation               oRA:cargo[ 10 ]
        .RAVBarOrient                       Calling Procedure
                                            .RACaller
     oRA:cargo[ 5 ][ 8 ]
        Vertical Handle for              oRA:cargo[ 11 ]
               Mouse Hot Spot               Calling Procedure
        .RAVBarHot                                  Line Number
                                            .RACallerLine
     oRA:cargo[ 6 ]
        Horizontal Scroll Bar            oRA:cargo[ 13 ]
        .RAHScrollBar                       Index for Nested Arrays
                                            .RAIndex

     Browse Columns Cargo

     column:cargo[ 1 ]
             Column Editable
             .RACEdit

     column:cargo[ 2 ]
             Column Picture String for Gets
             .RACPic

     column:cargo[ 3 ]
             Column WHEN block for Gets
             .RACWhen

     column:cargo[ 4 ]
             Column Valid block for Gets
             .RACValid

     column:cargo[ 5 ]
             Column GetReader block for Gets
             .RACReader

     column:cargo[ 7 ]
             Index of array for nested arrays
             .RACIndex

       Arguments:

     NONE

       Return:

     Object

       Example:

     twRAGetBrowse()