Main Page   Modules   Class Hierarchy   Data Structures   File List   Data Fields   Globals  

SBL_NEW_BLOCK Struct Reference
[MGui Structures]

Data feed for Skip and Clip List objects. More...


Data Fields

int from
 This field is meaningful only in case of 'Skip' List.

long offset
 Starting offset position relative to the location specified by 'from'.

int nc
 Item length.

int nr
 Number of rows (items) the application is asked to supply.

XL_ITEMpi
 Pointer to destination item list (where the application can store returned items).


Detailed Description

Data feed for Skip and Clip List objects.

This structure is passed to the NewBlock callback by the 'Clip' and 'Skip' List Objects when, due to user scrolling, the objects needs to query the application to supply new data items. The member 'nr' is also a return value of the callback in case of 'Skip' List Object. It specifies the number of rows actually returned. See MCreateSListSkip(), MCreateSListClip() and CmClippedSList for object creation details.


Field Documentation

int SBL_NEW_BLOCK::from
 

This field is meaningful only in case of 'Skip' List.

The Skip List object sets this value to tell the application where to retrieve items from. Possible values:

  • SEEK_SET (from the beginning)
  • SEEK_CUR (from current position)
  • SEEK_END (from the end of the list)

int SBL_NEW_BLOCK::nc
 

Item length.

int SBL_NEW_BLOCK::nr
 

Number of rows (items) the application is asked to supply.

If the nr of actually available items is smaller than the number requested by the object, then the application should set this field to the actual number of returned items.

long SBL_NEW_BLOCK::offset
 

Starting offset position relative to the location specified by 'from'.

XL_ITEM* SBL_NEW_BLOCK::pi
 

Pointer to destination item list (where the application can store returned items).


Generated on Sun Jun 29 13:03:08 2003 for MGui API by doxygen1.3-rc2