C5 TBrowse Class

 Provides objects for browsing table-oriented data

     A TBrowse object is a general purpose browsing mechanism for
     table-oriented data.  TBrowse objects provide a sophisticated architecture
     for acquiring, formatting, and displaying data.  Data retrieval and file
     positioning are performed via user-supplied code blocks, allowing a high
     degree of flexibility and interaction between the browsing mechanism and
     the underlying data source.  The format of individual data items can be
     precisely controlled via the TBColumn data retrieval code blocks;
     overall display formatting and attributes can be controlled by sending
     appropriate messages to the TBrowse object.

     A TBrowse object relies on one or more TBColumn objects.  A TBColumn
     object contains the information necessary to define a single column of
     the browse table (see TBColumn class in this chapter).

     During operation, a TBrowse object retrieves data by evaluating code
     blocks.  The data is organized into rows and columns and displayed
     within a specified rectangular region of the screen.  The TBrowse object
     maintains an internal browse cursor.  The data item on which the browse
     cursor rests is displayed in a highlighted color.  (The actual screen
     cursor is also positioned to the first character of this data item.)

     Initially, the browse cursor is placed on the data item at the top left
     of the browse display.  Messages can then be sent to the TBrowse object
     to navigate the displayed data, causing the browse cursor to move.
     These messages are normally sent in response to user keystrokes.

     New data is automatically retrieved as required by navigation requests.
     When navigation proceeds past the edge of the visible rectangle, rows or
     columns beyond that edge are automatically brought into view.  When new
     rows are brought into view, the underlying data source is repositioned
     by evaluating a code block.

     Note:  TBrowse objects do not clear the entire window before output
     during redisplay operations.  Part of the window may still be cleared
     when data from the existing display is scrolled.


     For fully operational examples of a TBrowse object, refer to the TBrowse
     introduction chapter in the Programming and Utilities guide and to
     TbDemo.prg located in \CLIPPER5\SOURCE\SAMPLE.

Class Functions

 TBrowseNew()      Create a new TBrowse object

     TBrowseNew(<nTop>, <nLeft>, <nBottom>, <nRight>)
        --> objTBrowse

     Returns a new TBrowse object with the specified coordinate settings.
     The TBrowse object is created with no columns and no code blocks for
     data positioning.  These must be provided before the TBrowse object
     can be used.

 TBrowseDB() Create a new TBrowse object for browsing a database file

 TBrowseDB(<nTop>, <nLeft>, <nBottom>, <nRight>)

        --> objTBrowse

  Returns a new TBrowse object with the specified coordinate settings
  and default code blocks for data source positioning within database
  files.  The default code blocks execute the GO TOP, GO BOTTOM, and
  SKIP operations.

  Note that TBrowseDB() creates an object with no column objects.  To
  make the TBrowse object usable, you must add a column for each field
  to be displayed.


More …


One response to “C5 TBrowse Class

  1. Pingback: C5 Classes | Viva Clipper !

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.