# Cursor conventions specification

This is a draft specification for a cursor naming and usage standard. 


## Mailinglist

Discussion of this specification should occur on [[xdg|http://lists.freedesktop.org/mailman/listinfo/xdg]]. 


## Cursor list
[[!table header="no" class="mointable" data="""
 **Cursor**  |  **Description** 
 _default_  |  Default cursor. Indicates the interface is idle and prepared to accept commands from the user. Used to manipulate basic user interface elements like buttons and scrollbars. Usually a left pointing diagonal arrow. 
 _text_  |  Text input cursor. Indicates that the cursor is in a region in which horizontal text can be selected and possibly edited. Typically rendered as a vertical I-beam. 
 _pointer_  |  Indicates that the object below the cursor is clickable. This cursor is typically used for links in web browsers. It shouldn't be abused for pushbuttons and other UI elements where it's otherwise apparent by the design of the widget that it's a clickable object. Often rendered as a pointing hand. 
 _help_  |  Help cursor. Indicates that the system is in a context help mode, and if the user clicks an object a small window will open up to provide usage information for that object. The context help mode is typically activated by clicking a help button on the titlebar of a window that provides context help. Often rendered as the default cursor with a question mark symbol next to it. 
 _progress_  |  Default cursor + busy cursor.  Indicates a pending activity which may asynchronously affect the interface but which is not blocking commands from the user. 
 _wait_  |  Busy cursor.  Indicates that the interface is not prepared to accept commands from the user and is blocked on some external resource. Often rendered as a watch or an hourglass. 
 _copy_  |  !DnD copy cursor. Indicates that a copy of the dragged object will be created in the area below the cursor if dropped. Typically rendered as the default cursor with a small plus sign next to it. 
 _alias_  |  !DnD link cursor. Indicates that a link to the original location of the dragged object will be created in the area below the cursor if dropped. Typically rendered as the default cursor with a small curved arrow next to it. 
 _no-drop_  |  !DnD no-drop cursor. Indicates that the dragged object can't be dropped in the region below the cursor. Typically rendered as the default cursor with a small circle with a diagonal line through it. Can be identical to not-allowed. 
 _not-allowed_  |  Forbidden cursor. Indicates that a particular region is invalid for the current operation. Often rendered as circle with a diagonal line through it. 
 _all-scroll_  |  Scroll/move cursor. Used to indicate that moving the mouse will also move the UI element below the cursor. Often rendered as a combined vertical and horizontal twin-headed arrow. 
 _row-resize_  |  Horizontal splitter bar cursor. Indicates that the bar below the cursor can be moved up and down to resize the objects it separates. Used when it's not apparent if the object below the cursor is just a visual separator between two other UI elements, or an object that can be manipulated. Usually rendered as a vertical twin-headed arrow, split in the middle by a horizontal line. 
 _col-resize_  |  Vertical splitter bar cursor. Indicates that the bar below the cursor can be moved left and right to resize the objects it separates. Used when it's not apparent if the object below the cursor is just a visual separator between two other UI elements, or an object that can be manipulated. Usually rendered as a horizonal twin-headed arrow, split in the middle by a vertical line. 
 _e-resize_  |  Indicates that the cursor is over the right edge of a window, and that the edge can be clicked and dragged in order to resize the window horizontally. 
 _ne-resize_  |  Indicates that the cursor is over the top-right edge of a window, and that the edge can be clicked and dragged in order to resize the window diagonally. 
 _nw-resize_  |  Indicates that the cursor is over the top-left edge of a window, and that the edge can be clicked and dragged in order to resize the window diagonally. 
 _n-resize_  |  Indicates that the cursor is over the top edge of a window, and that the edge can be clicked and dragged in order to resize the window vertically. 
 _se-resize_  |  Indicates that the cursor is over the bottom-right edge of a window, and that the edge can be clicked and dragged in order to resize the window diagonally. 
 _sw-resize_  |  Indicates that the cursor is over the bottom-left edge of a window, and that the edge can be clicked and dragged in order to resize the window diagonally. 
 _s-resize_  |  Indicates that the cursor is over the bottom edge of a window, and that the edge can be clicked and dragged in order to resize the window vertically. 
 _w-resize_  |  Indicates that the cursor is over the left edge of a window, and that the edge can be clicked and dragged in order to resize the window horizontally. 
"""]]


## Cursor list - Nice to have
[[!table header="no" class="mointable" data="""
 **Cursor**  |  **Description** 
 _vertical-text_  |  Text input cursor. Indicates that the cursor is in a region in which vertical text can be selected and possibly edited. Typically rendered as a horizontal I-beam. 
 _crosshair_  |  Crosshair cursor. Typically used for precision drawing or manipulation of an area. 
 _cell_  |  The thick plus sign cursor that's typically used in spread-sheet applications to select cells. 
"""]]


## Cursor list - up for discussion
[[!table header="no" class="mointable" data="""
 **Cursor**  |  **Description** 
 _default_  |  Default cursor. Indicates the interface is idle and prepared to accept commands from the user. Used to manipulate basic user interface elements like buttons and scrollbars. Usually a left pointing diagonal arrow. 
 _up-arrow_  |  Up pointing arrow cursor. This cursor is typically used to identify an insertion point. 
 _context-menu_  |  Indicates that a context menu is available for the object underneath the cursor. Typically rendered as the default cursor with a small menu-like graphic next to it. 
 _ew-resize_  |  Horizontal resizing cursor. Indicates that cursor is over the the left or right edge of a window, and that ithe edge can be clicked and dragged to resize the window horizontally. Typically rendered as a horizontal twin-headed arrow. 
 _ns-resize_  |  Vertical resizing cursor. Indicates that cursor is over the the top or bottom edge of a window, and that the edge can be clicked and dragged to resize the window vertically. Typically rendered as a verticaly twin-headed arrow. 
 _nesw-resize_  |  Back-diagonal resizing cursor. Indicates that the UI element below the cursor is the top-right or bottom-left corner of a window, and that it can be clicked and dragged to resize the window diagonally. Typically a twin-headed arrow. 
 _nwse-resize_  |  Forward-diagonal resizing cursor. Indicates that the UI element below the cursor is the top-left or bottom-right corner of a window, and that it can be clicked and dragged to resize the window diagonally. Typically a twin-headed arrow. 
"""]]

-- Main.[[FredrikHoeglund|FredrikHoeglund]] - 14 Oct 2003