xtd::forms::cursors Class Reference

Inheritance diagram for xtd::forms::cursors:

Definition

Provides a collection of xtd::forms::cursor objects for use by a Windows Forms application.

Header

#include <xtd/forms/cursors>

Namespace

xtd::forms

Library

xtd.forms

Examples

The following code example demonstrates the use of cursors component.

#include <xtd/xtd>
 
class form1 : public form {
public:
  form1() {
    text("Cursor example");
    start_position(form_start_position::manual);
    location({200, 200});
    client_size({360, 240});
    
    list_box_loading_indicators.parent(*this);
    list_box_loading_indicators.bounds({20, 20, 150, 200});
    list_box_loading_indicators.anchor(anchor_styles::top | anchor_styles::left | anchor_styles::bottom);
    list_box_loading_indicators.items().add_range({{"Default", cursors::default_cursor()}, {"Application Starting", cursors::app_starting()}, {"Arrow", cursors::arrow()}, {"Closed hand", cursors::closed_hand()}, {"Contextual menu", cursors::contextual_menu()}, {"Cell", cursors::cell()}, {"Cross", cursors::cross()}, {"Disappearing item", cursors::disappearing_item()}, {"Drag copy", cursors::drag_copy()}, {"Drag link", cursors::drag_link()}, {"Hand", cursors::hand()}, {"Help", cursors::help()}, {"Horizontal split", cursors::hsplit()}, {"I beam", cursors::ibeam()}, {"No", cursors::no()}, {"No drag", cursors::no_drag()}, {"No move 2d", cursors::no_move_2d()}, {"No move horizontal", cursors::no_move_horiz()}, {"No move vertical", cursors::no_move_vert()}, {"Open hand", cursors::open_hand()}, {"Pan east", cursors::pan_east()}, {"Pan north east", cursors::pan_ne()}, {"Pan north", cursors::pan_north()}, {"Pan north west", cursors::pan_nw()}, {"Pan south east", cursors::pan_se()}, {"Pan south", cursors::pan_south()}, {"Pan south west", cursors::pan_sw()}, {"Pan West", cursors::pan_west()}, {"Size all", cursors::size_all()}, {"Size north-east south-west", cursors::size_nesw()}, {"Size north south", cursors::size_ns()}, {"Size north-west south-east", cursors::size_nwse()}, {"Size west east", cursors::size_we()}, {"Up arrow", cursors::up_arrow()}, {"Vertical I beam", cursors::vibeam()}, {"Vertical split", cursors::vsplit()}, {"Wait", cursors::wait_cursor()}, {"Zoom in", cursors::zoom_in()}, {"Zoom out", cursors::zoom_out()}});
    list_box_loading_indicators.selected_index_changed += delegate_ {
      loading_indicator_panel.cursor(as<forms::cursor>(list_box_loading_indicators.selected_item().tag()));
    };
    list_box_loading_indicators.selected_item("Default");
    
    loading_indicator_panel.parent(*this);
    loading_indicator_panel.border_style(border_style::fixed_3d);
    loading_indicator_panel.back_color(drawing::system_colors::window());
    loading_indicator_panel.bounds({190, 20, 150, 200});
    loading_indicator_panel.anchor(anchor_styles::top | anchor_styles::left | anchor_styles::bottom | anchor_styles::right);
  }
  
private:
  list_box list_box_loading_indicators;
  panel loading_indicator_panel;
};
 
auto main() -> int {
  application::run(form1 {});
}

Public Static Properties
static auto	app_starting () -> xtd::forms::cursor
	Gets the cursor that appears when an application starts.
static auto	arrow () -> xtd::forms::cursor
	Gets the arrow cursor.
static auto	closed_hand () -> xtd::forms::cursor
	Gets the closed hand cursor.
static auto	contextual_menu () -> xtd::forms::cursor
	Gets the contextual menu cursor.
static auto	cell () -> xtd::forms::cursor
	Gets the cell cursor.
static auto	cross () -> xtd::forms::cursor
	Gets the crosshair cursor.
static auto	default_cursor () -> xtd::forms::cursor
	Gets the default cursor, which is usually an arrow cursor.
static auto	disappearing_item () -> xtd::forms::cursor
	Gets the disappearing item cursor.
static auto	drag_copy () -> xtd::forms::cursor
	Gets the drag copy cursor.
static auto	drag_link () -> xtd::forms::cursor
	Gets the drag link cursor.
static auto	hand () -> xtd::forms::cursor
	Gets the hand cursor, typically used when hovering over a Web link.
