  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Fifteen — Windows/OS Functions (continued)
Overview
The SetCursor function sets the cursor (the mouse) to a specific icon type.
Syntax/Parameters
Syntax
int = SetCursor ( [int type] );
Parameters
type
An optional int specifying the type of cursor to set. If omitted, the default is “wait”.
Return Value
A int which will be ERROR_NONE (0) or ERROR_SOFT. An error is returned if the frame of the application is not displayed.
Remarks
Only a limited number of cursors may be set, largely to allow the ‘wait’ cursor to be shown. The cursor is set only if the new cursor is different from the previous cursor; otherwise, the function returns immediately.
The cursor is a shared resource. A window should set the cursor shape only when the cursor is in its client area or when the window is capturing mouse input. In systems without a mouse, the window should restore the previous cursor before the cursor leaves the client area or before it relinquishes control to another window.
If a cursor is set in a function or within the script, it is automatically restored to the previous cursor on the exit of the function or exit of the script.
RestoreCursor
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.