W Wrapl, The Programming Language

Libraries:Gtk:Gdk:Cursor

Types

T

Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T



New(cursor_type @ Gtk.Gdk.CursorType.T) : Gtk.Gdk.Cursor.T

Creates a new cursor from the set of builtin cursors for the default display. See gdk_cursor_new_for_display().

To make the cursor invisible, use Gtk.Gdk.CursorType.BlankCursor.

cursor_type cursor to create
Returns a new T


NewForDisplay(display @ Gtk.Gdk.Display.T, cursor_type @ Gtk.Gdk.CursorType.T) : Gtk.Gdk.Cursor.T

Creates a new cursor from the set of builtin cursors. Some useful ones are:



NewFromName(display @ Gtk.Gdk.Display.T, name @ Std.String.T) : Gtk.Gdk.Cursor.T

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

display the Gtk.Gdk.Display.T for which the cursor will be created
name the name of the cursor
Returns a new T, or NULL if there is no cursor with the given name


NewFromPixbuf(display @ Gtk.Gdk.Display.T, pixbuf @ Gtk.Gdk.Pixbuf.T, x @ Std.Integer.SmallT, y @ Std.Integer.SmallT) : Gtk.Gdk.Cursor.T

Creates a new cursor from a pixbuf.

Not all GDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. The functions Gtk.Gdk.Display.SupportsCursorAlpha and Gtk.Gdk.Display.SupportsCursorColor can be used to determine whether RGBA cursors are supported; Gtk.Gdk.Display.GetDefaultCursorSize and Gtk.Gdk.Display.GetMaximalCursorSize give information about cursor sizes.

If x or y are -1, the pixbuf must have options named "x_hot" and "y_hot", resp., containing integer values between 0 and the width resp. height of the pixbuf. (Since: 3.0)

On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension.

display the Gtk.Gdk.Display.T for which the cursor will be created
pixbuf the Gtk.Gdk.Pixbuf.T containing the cursor image
x the horizontal offset of the 'hotspot' of the cursor.
y the vertical offset of the 'hotspot' of the cursor.
Returns a new T.


NewFromPixmap(source @ Gtk.Gdk.Pixmap.T, mask @ Gtk.Gdk.Pixmap.T, fg @ Gtk.Gdk.Color.T, bg @ Gtk.Gdk.Color.T, x @ Std.Integer.SmallT, y @ Std.Integer.SmallT) : Gtk.Gdk.Cursor.T

Creates a new cursor from a given pixmap and mask. Both the pixmap and mask must have a depth of 1 (i.e. each pixel has only 2 values - on or off). The standard cursor size is 16 by 16 pixels. You can create a bitmap from inline data as in the below example.

Example 6. Creating a custom cursor

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/* This data is in X bitmap format, and can be created with the 'bitmap'
   utility. */
#define cursor1_width 16
#define cursor1_height 16
static unsigned char cursor1_bits[] = {
  0x80, 0x01, 0x40, 0x02, 0x20, 0x04, 0x10, 0x08, 0x08, 0x10, 0x04, 0x20,
  0x82, 0x41, 0x41, 0x82, 0x41, 0x82, 0x82, 0x41, 0x04, 0x20, 0x08, 0x10,
  0x10, 0x08, 0x20, 0x04, 0x40, 0x02, 0x80, 0x01};
 
static unsigned char cursor1mask_bits[] = {
  0x80, 0x01, 0xc0, 0x03, 0x60, 0x06, 0x30, 0x0c, 0x18, 0x18, 0x8c, 0x31,
  0xc6, 0x63, 0x63, 0xc6, 0x63, 0xc6, 0xc6, 0x63, 0x8c, 0x31, 0x18, 0x18,
  0x30, 0x0c, 0x60, 0x06, 0xc0, 0x03, 0x80, 0x01};
 
 
 GdkCursor *cursor;
 GdkPixmap *source, *mask;
 GdkColor fg = { 0, 65535, 0, 0 }; /* Red. */
 GdkColor bg = { 0, 0, 0, 65535 }; /* Blue. */
 
 
 source = gdk_bitmap_create_from_data (NULL, cursor1_bits,
                                       cursor1_width, cursor1_height);
 mask = gdk_bitmap_create_from_data (NULL, cursor1mask_bits,
                                     cursor1_width, cursor1_height);
 cursor = gdk_cursor_new_from_pixmap (source, mask, &fg, &bg, 8, 8);
 g_object_unref (source);
 g_object_unref (mask);
 
 
 gdk_window_set_cursor (widget->window, cursor);


Methods

:"="(_ @ T, _ @ T)

:GetCursorType(self @ T) : Gtk.Gdk.CursorType.T

Returns the cursor type for this cursor.

cursor a T
Returns a Gtk.Gdk.CursorType.T


:GetDisplay(self @ T) : Gtk.Gdk.Display.T

Returns the display on which the T is defined.

cursor a T.
Returns the Gtk.Gdk.Display.T associated to cursor


:GetImage(self @ T) : Gtk.Gdk.Pixbuf.T

Returns a Gtk.Gdk.Pixbuf.T 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, NULL is returned.

cursor a T
Returns a Gtk.Gdk.Pixbuf.T representing cursor, or NULL


:Ref(self @ T) : Gtk.Gdk.Cursor.T

Adds a reference to cursor.

cursor a T
Returns Same cursor that was passed in. [transfer full]


:Unref(self @ T) : Std.Object.T

Removes a reference from cursor, deallocating the cursor if no references remain.

cursor a T


:"~="(_ @ T, _ @ T)