static auto	help () -> xtd::forms::cursor
	Gets the Help cursor, which is a combination of an arrow and a question mark.
static auto	hsplit () -> xtd::forms::cursor
	Gets the cursor that appears when the mouse is positioned over a horizontal splitter bar.
static auto	ibeam () -> xtd::forms::cursor
	Gets the I-beam cursor, which is used to show where the text cursor appears when the mouse is clicked.
static auto	no () -> xtd::forms::cursor
	Gets the cursor that indicates that a particular region is invalid for the current operation.
static auto	no_drag () -> xtd::forms::cursor
	Gets the cursor that indicates that a particular region is invalid for the current drag & drop operation.
static auto	no_move_2d () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is not moving, but the window can be scrolled in both a horizontal and vertical direction.
static auto	no_move_horiz () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is not moving, but the window can be scrolled in a horizontal direction.
static auto	no_move_vert () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is not moving, but the window can be scrolled in a vertical direction.
static auto	open_hand () -> xtd::forms::cursor
	Gets the open hand cursor.
static auto	pan_east () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally to the right.
static auto	pan_ne () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically upward and to the right.
static auto	pan_north () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling vertically in an upward direction.
static auto	pan_nw () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically upward and to the left.
static auto	pan_se () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically downward and to the right.
static auto	pan_south () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling vertically in a downward direction.
static auto	pan_sw () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically downward and to the left.
static auto	pan_west () -> xtd::forms::cursor
	Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally to the left.
static auto	size_all () -> xtd::forms::cursor
	Gets the four-headed sizing cursor, which consists of four joined arrows that point north, south, east, and west.
static auto	size_nesw () -> xtd::forms::cursor
	Gets the two-headed diagonal (northeast/southwest) sizing cursor.
static auto	size_ns () -> xtd::forms::cursor
	Gets the two-headed vertical (north/south) sizing cursor.
static auto	size_nwse () -> xtd::forms::cursor
	Gets the two-headed diagonal (northwest/southeast) sizing cursor.
static auto	size_we () -> xtd::forms::cursor
	Gets the two-headed diagonal (northwest/southeast) sizing cursor.
static auto	up_arrow () -> xtd::forms::cursor
	Gets the up arrow cursor, typically used to identify an insertion point.
static auto	vibeam () -> xtd::forms::cursor
	Gets the vertical I-beam cursor, which is used to show where the text cursor appears when the mouse is clicked for vertical layout.
static auto	vsplit () -> xtd::forms::cursor
	Gets the cursor that appears when the mouse is positioned over a vertical splitter bar.
static auto	wait_cursor () -> xtd::forms::cursor
	Gets the wait cursor, typically an hourglass shape.
static auto	zoom_in () -> xtd::forms::cursor
	Gets the zoom_in cursor, typically to zoom in an object.
static auto	zoom_out () -> xtd::forms::cursor
	Gets the zoom out cursor, typically to zoom out an object.

Public Static Methods
static auto	from_name (const xtd::string &name) -> xtd::forms::cursor
	Gets cursor from name.
static auto	get_cursors () -> const xtd::array< cursor > &
	Gets all cursors.

Member Function Documentation

app_starting()

auto xtd::forms::cursors::app_starting ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears when an application starts.

Returns

The cursor that represents the cursor that appears when an application starts.

Appearance

Windows	macOS	Gnome

arrow()

auto xtd::forms::cursors::arrow ( ) -> xtd::forms::cursor

staticnodiscard

Gets the arrow cursor.

Returns

The cursor that represents the arrow cursor.

Appearance

Windows	macOS	Gnome

closed_hand()

auto xtd::forms::cursors::closed_hand ( ) -> xtd::forms::cursor

staticnodiscard

Gets the closed hand cursor.

Returns

The cursor that represents the close hand cursor.

Appearance

Windows	macOS	Gnome

contextual_menu()

auto xtd::forms::cursors::contextual_menu ( ) -> xtd::forms::cursor

staticnodiscard

Gets the contextual menu cursor.

Returns

The cursor that represents the contextual menu cursor.

Appearance

Windows	macOS	Gnome

cell()

auto xtd::forms::cursors::cell ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cell cursor.

Returns

The cursor that represents the cell cursor.

Appearance

Windows	macOS	Gnome

cross()

auto xtd::forms::cursors::cross ( ) -> xtd::forms::cursor

staticnodiscard

Gets the crosshair cursor.

Returns

The cursor that represents the crosshair cursor.

Appearance

