gtkmm 4.16.0
|
Gdk::Cursor is used to create and destroy cursors. More...
#include <gdkmm/cursor.h>
Public Types | |
using | SlotGetTexture = sigc::slot< Glib::RefPtr< Texture >(int, double, int &, int &, int &, int &)> |
Callback used by a dynamic Gdk::Cursor to generate a texture for the cursor image at the given cursor_size and scale. | |
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. | |
static Glib::RefPtr< Cursor > | create_from_slot (const SlotGetTexture & slot, const Glib::RefPtr< Cursor > & fallback={}) |
Creates a new callback-based cursor object. | |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gdk::Cursor > | wrap (GdkCursor * object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Gdk::Cursor is used to create and destroy cursors.
Cursors are immutable objects, so once you created them, there is no way to modify them later. You should create a new cursor when you want to change something about it.
Cursors by themselves are not very interesting: they must be bound to a window for users to see them. This is done with Gdk::Surface::set_cursor() or Gdk::Surface::set_device_cursor(). Applications will typically use higher-level GTK functions such as Gtk::Widget::set_cursor() instead.
Cursors are not bound to a given Gdk::Display, so they can be shared. However, the appearance of cursors may vary when used on different platforms.
There are multiple ways to create cursors. The platform's own cursors can be created with create(const Glib::ustring& name, const Glib::RefPtr<Cursor>& fallback). That function lists the commonly available names that are shared with the CSS specification. Other names may be available, depending on the platform in use. On some platforms, what images are used for named cursors may be influenced by the cursor theme.
Another option to create a cursor is to use create(const Glib::RefPtr<const Texture>& texture, int hotspot_x, int hotspot_y, const Glib::RefPtr<Cursor>& fallback) and provide an image to use for the cursor.
To ease work with unsupported cursors, a fallback cursor can be provided. If a Gdk::Surface cannot use a cursor, it will try the fallback cursor. Fallback cursors can themselves have fallback cursors again, so it is possible to provide a chain of progressively easier to support cursors. If none of the provided cursors can be supported, the default cursor will be the ultimate fallback.
using Gdk::Cursor::SlotGetTexture = sigc::slot<Glib::RefPtr<Texture>(int, double, int&, int&, int&, int&)> |
Callback used by a dynamic Gdk::Cursor to generate a texture for the cursor image at the given cursor_size and scale.
The actual cursor size in application pixels may be different from cursor_size x cursor_size, and will be returned in width, height. The returned texture should have a size that corresponds to the actual cursor size, in device pixels (i.e. application pixels, multiplied by scale).
This function may fail and return an empty RefPtr, in which case the fallback cursor will be used.
cursor_size | The nominal cursor size, in application pixels. | |
scale | The device scale. | |
[out] | width | Return location for the actual cursor width, in application pixels. |
[out] | height | Return location for the actual cursor height, in application pixels. |
[out] | hotspot_x | Return location for the hotspot X position, in application pixels. |
[out] | hotspot_y | Return location for the hotspot Y position, in application pixels. |
|
noexcept |
|
overridenoexcept |
|
static |
Creates a new cursor from a Gdk::Texture
.
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. |
Gdk::Cursor
.
|
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" |
name | The name of the cursor. |
fallback | nullptr or the Gdk::Cursor to fall back to when this one cannot be supported. |
Gdk::Cursor
, or nullptr
if there is no cursor with the given name.
|
static |
Creates a new callback-based cursor object.
Cursors of this kind produce textures for the cursor image on demand, when the slot is called.
slot | Callback that lets you create a suitable texture. |
fallback | The Gdk::Cursor to fall back to when this one cannot be supported. |
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.
nullptr
to use the default cursor as fallback. 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.
nullptr
to use the default cursor as fallback. 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().
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().
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.
nullptr
if it is not a named cursor. Glib::RefPtr< Texture > Gdk::Cursor::get_texture | ( | ) |
Returns the texture for the cursor.
If the cursor is a named cursor, nullptr
will be returned.
nullptr
if it is a named cursor. 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.
nullptr
if it is a named cursor.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Cursor > > Gdk::Cursor::property_fallback | ( | ) | const |
Cursor to fall back to if this cursor cannot be displayed.
Glib::PropertyProxy_ReadOnly< int > Gdk::Cursor::property_hotspot_x | ( | ) | const |
X position of the cursor hotspot in the cursor image.
Default value: 0
Glib::PropertyProxy_ReadOnly< int > Gdk::Cursor::property_hotspot_y | ( | ) | const |
Y position of the cursor hotspot in the cursor image.
Default value: 0
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: ""
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.
|
related |
A Glib::wrap() method for this object.
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. |