gdk.Cursor.Cursor Class Reference

List of all members.

Detailed Description

Description These functions are used to create and destroy cursors.

There is a number of standard cursors, but it is also possible to construct new cursors from pixmaps and pixbufs. There may be limitations as to what kinds of cursors can be constructed on a given display, see gdk_display_supports_cursor_alpha(), gdk_display_supports_cursor_color(), gdk_display_get_default_cursor_size() and gdk_display_get_maximal_cursor_size(). Cursors by themselves are not very interesting, they must be be bound to a window for users to see them. This is done with gdk_window_set_cursor() or by setting the cursor member of the GdkWindowAttr struct passed to gdk_window_new().


Public Member Functions

GdkCursorgetCursorStruct ()
 this (GdkCursor *gdkCursor)
 Sets our main struct and passes it to the parent class.
 this (GdkCursorType cursorType)
 Creates a new cursor from the set of builtin cursors for the default display.
 this (Pixmap source, Pixmap mask, Color fg, Color bg, int x, int y)
 Creates a new cursor from a given pixmap and mask.
 this (Display display, Pixbuf pixbuf, int x, int y)
 Creates a new cursor from a pixbuf.
 this (Display display, char[] name)
 Creates a new cursor by looking up name in the current cursor theme.
 this (Display display, GdkCursorType cursorType)
 Creates a new cursor from the set of builtin cursors.
Display getDisplay ()
 Returns the display on which the GdkCursor is defined.
Pixbuf getImage ()
 Returns a GdkPixbuf with the image used to display the cursor.
Cursor ref ()
 Adds a reference to cursor.
void unref ()
 Removes a reference from cursor, deallocating the cursor if no references remain.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GdkCursorgdkCursor
 the main Gtk struct


Constructor & Destructor Documentation

gdk.Cursor.Cursor.this ( GdkCursor gdkCursor  ) 

Sets our main struct and passes it to the parent class.

gdk.Cursor.Cursor.this ( GdkCursorType  cursorType  ) 

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 gdk_cursor_new_from_pixmap() to create a cursor with no pixels in it. cursor_type: cursor to create Returns: a new GdkCursor

gdk.Cursor.Cursor.this ( Pixmap  source,
Pixmap  mask,
Color  fg,
Color  bg,
int  x,
int  y 
)

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. Example6.Creating a custom cursor /+* 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); gdk_pixmap_unref (source); gdk_pixmap_unref (mask); gdk_window_set_cursor (widget->window, cursor); source: the pixmap specifying the cursor. mask: the pixmap specifying the mask, which must be the same size as source. fg: the foreground color, used for the bits in the source which are 1. The color does not have to be allocated first. bg: the background color, used for the bits in the source which are 0. The color does not have to be allocated first. x: the horizontal offset of the 'hotspot' of the cursor. y: the vertical offset of the 'hotspot' of the cursor. Returns: a new GdkCursor.

gdk.Cursor.Cursor.this ( Display  display,
Pixbuf  pixbuf,
int  x,
int  y 
)

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 gdk_display_supports_cursor_alpha() and gdk_display_supports_cursor_color() can be used to determine whether RGBA cursors are supported; gdk_display_get_default_cursor_size() and gdk_display_get_maximal_cursor_size() give information about cursor sizes. On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension. display: the GdkDisplay for which the cursor will be created pixbuf: the GdkPixbuf 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 GdkCursor. Since 2.4

gdk.Cursor.Cursor.this ( Display  display,
char[]  name 
)

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

display: the GdkDisplay for which the cursor will be created name: the name of the cursor Returns: a new GdkCursor, or NULL if there is no cursor with the given name Since 2.8

gdk.Cursor.Cursor.this ( Display  display,
GdkCursorType  cursorType 
)

Creates a new cursor from the set of builtin cursors.

Some useful ones are: GDK_RIGHT_PTR (right-facing arrow) GDK_CROSSHAIR (crosshair) GDK_XTERM (I-beam) GDK_WATCH (busy) GDK_FLEUR (for moving objects) GDK_HAND1 (a right-pointing hand) GDK_HAND2 (a left-pointing hand) GDK_LEFT_SIDE (resize left side) GDK_RIGHT_SIDE (resize right side) GDK_TOP_LEFT_CORNER (resize northwest corner) GDK_TOP_RIGHT_CORNER (resize northeast corner) GDK_BOTTOM_LEFT_CORNER (resize southwest corner) GDK_BOTTOM_RIGHT_CORNER (resize southeast corner) GDK_TOP_SIDE (resize top side) GDK_BOTTOM_SIDE (resize bottom side) GDK_SB_H_DOUBLE_ARROW (move vertical splitter) GDK_SB_V_DOUBLE_ARROW (move horizontal splitter) To make the cursor invisible, use gdk_cursor_new_from_pixmap() to create a cursor with no pixels in it. display: the GdkDisplay for which the cursor will be created cursor_type: cursor to create Returns: a new GdkCursor Since 2.2


Member Function Documentation

GdkCursor* gdk.Cursor.Cursor.getCursorStruct (  ) 

Display gdk.Cursor.Cursor.getDisplay (  ) 

Returns the display on which the GdkCursor is defined.

cursor: a GdkCursor. Returns: the GdkDisplay associated to cursor Since 2.2

Pixbuf gdk.Cursor.Cursor.getImage (  ) 

Returns a GdkPixbuf 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 GdkCursor Returns: a GdkPixbuf representing cursor, or NULL Since 2.8

void* gdk.Cursor.Cursor.getStruct (  )  [protected]

the main Gtk struct as a void*

Cursor gdk.Cursor.Cursor.ref (  ) 

Adds a reference to cursor.

cursor: a GdkCursor Returns: Same cursor that was passed in

void gdk.Cursor.Cursor.unref (  ) 

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

cursor: a GdkCursor


Member Data Documentation

GdkCursor* gdk.Cursor.Cursor.gdkCursor [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo