Gjsify LogoGjsify Logo

Hierarchy

  • Cursor

Index

Constructors

  • 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_BLANK_CURSOR.

    Parameters

    Returns Gdk.Cursor

Properties

name: string

Methods

  • unref(): void
  • Removes a reference from cursor, deallocating the cursor if no references remain.

    Returns void

  • 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_BLANK_CURSOR.

    Parameters

    Returns Gdk.Cursor

  • 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) #GDK_BLANK_CURSOR (Blank cursor). Since 2.16

    Parameters

    • display: Gdk.Display

      the #GdkDisplay for which the cursor will be created

    • cursorType: Gdk.CursorType

      cursor to create

    Returns Gdk.Cursor

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

    Parameters

    • display: Gdk.Display

      the #GdkDisplay for which the cursor will be created

    • name: string

      the name of the cursor

    Returns Gdk.Cursor

  • 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.

    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.

    Parameters

    • display: Gdk.Display

      the #GdkDisplay for which the cursor will be created

    • pixbuf: Pixbuf

      the #GdkPixbuf containing the cursor image

    • x: number

      the horizontal offset of the 'hotspot' of the cursor.

    • y: number

      the vertical offset of the 'hotspot' of the cursor.

    Returns Gdk.Cursor

  • 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.

    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); g_object_unref (source); g_object_unref (mask);

    gdk_window_set_cursor (widget->window, cursor);

    Parameters

    • source: Gdk.Pixmap

      the pixmap specifying the cursor.

    • mask: Gdk.Pixmap

      the pixmap specifying the mask, which must be the same size as source.

    • fg: Gdk.Color

      the foreground color, used for the bits in the source which are 1. The color does not have to be allocated first.

    • bg: Gdk.Color

      the background color, used for the bits in the source which are 0. The color does not have to be allocated first.

    • x: number

      the horizontal offset of the 'hotspot' of the cursor.

    • y: number

      the vertical offset of the 'hotspot' of the cursor.

    Returns Gdk.Cursor

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method