You are here: Lua Scripting Resources eGuide > Lua Scripting API Reference Guide > Cursor Library > set

6.1 set

cursor.set(cursorname)

Parameter cursorname is a string that contains the name of the cursor shape to use for the mouse pointer. It can be one of the following strings:

Cursor icon

Cursor name

SmartClick?

Usage Notes

"default", "pointer"

N

Used to show the position of the cursor.

“hand pointer”

Y

Used to indicate that the underlying object can be selected or activated with a click.

“crosshair”

Y

Used for fine control of a selection – often used to indicate the bounds of a rectangular region selection.

'hand open"

Y

Indicates that the underlying object can be grabbed.

"hand closed"

N

Indicates that the underlying object has been grabbed.

"drag grab"

N

Typically used to indicate that a pan type of operation is in progress.

“rotation”

Y

Indicates that the underlying object can be rotated and is also used to indicate that the rotation operation is ongoing.

“translation”

Y

Indicates that the underlying object can be translated and is also used to indicate that the translation operation is ongoing.

"dilation"

Y

Indicates that the underlying object can be dilated and is also used to indicate that the dilation operation is ongoing.

“diag resize”

Y

Indicates that a grab at this location will initiate a diagonal resize operation. A hand closed should be used during the resize operation.

“resize column”

Y

Indicates that a grab at this location will initiate a resize column or horizontal resize operation. A hand closed should be used during the resize operation.

“resize row”

Y

Indicates that a grab at this location will initiate a resize row or vertical resize operation. A hand closed should be used during the resize operation.

“zoom in”

Y

Indicates that a click will result in a zoom in.

“zoom out”

Y

Indicates that a click will result in a zoom out.

“zoom box”

Y

Indicates that a click will initiate a zoom box operation.

"pencil"

Y

Indicates that a click will result in the next step in some kind of construction or drawing operation.

"hide"

Y

Indicates that a click will hide the underlying object.

"show"

N

Indicates that a click will show the underlying object.

"clear"

N

Indicates that a click will delete the underlying object.

"animate

Y

Indicates that a click will animate the underlying object.

"interrogate"

N

 

"text"

N

Indicates that the underlying object is text and that a click will initiate an edit of that text.

"link select"

N

Used as part of a linking operation to indicate that the underlying object is available to be linked to.

"unavailable"

N

The current operation is unavailable for the underlying object.

"wait busy"

N

Used by the system to indicate that the handheld is busy doing work.

"writing"

N

Deprecated.

"hollow pointer"

Y

Used when you need a SmartClick mouse pointer. Indicates that the object under the cursor can be selected.

"arrow"

N

No standard usage.

"dotted arrow"

Y

No standard usage.

"excel plus"

Y

Used to indicate the location suitable for initiation of a drag to fill operation.

"mod label"

Y

Deprecated.

What is SmartClick?

SmartClick improves the user experience by making it easier to center click on an object.

How does it work?

When the application displays a SmartClick cursor it is an indication that the next user operation will likely be a center click. Therefore, when a SmartClick cursor is displayed, any click (button press) on the touchpad will result in a center click event being sent to the active application. In this context the user does not have to worry about positioning the finger in the very center of the touchpad – even clicking on the edge of the touchpad will result in a center click.

Introduced in platform.apiLevel = '1.0'