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

TBROWSENew()

Create a Browse Object
---------------------------------------------------------------------------------

 Constructor syntax

        TBROWSENew(<nTop>,<nLeft>,<nBottom>,<nRight>)   --> <oBrowse>  

 Arguments

        <nTop>      Top Row      

        <nLeft>     Top Left Column      

        <nBottom>   Bottom Row      

        <nRight>    Bottom Right Column    

 Returns

        <oBrowse>    An new Browse Object    

 Description

      This function set up a browsing window at top-left coordinates of
      <nTop>,<nLeft> to bottom-right coordinates of <nBottom>,<nRight>.
      To browse Database files use TBROWSEDB() function insted.

 Data

      :aColumns       Array to hold all browse columns

      :autoLite       Logical value to control highlighting

      :cargo          User-definable variable

      :colorSpec      Color table for the TBrowse display

      :colPos         Current cursor column position

      :colSep         Column separator character

      :footSep        Footing separator character

      :freeze         Number of columns to freeze

      :goBottomBlock  Code block executed by TBrowse:goBottom()

      :goTopBlock     Code block executed by TBrowse:goTop()

      :headSep        Heading separator character

      :hitBottom      Indicates the end of available data

      :hitTop         Indicates the beginning of available data

      :leftVisible    Indicates position of leftmost unfrozen column  in
       display

      :nBottom        Bottom row number for the TBrowse display

      :nLeft          Leftmost column for the TBrowse display

      :nRight         Rightmost column for the TBrowse display

      :nTop           Top row number for the TBrowse display

      :rightVisible   Indicates position of rightmost unfrozen column  in
       display

      :rowCount       Number of visible data rows in the TBrowse  display

      :rowPos         Current cursor row position

      :skipBlock      Code block used to reposition data source

      :stable         Indicates if the TBrowse object is stable

      :aRedraw        Array of logical items indicating, is appropriate
       row need to be redraw

      :RelativePos    Indicates record position relatively position of
       first record on the screen

      :lHeaders       Internal variable which indicates whether there  are
       column footers to paint

      :lFooters       Internal variable which indicates whether there  are
       column footers to paint

      :aRect          The rectangle specified with ColorRect()

      :aRectColor     The color positions to use in the rectangle
       specified with ColorRect()

      :aKeys        Holds the Default movement keys

 Method

      New(nTop, nLeft, nBottom, nRight) Create an new Browse class and set
       the  default values

      Down()       Moves the cursor down one row

      End()        Moves the cursor to the rightmost visible data column

      GoBottom()   Repositions the data source to the bottom of file

      GoTop()      Repositions the data source to the top of file

      Home()       Moves the cursor to the leftmost visible data column

      Left()       Moves the cursor left one column

      PageDown()   Repositions the data source downward

      PageUp()     Repositions the data source upward

      PanEnd()     Moves the cursor to the rightmost data column

      PanHome()    Moves the cursor to the leftmost visible data column

      PanLeft()    Pans left without changing the cursor position

      PanRight()   Pans right without changing the cursor position

      Right()      Moves the cursor right one column

      Up()         Moves the cursor up one row

      ColCount()    Return the Current number of Columns

      ColorRect()   Alters the color of a rectangular group of cells

      ColWidth( nColumn )  Returns the display width of a particular column

      Configure( nMode )   Reconfigures the internal settings of the
       TBrowse  object nMode is an undocumented parameter in CA-Cl*pper

      LeftDetermine()      Determine leftmost unfrozen column in display

      DeHilite()           Dehighlights the current cell

      DelColumn( nPos )    Delete a column object from a browse

      ForceStable()        Performs a full stabilization

      GetColumn( nColumn ) Gets a specific TBColumn object

      Hilite()             Highlights the current cell

      InsColumn( nPos, oCol )   Insert a column object in a browse

      Invalidate()        Forces entire redraw during next stabilization

      RefreshAll()        Causes all data to be recalculated during the
       next  stabilize

      RefreshCurrent()    Causes the current row to be refilled and
       repainted  on next stabilize

      SetColumn( nColumn, oCol )   Replaces one TBColumn object with
       another

      Stabilize()          Performs incremental stabilization

      DispCell( nColumn, cColor )  Displays a single cell

 Examples

      See tests/testbrw.prg

 Tests

      See tests/testbrw.prg

Status

      Started

 Compliance

      This functions is Compatible with Ca-Clipper 5.2. The applykey() and
      Setkey() methods are only visible if HB_COMPAT_C53 is defined.

 Platforms

      All

 Files

      Library is rtl