PtGenListDrawBackground()

Draw the background of a list

Synopsis:

void PtGenListDrawBackground(
         PtWidget_t *list,
         PtGenListItem_t const *items,
         unsigned nitems,
         PhRect_t const *where,
         int lmarg,
         int rmarg,
         int tmarg,
         int bmarg );

Arguments:

list

The widget pointer.

items

A pointer to the PtGenListItem_t structure for the first item that needs to be redrawn.

nitems

The number of items the function should look at.

where

A pointer to a PhRect_t structure (see the Photon Library Reference) that defines the extent of the items.

lmarg, rmarg, tmarg, bmarg

These arguments define additional "margins" on the left, right, top, and bottom -- by setting them to a positive value, you can shorten the selection bar.

Description:

This function can be used by a child class of PtGenList for drawing the background. If the Pt_GEN_LIST_SHOW_DAMAGED bit is set in list->gflags, the function draws only the background for damaged items.

To determine the color it uses to draw the background, PtGenListDrawBackground() calls the List Attributes method for the list widget.

Classification:

Photon

See also:

PtGenList, PtGenListItem_t

PhRect_t in the Photon Library Reference