Method XbpBrowse():new()

Creates instances of the XbpBrowse class.

XbpBrowse():new( [<oParent>], ;
                 [<oOwner>], ;
                 [<aPos>], ;
                 [<aSize>], ;
                 [<aPresParam>], ;
                 [<lVisible>] ) --> oXbpBrowse

The parent for an XbpBrowse object can be optionally specified using the parameter <oParent>. By default <oParent> is the active window (the return value of SetAppWindow()). If the default is used, the active window must be an XbpCrt window. If the active window is an XbpDialog window, the drawing area of the window must be specified for <oParent>. The drawing area is referenced using the instance variable oXbpDialog:drawingArea.

<oOwner> can be used to set the owner for the XbpBrowse object. By default, <oOwner> is the same as <oParent>.

<aPos> := { nX, nY }

The optional parameter <aPos> can be used to specify the position where the XbpBrowse object is displayed. By default, this parameter contains the array {0,0}. This specifies the position for the lower left corner of the XbpBrowse object. The first element contains the x coordinate and the second contains the y coordinate. The coordinates are relative to the coordinate system of <oParent>.

<aSize> := { nXsize, nYsize }

The parameter <aSize> optionally specifies the size of the XbpBrowse object. <aSize> must be an array containing two elements. The first element specifies the dimension in the x direction (width) and the second element specifies the dimension in the y direction (height). If no size is specified, the XbpBrowse object uses the entire size of its parent. The value for <aSize> is then determined with the expression self:setParent():currentSize().

A two dimensional array can be specified for <aPresParam>. Refer to Generic presentation parametersfor a detailed explanation.

In addition to the generic presentation parameters, an XbpBrowse object recognizes color attributes for the browse cursor.

#define constant	Description
XBP_PP_HILITE_BGCLR	Background color of browse cursor
XBP_PP_HILITE_FGCLR	Foreground color of browse cursor

Special presentation parameters valid for XbpColumn objects can also be used for an XbpBrowse object to configure Heading Area, Data Area and Footing Area of the entire browser. When constants for XbpColumn configuration are specified for an XbpBrowse object, they are used by all XbpColumn objects subsequently added to XbpBrowse. A description of XPP_PP_COL_ constants is given in the XbpColumn() class.

The parameter <lVisible> determines whether the XbpBrowse object is visible immediately after the call to the method :create(). By default, <lVisible> is .F. (false) and the XbpBrowse object is not displayed after :create() is executed. This allows XbpColumn objects to be attached without the screen being updated each time the browser receives a new column. When all columns are added, an XbpBrowse object is displayed by calling its :show() method.

The class method :new() returns an XbpBrowse object.

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.

Method XbpBrowse():new() Foundation