CANDIDATEFORM

The CANDIDATEFORM structure contains position information for the candidate window.

typedef struct tagCANDIDATEFORM {
  DWORD  dwIndex;       
  DWORD  dwStyle;       
  POINT  ptCurrentPos;  
  RECT   rcArea;        
} CANDIDATEFORM, *PCANDIDATEFORM;

Members

dwIndex

Candidate list identifier. Can be 0 for the first list, 1 for the second, and so on. The maximum index is 3.

dwStyle

Position style. This member can be one of the following values.

Value	Meaning
CFS_CANDIDATEPOS	Displays the upper-left corner of the candidate list window at the position specified by ptCurrentPos. The coordinates are relative to the upper-left corner of the window containing the list window, and are subject to adjustment by the system.
CFS_EXCLUDE	Excludes the candidate window from the area specified by rcArea. The ptCurrentPos member specifies the coordinates of the current point of interest, typically the caret position.

ptCurrentPos

A POINT structure containing the coordinates of the upper-left corner of the candidate window or the caret position, depending on the value of dwStyle.

rcArea

A RECT structure containing the coordinates of the upper-left and lower-right corners of the exclusion area.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.

See Also

Input Method Editor Overview, Input Method Editor Structures, POINT, RECT