WAGINFO (Windows Embedded CE 6.0)
1/6/2010
The WAGINFO structure contains the window auto gesture settings that you set or query for a window. You can use this structure with the SetWindowAutoGesture and GetWindowAutoGesture functions.
Syntax
typedef struct tagWAGI {
size_t cbSize;
DWORD dwFlags;
UINT nOwnerAnimateMessage;
UINT nAnimateStatusMessage;
HBRUSH hExtentBrush;
UINT nItemHeight;
UINT nItemWidth;
BYTE bHorizontalExtent;
BYTE bVerticalExtent;
} WAGINFO
Parameters
Term |
Definition |
cbSize |
Size of the structure in bytes. |
dwFlags |
A bit mask that combines the following properties:
WAGIF_OWNERANIMATEIndicates that the window procedure handles all animation. The window auto gesture system sends animation messages, specified in nOwnerAnimateMessage, to the window procedure each time you need to animate the window. When you set this flag, the window procedure is also responsible for manipulating the scroll bar position and drawing the control content. This flag is required.
WAGIF_VSCROLLABLEEnables vertical scrolling for pan and flick gestures. Ignores horizontal scrolling. Combine with WAGIF_HSCROLLABLE to enable scrolling in all directions.
WAGIF_HSCROLLABLEEnables horizontal scrolling for pan and flick gestures. Ignores vertical scrolling. Combine with WAGIF_VSCROLLABLE to enable scrolling in all directions.
WAGIF_LOCKAXESLimits scrolling for flick gestures to the horizontal and vertical axes. Ignored unless WAGIF_VSCROLLABLE and WAGIF_HSCROLLABLE are both set. If you set WAGIF_LOCKAXES, you must also set WAGIF_IGNOREPAN.
WAGIF_IGNOREPANTurns off automatic gesture handling of pan messages.
WAGIF_IGNORESCROLLTurns off automatic gesture handling of flick messages.
|
nOwnerAnimateMessage |
The animation message ID that the window auto gesture system sends to the window. This message indicates that the window must redraw the window content after a touch interaction. You must set this value to either greater than the value of WM_USER or to 0 (zero). If you set this value to 0 (zero), then the window auto gesture system sends either WM_HSCROLL or WM_VSCROLL messages when you must redraw the window, and the nHorizontalExtent and nVerticalExtent members are treated as 0 (zero). |
nAnimateStatusMessage |
The message ID that the window auto gesture system sends to the window procedure when touch interactions start and end. You must set this value to either greater than the value of WM_USER or to 0 (zero). If you set this value to 0 (zero), then the window auto gesture system does not send any animation status messages. The lParam value contains the status information that identifies the new animation state for the control. The following values are possible:
WAG_STATUS_ANIMATION_CHANGE indicates that the scrolling input mode has changed. For example, it may change from a continuous input (pan) to a discrete one (flick). The wParam value contains more information about the lParam value. If lParam is WAG_STATUS_ANIMATION_START or WAG_STATUS_ANIMATION_CHANGE, the valid wParam values are WAG_STATUS_ANIMATION_CONTINUOUS or WAG_STATUS_ANIMATION_DISCRETE. If lParam is WAG_STATUS_ANIMATION_END, then wParam is WAG_STATUS_ANIMATION_ FINISHED (the animation finished without any interruptions) or WAG_STATUS_ANIMATION_INTERRUPTED (a new input interrupts the animation, such as tapping a list that is scrolling because of a previous flick). |
hExtentBrush |
Reserved. |
nItemHeight |
The height of each item in the scroll range, in pixels. If you set this value to 0 (zero), then the window auto gesture system calculates the item height by using the following formula: nItemHeight = <Window Client size> / vertical scroll bar page range size When the value is 0 (zero), the height is recalculated if the window size changes. |
nItemWidth |
The width of each item in the scroll range, in pixels. If you set this value to 0 (zero), then the window auto gesture system calculates the item width by using the following formula: nItemHeight = <Window Client size> / horizontal scroll bar page range size When the value is 0 (zero), the width is recalculated if the window size changes. |
bHorizontalExtent |
The percentage of the viewable window height that can be extended beyond the scroll range in the horizontal axis, from 0 to 100. Once the pan action reaches the limit, no more pan messages are processed. If you set nOwnerAnimateMessage to 0 (zero), bHorizontalExtent is treated as 0 (zero), there are no boundary animations for pan messages, and flick messages use the bounce animation. If you set nOwnerAnimateMessage to a nonzero value, both pan and flick messages use the rubber band boundary animation. For more information about boundary animations, see Physics Engine Constants. |
bVerticalExtent |
The percentage of the viewable window width that can be extended beyond the scroll range in the vertical axis, from 0 to 100. Once the pan action reaches the limit, no more pan messages are processed. If you set nOwnerAnimateMessage to 0 (zero), bVerticalExtent is treated as 0 (zero), there are no boundary animations for pan messages, and flick messages use the bounce animation. If you set nOwnerAnimateMessage to a nonzero value, both pan and flick messages use the rubber band boundary animation. For more information about boundary animations, see Physics Engine Constants. |
Remarks
A call to SetWindowAutoGesture returns false if dwFlags does not include WAGIF_OWNERANIMATE.
Requirements
Header | pwinuser.h |
sysgen | SYSGEN_GESTUREANIMATION |