NMPGSCROLL structure (commctrl.h)

  • Article

Contains and receives information that the pager control uses when scrolling the contained window. It is used with the PGN_SCROLL notification.

Syntax

typedef struct {
  NMHDR hdr;
  WORD  fwKeys;
  RECT  rcParent;
  int   iDir;
  int   iXpos;
  int   iYpos;
  int   iScroll;
} NMPGSCROLL, *LPNMPGSCROLL;

Members

hdr

Type: NMHDR

NMHDR structure that contains information about the notification.

fwKeys

Type: BOOL

Modifier keys that are down when the scroll occurs. This can be one or more of the following values:

Value Meaning
0
 None of the modifier keys are down.
PGK_SHIFT
 The SHIFT key is down.
PGK_CONTROL
 The CONTROL key is down.
PGK_MENU
 The ALT key is down.

rcParent

Type: RECT

Contains the client rectangle of the pager control.

iDir

Type: int

Value that indicates in which direction the scroll is occurring. This will be one of the following values:

Value Meaning
PGF_SCROLLDOWN
 The contained window is being scrolled down.
PGF_SCROLLLEFT
 The contained window is being scrolled to the left.
PGF_SCROLLRIGHT
 The contained window is being scrolled to the right.
PGF_SCROLLUP
 The contained window is being scrolled up.

iXpos

Type: int

Contains the horizontal scroll position of the contained window, in pixels, before the scroll action.

iYpos

Type: int

Contains the vertical scroll position of the contained window, in pixels, before the scroll action.

iScroll

Type: int

On entry, contains the default scroll delta in pixels. This member can be modified to contain a different scroll delta amount if desired. This value is always positive, regardless of the scroll direction.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header commctrl.h