enum Tput::Namespace::MouseCursorShape

Overview

GUI mouse-pointer shapes settable via xterm's OSC 22 ; Pt ST (see Tput::Output#mouse_cursor_shape). #cursor_name yields the on-the-wire name handed to the terminal.

Naming — where a shape exists in both Qt's Qt::CursorShape and the X11 cursor font (X11/cursorfont.h), the Qt name is the primary member and the X11 cursor-font name is an alias (e.g. ArrowCursor/LeftPtr, PointingHandCursor/Hand2, IBeamCursor/Xterm). Other cursor-font glyphs use their cursorfont names; Qt-only shapes (diagonal resizes, drag, open/closed hand, forbidden, busy, blank, splitters) use their Qt names.

On-the-wire mapping (#cursor_name):

• Members backed by a cursor-font glyph emit that glyph name.
• Qt-only shapes with no cursor-font glyph emit an Xcursor theme name (e.g. left_ptr_watch, dnd-move), resolved only on terminals whose OSC 22 falls back to the Xcursor library (recent xterm).

Best-effort and applies only while the pointer is over the terminal window: xterm honors it, most other emulators (and Wayland-native terminals) ignore it. OSC 22 has no custom-bitmap option, so Qt's BitmapCursor/CustomCursor have no equivalent here.

Defined in:

tput/namespace.cr

Enum Members

XCursor = 0

Arrow = 1

BasedArrowDown = 2

BasedArrowUp = 3

Boat = 4

Bogosity = 5

BottomLeftCorner = 6

BottomRightCorner = 7

BottomSide = 8

BottomTee = 9

BoxSpiral = 10

UpArrowCursor = 11

CenterPtr = 11

Circle = 12

Clock = 13

CoffeeMug = 14

Cross = 15

CrossReverse = 16

CrossCursor = 17

Crosshair = 17

DiamondCross = 18

Dot = 19

Dotbox = 20

DoubleArrow = 21

DraftLarge = 22

DraftSmall = 23

DrapedBox = 24

Exchange = 25

SizeAllCursor = 26

Fleur = 26

Gobbler = 27

Gumby = 28

Hand1 = 29

PointingHandCursor = 30

Hand2 = 30

Heart = 31

Icon = 32

IronCross = 33

ArrowCursor = 34

LeftPtr = 34

LeftSide = 35

LeftTee = 36

LeftButton = 37

LlAngle = 38

LrAngle = 39

Man = 40

MiddleButton = 41

Mouse = 42

Pencil = 43

Pirate = 44

Plus = 45

WhatsThisCursor = 46

QuestionArrow = 46

RightPtr = 47

RightSide = 48

RightTee = 49

RightButton = 50

RtlLogo = 51

Sailboat = 52

SbDownArrow = 53

SizeHorCursor = 54

SbHDoubleArrow = 54

SbLeftArrow = 55

SbRightArrow = 56

SbUpArrow = 57

SizeVerCursor = 58

SbVDoubleArrow = 58

Shuttle = 59

Sizing = 60

Spider = 61

Spraycan = 62

Star = 63

Target = 64

Tcross = 65

TopLeftArrow = 66

TopLeftCorner = 67

TopRightCorner = 68

TopSide = 69

TopTee = 70

Trek = 71

UlAngle = 72

Umbrella = 73

UrAngle = 74

WaitCursor = 75

Watch = 75

IBeamCursor = 76

Xterm = 76

SizeBDiagCursor = 100

Qt shapes with no X11 cursor-font glyph; #cursor_name emits an Xcursor theme name for these. Offset to leave the cursor-font block contiguous.

SizeFDiagCursor = 101

SplitVCursor = 102

SplitHCursor = 103

BlankCursor = 104

ForbiddenCursor = 105

BusyCursor = 106

OpenHandCursor = 107

ClosedHandCursor = 108

DragCopyCursor = 109

DragMoveCursor = 110

DragLinkCursor = 111

Instance Method Summary

• #arrow?

  Returns true if this enum value equals Arrow

• #arrow_cursor?

  Returns true if this enum value equals ArrowCursor

• #based_arrow_down?

  Returns true if this enum value equals BasedArrowDown

• #based_arrow_up?

  Returns true if this enum value equals BasedArrowUp

• #blank_cursor?

  Returns true if this enum value equals BlankCursor

• #boat?

  Returns true if this enum value equals Boat

• #bogosity?

  Returns true if this enum value equals Bogosity

• #bottom_left_corner?

  Returns true if this enum value equals BottomLeftCorner

• #bottom_right_corner?

  Returns true if this enum value equals BottomRightCorner

• #bottom_side?

  Returns true if this enum value equals BottomSide

• #bottom_tee?

  Returns true if this enum value equals BottomTee

• #box_spiral?

  Returns true if this enum value equals BoxSpiral

• #busy_cursor?

  Returns true if this enum value equals BusyCursor

• #center_ptr?

  Returns true if this enum value equals CenterPtr

• #circle?

  Returns true if this enum value equals Circle

• #clock?

  Returns true if this enum value equals Clock

• #closed_hand_cursor?

  Returns true if this enum value equals ClosedHandCursor

• #coffee_mug?

  Returns true if this enum value equals CoffeeMug

• #cross?

  Returns true if this enum value equals Cross

• #cross_cursor?

  Returns true if this enum value equals CrossCursor

• #cross_reverse?

  Returns true if this enum value equals CrossReverse

• #crosshair?

  Returns true if this enum value equals Crosshair

• #cursor_name : String

  The name OSC 22 expects on the wire for this shape.

• #diamond_cross?

  Returns true if this enum value equals DiamondCross

• #dot?

  Returns true if this enum value equals Dot

• #dotbox?

  Returns true if this enum value equals Dotbox

• #double_arrow?

  Returns true if this enum value equals DoubleArrow

• #draft_large?

  Returns true if this enum value equals DraftLarge

• #draft_small?

  Returns true if this enum value equals DraftSmall

• #drag_copy_cursor?

  Returns true if this enum value equals DragCopyCursor

• #drag_link_cursor?

  Returns true if this enum value equals DragLinkCursor

• #drag_move_cursor?

  Returns true if this enum value equals DragMoveCursor

• #draped_box?

  Returns true if this enum value equals DrapedBox

• #exchange?

  Returns true if this enum value equals Exchange

• #fleur?

  Returns true if this enum value equals Fleur

• #forbidden_cursor?

  Returns true if this enum value equals ForbiddenCursor

• #gobbler?

  Returns true if this enum value equals Gobbler

• #gumby?

  Returns true if this enum value equals Gumby

• #hand1?

  Returns true if this enum value equals Hand1

• #hand2?

  Returns true if this enum value equals Hand2

• #heart?

  Returns true if this enum value equals Heart

• #i_beam_cursor?

  Returns true if this enum value equals IBeamCursor

• #icon?

  Returns true if this enum value equals Icon

• #iron_cross?

  Returns true if this enum value equals IronCross

• #left_button?

  Returns true if this enum value equals LeftButton

• #left_ptr?

  Returns true if this enum value equals LeftPtr

• #left_side?

  Returns true if this enum value equals LeftSide

• #left_tee?

  Returns true if this enum value equals LeftTee

• #ll_angle?

  Returns true if this enum value equals LlAngle

• #lr_angle?

  Returns true if this enum value equals LrAngle

• #man?

  Returns true if this enum value equals Man

• #middle_button?

  Returns true if this enum value equals MiddleButton

• #mouse?

  Returns true if this enum value equals Mouse

• #open_hand_cursor?

  Returns true if this enum value equals OpenHandCursor

• #pencil?

  Returns true if this enum value equals Pencil

• #pirate?

  Returns true if this enum value equals Pirate

• #plus?

  Returns true if this enum value equals Plus

• #pointing_hand_cursor?

  Returns true if this enum value equals PointingHandCursor

• #question_arrow?

  Returns true if this enum value equals QuestionArrow

• #right_button?

  Returns true if this enum value equals RightButton

• #right_ptr?

  Returns true if this enum value equals RightPtr

• #right_side?

  Returns true if this enum value equals RightSide

• #right_tee?

  Returns true if this enum value equals RightTee

• #rtl_logo?

  Returns true if this enum value equals RtlLogo

• #sailboat?

  Returns true if this enum value equals Sailboat

• #sb_down_arrow?

  Returns true if this enum value equals SbDownArrow

• #sb_h_double_arrow?

  Returns true if this enum value equals SbHDoubleArrow

• #sb_left_arrow?

  Returns true if this enum value equals SbLeftArrow

• #sb_right_arrow?

  Returns true if this enum value equals SbRightArrow

• #sb_up_arrow?

  Returns true if this enum value equals SbUpArrow

• #sb_v_double_arrow?

  Returns true if this enum value equals SbVDoubleArrow

• #shuttle?

  Returns true if this enum value equals Shuttle

• #size_all_cursor?

  Returns true if this enum value equals SizeAllCursor

• #size_b_diag_cursor?

  Returns true if this enum value equals SizeBDiagCursor

• #size_f_diag_cursor?

  Returns true if this enum value equals SizeFDiagCursor

• #size_hor_cursor?

  Returns true if this enum value equals SizeHorCursor

• #size_ver_cursor?

  Returns true if this enum value equals SizeVerCursor

• #sizing?

  Returns true if this enum value equals Sizing

• #spider?

  Returns true if this enum value equals Spider

• #split_h_cursor?

  Returns true if this enum value equals SplitHCursor

• #split_v_cursor?

  Returns true if this enum value equals SplitVCursor

• #spraycan?

  Returns true if this enum value equals Spraycan

• #star?

  Returns true if this enum value equals Star

• #target?

  Returns true if this enum value equals Target

• #tcross?

  Returns true if this enum value equals Tcross

• #top_left_arrow?

  Returns true if this enum value equals TopLeftArrow

• #top_left_corner?

  Returns true if this enum value equals TopLeftCorner

• #top_right_corner?

  Returns true if this enum value equals TopRightCorner

• #top_side?

  Returns true if this enum value equals TopSide

• #top_tee?

  Returns true if this enum value equals TopTee

• #trek?

  Returns true if this enum value equals Trek

• #ul_angle?

  Returns true if this enum value equals UlAngle

• #umbrella?

  Returns true if this enum value equals Umbrella

• #up_arrow_cursor?

  Returns true if this enum value equals UpArrowCursor

• #ur_angle?

  Returns true if this enum value equals UrAngle

• #wait_cursor?

  Returns true if this enum value equals WaitCursor

• #watch?

  Returns true if this enum value equals Watch

• #whats_this_cursor?

  Returns true if this enum value equals WhatsThisCursor

• #x_cursor?

  Returns true if this enum value equals XCursor

• #xterm?

  Returns true if this enum value equals Xterm

Instance Method Detail