cursor.width Parameter

cursor.width parameter

Use the cursor.width parameter to set or query the width in pixels used to display the cursor in insert mode.

Availability

query command
set command
current parameter
default parameter
install parameter

Scope

cursor.width is scoped to the current view.
current.cursor.width is scoped to the current view.
default.cursor.width is globally scoped.
install.cursor.width is globally scoped.

Syntax
query cursor.width
set cursor.width [ default | n ]
query current.cursor.width
query default.cursor.width
set default.cursor.width [ install | n ]
query install.cursor.width 
Parameters

default If you specify the default parameter for the set cursor.width command, the current view will use the value of default.cursor.width to display the cursor in insert mode.
n If you specify the n parameter for the set cursor.width command, the current view will use n pixels for displaying the cursor in insert mode. If you specify the n parameter for the set default.cursor.width command, all document views that have the cursor.width set to default will use n pixels to display the cursor in insert mode.

n must be an integer value between 1 and 20.
install If you specify the install parameter for the set default.cursor.width command, all views with cursor.width set to default will use the value of install.cursor.width to determine the width in pixels for displaying the cursor in insert mode.

Description

If you do not specify any of the parameters for the set cursor.width command, default is assumed. If you do not specify any of the parameters for the set default.cursor.width command, install is assumed.

The query current.cursor.width command returns the width in pixels used to display the cursor in insert mode in the current view.

In replace mode, the width of the cursor is the width of the character at the current location.

Examples
query cursor.width
set cursor.width 4
query current.cursor.width
query default.cursor.width
set default.cursor.width 1
query install.cursor.width 
query command
set command
current parameter
default parameter
install parameter
cursor.blinkTime parameter
insertMode parameter
toggleInsert action

default	If you specify the default parameter for the set cursor.width command, the current view will use the value of default.cursor.width to display the cursor in insert mode.
n	If you specify the n parameter for the set cursor.width command, the current view will use n pixels for displaying the cursor in insert mode. If you specify the n parameter for the set default.cursor.width command, all document views that have the cursor.width set to default will use n pixels to display the cursor in insert mode. n must be an integer value between 1 and 20.
install	If you specify the install parameter for the set default.cursor.width command, all views with cursor.width set to default will use the value of install.cursor.width to determine the width in pixels for displaying the cursor in insert mode.