1 ;; Common Lisp bindings for GTK+ v2.x
2 ;; Copyright 1999-2005 Espen S. Johnsen <espen@users.sf.net>
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:
12 ;; The above copyright notice and this permission notice shall be
13 ;; included in all copies or substantial portions of the Software.
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.
23 ;; $Id: gtktypes.lisp,v 1.38 2005/04/24 13:30:40 espen Exp $
27 (defclass requisition (boxed)
30 :accessor requisition-width
35 :accessor requisition-height
38 (:metaclass boxed-class))
41 (defclass allocation (struct)
44 :accessor allocation-width
49 :accessor allocation-width
54 :accessor allocation-width
59 :accessor allocation-height
62 (:metaclass struct-class))
64 (defclass border (boxed)
72 :accessor border-right
82 :accessor border-bottom
85 (:metaclass boxed-class))
87 (defclass stock-item (struct)
90 :accessor stock-item-id
95 :accessor stock-item-label
100 :accessor stock-item-modifier
102 :type gdk:modifier-type)
105 :accessor stock-item-keyval
110 :accessor stock-item-translation-domain
111 :initarg :translation-domain
113 (:metaclass struct-class))
115 ;; We don't really need to access any of these slots, but we need to
116 ;; specify the size of the struct somehow
117 (defclass tree-iter (boxed)
118 ((stamp :allocation :alien :type int)
119 (user-data :allocation :alien :type pointer)
120 (user-data2 :allocation :alien :type pointer)
121 (user-data3 :allocation :alien :type pointer))
122 (:metaclass boxed-class))
125 ;; (defclass tree-path (boxed)
126 ;; ((depth :allocation :alien :type int)
127 ;; (indices :allocation :alien :type pointer))
128 ;; (:metaclass boxed-class))
130 (deftype tree-path () '(vector integer))
131 (register-type 'tree-path '|gtk_tree_path_get_type|)
134 '(or int (enum (:start 0) (:end -1) (:first 0) (:last -1))))
136 (defmethod reader-function ((type (eql 'position)) &rest args)
137 (declare (ignore type args))
138 (reader-function 'int))
140 (define-types-by-introspection "Gtk"
142 ("GtkObject" :ignore t)
143 ("GtkRequisition" :ignore t)
144 ("GtkBorder" :ignore t)
145 ("GtkTreeIter" :ignore t)
146 ("GtkTreePath" :ignore t)
147 ; ("GtkStyle" :ignore t)
153 :allocation :instance
154 :accessor widget-child-properties
155 :type container-child)
158 :getter "gtk_widget_get_window"
159 :reader widget-window
161 (parent :merge t :initarg nil)
162 (visible :merge t :initarg nil)
165 :getter %widget-parent-window
166 :setter "gtk_widget_set_parent_window"
167 :accessor widget-parent-window
168 :initarg :parent-window
172 :getter "gtk_widget_get_state"
173 :setter "gtk_widget_set_state"
174 :accessor widget-state
179 :getter "gtk_widget_get_colormap"
180 :setter "gtk_widget_set_colormap"
182 :accessor widget-colormap
186 :getter "gtk_widget_get_visual"
187 :reader widget-visual
191 :getter "gtk_widget_get_direction"
192 :setter "gtk_widget_set_direction"
193 :accessor widget-direction
195 :type text-direction)
198 :getter "gtk_widget_get_composite_name"
199 :setter "gtk_widget_set_composite_name"
200 :accessor widget-composite-name
201 :initarg :composite-name
202 :type (copy-of string)) ; will leak the string when setting
205 :getter "gtk_widget_get_settings"
206 :accessor widget-settings
210 :getter "gtk_widget_get_child_visible"
211 :setter "gtk_widget_set_child_visible"
212 :accessor widget-child-visible-p
213 :initarg :child-visible
216 :merge t :unbound -1)
218 :merge t :unbound -1)))
225 :getter container-children
226 :setter (setf container-children)
227 ;; The following doesn't work because gtk_container_get_children doesn't
228 ;; increase the reference count of the children
229 ; :getter "gtk_container_get_children"
230 ; :reader container-children
231 ; :type (glist widget)
235 :getter "gtk_container_child_type"
236 :reader container-child-type
240 :getter "gtk_container_get_focus_child"
241 :setter "gtk_container_set_focus_child"
242 :accessor container-focus-child
243 :initarg :focus-child
247 :getter container-focus-chain
248 :setter (setf container-focus-chain))
251 :getter "gtk_container_get_focus_hadjustment"
252 :setter "gtk_container_set_focus_hadjustment"
253 :accessor container-focus-hadjustment
254 :initarg :focus-hadjustment
258 :getter "gtk_container_get_focus_vadjustment"
259 :setter "gtk_container_set_focus_vadjustment"
260 :accessor container-focus-vadjustment
261 :initarg :focus-vadjustment
265 :getter "gtk_container_get_reallocate_redraws"
266 :setter "gtk_container_set_reallocate_redraws"
267 :accessor container-reallocate-redraws
268 :initarg :reallocate-redraws
275 :getter "gtk_bin_get_child"
276 :setter (setf bin-child)
284 :getter "gtk_window_get_focus"
285 :setter "gtk_window_set_focus"
286 :accessor window-focus-widget
287 :initarg :focus-widget
291 :getter "gtk_window_get_default"
292 :setter "gtk_window_set_default"
293 :accessor window-default-widget
294 :initarg :default-widget
298 :getter "gtk_window_get_has_frame"
299 :setter "gtk_window_set_has_frame"
300 :accessor window-has-frame-p
305 :getter "gtk_window_get_icon_list"
306 :setter "gtk_window_set_icon_list"
307 :accessor window-icon-list
309 :type (glist gdk:pixbuf))
312 :getter "gtk_window_get_mnemonic_modifier"
313 :setter "gtk_window_set_mnemonic_modifier"
314 :accessor window-mnemonic-modifier
315 :initarg :mnemonic-modifier
316 :type gdk:modifier-type)
319 :getter "gtk_window_get_transient_for"
320 :setter "gtk_window_set_transient_for"
321 :accessor window-transient-for
322 :initarg :transient-for
326 :getter "gtk_window_get_group"
327 :setter (setf window-group)
331 (default-width :merge t :unbound -1)
332 (default-height :merge t :unbound -1)))
338 :accessor window-group-grabs
339 :type (gslist window))))
345 :getter "gtk_tooltips_get_enabled"
346 :setter (setf tooltips-enabled-p)
347 :reader tooltips-enabled-p
355 :getter menu-item-label
356 :setter (setf menu-item-label)
359 :allocation :user-data
361 :initarg :use-underline
362 :accessor menu-item-use-underline-p)
365 :getter "gtk_menu_item_get_right_justified"
366 :setter "gtk_menu_item_set_right_justified"
367 :accessor menu-item-right-justified-p
368 :initarg :right-justified
372 :getter "gtk_menu_item_get_submenu"
373 :setter "gtk_menu_item_set_submenu"
374 :accessor menu-item-submenu
378 ("GtkColorSelectionDialog"
382 :reader color-selection-dialog-colorsel
386 :reader color-selection-dialog-ok-button
390 :reader color-selection-dialog-cancel-button
394 :reader color-selection-dialog-help-button
401 :reader scrolled-window-hscrollbar
405 :reader scrolled-window-vscrollbar
412 :getter "gtk_paned_get_child1"
413 :setter "gtk_paned_add1"
414 :accessor paned-child1
419 :getter "gtk_paned_get_child2"
420 :setter "gtk_paned_add2"
421 :accessor paned-child2
429 :getter "gtk_menu_get_accel_group"
430 :setter "gtk_menu_set_accel_group"
431 :accessor menu-accel-group
432 :initarg :accel-group
436 :getter "gtk_menu_get_active"
437 :setter (setf menu-active)
443 :getter "gtk_menu_get_screen"
444 :setter "gtk_menu_set_screen"
445 :accessor menu-screen
450 :getter "gtk_menu_get_attach_widget"
451 :reader menu-attach-widget
456 :getter "gtk_menu_get_tearoff_state"
457 :setter "gtk_menu_set_tearoff_state"
458 :accessor menu-tearoff-state-p
459 :initarg :tearoff-state
466 :getter "gtk_toolbar_get_tooltips"
467 :setter "gtk_toolbar_set_tooltips"
468 :accessor toolbar-show-tooltips-p
469 :initarg :show-tooltips
473 :getter "gtk_toolbar_get_tooltips_object"
474 :reader toolbar-tooltips
477 :allocation :property
478 :pname "toolbar-style"
479 :initarg :toolbar-style
480 :accessor toolbar-style
484 :getter "gtk_toolbar_get_n_items"
485 :reader toolbar-n-items
492 :getter "gtk_tool_item_get_use_drag_window"
493 :setter "gtk_tool_item_set_use_drag_window"
494 :accessor tool-item-use-drag-window-p
495 :initarg :drag-window
498 :allocation :user-data
499 :setter (setf tool-item-tip-text)
501 :reader tool-item-tip-text)
503 :allocation :user-data
504 :setter (setf tool-item-tip-private)
505 :initarg :tip-private
506 :reader tool-item-tip-private)))
510 ((stock-id :merge t :initarg :stock)
511 (icon-widget :merge t :initarg :icon)))
513 ("GtkToggleToolButton"
517 :getter "gtk_toggle_tool_button_get_active"
518 :setter "gtk_toggle_tool_button_get_active"
519 :accessor toggle-tool-button-active-p
523 ("GtkRadioToolButton"
527 :getter "gtk_radio_tool_button_get_group"
528 :reader radio-tool-button-group
529 :type (copy-of (gslist widget)))
531 :allocation :user-data
533 :accessor radio-tool-button-value
534 :documentation "Value passed as argument to the activate callback")))
540 :getter %notebook-current-page
541 :setter (setf notebook-current-page)
542 :reader notebook-current-page
544 :initarg :current-page)
547 :getter "gtk_notebook_get_current_page"
548 :setter "gtk_notebook_set_current_page"
550 :initarg :current-page-num
551 :accessor notebook-current-page-num
558 :getter "gtk_ruler_get_metric"
559 :setter "gtk_ruler_set_metric"
560 :accessor ruler-metric
566 ; deprecated properties
567 ((bar-style :ignore t)
568 (adjustment :ignore t)
569 (activity-step :ignore t)
570 (activity-blocks :ignore t)
571 (discrete-blocks :ignore t)))
575 ; deprecated property
576 ((shadow :ignore t)))
580 ; deprecated property
581 ((shadow :ignore t)))
587 :getter "gtk_table_get_default_col_spacing"
588 :setter "gtk_table_set_col_spacings"
589 :initarg :column-spacing
593 :getter "gtk_table_get_default_row_spacing"
594 :setter "gtk_table_set_row_spacings"
595 :initarg :row-spacing
596 :type unsigned-int)))
602 :getter "gtk_dialog_get_vbox"
607 :getter "gtk_dialog_get_action_area"
608 :reader dialog-action-area
615 :getter "gtk_entry_get_layout"
619 :getter "gtk_entry_get_completion"
620 :setter "gtk_entry_set_completion"
622 :accessor entry-completion
623 :type entry-completion)
624 (max-length :merge t :unbound 0)
626 (width-chars :merge t :unbound -1)))
628 ("GtkEntryCompletion"
632 :getter "gtk_entry_completion_get_entry"
633 :reader entry-completion-entry
635 (minimum-key-length :merge t :unbound -1)
637 (text-column :merge t :unbound -1)))
643 :getter "gtk_radio_button_get_group"
644 :reader radio-button-group
645 :type (copy-of (gslist widget)))
647 :allocation :user-data
649 :accessor radio-button-value
650 :documentation "Value passed as argument to the activate callback")))
656 :getter "gtk_radio_menu_item_get_group"
657 :reader radio-menu-item-group
658 :type (copy-of (gslist widget)))
660 :allocation :user-data
662 :accessor radio-menu-item-value
663 :documentation "Value passed as argument to the activate callback")))
669 :getter "gtk_layout_get_bin_window"
670 :reader layout-bin-window
677 :getter "gtk_fixed_get_has_window"
678 :setter "gtk_fixed_set_has_window"
679 :reader fixed-has-window-p
687 :getter "gtk_range_get_value"
688 :setter "gtk_range_set_value"
690 :accessor range-value
695 :setter (setf range-upper)
700 :setter (setf range-lower)
704 :getter range-step-increment
705 :setter (setf range-step-increment)
706 :initarg :step-increment)
709 :getter range-page-increment
710 :setter (setf range-page-increment)
711 :initarg :page-increment)))
717 (pixel-size :merge t :unbound -1)))
723 :getter "gtk_label_get_layout"
725 :type pango:layout)))
731 :getter "gtk_scale_get_layout"
733 :type pango:layout)))
739 :getter "gtk_editable_get_editable"
740 :setter "gtk_editable_set_editable"
741 :reader editable-editable-p
746 :getter "gtk_editable_get_position"
747 :setter "gtk_editable_set_position"
748 :reader editable-position
753 :getter editable-text
754 :setter (setf editable-text)
761 :getter "gtk_file_chooser_get_filename"
762 :setter "gtk_file_chooser_set_filename"
763 :accessor file-chooser-filename
768 :setter "gtk_file_chooser_set_current_name"
769 :accessor file-chooser-current-name
770 :initarg :current-name
774 :setter "gtk_file_chooser_set_current_folder"
775 :setter "gtk_file_chooser_get_current_folder"
776 :accessor file-chooser-current-folder
777 :initarg :current-folder
781 :getter "gtk_file_chooser_get_uri"
782 :setter "gtk_file_chooser_set_uri"
783 :accessor file-chooser-uri
788 :setter "gtk_file_chooser_set_current_folder_uri"
789 :setter "gtk_file_chooser_get_current_folder_uri"
790 :accessor file-chooser-current-folder-uri
791 :initarg :current-folder-uri
798 :getter "gtk_file_filter_get_name"
799 :setter "gtk_file_filter_set_name"
800 :accessor file-filter-name
808 :getter "gtk_tree_view_get_columns"
809 :reader tree-view-columns
810 :type (glist tree-view-column))
813 :getter "gtk_tree_view_get_selection"
814 :reader tree-view-selection
815 :type tree-selection)))
821 :getter "gtk_tree_model_get_n_columns"
822 :reader tree-model-n-columns
829 :getter "gtk_tree_selection_get_mode"
830 :setter "gtk_tree_selection_set_mode"
831 :accessor tree-selection-mode
833 :type selection-mode)
836 :getter "gtk_tree_selection_get_mode"
837 :reader tree-selection-mode
844 :getter "gtk_combo_box_get_active_iter"
845 :setter "gtk_combo_box_set_active_iter"
846 :accessor combo-box-active-iter
853 :getter "gtk_text_buffer_get_line_count"
854 :reader text-buffer-line-count
858 :getter "gtk_text_buffer_get_char_count"
859 :reader text-buffer-char-count
863 :getter "gtk_text_buffer_get_modified"
864 :setter "gtk_text_buffer_set_modified"
865 :accessor text-buffer-modifed-p
872 :getter "gtk_text_view_get_default_attributes"
873 :reader text-view-default-attributes
874 :type text-attributes)))
880 :getter "gtk_text_tag_table_get_size"
881 :reader text-tag-table-size
888 :getter "gtk_text_tag_get_priority"
889 :setter "gtk_text_tag_set_priority"
890 :accessor text-tag-priority
893 :merge t :type pango:weight)))
899 :getter "gtk_text_mark_get_buffer"
900 :reader text-mark-buffer
904 :getter "gtk_text_mark_get_name"
905 :reader text-mark-name
909 :getter "gtk_text_mark_get_visible"
910 :setter "gtk_text_mark_set_visible"
911 :accessor text-mark-visible-p
915 :getter "gtk_text_mark_get_deleted"
916 :reader text-mark-deleted-p
920 :getter "gtk_text_mark_get_left_gravity"
921 :reader text-mark-left-gravity-p
929 :getter "gtk_ui_manager_get_action_groups"
930 :reader ui-manager-action-groups
931 :type (copy-of (glist action-group)))
934 :getter "gtk_ui_manager_get_accel_group"
935 :reader ui-manager-accel-group
938 ("GtkUIManagerItemType"
939 :type ui-manager-item-type)
944 :allocation :user-data :initarg :accelerator
945 :reader action-accelerator)))
951 :getter "gtk_toggle_action_get_active"
952 :setter "gtk_toggle_action_set_active"
954 :accessor toggle-action-active-p
961 :getter "gtk_radio_button_get_group"
962 :reader radio-action-group
963 :type (copy-of (gslist widget)))
965 :allocation :property :pname "value" :type int
966 :documentation "A hack so we can use the alien function gtk_radio_action_get_current_value to retrieve the active radio action in a group.")
968 :allocation :user-data :initarg :value :accessor radio-action-value)))
974 :getter "gtk_color_selection_get_previous_alpha"
975 :setter "gtk_color_selection_get_previous_alpha"
976 :initarg :previous-alpha
977 :accessor color-selection-previous-alpha
981 :getter "gtk_color_selection_get_previous_color"
982 :setter "gtk_color_selection_get_previous_color"
983 :initarg :previous-color
984 :accessor color-selection-previous-color
989 ; deprecated property
996 :getter "gtk_clipboard_get_display"
997 :reader clipboard-display
1003 ((text-column :merge t :setter %icon-view-set-text-column)
1004 (markup-column :merge t :setter %icon-view-set-markup-column)
1005 (pixbuf-column :merge t :setter %icon-view-set-pixbuf-column)))
1008 ("GtkFundamentalType" :ignore t)
1009 ("GtkArgFlags" :ignore t)
1012 ;; Deprecated widgets
1013 ("GtkCList" :ignore-prefix t)
1014 ("GtkCTree" :ignore-prefix t)
1015 ("GtkList" :ignore t)
1016 ("GtkListItem" :ignore t)
1017 ("GtkTree" :ignore t)
1018 ("GtkTreeItem" :ignore t)
1019 ("GtkItemFactory" :ignore t)
1020 ("GtkText" :ignore t)
1021 ("GtkPacker" :ignore-prefix t)
1022 ("GtkPixmap" :ignore t)
1023 ("GtkPreview" :ignore-prefix t)
1024 ("GtkProgres" :ignore t)
1025 ("GtkTipsQuery" :ignore t)
1026 ("GtkOldEditable" :ignore t)
1027 ("GtkCombo" :ignore t)
1028 ("GtkOptionMenu" :ignore t)
1029 ("GtkFileSelection" :ignore t)
1033 ("GtkFileSystemModule" :ignore t)
1034 ("GtkIMModule" :ignore t)
1035 ("GtkThemeEngine" :ignore t))
1038 (defclass text-iter (boxed)
1040 :allocation :virtual
1041 :getter "gtk_text_iter_get_buffer"
1042 :reader text-iter-buffer
1043 :type pointer) ;text-buffer)
1045 :allocation :virtual
1046 :getter "gtk_text_iter_get_offset"
1047 :setter "gtk_text_iter_set_offset"
1048 :accessor text-iter-offset
1051 :allocation :virtual
1052 :getter "gtk_text_iter_get_line"
1053 :setter "gtk_text_iter_set_line"
1054 :accessor text-iter-line
1057 :allocation :virtual
1058 :getter "gtk_text_iter_get_line_offset"
1059 :setter "gtk_text_iter_set_line_offset"
1060 :accessor text-iter-line-offset
1063 :allocation :virtual
1064 :getter "gtk_text_iter_get_line_index"
1065 :setter "gtk_text_iter_set_line_index"
1066 :accessor text-iter-line-index
1069 :allocation :virtual
1070 :getter "gtk_text_iter_get_visible_line_index"
1071 :setter "gtk_text_iter_set_visible_line_index"
1072 :accessor text-iter-visible-line-index
1074 (visible-line-offset
1075 :allocation :virtual
1076 :getter "gtk_text_iter_get_visible_line_offset"
1077 :setter "gtk_text_iter_set_visible_line_offset"
1078 :accessor text-iter-visible-line-offset
1080 ;; Workaround to get correct size
1082 :allocation :alien :offset #.(* 13 (size-of 'pointer))
1084 (:metaclass boxed-class
1085 ;; I am pretty sure this was working in older versons on CMUCL
1086 ; :size #.(* 14 (size-of 'pointer))
1090 (defclass tooltips-data (struct)
1093 :reader tooltips-data-tooltips
1097 :reader tooltips-data-widget
1101 :reader tooltips-data-tip-text
1105 :reader tooltips-data-tip-private
1107 (:metaclass struct-class))
1109 (defclass file-filter-info (struct)
1113 :type file-filter-flags)
1124 :initarg :display-name
1130 (:metaclass struct-class))
1133 (defclass accel-key (struct)
1139 :type gdk:modifier-type)
1142 :type (unsigned 16)))
1143 (:metaclass struct-class))
1145 (defclass accel-group-entry (struct)
1149 :type (inlined accel-key))
1156 (:metaclass struct-class))