Ardour  9.0-pre0-582-g084a23a80d
Gdk::Cursor Class Reference

#include <cursor.h>

Public Member Functions

 Cursor ()
 
 Cursor (GdkCursor *gobject, bool make_a_copy=true)
 
 Cursor (const Cursor &other)
 
Cursoroperator= (const Cursor &other)
 
 ~Cursor ()
 
void swap (Cursor &other)
 
GdkCursorgobj ()
 Provides access to the underlying C instance. More...
 
const GdkCursorgobj () const
 Provides access to the underlying C instance. More...
 
GdkCursorgobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. More...
 
 Cursor (CursorType cursor_type)
 
 Cursor (const Glib::RefPtr< Pixmap > &source, const Glib::RefPtr< Pixmap > &mask, const Color &fg, const Color &bg, int x, int y)
 
 Cursor (const Glib::RefPtr< Display > &display, CursorType cursor_type)
 
 Cursor (const Glib::RefPtr< Display > &display, const Glib::RefPtr< Pixbuf > &pixbuf, int x, int y)
 
 Cursor (const Glib::RefPtr< Display > &display, const Glib::ustring &name)
 
Glib::RefPtr< Displayget_display ()
 
Glib::RefPtr< const Displayget_display () const
 
Glib::RefPtr< Gdk::Pixbufget_image ()
 
Glib::RefPtr< const Gdk::Pixbufget_image () const
 
CursorType get_cursor_type () const
 

Static Public Member Functions

static GType get_type () G_GNUC_CONST
 

Protected Attributes

GdkCursorgobject_
 

Related Functions

(Note that these are not member functions.)

void swap (Cursor &lhs, Cursor &rhs)
 
Gdk::Cursor wrap (GdkCursor *object, bool take_copy=false)
 

Detailed Description

This represents a cursor.

Definition at line 158 of file cursor.h.

Constructor & Destructor Documentation

◆ Cursor() [1/8]

Gdk::Cursor::Cursor ( )

◆ Cursor() [2/8]

Gdk::Cursor::Cursor ( GdkCursor gobject,
bool  make_a_copy = true 
)
explicit

◆ Cursor() [3/8]

Gdk::Cursor::Cursor ( const Cursor other)

◆ ~Cursor()

Gdk::Cursor::~Cursor ( )

◆ Cursor() [4/8]

Gdk::Cursor::Cursor ( CursorType  cursor_type)
explicit

◆ Cursor() [5/8]

Gdk::Cursor::Cursor ( const Glib::RefPtr< Pixmap > &  source,
const Glib::RefPtr< Pixmap > &  mask,
const Color fg,
const Color bg,
int  x,
int  y 
)

◆ Cursor() [6/8]

Gdk::Cursor::Cursor ( const Glib::RefPtr< Display > &  display,
CursorType  cursor_type 
)
explicit

◆ Cursor() [7/8]

Gdk::Cursor::Cursor ( const Glib::RefPtr< Display > &  display,
const Glib::RefPtr< Pixbuf > &  pixbuf,
int  x,
int  y 
)

◆ Cursor() [8/8]

Gdk::Cursor::Cursor ( const Glib::RefPtr< Display > &  display,
const Glib::ustring &  name 
)
explicit

Member Function Documentation

◆ get_cursor_type()

CursorType Gdk::Cursor::get_cursor_type ( ) const

Returns the cursor type for this cursor.

Returns
A Gdk::CursorType.

◆ get_display() [1/2]

Glib::RefPtr<Display> Gdk::Cursor::get_display ( )

Returns the display on which the Gdk::Cursor is defined.

Returns
The Gdk::Display associated to cursor.

◆ get_display() [2/2]

Glib::RefPtr<const Display> Gdk::Cursor::get_display ( ) const

Returns the display on which the Gdk::Cursor is defined.

Returns
The Gdk::Display associated to cursor.

◆ get_image() [1/2]

Glib::RefPtr<Gdk::Pixbuf> Gdk::Cursor::get_image ( )

Returns a Gdk::Pixbuf with the image used to display the cursor.

Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data. In this case, 0 is returned.

Returns
A Gdk::Pixbuf representing cursor, or 0.

◆ get_image() [2/2]

Glib::RefPtr<const Gdk::Pixbuf> Gdk::Cursor::get_image ( ) const

Returns a Gdk::Pixbuf with the image used to display the cursor.

Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data. In this case, 0 is returned.

Returns
A Gdk::Pixbuf representing cursor, or 0.

◆ 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 instance.

Definition at line 182 of file cursor.h.

◆ gobj() [2/2]

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

Provides access to the underlying C instance.

Definition at line 185 of file cursor.h.

◆ gobj_copy()

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

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

◆ operator=()

Cursor& Gdk::Cursor::operator= ( const Cursor other)

◆ swap()

void Gdk::Cursor::swap ( Cursor other)

Friends And Related Function Documentation

◆ swap()

void swap ( Cursor lhs,
Cursor rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side

Definition at line 259 of file cursor.h.

◆ wrap()

Gdk::Cursor wrap ( GdkCursor object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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.

Member Data Documentation

◆ gobject_

GdkCursor* Gdk::Cursor::gobject_
protected

Definition at line 191 of file cursor.h.


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