Windows	macOS	Gnome

default_cursor()

auto xtd::forms::cursors::default_cursor ( ) -> xtd::forms::cursor

staticnodiscard

Gets the default cursor, which is usually an arrow cursor.

Returns

The cursor that represents the default cursor.

Appearance

Windows	macOS	Gnome

disappearing_item()

auto xtd::forms::cursors::disappearing_item ( ) -> xtd::forms::cursor

staticnodiscard

Gets the disappearing item cursor.

Returns

The cursor that represents the disappearing item cursor.

Appearance

Windows	macOS	Gnome

drag_copy()

auto xtd::forms::cursors::drag_copy ( ) -> xtd::forms::cursor

staticnodiscard

Gets the drag copy cursor.

Returns

The cursor that represents the drag copy cursor.

Appearance

Windows	macOS	Gnome

drag_link()

auto xtd::forms::cursors::drag_link ( ) -> xtd::forms::cursor

staticnodiscard

Gets the drag link cursor.

Returns

The cursor that represents the drag link cursor.

Appearance

Windows	macOS	Gnome

hand()

auto xtd::forms::cursors::hand ( ) -> xtd::forms::cursor

staticnodiscard

Gets the hand cursor, typically used when hovering over a Web link.

Returns

The cursor that represents the hand cursor.

Appearance

Windows	macOS	Gnome

help()

auto xtd::forms::cursors::help ( ) -> xtd::forms::cursor

staticnodiscard

Gets the Help cursor, which is a combination of an arrow and a question mark.

Returns

The cursor that represents the Help cursor.

Appearance

Windows	macOS	Gnome

hsplit()

auto xtd::forms::cursors::hsplit ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears when the mouse is positioned over a horizontal splitter bar.

Returns

The cursor that represents the cursor that appears when the mouse is positioned over a horizontal splitter bar.

Appearance

Windows	macOS	Gnome

ibeam()

auto xtd::forms::cursors::ibeam ( ) -> xtd::forms::cursor

staticnodiscard

Gets the I-beam cursor, which is used to show where the text cursor appears when the mouse is clicked.

Returns

The cursor that represents the I-beam cursor.

Appearance

Windows	macOS	Gnome

no()

auto xtd::forms::cursors::no ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that indicates that a particular region is invalid for the current operation.

Returns

The cursor that represents the cursor that indicates that a particular region is invalid for the current operation.

Appearance

Windows	macOS	Gnome

no_drag()

auto xtd::forms::cursors::no_drag ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that indicates that a particular region is invalid for the current drag & drop operation.

Returns

The cursor that represents the cursor that indicates that a particular region is invalid for the curren drag & drop operation.

Appearance

Windows	macOS	Gnome

no_move_2d()

auto xtd::forms::cursors::no_move_2d ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is not moving, but the window can be scrolled in both a horizontal and vertical direction.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is not moving.

Appearance

Windows	macOS	Gnome

no_move_horiz()

auto xtd::forms::cursors::no_move_horiz ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is not moving, but the window can be scrolled in a horizontal direction.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is not moving.

Appearance

Windows	macOS	Gnome

no_move_vert()

auto xtd::forms::cursors::no_move_vert ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is not moving, but the window can be scrolled in a vertical direction.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is not moving.

Appearance

Windows	macOS	Gnome

open_hand()

auto xtd::forms::cursors::open_hand ( ) -> xtd::forms::cursor

staticnodiscard

Gets the open hand cursor.

Returns

The cursor that represents the open hand cursor.

Appearance

Windows	macOS	Gnome

pan_east()

auto xtd::forms::cursors::pan_east ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally to the right.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally to the right.

Appearance

Windows	macOS	Gnome

pan_ne()

auto xtd::forms::cursors::pan_ne ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically upward and to the right.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically upward and to the right.

Appearance

Windows	macOS	Gnome

pan_north()

auto xtd::forms::cursors::pan_north ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling vertically in an upward direction.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling vertically in an upward direction.

Appearance

Windows	macOS	Gnome

pan_nw()

auto xtd::forms::cursors::pan_nw ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically upward and to the left.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically upward and to the left.

Appearance

Windows	macOS	Gnome

pan_se()

auto xtd::forms::cursors::pan_se ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically downward and to the right.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically downward and to the right.

Appearance

Windows	macOS	Gnome

pan_south()

auto xtd::forms::cursors::pan_south ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling vertically in a downward direction.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling vertically in a downward direction.

Appearance

Windows	macOS	Gnome

pan_sw()

