chiark - git - mdw - clg/blob - gtk/gtkselection.lisp

   1 ;; Common Lisp bindings for GTK+ v2.x
   2 ;; Copyright 2005-2006 Espen S. Johnsen <espen@users.sf.net>
   3 ;;
   4 ;; Permission is hereby granted, free of charge, to any person obtaining
   5 ;; a copy of this software and associated documentation files (the
   6 ;; "Software"), to deal in the Software without restriction, including
   7 ;; without limitation the rights to use, copy, modify, merge, publish,
   8 ;; distribute, sublicense, and/or sell copies of the Software, and to
   9 ;; permit persons to whom the Software is furnished to do so, subject to
  10 ;; the following conditions:
  11 ;;
  12 ;; The above copyright notice and this permission notice shall be
  13 ;; included in all copies or substantial portions of the Software.
  14 ;;
  15 ;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16 ;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17 ;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18 ;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  19 ;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  20 ;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  21 ;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22
  23 ;; $Id: gtkselection.lisp,v 1.10 2007-12-12 15:10:04 espen Exp $
  24
  25
  26 (in-package "GTK")
  27
  28
  29 ;;;; Selection
  30
  31 (defbinding %target-list-ref () pointer
  32   (location pointer))
  33
  34 (defbinding %target-list-unref () nil
  35   (location pointer))
  36
  37 (defbinding %target-list-new () pointer
  38   (targets (vector (inlined target-entry)))
  39   ((length targets) int))
  40
  41 (defmethod allocate-foreign ((target-list target-list) &key targets)
  42   (%target-list-new targets))
  43
  44 (defbinding target-list-add (target-list target &optional flags info) nil
  45   (target-list target-list)
  46   ((gdk:atom-intern target) gdk:atom)
  47   (flags target-flags)
  48   (info unsigned-int))
  49
  50 (defbinding target-list-add-table (target-list targets) nil
  51   (target-list target-list)
  52   ((etypecase targets
  53      ((or vector list) targets)
  54      (target-entry (vector targets)))
  55    (vector (inlined target-entry)))
  56   ((etypecase targets
  57      ((or vector list) (length targets))
  58      (target-entry 1))
  59    int))
  60
  61 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
  62 (progn
  63   (defbinding target-list-add-text-targets (target-list info &optional writable-p) nil
  64     (target-list target-list)
  65     (info unsigned-int)
  66     (writable-p boolean))
  67
  68   (defbinding target-list-add-image-targets (target-list info &optional writable-p) nil
  69     (target-list target-list)
  70     (info unsigned-int)
  71     (writable-p boolean))
  72
  73   (defbinding target-list-add-uri-targets (target-list info &optional writable-p) nil
  74     (target-list target-list)
  75     (info unsigned-int)
  76     (writable-p boolean)))
  77
  78 (defbinding target-list-remove (target-list target) nil
  79   (target-list target-list)
  80   ((gdk:atom-intern target) gdk:atom))
  81
  82 (defbinding target-list-find (target-list target) boolean
  83   (target-list target-list)
  84   ((gdk:atom-intern target) gdk:atom)
  85   (info unsigned-int :out))
  86
  87 (defbinding target-table-new-from-list () (vector (inlined target-entry) n-targets)
  88   (target-list target-list)
  89   (n-targets int :out))
  90
  91 (defun ensure-target-table (targets)
  92   (etypecase targets
  93     (target-list (target-table-new-from-list targets))
  94     ((or vector list) targets)))
  95
  96 (defbinding (selection-set-owner "gtk_selection_owner_set_for_display")
  97     (widget selection time &optional (display (gdk:display-get-default)))
  98     boolean
  99   (display gdk:display)
 100   (widget widget)
 101   ((gdk:atom-intern selection) gdk:atom)
 102   (time (unsigned 32)))
 103
 104 (defbinding selection-add-target (widget selection target info) nil
 105   (widget widget)
 106   ((gdk:atom-intern selection) gdk:atom)
 107   ((gdk:atom-intern target) gdk:atom)
 108   (info unsigned-int))
 109
 110 (defbinding selection-add-targets (widget selection targets) nil
 111   (widget widget)
 112   ((gdk:atom-intern selection) gdk:atom)
 113   ((etypecase targets
 114      ((or vector list) targets)
 115      (target-entry (vector targets)))
 116    (vector (inlined target-entry)))
 117   ((etypecase targets
 118      ((or vector list) (length targets))
 119      (target-entry 1))
 120    int))
 121
 122 (defbinding selection-clear-targets (widget selection) nil
 123   (widget widget)
 124   ((gdk:atom-intern selection) gdk:atom))
 125
 126 (defbinding selection-convert (widget selection target time) boolean
 127   (widget widget)
 128   ((gdk:atom-intern selection) gdk:atom)
 129   ((gdk:atom-intern target) gdk:atom)
 130   (time unsigned-int))
 131
 132 (defbinding selection-data-set (selection-data type format data length) boolean
 133   (selection-data selection-data)
 134   ((gdk:atom-intern type) gdk:atom)
 135   (format int)
 136   (data pointer)
 137   (length int))
 138
 139 (defbinding selection-data-set-text () boolean
 140   (selection-data selection-data)
 141   (text string)
 142   (-1 integer))
 143
 144 (defbinding selection-data-get-text () string
 145   (selection-data selection-data))
 146
 147 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 148 (progn
 149   (defbinding selection-data-set-pixbuf () boolean
 150     (selection-data selection-data)
 151     (puxbuf gdk:pixbuf))
 152
 153   (defbinding selection-data-get-pixbuf () gdk:pixbuf
 154     (selection-data selection-data))
 155
 156   (defbinding selection-data-set-uris () boolean
 157     (selection-data selection-data)
 158     (uris (null-terminated-vector string)))
 159
 160   (defbinding selection-data-get-uris () (null-terminated-vector string)
 161     (selection-data selection-data)))
 162
 163 (defbinding %selection-data-get-targets () boolean
 164   (selection-data selection-data)
 165   (targets (vector gdk:atom n-targets) :out)
 166   (n-targets int :out))
 167
 168 (defun selection-data-get-targets (selection-data)
 169   (multiple-value-bind (valid-p targets)
 170       (%selection-data-get-targets selection-data)
 171     (when valid-p
 172       (map-into targets #'gdk:atom-name targets))))
 173
 174 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 175 (defbinding selection-data-targets-include-image-p (selection-data &optional writable-p) boolean
 176   (selection-data selection-data)
 177   (writable-p boolean))
 178
 179 (defbinding selection-data-targets-include-text-p () boolean
 180   (selection-data selection-data))
 181
 182 (defbinding selection-remove-all () boolean
 183   (widget widget))
 184
 185
 186 ;;; Clipboard -- untestet
 187
 188 (defbinding (clipboard-get "gtk_clipboard_get_for_display")
 189     (selection &optional (display (gdk:display-get-default))) clipboard
 190   (display gdk:display)
 191   ((gdk:atom-intern selection) gdk:atom))
 192
 193 (define-callback %clipboard-get-callback nil
 194     ((clipboard pointer) (selection-data selection-data)
 195      (info unsigned-int) (callback-ids unsigned-int))
 196   (declare (ignore clipboard))
 197   (funcall (car (find-user-data callback-ids)) selection-data info))
 198
 199 (define-callback %clipboard-clear-callback nil
 200     ((clipboard pointer) (callback-ids unsigned-int))
 201   (declare (ignore clipboard))
 202   (funcall (cdr (find-user-data callback-ids))))
 203
 204 (defbinding %clipboard-set-with-data (clipboard targets get-func clear-func) boolean
 205   (clipboard clipboard)
 206   (targets (vector (inlined target-entry)))
 207   ((length targets) unsigned-int)
 208   (%clipboard-get-callback callback)
 209   (%clipboard-clear-callback callback)
 210   ((register-user-data (cons get-func clear-func)) unsigned-int))
 211
 212 (defun clipboard-set-with-data (clipboard targets get-func &optional clear-func)
 213   (%clipboard-set-with-data clipboard (ensure-target-table targets)
 214    get-func (or clear-func #'(lambda ()))))
 215
 216 (defbinding clipboard-clear () nil
 217   (clipboard clipboard))
 218
 219 (defbinding clipboard-set-text () nil
 220   (clipboard clipboard)
 221   (text string)
 222   ((length text) int))
 223
 224 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 225 (defbinding clipboard-set-image () nil
 226   (clipboard clipboard)
 227   (pixbuf gdk:pixbuf))
 228
 229 (defun clipboard-set (clipboard object)
 230   (etypecase object
 231     (string (clipboard-set-text clipboard object))
 232     #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 233     (gdk:pixbuf (clipboard-set-image clipboard object))))
 234
 235 (define-callback-marshal %clipboard-receive-callback nil
 236  ((:ignore clipboard) selection-data))
 237
 238 (defbinding clipboard-request-contents (clipboard target callback) nil
 239   (clipboard clipboard)
 240   ((gdk:atom-intern target) gdk:atom)
 241   (%clipboard-receive-callback callback)
 242   ((register-callback-function callback) unsigned-int))
 243
 244 (define-callback-marshal %clipboard-text-receive-callback nil
 245   ((:ignore clipboard) (text string)))
 246
 247
 248 (defbinding clipboard-request-text (clipboard callback) nil
 249   (clipboard clipboard)
 250   (%clipboard-text-receive-callback callback)
 251   ((register-callback-function callback) unsigned-int))
 252
 253 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 254 (progn
 255   (define-callback-marshal %clipboard-image-receive-callback nil
 256     ((:ignore clipboard) (image gdk:pixbuf)))
 257
 258   (defbinding clipboard-request-image (clipboard callback) nil
 259     (clipboard clipboard)
 260     (%clipboard-image-receive-callback callback)
 261     ((register-callback-function callback) unsigned-int)))
 262
 263
 264 (define-callback %clipboard-targets-receive-callback nil
 265     ((clipboard pointer) (atoms (vector gdk:atom n-atoms))
 266      (n-atoms unsigned-int) (callback-id unsigned-int))
 267   (declare (ignore clipboard))
 268   (funcall (find-user-data callback-id) (map-into atoms #'gdk:atom-name atoms)))
 269
 270 (defbinding clipboard-request-targets (clipboard callback) nil
 271   (clipboard clipboard)
 272   (%clipboard-targets-receive-callback callback)
 273   ((register-callback-function callback) unsigned-int))
 274
 275 (defbinding clipboard-wait-for-contents (clipboard target) selection-data
 276   (clipboard clipboard)
 277   ((gdk:atom-intern target) gdk:atom))
 278
 279 (defbinding clipboard-wait-for-text () string
 280   (clipboard clipboard))
 281
 282 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 283 (defbinding clipboard-wait-for-image () (referenced gdk:pixbuf)
 284   (clipboard clipboard))
 285
 286 (defbinding clipboard-wait-is-text-available-p () boolean
 287   (clipboard clipboard))
 288
 289 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 290 (defbinding clipboard-wait-is-image-available-p () boolean
 291   (clipboard clipboard))
 292
 293 (defbinding %clipboard-wait-for-targets () boolean
 294   (clipboard clipboard)
 295   (targets (vector gdk:atom n-targets) :out)
 296   (n-targets unsigned-int :out))
 297
 298 (defun clipboard-wait-for-targets (clipboard)
 299   (multiple-value-bind (valid-p targets)
 300       (%clipboard-wait-for-targets clipboard)
 301     (when valid-p
 302       (map-into targets #'gdk:atom-name targets))))
 303
 304 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 305 (defbinding clipboard-wait-is-target-available-p (clipboard target) boolean
 306   (clipboard clipboard)
 307   ((gdk:atom-intern target) gdk:atom))
 308
 309 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 310 (defbinding clipboard-set-can-store (clipboard targets) nil
 311   (clipboard clipboard)
 312   ((map 'vector #'gdk:atom-intern targets) (vector gdk:atom))
 313   ((length targets) int))
 314
 315 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 316 (defbinding clipboard-store () nil
 317   (clipboard clipboard))
 318
 319
 320 ;;;; Drag and Drop
 321
 322 (defbinding drag-dest-set (widget flags targets actions) nil
 323   (widget widget)
 324   (flags dest-defaults)
 325   ((etypecase targets
 326      ((or vector list) targets)
 327      (target-entry (vector targets)))
 328    (vector (inlined target-entry)))
 329   ((etypecase targets
 330      ((or vector list) (length targets))
 331      (target-entry 1))
 332    int)
 333   (actions gdk:drag-action))
 334
 335 (defbinding drag-dest-set-proxy () nil
 336   (widget widget)
 337   (window gdk:window)
 338   (protocol gdk:drag-protocol)
 339   (use-coordinates-p boolean))
 340
 341 (defbinding drag-dest-unset () nil
 342   (widget widget))
 343
 344 (defbinding drag-dest-find-target () gdk:atom
 345   (widget widget)
 346   (context gdk:drag-context)
 347   (targets target-list))
 348
 349 (defbinding drag-dest-get-target-list () target-list
 350   (widget widget))
 351
 352 (defbinding drag-dest-set-target-list () nil
 353   (widget widget)
 354   (targets target-list))
 355
 356 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 357 (progn
 358   (defbinding drag-dest-add-text-targets () nil
 359     (widget widget))
 360
 361   (defbinding drag-dest-add-image-targets () nil
 362     (widget widget))
 363
 364   (defbinding drag-dest-add-uri-targets () nil
 365     (widget widget)))
 366
 367 (defbinding drag-finish () nil
 368   (context gdk:drag-context)
 369   (success boolean)
 370   (delete boolean)
 371   (time unsigned-int))
 372
 373 (defbinding drag-get-data () nil
 374   (widget widget)
 375   (context gdk:drag-context)
 376   (target gdk:atom)
 377   (time unsigned-int))
 378
 379 (defbinding drag-get-source-widget () widget
 380   (context gdk:drag-context))
 381
 382 (defbinding drag-highlight () nil
 383   (widget widget))
 384
 385 (defbinding drag-unhighlight () nil
 386   (widget widget))
 387
 388 (defbinding drag-begin () gdk:drag-context
 389   (widget widget)
 390   (targets target-list)
 391   (actions gdk:drag-action)
 392   (button int)
 393   (event gdk:event))
 394
 395 (defbinding %drag-set-icon-widget () nil
 396   (context gdk:drag-context)
 397   (widget widget)
 398   (hot-x int)
 399   (hot-y int))
 400
 401 (defbinding %drag-set-icon-pixmap () nil
 402   (context gdk:drag-context)
 403   (pixmap gdk:pixmap)
 404   (mask gdk:bitmap)
 405   (hot-x int)
 406   (hot-y int))
 407
 408 (defbinding %drag-set-icon-pixbuf () nil
 409   (context gdk:drag-context)
 410   (pixbuf gdk:pixbuf)
 411   (hot-x int)
 412   (hot-y int))
 413
 414 (defbinding %drag-set-icon-stock () nil
 415   (context gdk:drag-context)
 416   (stock-id string)
 417   (hot-x int)
 418   (hot-y int))
 419
 420 (defbinding %drag-set-icon-default () nil
 421   (context gdk:drag-context))
 422
 423 (defun drag-set-icon (context icon &optional (hot-x 0) (hot-y 0))
 424   (etypecase icon
 425     (widget (%drag-set-icon-widget context icon hot-x hot-y))
 426     (gdk:pixbuf (%drag-set-icon-pixbuf context icon hot-x hot-y))
 427     (string (%drag-set-icon-stock context icon hot-x hot-y))
 428     (vector (multiple-value-bind (pixmap mask) (gdk:pixmap-create icon)
 429               (%drag-set-icon-pixmap context pixmap mask hot-x hot-y)))
 430     (pathname (let ((pixbuf (gdk:pixbuf-load icon)))
 431                 (%drag-set-icon-pixbuf context pixbuf hot-x hot-y)))
 432     (null (%drag-set-icon-default context))))
 433
 434 (defbinding drag-check-threshold-p () boolean
 435   (widget widget)
 436   (start-x int)
 437   (start-y int)
 438   (current-x int)
 439   (current-y int))
 440
 441 (defbinding drag-source-set (widget start-button-mask targets actions) nil
 442   (widget widget)
 443   (start-button-mask gdk:modifier-type)
 444   ((etypecase targets
 445      ((or vector list) targets)
 446      (target-entry (vector targets)))
 447    (vector (inlined target-entry)))
 448   ((etypecase targets
 449      ((or vector list) (length targets))
 450      (target-entry 1))
 451    int)
 452   (actions gdk:drag-action))
 453
 454 (defbinding %drag-source-set-icon-pixbuf () nil
 455   (widget widget)
 456   (pixbuf gdk:pixbuf))
 457
 458 (defbinding %drag-source-set-icon-stock () nil
 459   (widget widget)
 460   (pixbuf gdk:pixbuf))
 461
 462 (defun drag-source-set-icon (widget icon)
 463   (etypecase icon
 464     (gdk:pixbuf (%drag-source-set-icon-pixbuf widget icon))
 465     (string (%drag-source-set-icon-stock widget icon))
 466 ;    (vector )
 467     (pathname (let ((pixbuf (gdk:pixbuf-load icon)))
 468                 (%drag-source-set-icon-pixbuf widget pixbuf)))))
 469
 470 (defbinding drag-source-unset () nil
 471   (widget widget))
 472
 473 (defbinding drag-source-set-target-list () nil
 474   (widget widget)
 475   (targets (or null target-list)))
 476
 477 (defbinding drag-source-get-target-list () target-list
 478   (widget widget))
 479
 480 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.6.0")
 481 (progn
 482   (defbinding drag-source-add-text-targets () nil
 483     (widget widget))
 484
 485   (defbinding drag-source-add-image-targets () nil
 486     (widget widget))
 487
 488   (defbinding drag-source-add-uri-targets () nil
 489     (widget widget)))