This represents a cursor. More...

#include <gdkmm/cursor.h>

Inheritance diagram for Gdk::Cursor:

Public Member Functions
	Cursor (Cursor && src) noexcept

Cursor &	operator= (Cursor && src) noexcept

	~Cursor () noexcept override

GdkCursor *	gobj ()
	Provides access to the underlying C GObject.

const GdkCursor *	gobj () const
	Provides access to the underlying C GObject.

GdkCursor *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Glib::RefPtr< Cursor >	get_fallback ()
	Returns the fallback for this cursor.

Glib::RefPtr< const Cursor >	get_fallback () const
	Returns the fallback for this cursor.

Glib::ustring	get_name () const
	Returns the name of the cursor.

Glib::RefPtr< Texture >	get_texture ()
	Returns the texture for the cursor.

Glib::RefPtr< const Texture >	get_texture () const
	Returns the texture for the cursor.

int	get_hotspot_x () const
	Returns the horizontal offset of the hotspot.

int	get_hotspot_y () const
	Returns the vertical offset of the hotspot.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Cursor > >	property_fallback () const
	Cursor to fall back to if this cursor cannot be displayed.

Glib::PropertyProxy_ReadOnly< int >	property_hotspot_x () const
	X position of the cursor hotspot in the cursor image.

Glib::PropertyProxy_ReadOnly< int >	property_hotspot_y () const
	Y position of the cursor hotspot in the cursor image.

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_name () const
	Name of this this cursor.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Texture > >	property_texture () const
	The texture displayed by this cursor.

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< Cursor >	create (const Glib::RefPtr< const Texture > & texture, int hotspot_x, int hotspot_y, const Glib::RefPtr< Cursor > & fallback={})
	Creates a new cursor from a `Gdk::Texture`.

