Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/cursors.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Cursors
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Standard and pixmap cursors
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 These functions are used to create and destroy cursors.
  10 There is a number of standard cursors, but it is also
  11 possible to construct new cursors from pixmaps and
  12 pixbufs. There may be limitations as to what kinds of
  13 cursors can be constructed on a given display, see
  14 gdk_display_supports_cursor_alpha(),
  15 gdk_display_supports_cursor_color(),
  16 gdk_display_get_default_cursor_size() and
  17 gdk_display_get_maximal_cursor_size().
  18 </para>
  19 <para>
  20 Cursors by themselves are not very interesting, they must be be
  21 bound to a window for users to see them. This is done with
  22 gdk_window_set_cursor() or by setting the cursor member of the
  23 #GdkWindowAttr struct passed to gdk_window_new().
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28
  29 </para>
  30
  31 <!-- ##### SECTION Stability_Level ##### -->
  32
  33
  34 <!-- ##### STRUCT GdkCursor ##### -->
  35 <para>
  36 A <type>GdkCursor</type> structure represents a cursor.
  37 </para>
  38
  39 @type: the #GdkCursorType of the cursor
  40
  41 <!-- ##### ENUM GdkCursorType ##### -->
  42 <para>
  43 The standard cursors available.
  44 </para>
  45
  46 @GDK_X_CURSOR: <inlinegraphic format="PNG" fileref="X_cursor.png"></inlinegraphic>
  47 @GDK_ARROW: <inlinegraphic format="PNG" fileref="arrow.png"></inlinegraphic>
  48 @GDK_BASED_ARROW_DOWN: <inlinegraphic format="PNG" fileref="based_arrow_down.png"></inlinegraphic>
  49 @GDK_BASED_ARROW_UP: <inlinegraphic format="PNG" fileref="based_arrow_up.png"></inlinegraphic>
  50 @GDK_BOAT: <inlinegraphic format="PNG" fileref="boat.png"></inlinegraphic>
  51 @GDK_BOGOSITY: <inlinegraphic format="PNG" fileref="bogosity.png"></inlinegraphic>
  52 @GDK_BOTTOM_LEFT_CORNER: <inlinegraphic format="PNG" fileref="bottom_left_corner.png"></inlinegraphic>
  53 @GDK_BOTTOM_RIGHT_CORNER: <inlinegraphic format="PNG" fileref="bottom_right_corner.png"></inlinegraphic>
  54 @GDK_BOTTOM_SIDE: <inlinegraphic format="PNG" fileref="bottom_side.png"></inlinegraphic>
  55 @GDK_BOTTOM_TEE: <inlinegraphic format="PNG" fileref="bottom_tee.png"></inlinegraphic>
  56 @GDK_BOX_SPIRAL: <inlinegraphic format="PNG" fileref="box_spiral.png"></inlinegraphic>
  57 @GDK_CENTER_PTR: <inlinegraphic format="PNG" fileref="center_ptr.png"></inlinegraphic>
  58 @GDK_CIRCLE: <inlinegraphic format="PNG" fileref="circle.png"></inlinegraphic>
  59 @GDK_CLOCK: <inlinegraphic format="PNG" fileref="clock.png"></inlinegraphic>
  60 @GDK_COFFEE_MUG: <inlinegraphic format="PNG" fileref="coffee_mug.png"></inlinegraphic>
  61 @GDK_CROSS: <inlinegraphic format="PNG" fileref="cross.png"></inlinegraphic>
  62 @GDK_CROSS_REVERSE: <inlinegraphic format="PNG" fileref="cross_reverse.png"></inlinegraphic>
  63 @GDK_CROSSHAIR: <inlinegraphic format="PNG" fileref="crosshair.png"></inlinegraphic>
  64 @GDK_DIAMOND_CROSS: <inlinegraphic format="PNG" fileref="diamond_cross.png"></inlinegraphic>
  65 @GDK_DOT: <inlinegraphic format="PNG" fileref="dot.png"></inlinegraphic>
  66 @GDK_DOTBOX: <inlinegraphic format="PNG" fileref="dotbox.png"></inlinegraphic>
  67 @GDK_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="double_arrow.png"></inlinegraphic>
  68 @GDK_DRAFT_LARGE: <inlinegraphic format="PNG" fileref="draft_large.png"></inlinegraphic>
  69 @GDK_DRAFT_SMALL: <inlinegraphic format="PNG" fileref="draft_small.png"></inlinegraphic>
  70 @GDK_DRAPED_BOX: <inlinegraphic format="PNG" fileref="draped_box.png"></inlinegraphic>
  71 @GDK_EXCHANGE: <inlinegraphic format="PNG" fileref="exchange.png"></inlinegraphic>
  72 @GDK_FLEUR: <inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic>
  73 @GDK_GOBBLER: <inlinegraphic format="PNG" fileref="gobbler.png"></inlinegraphic>
  74 @GDK_GUMBY: <inlinegraphic format="PNG" fileref="gumby.png"></inlinegraphic>
  75 @GDK_HAND1: <inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic>
  76 @GDK_HAND2: <inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic>
  77 @GDK_HEART: <inlinegraphic format="PNG" fileref="heart.png"></inlinegraphic>
  78 @GDK_ICON: <inlinegraphic format="PNG" fileref="icon.png"></inlinegraphic>
  79 @GDK_IRON_CROSS: <inlinegraphic format="PNG" fileref="iron_cross.png"></inlinegraphic>
  80 @GDK_LEFT_PTR: <inlinegraphic format="PNG" fileref="left_ptr.png"></inlinegraphic>
  81 @GDK_LEFT_SIDE: <inlinegraphic format="PNG" fileref="left_side.png"></inlinegraphic>
  82 @GDK_LEFT_TEE: <inlinegraphic format="PNG" fileref="left_tee.png"></inlinegraphic>
  83 @GDK_LEFTBUTTON: <inlinegraphic format="PNG" fileref="leftbutton.png"></inlinegraphic>
  84 @GDK_LL_ANGLE: <inlinegraphic format="PNG" fileref="ll_angle.png"></inlinegraphic>
  85 @GDK_LR_ANGLE: <inlinegraphic format="PNG" fileref="lr_angle.png"></inlinegraphic>
  86 @GDK_MAN: <inlinegraphic format="PNG" fileref="man.png"></inlinegraphic>
  87 @GDK_MIDDLEBUTTON: <inlinegraphic format="PNG" fileref="middlebutton.png"></inlinegraphic>
  88 @GDK_MOUSE: <inlinegraphic format="PNG" fileref="mouse.png"></inlinegraphic>
  89 @GDK_PENCIL: <inlinegraphic format="PNG" fileref="pencil.png"></inlinegraphic>
  90 @GDK_PIRATE: <inlinegraphic format="PNG" fileref="pirate.png"></inlinegraphic>
  91 @GDK_PLUS: <inlinegraphic format="PNG" fileref="plus.png"></inlinegraphic>
  92 @GDK_QUESTION_ARROW: <inlinegraphic format="PNG" fileref="question_arrow.png"></inlinegraphic>
  93 @GDK_RIGHT_PTR: <inlinegraphic format="PNG" fileref="right_ptr.png"></inlinegraphic>
  94 @GDK_RIGHT_SIDE: <inlinegraphic format="PNG" fileref="right_side.png"></inlinegraphic>
  95 @GDK_RIGHT_TEE: <inlinegraphic format="PNG" fileref="right_tee.png"></inlinegraphic>
  96 @GDK_RIGHTBUTTON: <inlinegraphic format="PNG" fileref="rightbutton.png"></inlinegraphic>
  97 @GDK_RTL_LOGO: <inlinegraphic format="PNG" fileref="rtl_logo.png"></inlinegraphic>
  98 @GDK_SAILBOAT: <inlinegraphic format="PNG" fileref="sailboat.png"></inlinegraphic>
  99 @GDK_SB_DOWN_ARROW: <inlinegraphic format="PNG" fileref="sb_down_arrow.png"></inlinegraphic>
 100 @GDK_SB_H_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="sb_h_double_arrow.png"></inlinegraphic>
 101 @GDK_SB_LEFT_ARROW: <inlinegraphic format="PNG" fileref="sb_left_arrow.png"></inlinegraphic>
 102 @GDK_SB_RIGHT_ARROW: <inlinegraphic format="PNG" fileref="sb_right_arrow.png"></inlinegraphic>
 103 @GDK_SB_UP_ARROW: <inlinegraphic format="PNG" fileref="sb_up_arrow.png"></inlinegraphic>
 104 @GDK_SB_V_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="sb_v_double_arrow.png"></inlinegraphic>
 105 @GDK_SHUTTLE: <inlinegraphic format="PNG" fileref="shuttle.png"></inlinegraphic>
 106 @GDK_SIZING: <inlinegraphic format="PNG" fileref="sizing.png"></inlinegraphic>
 107 @GDK_SPIDER: <inlinegraphic format="PNG" fileref="spider.png"></inlinegraphic>
 108 @GDK_SPRAYCAN: <inlinegraphic format="PNG" fileref="spraycan.png"></inlinegraphic>
 109 @GDK_STAR: <inlinegraphic format="PNG" fileref="star.png"></inlinegraphic>
 110 @GDK_TARGET: <inlinegraphic format="PNG" fileref="target.png"></inlinegraphic>
 111 @GDK_TCROSS: <inlinegraphic format="PNG" fileref="tcross.png"></inlinegraphic>
 112 @GDK_TOP_LEFT_ARROW: <inlinegraphic format="PNG" fileref="top_left_arrow.png"></inlinegraphic>
 113 @GDK_TOP_LEFT_CORNER: <inlinegraphic format="PNG" fileref="top_left_corner.png"></inlinegraphic>
 114 @GDK_TOP_RIGHT_CORNER: <inlinegraphic format="PNG" fileref="top_right_corner.png"></inlinegraphic>
 115 @GDK_TOP_SIDE: <inlinegraphic format="PNG" fileref="top_side.png"></inlinegraphic>
 116 @GDK_TOP_TEE: <inlinegraphic format="PNG" fileref="top_tee.png"></inlinegraphic>
 117 @GDK_TREK: <inlinegraphic format="PNG" fileref="trek.png"></inlinegraphic>
 118 @GDK_UL_ANGLE: <inlinegraphic format="PNG" fileref="ul_angle.png"></inlinegraphic>
 119 @GDK_UMBRELLA: <inlinegraphic format="PNG" fileref="umbrella.png"></inlinegraphic>
 120 @GDK_UR_ANGLE: <inlinegraphic format="PNG" fileref="ur_angle.png"></inlinegraphic>
 121 @GDK_WATCH: <inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic>
 122 @GDK_XTERM: <inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic>
 123 @GDK_BLANK_CURSOR: Blank cursor. Since 2.16
 124 @GDK_LAST_CURSOR: last cursor type
 125 @GDK_CURSOR_IS_PIXMAP: type of cursors constructed with
 126   gdk_cursor_new_from_pixmap() or gdk_cursor_new_from_pixbuf()
 127
 128
 129 <!-- ##### FUNCTION gdk_cursor_new ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @cursor_type:
 135 @Returns:
 136
 137
 138 <!-- ##### FUNCTION gdk_cursor_new_from_pixmap ##### -->
 139 <para>
 140 </para>
 141
 142 @source:
 143 @mask:
 144 @fg:
 145 @bg:
 146 @x:
 147 @y:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION gdk_cursor_new_from_pixbuf ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @display:
 157 @pixbuf:
 158 @x:
 159 @y:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION gdk_cursor_new_from_name ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @display:
 169 @name:
 170 @Returns:
 171
 172
 173 <!-- ##### FUNCTION gdk_cursor_new_for_display ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @display:
 179 @cursor_type:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION gdk_cursor_get_display ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @cursor:
 189 @Returns:
 190
 191
 192 <!-- ##### FUNCTION gdk_cursor_get_image ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @cursor:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION gdk_cursor_ref ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @cursor:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION gdk_cursor_unref ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @cursor:
 216
 217
 218 <!-- ##### MACRO gdk_cursor_destroy ##### -->
 219 <para>
 220 Destroys a cursor, freeing any resources allocated for it.
 221 </para>
 222
 223
 224