INKINGINFO

2.0

Provides information about where and how the system should display ink.

typedef struct {

DWORD cbSize;

UINT wFlags;

PENTIP tip;

RECT rectClip;

RECT rectInkStop;

HRGN hrgnClip;

HRGN hrgnInkStop;

} INKINGINFO;

Members

cbSize

Size of this structure in bytes.

wFlags

A bitwise-OR combination of the following PII_ flags:

Constant	Description
PII_INKPENTIP	Use tip for pen characteristics.
PII_INKCLIPRECT	Clip ink using rectClip.
PII_INKSTOPRECT	Terminate inking on a pen-down event inside rectInkStop.
PII_INKCLIPRGN	Clip ink using hrgnClip. If hrgnClip is set, any value in rectClip is disregarded.
PII_INKSTOPRGN	Terminate inking on a pen-down event inside hrgnInkStop.
PII_SAVEBACKGROUND	Save the background that is being inked on. The saved background is restored when the current input session terminates.
PII_CLIPSTOP	Directs Windows to stop inking if the pen goes down outside rectClip or hrgnClip, if either have been set.

tip

A PENTIP1AOCX_ structure defining the pen type, size, and color.

rectClip

Clipping rectangle for the ink. Setting rectClip to { -32767, -32767, 32767, 32767} is equivalent to having no clipping region.

rectInkStop

Rectangle in which a pen-down event stops inking. Setting rectInkStop to empty is equivalent to not having an ink stop region.

hrgnClip

Clipping region for the ink. Setting hrgnClip to NULL is equivalent to not having a clipping region.

hrgnInkStop

Region in which a pen-down event stops inking. Setting hrgnInkStop to NULL is equivalent to not having an ink stop region.

Comments

All areas are in screen coordinates.

The wFlags member specifies which of the other members contain valid information. For example, if PII_INKCLIPRECT is set in wFlags, the rectClip member specifies the clipping rectangle. Otherwise, a default value is used.

Before using INKINGINFO, an application must initialize cbSize with sizeof( INKINGINFO ).

See Also

PENTIP, StartInking