static Glib::RefPtr< Cursor >	create (const Glib::ustring & name, const Glib::RefPtr< Cursor > & fallback={})
	Creates a new cursor by looking up name in the current cursor theme.

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gdk::Cursor >	wrap (GdkCursor * object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

This represents a cursor.

Constructor & Destructor Documentation

◆ Cursor()

Gdk::Cursor::Cursor ( Cursor && src )

noexcept

◆ ~Cursor()

Gdk::Cursor::~Cursor ( )

overridenoexcept

Member Function Documentation

◆ create() [1/2]

static Glib::RefPtr< Cursor > Gdk::Cursor::create	(	const Glib::RefPtr< const Texture > &	texture,
		int	hotspot_x,
		int	hotspot_y,
		const Glib::RefPtr< Cursor > &	fallback = `{}`
	)

static

Creates a new cursor from a Gdk::Texture.

Parameters

texture	The texture providing the pixel data.
hotspot_x	The horizontal offset of the “hotspot” of the cursor.
hotspot_y	The vertical offset of the “hotspot” of the cursor.
fallback	The `Gdk::Cursor` to fall back to when this one cannot be supported.

Returns: A new Gdk::Cursor.

◆ create() [2/2]

static Glib::RefPtr< Cursor > Gdk::Cursor::create	(	const Glib::ustring &	name,
		const Glib::RefPtr< Cursor > &	fallback = `{}`
	)

static

Creates a new cursor by looking up name in the current cursor theme.

A recommended set of cursor names that will work across different platforms can be found in the CSS specification:


"none"	"default"	"help"	"pointer"
"context-menu"	"progress"	"wait"	"cell"
"crosshair"	"text"	"vertical-text"	"alias"
"copy"	"no-drop"	"move"	"not-allowed"
"grab"	"grabbing"	"all-scroll"	"col-resize"
"row-resize"	"n-resize"	"e-resize"	"s-resize"
"w-resize"	"ne-resize"	"nw-resize"	"sw-resize"
"se-resize"	"ew-resize"	"ns-resize"	"nesw-resize"
"nwse-resize"	"zoom-in"	"zoom-out"

Parameters

name	The name of the cursor.
fallback	`nullptr` or the `Gdk::Cursor` to fall back to when this one cannot be supported.

Returns: A new Gdk::Cursor, or nullptr if there is no cursor with the given name.

◆ get_fallback() [1/2]

Glib::RefPtr< Cursor > Gdk::Cursor::get_fallback ( )

Returns the fallback for this cursor.

The fallback will be used if this cursor is not available on a given Gdk::Display. For named cursors, this can happen when using nonstandard names or when using an incomplete cursor theme. For textured cursors, this can happen when the texture is too large or when the Gdk::Display it is used on does not support textured cursors.

Returns: The fallback of the cursor or nullptr to use the default cursor as fallback.

◆ get_fallback() [2/2]

Glib::RefPtr< const Cursor > Gdk::Cursor::get_fallback ( ) const

Returns the fallback for this cursor.

The fallback will be used if this cursor is not available on a given Gdk::Display. For named cursors, this can happen when using nonstandard names or when using an incomplete cursor theme. For textured cursors, this can happen when the texture is too large or when the Gdk::Display it is used on does not support textured cursors.

Returns: The fallback of the cursor or nullptr to use the default cursor as fallback.

◆ get_hotspot_x()

int Gdk::Cursor::get_hotspot_x ( ) const

Returns the horizontal offset of the hotspot.

The hotspot indicates the pixel that will be directly above the cursor.

Note that named cursors may have a nonzero hotspot, but this function will only return the hotspot position for cursors created with new_from_texture().

Returns: The horizontal offset of the hotspot or 0 for named cursors.

◆ get_hotspot_y()

int Gdk::Cursor::get_hotspot_y ( ) const

Returns the vertical offset of the hotspot.

The hotspot indicates the pixel that will be directly above the cursor.

Note that named cursors may have a nonzero hotspot, but this function will only return the hotspot position for cursors created with new_from_texture().

Returns: The vertical offset of the hotspot or 0 for named cursors.

◆ get_name()

Glib::ustring Gdk::Cursor::get_name ( ) const

Returns the name of the cursor.

If the cursor is not a named cursor, nullptr will be returned.

Returns: The name of the cursor or nullptr if it is not a named cursor.

◆ get_texture() [1/2]

Glib::RefPtr< Texture > Gdk::Cursor::get_texture ( )

Returns the texture for the cursor.

If the cursor is a named cursor, nullptr will be returned.

Returns: The texture for cursor or nullptr if it is a named cursor.

◆ get_texture() [2/2]

Glib::RefPtr< const Texture > Gdk::Cursor::get_texture ( ) const

Returns the texture for the cursor.

If the cursor is a named cursor, nullptr will be returned.

Returns: The texture for cursor or nullptr if it is a named cursor.

◆ get_type()

static GType Gdk::Cursor::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GdkCursor * Gdk::Cursor::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GdkCursor * Gdk::Cursor::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GdkCursor * Gdk::Cursor::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

Cursor & Gdk::Cursor::operator= ( Cursor && src )

noexcept

◆ property_fallback()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Cursor > > Gdk::Cursor::property_fallback ( ) const

Cursor to fall back to if this cursor cannot be displayed.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_hotspot_x()

Glib::PropertyProxy_ReadOnly< int > Gdk::Cursor::property_hotspot_x ( ) const

X position of the cursor hotspot in the cursor image.

Default value: 0

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_hotspot_y()

Glib::PropertyProxy_ReadOnly< int > Gdk::Cursor::property_hotspot_y ( ) const

Y position of the cursor hotspot in the cursor image.

Default value: 0

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_name()

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gdk::Cursor::property_name ( ) const

Name of this this cursor.

The name will be nullptr if the cursor was created from a texture.

Default value: ""

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_texture()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Texture > > Gdk::Cursor::property_texture ( ) const

The texture displayed by this cursor.

The texture will be nullptr if the cursor was created from a name.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gdk::Cursor > wrap	(	GdkCursor *	object,
		bool	take_copy = `false`
	)

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

Public Member Functions

Static Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ Cursor()

◆ ~Cursor()

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ get_fallback() [1/2]

◆ get_fallback() [2/2]

◆ get_hotspot_x()

◆ get_hotspot_y()

◆ get_name()

◆ get_texture() [1/2]

◆ get_texture() [2/2]

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ property_fallback()

◆ property_hotspot_x()

◆ property_hotspot_y()

◆ property_name()

◆ property_texture()

Friends And Related Function Documentation

◆ wrap()