auto xtd::forms::cursors::pan_sw ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically downward and to the left.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally and vertically downward and to the left.

Appearance

Windows	macOS	Gnome

pan_west()

auto xtd::forms::cursors::pan_west ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally to the left.

Returns

The cursor that represents the cursor that appears during wheel operations when the mouse is moving and the window is scrolling horizontally to the left.

Appearance

Windows	macOS	Gnome

size_all()

auto xtd::forms::cursors::size_all ( ) -> xtd::forms::cursor

staticnodiscard

Gets the four-headed sizing cursor, which consists of four joined arrows that point north, south, east, and west.

Returns

The cursor that represents the four-headed sizing cursor.

Appearance

Windows	macOS	Gnome

size_nesw()

auto xtd::forms::cursors::size_nesw ( ) -> xtd::forms::cursor

staticnodiscard

Gets the two-headed diagonal (northeast/southwest) sizing cursor.

Returns

The cursor that represents two-headed diagonal (northeast/southwest) sizing cursor.

Appearance

Windows	macOS	Gnome

size_ns()

auto xtd::forms::cursors::size_ns ( ) -> xtd::forms::cursor

staticnodiscard

Gets the two-headed vertical (north/south) sizing cursor.

Returns

The cursor that represents the two-headed vertical (north/south) sizing cursor.

Appearance

Windows	macOS	Gnome

size_nwse()

auto xtd::forms::cursors::size_nwse ( ) -> xtd::forms::cursor

staticnodiscard

Gets the two-headed diagonal (northwest/southeast) sizing cursor.

Returns

The cursor that represents the two-headed diagonal (northwest/southeast) sizing cursor.

Appearance

Windows	macOS	Gnome

size_we()

auto xtd::forms::cursors::size_we ( ) -> xtd::forms::cursor

staticnodiscard

Gets the two-headed diagonal (northwest/southeast) sizing cursor.

Returns

The cursor that represents the two-headed diagonal (northwest/southeast) sizing cursor.

Appearance

Windows	macOS	Gnome

up_arrow()

auto xtd::forms::cursors::up_arrow ( ) -> xtd::forms::cursor

staticnodiscard

Gets the up arrow cursor, typically used to identify an insertion point.

Returns

The cursor that represents the up arrow cursor.

Appearance

Windows	macOS	Gnome

vibeam()

auto xtd::forms::cursors::vibeam ( ) -> xtd::forms::cursor

staticnodiscard

Gets the vertical I-beam cursor, which is used to show where the text cursor appears when the mouse is clicked for vertical layout.

Returns

The cursor that represents the vertical I-beam cursor.

Appearance

Windows	macOS	Gnome

vsplit()

auto xtd::forms::cursors::vsplit ( ) -> xtd::forms::cursor

staticnodiscard

Gets the cursor that appears when the mouse is positioned over a vertical splitter bar.

Returns

The cursor that represents the cursor that appears when the mouse is positioned over a vertical splitter bar.

Appearance

Windows	macOS	Gnome

wait_cursor()

auto xtd::forms::cursors::wait_cursor ( ) -> xtd::forms::cursor

staticnodiscard

Gets the wait cursor, typically an hourglass shape.

Returns

The cursor that represents the wait cursor.

Appearance

Windows	macOS	Gnome

zoom_in()

auto xtd::forms::cursors::zoom_in ( ) -> xtd::forms::cursor

staticnodiscard

Gets the zoom_in cursor, typically to zoom in an object.

Returns

The cursor that represents the zoom in cursor.

Appearance

Windows	macOS	Gnome

zoom_out()

auto xtd::forms::cursors::zoom_out ( ) -> xtd::forms::cursor

staticnodiscard

Gets the zoom out cursor, typically to zoom out an object.

Returns

The cursor that represents the zoom out cursor.

Appearance

Windows	macOS	Gnome

from_name()

auto xtd::forms::cursors::from_name ( const xtd::string & name ) -> xtd::forms::cursor

staticnodiscard

Gets cursor from name.

Parameters

name	The name to retreive the corresponding xtd::forms::cursor.

Returns

xtd::forms::cursor corrstandigng to tha parameter name..

Exceptions

xtd::argument_exception

xtd::forms::cursor not found with specified name.

get_cursors()

auto xtd::forms::cursors::get_cursors ( ) -> const xtd::array< cursor > &

staticnodiscard

Gets all cursors.

Returns

cursor array.

---

The documentation for this class was generated from the following file:

• xtd.forms/include/xtd/forms/cursors.hpp