doc/gdk.structs.texi

   1 @menu
   2 * color::
   3 * cursor::
   4 * event::
   5 * event-button::
   6 * event-client::
   7 * event-client-16::
   8 * event-client-32::
   9 * event-client-8::
  10 * event-configure::
  11 * event-crossing::
  12 * event-dnd::
  13 * event-expose::
  14 * event-focus::
  15 * event-grab-broken::
  16 * event-key::
  17 * event-motion::
  18 * event-no-expose::
  19 * event-owner-change::
  20 * event-property::
  21 * event-proximity::
  22 * event-scroll::
  23 * event-selection::
  24 * event-setting::
  25 * event-visibility::
  26 * event-window-state::
  27 * font::
  28 * geometry::
  29 * rectangle::
  30 @end menu
  31
  32 @node color
  33 @section color
  34 @Struct color
  35 Superclass: @code{structure-object}
  36
  37 Slots:
  38 @itemize
  39 @item @anchor{slot.color.blue}blue. Accessor: color-blue.
  40 @item @anchor{slot.color.green}green. Accessor: color-green.
  41 @item @anchor{slot.color.pixel}pixel. Accessor: color-pixel.
  42 @item @anchor{slot.color.red}red. Accessor: color-red.
  43 @end itemize
  44
  45
  46 @node cursor
  47 @section cursor
  48 @Struct cursor
  49 Superclass: @code{structure-object}
  50
  51 Slots:
  52 @itemize
  53 @item @anchor{slot.cursor.type}type. Accessor: cursor-type.
  54 @end itemize
  55
  56
  57 @node event
  58 @section event
  59 @Struct event
  60 Superclass: @code{structure-object}
  61
  62 Subclasses: @ref{event-key} @ref{event-button} @ref{event-scroll} @ref{event-motion} @ref{event-expose} @ref{event-visibility} @ref{event-crossing} @ref{event-focus} @ref{event-configure} @ref{event-property} @ref{event-selection} @ref{event-dnd} @ref{event-proximity} @ref{event-client} @ref{event-no-expose} @ref{event-window-state} @ref{event-setting} @ref{event-owner-change} @ref{event-grab-broken}
  63
  64 Slots:
  65 @itemize
  66 @item @anchor{slot.event.send-event}send-event. Accessor: event-send-event.
  67 @item @anchor{slot.event.type}type. Accessor: event-type.
  68 @item @anchor{slot.event.window}window. Accessor: event-window.
  69 @end itemize
  70
  71
  72 @node event-button
  73 @section event-button
  74 @Struct event-button
  75 Superclass: @ref{event}
  76
  77 Slots:
  78 @itemize
  79 @item @anchor{slot.event-button.axes}axes. Accessor: event-button-axes.
  80 @item @anchor{slot.event-button.button}button. Accessor: event-button-button.
  81 @item @anchor{slot.event-button.device}device. Accessor: event-button-device.
  82 @item @anchor{slot.event-button.state}state. Accessor: event-button-state.
  83 @item @anchor{slot.event-button.time}time. Accessor: event-button-time.
  84 @item @anchor{slot.event-button.type}type. Accessor: event-button-type.
  85 @item @anchor{slot.event-button.x}x. Accessor: event-button-x.
  86 @item @anchor{slot.event-button.x-root}x-root. Accessor: event-button-x-root.
  87 @item @anchor{slot.event-button.y}y. Accessor: event-button-y.
  88 @item @anchor{slot.event-button.y-root}y-root. Accessor: event-button-y-root.
  89 @end itemize
  90
  91
  92 @node event-client
  93 @section event-client
  94 @Struct event-client
  95 Superclass: @ref{event}
  96
  97 Subclasses: @ref{event-client-8} @ref{event-client-16} @ref{event-client-32}
  98
  99 Slots:
 100 @itemize
 101 @item @anchor{slot.event-client.data-format}data-format. Accessor: event-client-data-format.
 102 @item @anchor{slot.event-client.message-time}message-time. Accessor: event-client-message-time.
 103 @item @anchor{slot.event-client.type}type. Accessor: event-client-type.
 104 @end itemize
 105
 106
 107 @node event-client-16
 108 @section event-client-16
 109 @Struct event-client-16
 110 Superclass: @ref{event-client}
 111
 112 Slots:
 113 @itemize
 114 @item @anchor{slot.event-client-16.data}data. Accessor: event-client-16-data.
 115 @item @anchor{slot.event-client-16.data-format}data-format. Accessor: event-client-16-data-format.
 116 @end itemize
 117
 118
 119 @node event-client-32
 120 @section event-client-32
 121 @Struct event-client-32
 122 Superclass: @ref{event-client}
 123
 124 Slots:
 125 @itemize
 126 @item @anchor{slot.event-client-32.data}data. Accessor: event-client-32-data.
 127 @item @anchor{slot.event-client-32.data-format}data-format. Accessor: event-client-32-data-format.
 128 @end itemize
 129
 130
 131 @node event-client-8
 132 @section event-client-8
 133 @Struct event-client-8
 134 Superclass: @ref{event-client}
 135
 136 Slots:
 137 @itemize
 138 @item @anchor{slot.event-client-8.data}data. Accessor: event-client-8-data.
 139 @item @anchor{slot.event-client-8.data-format}data-format. Accessor: event-client-8-data-format.
 140 @end itemize
 141
 142
 143 @node event-configure
 144 @section event-configure
 145 @Struct event-configure
 146 Superclass: @ref{event}
 147
 148 Slots:
 149 @itemize
 150 @item @anchor{slot.event-configure.height}height. Accessor: event-configure-height.
 151 @item @anchor{slot.event-configure.type}type. Accessor: event-configure-type.
 152 @item @anchor{slot.event-configure.width}width. Accessor: event-configure-width.
 153 @item @anchor{slot.event-configure.x}x. Accessor: event-configure-x.
 154 @item @anchor{slot.event-configure.y}y. Accessor: event-configure-y.
 155 @end itemize
 156
 157
 158 @node event-crossing
 159 @section event-crossing
 160 @Struct event-crossing
 161 Superclass: @ref{event}
 162
 163 Slots:
 164 @itemize
 165 @item @anchor{slot.event-crossing.detail}detail. Accessor: event-crossing-detail.
 166 @item @anchor{slot.event-crossing.focus}focus. Accessor: event-crossing-focus.
 167 @item @anchor{slot.event-crossing.mode}mode. Accessor: event-crossing-mode.
 168 @item @anchor{slot.event-crossing.state}state. Accessor: event-crossing-state.
 169 @item @anchor{slot.event-crossing.sub-window}sub-window. Accessor: event-crossing-sub-window.
 170 @item @anchor{slot.event-crossing.time}time. Accessor: event-crossing-time.
 171 @item @anchor{slot.event-crossing.type}type. Accessor: event-crossing-type.
 172 @item @anchor{slot.event-crossing.x}x. Accessor: event-crossing-x.
 173 @item @anchor{slot.event-crossing.x-root}x-root. Accessor: event-crossing-x-root.
 174 @item @anchor{slot.event-crossing.y}y. Accessor: event-crossing-y.
 175 @item @anchor{slot.event-crossing.y-root}y-root. Accessor: event-crossing-y-root.
 176 @end itemize
 177
 178
 179 @node event-dnd
 180 @section event-dnd
 181 @Struct event-dnd
 182 Superclass: @ref{event}
 183
 184 Slots:
 185 @itemize
 186 @item @anchor{slot.event-dnd.drag-context}drag-context. Accessor: event-dnd-drag-context.
 187 @item @anchor{slot.event-dnd.time}time. Accessor: event-dnd-time.
 188 @item @anchor{slot.event-dnd.type}type. Accessor: event-dnd-type.
 189 @item @anchor{slot.event-dnd.x-root}x-root. Accessor: event-dnd-x-root.
 190 @item @anchor{slot.event-dnd.y-root}y-root. Accessor: event-dnd-y-root.
 191 @end itemize
 192
 193
 194 @node event-expose
 195 @section event-expose
 196 @Struct event-expose
 197 Superclass: @ref{event}
 198
 199 Slots:
 200 @itemize
 201 @item @anchor{slot.event-expose.area}area. Accessor: event-expose-area.
 202 @item @anchor{slot.event-expose.count}count. Accessor: event-expose-count.
 203 @item @anchor{slot.event-expose.region}region. Accessor: event-expose-region.
 204 @item @anchor{slot.event-expose.type}type. Accessor: event-expose-type.
 205 @end itemize
 206
 207
 208 @node event-focus
 209 @section event-focus
 210 @Struct event-focus
 211 Superclass: @ref{event}
 212
 213 Slots:
 214 @itemize
 215 @item @anchor{slot.event-focus.in}in. Accessor: event-focus-in.
 216 @item @anchor{slot.event-focus.type}type. Accessor: event-focus-type.
 217 @end itemize
 218
 219
 220 @node event-grab-broken
 221 @section event-grab-broken
 222 @Struct event-grab-broken
 223 Superclass: @ref{event}
 224
 225 Slots:
 226 @itemize
 227 @item @anchor{slot.event-grab-broken.grab-window}grab-window. Accessor: event-grab-broken-grab-window.
 228 @item @anchor{slot.event-grab-broken.implicit}implicit. Accessor: event-grab-broken-implicit.
 229 @item @anchor{slot.event-grab-broken.keyboard}keyboard. Accessor: event-grab-broken-keyboard.
 230 @item @anchor{slot.event-grab-broken.type}type. Accessor: event-grab-broken-type.
 231 @end itemize
 232
 233
 234 @node event-key
 235 @section event-key
 236 @Struct event-key
 237 Superclass: @ref{event}
 238
 239 Slots:
 240 @itemize
 241 @item @anchor{slot.event-key.group}group. Accessor: event-key-group.
 242 @item @anchor{slot.event-key.hardware-keycode}hardware-keycode. Accessor: event-key-hardware-keycode.
 243 @item @anchor{slot.event-key.is-modifier}is-modifier. Accessor: event-key-is-modifier.
 244 @item @anchor{slot.event-key.keyval}keyval. Accessor: event-key-keyval.
 245 @item @anchor{slot.event-key.length}length. Accessor: event-key-length.
 246 @item @anchor{slot.event-key.state}state. Accessor: event-key-state.
 247 @item @anchor{slot.event-key.string}string. Accessor: event-key-string.
 248 @item @anchor{slot.event-key.time}time. Accessor: event-key-time.
 249 @item @anchor{slot.event-key.type}type. Accessor: event-key-type.
 250 @end itemize
 251
 252
 253 @node event-motion
 254 @section event-motion
 255 @Struct event-motion
 256 Superclass: @ref{event}
 257
 258 Slots:
 259 @itemize
 260 @item @anchor{slot.event-motion.axes}axes. Accessor: event-motion-axes.
 261 @item @anchor{slot.event-motion.device}device. Accessor: event-motion-device.
 262 @item @anchor{slot.event-motion.is-hint}is-hint. Accessor: event-motion-is-hint.
 263 @item @anchor{slot.event-motion.state}state. Accessor: event-motion-state.
 264 @item @anchor{slot.event-motion.time}time. Accessor: event-motion-time.
 265 @item @anchor{slot.event-motion.type}type. Accessor: event-motion-type.
 266 @item @anchor{slot.event-motion.x}x. Accessor: event-motion-x.
 267 @item @anchor{slot.event-motion.x-root}x-root. Accessor: event-motion-x-root.
 268 @item @anchor{slot.event-motion.y}y. Accessor: event-motion-y.
 269 @item @anchor{slot.event-motion.y-root}y-root. Accessor: event-motion-y-root.
 270 @end itemize
 271
 272
 273 @node event-no-expose
 274 @section event-no-expose
 275 @Struct event-no-expose
 276 Superclass: @ref{event}
 277
 278 Slots:
 279 @itemize
 280 @item @anchor{slot.event-no-expose.type}type. Accessor: event-no-expose-type.
 281 @end itemize
 282
 283
 284 @node event-owner-change
 285 @section event-owner-change
 286 @Struct event-owner-change
 287 Superclass: @ref{event}
 288
 289 Slots:
 290 @itemize
 291 @item @anchor{slot.event-owner-change.owner}owner. Accessor: event-owner-change-owner.
 292 @item @anchor{slot.event-owner-change.reason}reason. Accessor: event-owner-change-reason.
 293 @item @anchor{slot.event-owner-change.selection}selection. Accessor: event-owner-change-selection.
 294 @item @anchor{slot.event-owner-change.selection-time}selection-time. Accessor: event-owner-change-selection-time.
 295 @item @anchor{slot.event-owner-change.time}time. Accessor: event-owner-change-time.
 296 @item @anchor{slot.event-owner-change.type}type. Accessor: event-owner-change-type.
 297 @end itemize
 298
 299
 300 @node event-property
 301 @section event-property
 302 @Struct event-property
 303 Superclass: @ref{event}
 304
 305 Slots:
 306 @itemize
 307 @item @anchor{slot.event-property.atom}atom. Accessor: event-property-atom.
 308 @item @anchor{slot.event-property.state}state. Accessor: event-property-state.
 309 @item @anchor{slot.event-property.time}time. Accessor: event-property-time.
 310 @item @anchor{slot.event-property.type}type. Accessor: event-property-type.
 311 @end itemize
 312
 313
 314 @node event-proximity
 315 @section event-proximity
 316 @Struct event-proximity
 317 Superclass: @ref{event}
 318
 319 Slots:
 320 @itemize
 321 @item @anchor{slot.event-proximity.device}device. Accessor: event-proximity-device.
 322 @item @anchor{slot.event-proximity.time}time. Accessor: event-proximity-time.
 323 @item @anchor{slot.event-proximity.type}type. Accessor: event-proximity-type.
 324 @end itemize
 325
 326
 327 @node event-scroll
 328 @section event-scroll
 329 @Struct event-scroll
 330 Superclass: @ref{event}
 331
 332 Slots:
 333 @itemize
 334 @item @anchor{slot.event-scroll.device}device. Accessor: event-scroll-device.
 335 @item @anchor{slot.event-scroll.direction}direction. Accessor: event-scroll-direction.
 336 @item @anchor{slot.event-scroll.state}state. Accessor: event-scroll-state.
 337 @item @anchor{slot.event-scroll.time}time. Accessor: event-scroll-time.
 338 @item @anchor{slot.event-scroll.type}type. Accessor: event-scroll-type.
 339 @item @anchor{slot.event-scroll.x}x. Accessor: event-scroll-x.
 340 @item @anchor{slot.event-scroll.x-root}x-root. Accessor: event-scroll-x-root.
 341 @item @anchor{slot.event-scroll.y}y. Accessor: event-scroll-y.
 342 @item @anchor{slot.event-scroll.y-root}y-root. Accessor: event-scroll-y-root.
 343 @end itemize
 344
 345
 346 @node event-selection
 347 @section event-selection
 348 @Struct event-selection
 349 Superclass: @ref{event}
 350
 351 Slots:
 352 @itemize
 353 @item @anchor{slot.event-selection.property}property. Accessor: event-selection-property.
 354 @item @anchor{slot.event-selection.requestor}requestor. Accessor: event-selection-requestor.
 355 @item @anchor{slot.event-selection.selection}selection. Accessor: event-selection-selection.
 356 @item @anchor{slot.event-selection.target}target. Accessor: event-selection-target.
 357 @item @anchor{slot.event-selection.time}time. Accessor: event-selection-time.
 358 @item @anchor{slot.event-selection.type}type. Accessor: event-selection-type.
 359 @end itemize
 360
 361
 362 @node event-setting
 363 @section event-setting
 364 @Struct event-setting
 365 Superclass: @ref{event}
 366
 367 Slots:
 368 @itemize
 369 @item @anchor{slot.event-setting.action}action. Accessor: event-setting-action.
 370 @item @anchor{slot.event-setting.name}name. Accessor: event-setting-name.
 371 @item @anchor{slot.event-setting.type}type. Accessor: event-setting-type.
 372 @end itemize
 373
 374
 375 @node event-visibility
 376 @section event-visibility
 377 @Struct event-visibility
 378 Superclass: @ref{event}
 379
 380 Slots:
 381 @itemize
 382 @item @anchor{slot.event-visibility.state}state. Accessor: event-visibility-state.
 383 @item @anchor{slot.event-visibility.type}type. Accessor: event-visibility-type.
 384 @end itemize
 385
 386
 387 @node event-window-state
 388 @section event-window-state
 389 @Struct event-window-state
 390 Superclass: @ref{event}
 391
 392 Slots:
 393 @itemize
 394 @item @anchor{slot.event-window-state.changed-mask}changed-mask. Accessor: event-window-state-changed-mask.
 395 @item @anchor{slot.event-window-state.new-window-state}new-window-state. Accessor: event-window-state-new-window-state.
 396 @item @anchor{slot.event-window-state.type}type. Accessor: event-window-state-type.
 397 @end itemize
 398
 399
 400 @node font
 401 @section font
 402 @Struct font
 403 Superclass: @code{structure-object}
 404
 405 Slots:
 406 @itemize
 407 @item @anchor{slot.font.ascent}ascent. Accessor: font-ascent.
 408 @item @anchor{slot.font.descent}descent. Accessor: font-descent.
 409 @item @anchor{slot.font.type}type. Accessor: font-type.
 410 @end itemize
 411
 412
 413 @node geometry
 414 @section geometry
 415 @Struct geometry
 416 Superclass: @code{structure-object}
 417
 418 Slots:
 419 @itemize
 420 @item @anchor{slot.geometry.base-height}base-height. Accessor: geometry-base-height.
 421 @item @anchor{slot.geometry.base-width}base-width. Accessor: geometry-base-width.
 422 @item @anchor{slot.geometry.gravity}gravity. Accessor: geometry-gravity.
 423 @item @anchor{slot.geometry.height-increment}height-increment. Accessor: geometry-height-increment.
 424 @item @anchor{slot.geometry.max-aspect}max-aspect. Accessor: geometry-max-aspect.
 425 @item @anchor{slot.geometry.max-height}max-height. Accessor: geometry-max-height.
 426 @item @anchor{slot.geometry.max-width}max-width. Accessor: geometry-max-width.
 427 @item @anchor{slot.geometry.min-aspect}min-aspect. Accessor: geometry-min-aspect.
 428 @item @anchor{slot.geometry.min-height}min-height. Accessor: geometry-min-height.
 429 @item @anchor{slot.geometry.min-width}min-width. Accessor: geometry-min-width.
 430 @item @anchor{slot.geometry.width-increment}width-increment. Accessor: geometry-width-increment.
 431 @end itemize
 432
 433
 434 @node rectangle
 435 @section rectangle
 436 @Struct rectangle
 437 Superclass: @code{structure-object}
 438
 439 Slots:
 440 @itemize
 441 @item @anchor{slot.rectangle.height}height. Accessor: rectangle-height.
 442 @item @anchor{slot.rectangle.width}width. Accessor: rectangle-width.
 443 @item @anchor{slot.rectangle.x}x. Accessor: rectangle-x.
 444 @item @anchor{slot.rectangle.y}y. Accessor: rectangle-y.
 445 @end itemize
 446
 447