ReaderScroll callback function

Článek
12/11/2020

[ReaderScroll is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

An application-defined callback function used when the mouse pointer is moved within the portion of the reader mode window that has been declared as the active scrolling area.

Syntax

BOOL CALLBACK ReaderScroll(
  _In_ PREADERMODEINFO prmi,
  _In_ int             dx,
  _In_ int             dy
);

Parameters

prmi [in]

Type: PREADERMODEINFO

A pointer to the READERMODEINFO structure that was passed to the DoReaderMode function. This structure defines the reader mode window and the active scrolling area.

dx [in]

Type: int

The distance to scroll horizontally. If the RMF_VERTICALONLY flag is set in the READERMODEINFO structure, this value is always 0.

dy [in]

Type: int

The distance to scroll vertically. If the RMF_HORIZONTALONLY flag is set in the READERMODEINFO structure, this value is always 0.

Return value

Type: BOOL

This function should always return TRUE.

Remarks

When the application receives notification from this function, the application is responsible for scrolling the reader mode window in the direction specified by the dx and dy parameters.

Examples

The following example outlines an implementation of this function using a custom function to accomplish the scrolling.

BOOL CALLBACK
ReaderScrollCallback(PREADERMODEINFO prmi, int dx, int dy)
{
    if (prmi == NULL) 
        return FALSE;

    // Call custom ScrollWindow method to scroll the window
    ScrollWindow(prmi->hwnd, dx, dy);
    
    return TRUE;
}

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]

Sdílet prostřednictvím