Public Member Functions | Related Functions

Gdk::Cursor Class Reference

This represents a cursor. More...

Inheritance diagram for Gdk::Cursor:
Inheritance graph
[legend]
Collaboration diagram for Gdk::Cursor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~Cursor ()
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.
 Cursor (CursorType cursor_type)
 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 ()
 Returns the display on which the Gdk::Cursor is defined.
Glib::RefPtr< const Displayget_display () const
 Returns the display on which the Gdk::Cursor is defined.
Glib::RefPtr< Gdk::Pixbufget_image ()
 Returns a Gdk::Pixbuf with the image used to display the cursor.
Glib::RefPtr< const Gdk::Pixbufget_image () const
 Returns a Gdk::Pixbuf with the image used to display the cursor.
CursorType get_cursor_type () const

Related Functions

(Note that these are not member functions.)


Glib::RefPtr< Gdk::Cursorwrap (GdkCursor* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

This represents a cursor.


Constructor & Destructor Documentation

virtual Gdk::Cursor::~Cursor (  ) [virtual]
Gdk::Cursor::Cursor ( CursorType  cursor_type ) [explicit]
Gdk::Cursor::Cursor ( const Glib::RefPtr< Display >&  display,
CursorType  cursor_type 
) [explicit]
Gdk::Cursor::Cursor ( const Glib::RefPtr< Display >&  display,
const Glib::RefPtr< Pixbuf >&  pixbuf,
int  x,
int  y 
)
Gdk::Cursor::Cursor ( const Glib::RefPtr< Display >&  display,
const Glib::ustring name 
) [explicit]

Member Function Documentation

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

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

Since gtkmm 2.2:
Returns:
The Gdk::Display associated to cursor.
Glib::RefPtr<const Display> Gdk::Cursor::get_display (  ) const

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

Since gtkmm 2.2:
Returns:
The Gdk::Display associated to cursor.
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.

Since gtkmm 2.8:
Returns:
A Gdk::Pixbuf representing cursor, or 0.
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.

Since gtkmm 2.8:
Returns:
A Gdk::Pixbuf representing cursor, or 0.
const GdkCursor* Gdk::Cursor::gobj (  ) const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GdkCursor* Gdk::Cursor::gobj (  ) [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

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.


Friends And Related Function Documentation

Glib::RefPtr< 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.

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