c:\spider2\sports2000\gui\bbin.w

/*------------------------------------------------------------------------

  File: adm2\src\browser.w

  Description: SmartDataBrowser Object

  Input Parameters:
      <none>

  Output Parameters:
      <none>

------------------------------------------------------------------------*/

Parameters:

None

Procedures Summary:

dataAvailable   •  destroyObject   •  disable_UI   •  displayLinks   •  displayObjects   •  initializeObject   •  repositionObject   •  resizeObject   •  start-super-proc

Functions Summary:

anyMessage   •  fetchMessages   •  getObjectType   •  getObjectVersion   •  getRowObject   •  getUIBMode   •  getUserProperty   •  linkHandles   •  messageNumber   •  setUserProperty   •  showMessage   •  stripCalcs

Procedures:

/*------------------------------------------------------------------------------
  Purpose:     SmartDataBrowser version of dataAvailable.
               Repositions itself in response to a query reposition in its 
               DataSource.
  Parameters:  pcRelative AS CHARACTER
               Possible values are:
               FIRST    - Repositions to the first row in the browse
               LAST     - Repositions to the last row in the browse
               PREV     - Repositions to the prev row in the browse
               NEXT     - Repositions to the next row in the browse
               REPOSITIONED - A navigation has taken place, but the query has 
                              been repositioned so the browse is already 
                              on the correct record 
               DIFFERENT- Returns or invokes next up on the chain 
                         (If database based browse query.p will publish 
                          dataavail, is not important for SDO browsing)
                                          
  Notes:       This procedure is here rather than in browser.p because it
               must sometimes use query.p, and sometimes datavis.p, as its
               super procedure, depending on whether the SmartDataBrowser has 
               its own database query.
------------------------------------------------------------------------------*/

INPUT pcRelative AS CHARACTER  


/*------------------------------------------------------------------------------
  Purpose:     DISABLE the User Interface
  Parameters:  <none>
  Notes:       Here we clean-up the user-interface by deleting
               dynamic widgets we have created and/or hide 
               frames.  This procedure is usually called when
               we are ready to "clean-up" after running.
------------------------------------------------------------------------------*/

/*------------------------------------------------------------------------------
  Purpose:     This procedure is run during initialization to display initial
               values for non-database-related fields, and is also run from
               displayFields in case those values change with each new record.
  Parameters:  <none>
  Notes:       This procedure is in the include file rather than the super 
               procedure because it is easiest to display the fields in the
               DISPLAYED-OBJECTS list from the object itself. 
------------------------------------------------------------------------------*/

INPUT pdCol AS DECIMAL  
INPUT pdRow AS DECIMAL  


INPUT pd_height AS DECIMAL  
INPUT pd_width AS DECIMAL  


/*------------------------------------------------------------------------------
  Purpose:     Procedure to start a super proc if it's not already running, 
               and to add it as a super proc in any case.
  Parameters:  Procedure name to make super.
  Notes:       NOTE: This presumes that we want only one copy of an ADM
               super procedure running per session, meaning that they are 
               stateless and "multi-threaded". This is intended to be the case
               for ours, but may not be true for all super procs.
------------------------------------------------------------------------------*/

INPUT pcProcName AS CHARACTER  


Functions:

FUNCTION anyMessage RETURNS LOGICAL IN SUPER .

FUNCTION fetchMessages RETURNS CHARACTER IN SUPER .

FUNCTION getObjectType RETURNS CHARACTER ( ) FORWARD .

FUNCTION getObjectVersion RETURNS CHARACTER IN SUPER .

FUNCTION getRowObject RETURNS HANDLE ( ) FORWARD .

FUNCTION getUIBMode RETURNS CHARACTER IN SUPER .

FUNCTION getUserProperty RETURNS CHARACTER ( INPUT pcPropName AS CHARACTER INPUT ) IN SUPER .

FUNCTION linkHandles RETURNS CHARACTER ( INPUT pcLink AS CHARACTER INPUT ) IN SUPER .

FUNCTION messageNumber RETURNS CHARACTER ( INPUT piMessage AS INTEGER INPUT ) IN SUPER .

/* These preprocessors let the get and set methods know at compile time
    which property values are located in the temp-table and which must
    be accessed through the property functions.
 */

FUNCTION setUserProperty RETURNS LOGICAL ( INPUT pcPropName AS CHARACTER INPUT , INPUT pcPropValue AS CHARACTER INPUT ) IN SUPER .

/* These preprocessors tell at compile time which properties can be
     retrieved directly from the property temp-table. */

FUNCTION showMessage RETURNS LOGICAL ( INPUT pcText AS CHARACTER INPUT ) IN SUPER .

FUNCTION stripCalcs RETURNS CHARACTER ( INPUT cClause AS CHARACTER INPUT ) IN SUPER .