Difference between revisions of "cursor.set"

From Inspired-Lua Wiki
Jump to navigation Jump to search
(Created page with " Category:cursor")
 
Line 1: Line 1:
 +
cursor.'''set''' is a function that is part of the [[:Category:cursor|cursor functions]].
 +
<br />
  
 +
It sets the shape of the mouse pointer to display.<br />
 +
 +
{{Since|3.0}}
 +
 +
== Syntax  ==
 +
cursor.'''set'''(cursorName)
 +
 +
{| class="wikitable"
 +
|-
 +
! Parameter !! Type !! Description
 +
|-
 +
| <u><center>cursorName</center></u> || string || The name of the cursor shape to use for the mouse pointer. It can be one of the following strings :
 +
"default",
 +
"interrogation",
 +
"crosshair",
 +
"text",
 +
"pointer",
 +
"link select",
 +
"diag resize",
 +
"wait busy",
 +
"hollow pointer",
 +
"rotation",
 +
"pencil",
 +
"zoom box",
 +
"hide",
 +
"arrow",
 +
"zoom out",
 +
"dotted arrow",
 +
"clear",
 +
"animate",
 +
"excel plus",
 +
"mod label",
 +
"writing",
 +
"unavailable",
 +
"resize row",
 +
"resize column",
 +
"drag grab",
 +
"hand open",
 +
"hand closed",
 +
"hand pointer",
 +
"zoom in",
 +
"dilation",
 +
"translation",
 +
"show"
 +
|-
 +
|}
 +
 +
== Example  ==
 +
<syntaxhighlight>if (needsCursor == true) then
 +
  cursor.set("pencil")
 +
end</syntaxhighlight>
 +
 +
== See also  ==
 +
*[[cursor.show]]
 +
 +
<br /><br />
 +
 +
 +
[[Category:cursor]]
  
  
 
[[Category:cursor]]
 
[[Category:cursor]]

Revision as of 12:20, 11 June 2011

cursor.set is a function that is part of the cursor functions.

It sets the shape of the mouse pointer to display.

This has been introduced in TI-Nspire OS 3.0 (Changes).


Syntax

cursor.set(cursorName)

Parameter Type Description
cursorName
string The name of the cursor shape to use for the mouse pointer. It can be one of the following strings :

"default", "interrogation", "crosshair", "text", "pointer", "link select", "diag resize", "wait busy", "hollow pointer", "rotation", "pencil", "zoom box", "hide", "arrow", "zoom out", "dotted arrow", "clear", "animate", "excel plus", "mod label", "writing", "unavailable", "resize row", "resize column", "drag grab", "hand open", "hand closed", "hand pointer", "zoom in", "dilation", "translation", "show"

Example

if (needsCursor == true) then
   cursor.set("pencil")
end

See also