SSGetCursor, SSSetCursor Functions
Applies To
fpSpread DLL control
Description
Set or return the pointer the fpSpread control displays in a variety of situations.
Syntax
C
HCURSOR SSGetCursor(HWND hWnd, WORD wType);
BOOL SSSetCursor(HWND hWnd, WORD wType, HCURSOR hCursor);
C++
HCURSOR TSpread::GetCursor(WORD wType);
BOOL TSpread::SetCursor(WORD wType, HCURSOR hCursor);
Parameters
The SSGetCursor function has the following parameters:
| Parameter | Description | |
|---|---|---|
| hWnd | Window handle of the fpSpread control | |
| wType | Pointer type to be returned Use one of the following values: |
|
| Constant | Description | |
| SS_CURSORTYPE_DEFAULT | Crosshair pointer used throughout control | |
| SS_CURSORTYPE_COLRESIZE | Pointer displayed to resize column widths | |
| SS_CURSORTYPE_ROWRESIZE | Pointer displayed to resize row heights | |
| SS_CURSORTYPE_BUTTON | Pointer displayed over a button | |
| SS_CURSORTYPE_GRAYAREA | Pointer displayed over the gray area | |
| SS_CURSORTYPE_LOCKEDCELL | Pointer displayed over a locked cell | |
| SS_CURSORTYPE_COLHEADER | Pointer displayed over column header | |
| SS_CURSORTYPE_ROWHEADER | Pointer displayed over row header | |
| SS_CURSORTYPE_DRAGDROPAREA | Pointer displayed on the edge of the selection to drag and drop | |
| SS_CURSORTYPE_DRAGDROP | Pointer displayed while drag-drop operation is being performed | |
The SSSetCursor function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| wType | Pointer type (Can be one of the values listed for the SSGetCursor wType parameter.) |
| hCursor | New pointer to display (Value can be a valid pointer handle or one of the values listed for the return values for the SSGetCursor function. It is the application's responsibility to delete the pointer after the Spread control has been destroyed.) |
Remarks
This function is applied to the entire workbook, including all sheets in the control.
Return Value
SSGetCursor: The pointer returned can be a pointer handle or one of the following values.
| Constant | Description |
|---|---|
| SS_CURSOR_DEFAULT | Supplied default pointer |
| SS_CURSOR_ARROW | Windows arrow pointer |
| SS_CURSOR_DEFCOLRESIZE | Supplied default column resize pointer |
| SS_CURSOR_DEFROWRESIZE | Supplied default row resize pointer |
SSSetCursor: TRUE if the function completes successfully; FALSE otherwise.
See Also
ActiveX Correspondence
CursorIcon, CursorStyle, CursorType properties