1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 A multi-columned scrolling list widget.
7 <!-- ##### SECTION Long_Description ##### -->
9 The #GtkCList widget is a very useful multi-columned scrolling list. It can display
10 data in nicely aligned vertical columns, with titles at the top of the list.
13 <!-- ##### SECTION See_Also ##### -->
18 <!-- ##### STRUCT GtkCList ##### -->
20 This is the embodiment of the #GtkCList widget. This structure contains
21 only private data, and should be accessed only via the CList API.
25 <!-- ##### SIGNAL GtkCList::abort-column-resize ##### -->
27 This signal is emitted when a column resize is aborted.
30 @clist: the object which received the signal.
32 <!-- ##### SIGNAL GtkCList::click-column ##### -->
34 This signal is emitted when a column title is clicked.
37 @clist: The object which received the signal.
38 @column: The number of the column.
40 <!-- ##### SIGNAL GtkCList::end-selection ##### -->
42 This signal is emitted when a selection ends in a
43 multiple selection CList.
46 @clist: the object which received the signal.
48 <!-- ##### SIGNAL GtkCList::extend-selection ##### -->
50 This signal is emitted when the selection is extended.
53 @clist: the object which received the signal.
54 @scroll_type: A #GtkScrollType value of any scrolling operation the
55 occured during the selection.
56 @position: A value between 0.0 and 1.0.
57 @auto_start_selection: %TRUE or %FALSE.
59 <!-- ##### SIGNAL GtkCList::resize-column ##### -->
61 This signal is emitted when a column is resized.
64 @clist: The object which received the signal.
65 @column: The number of the column
66 @width: The new width of the column.
68 <!-- ##### SIGNAL GtkCList::row-move ##### -->
70 This signal is emitted when a row is moved.
73 @clist: The object which received the signal.
74 @arg1: The source position of the row.
75 @arg2: The destination position of the row.
77 <!-- ##### SIGNAL GtkCList::scroll-horizontal ##### -->
79 This signal is emitted when the CList is scrolled horizontally.
82 @clist: the object which received the signal.
83 @scroll_type: A #GtkScrollType value of how the scroll operation occured.
84 @position: a value between 0.0 and 1.0.
86 <!-- ##### SIGNAL GtkCList::scroll-vertical ##### -->
88 This signal is emitted when the CList is scrolled vertically.
91 @clist: the object which received the signal.
92 @scroll_type: A #GtkScrollType value of how the scroll operation occured.
93 @position: A value between 0.0 and 1.0.
95 <!-- ##### SIGNAL GtkCList::select-all ##### -->
97 This signal is emitted when all the rows are selected in a CList.
100 @clist: the object which received the signal.
102 <!-- ##### SIGNAL GtkCList::select-row ##### -->
104 This signal is emitted when the user selects a row in the list.
105 It is emitted for every row that is selected in a multi-selection or
106 by calling gtk_clist_select_all().
109 @clist: The object which received the signal.
110 @row: The row selected.
111 @column: The column where the selection occured.
112 @event: A #GdkEvent structure for the selection.
114 <!-- ##### SIGNAL GtkCList::set-scroll-adjustments ##### -->
119 @clist: the object which received the signal.
123 <!-- ##### SIGNAL GtkCList::start-selection ##### -->
125 This signal is emitted when a drag-selection is started in
126 a multiple-selection CList.
129 @clist: the object which received the signal.
131 <!-- ##### SIGNAL GtkCList::toggle-add-mode ##### -->
133 This signal is emitted when "add mode" is toggled.
136 @clist: the object which received the signal.
138 <!-- ##### SIGNAL GtkCList::toggle-focus-row ##### -->
143 @clist: The object which received the signal.
145 <!-- ##### SIGNAL GtkCList::undo-selection ##### -->
147 This signal is emitted when an undo selection occurs in the CList,
148 probably via calling gtk_clist_undo_selection().
151 @clist: the object which received the signal.
153 <!-- ##### SIGNAL GtkCList::unselect-all ##### -->
155 This signal is emitted when all rows are unselected in a CList.
158 @clist: the object which received the signal.
160 <!-- ##### SIGNAL GtkCList::unselect-row ##### -->
162 This signal is emitted when the user unselects a row in the list.
163 It is emitted for every row that is unselected in a multi-selection or
164 by calling gtk_clist_unselect_all(). It is also emitted for the
165 previously selected row in a "single" or "browse" mode CList.
168 @clist: The object which received the signal.
169 @row: The selected row
170 @column: The column where the selection occured.
173 <!-- ##### ARG GtkCList:n-columns ##### -->
175 An integer value for a column.
178 <!-- ##### ARG GtkCList:reorderable ##### -->
180 A boolean value for determining if the user can re-order the CList's
184 <!-- ##### ARG GtkCList:row-height ##### -->
186 An integer value representing the height of a row in pixels.
189 <!-- ##### ARG GtkCList:selection-mode ##### -->
191 Sets the type of selection mode for the CList.
194 <!-- ##### ARG GtkCList:shadow-type ##### -->
196 Sets the shadowing for the CList.
199 <!-- ##### ARG GtkCList:sort-type ##### -->
204 <!-- ##### ARG GtkCList:titles-active ##### -->
206 A boolean value for setting whether the column titles can be
210 <!-- ##### ARG GtkCList:use-drag-icons ##### -->
212 A boolean value for setting whether to use icons during drag
216 <!-- ##### ENUM GtkCellType ##### -->
218 Identifies the type of element in the current cell of the CList. Cells can
219 contain text, pixmaps, or both. Unfortunately support for %GTK_CELL_WIDGET
229 <!-- ##### ENUM GtkButtonAction ##### -->
231 Values for specifying what mouse button events a CList will
240 <!-- ##### MACRO GTK_CLIST_FLAGS ##### -->
242 Reads the current flags of the specified CList.
245 @clist: The #GtkCList widget from which to get the flags
248 <!-- ##### MACRO GTK_CLIST_SET_FLAG ##### -->
250 A macro to set a particular flag for the specified CList.
253 @clist: The #GtkCList widget to affect.
254 @flag: A single #GtkCList flag to set. NOTE: Do not add the GTK_ prefix.
257 <!-- ##### MACRO GTK_CLIST_UNSET_FLAG ##### -->
259 A macro to clear a particular flag for the specified CList.
262 @clist: The #GtkCList widget to affect.
263 @flag: A single #GtkCList flag to clear. NOTE: Do not add the GTK_ prefix.
266 <!-- ##### MACRO GTK_CLIST_IN_DRAG ##### -->
268 A macro to check whether the #GtkCList is in "drag mode."
271 @clist: The #GtkCList to check.
274 <!-- ##### MACRO GTK_CLIST_ROW_HEIGHT_SET ##### -->
276 A macro to check whether the #GtkCList's row height is set.
279 @clist: The #GtkCList to check.
282 <!-- ##### MACRO GTK_CLIST_SHOW_TITLES ##### -->
284 A macro to check whether the flag for showing the
285 widget's column titles is set.
288 @clist: The #GtkCList widget to check.
291 <!-- ##### MACRO GTK_CLIST_ADD_MODE ##### -->
293 A macro to test whether the CList is in "add mode."
296 @clist: The #GtkCList widget to check.
299 <!-- ##### MACRO GTK_CLIST_AUTO_SORT ##### -->
301 A macro to test whether the CList has automatic sorting
305 @clist: The #GtkCList widget to check.
308 <!-- ##### MACRO GTK_CLIST_AUTO_RESIZE_BLOCKED ##### -->
310 A macro to check if automatic resizing of columns is blocked.
313 @clist: The #GtkCList widget to check.
316 <!-- ##### MACRO GTK_CLIST_REORDERABLE ##### -->
318 A macro to test if the CList's columns are re-orderable
321 @clist: The #GtkCList widget to check.
324 <!-- ##### MACRO GTK_CLIST_USE_DRAG_ICONS ##### -->
326 A macro to check if the USE_DRAG_ICONS property is enabled.
329 @clist: The #GtkCList widget to check.
332 <!-- ##### MACRO GTK_CLIST_DRAW_DRAG_LINE ##### -->
334 A macro to check if the DRAW_DRAG_LINE property is enabled.
337 @clist: The #GtkCList widget to check.
340 <!-- ##### MACRO GTK_CLIST_DRAW_DRAG_RECT ##### -->
342 A macro to check if the DRAW_DRAG_RECT property is enabled.
345 @clist: The #GtkCList widget to check.
348 <!-- ##### MACRO GTK_CLIST_ROW ##### -->
350 A macro to cast a GList element to a CListRow pointer.
353 @_glist_: The GList element to convert.
356 <!-- ##### MACRO GTK_CELL_TEXT ##### -->
358 A macro to cast a generic #GtkCList cell item to a GtkCellText pointer.
361 @cell: The #GtkCList cell item to convert.
364 <!-- ##### MACRO GTK_CELL_PIXMAP ##### -->
366 A macro to cast a generic #GtkCList cell item to a GtkCellPixmap pointer.
369 @cell: The #GtkCList cell item to convert.
372 <!-- ##### MACRO GTK_CELL_PIXTEXT ##### -->
374 A macro to cast a generic #GtkCList cell item to a GtkCellPixText pointer.
377 @cell: The #GtkCList cell item to convert.
380 <!-- ##### MACRO GTK_CELL_WIDGET ##### -->
382 A macro to cast a generic #GtkCList cell item to a GtkCellWidget pointer.
385 @cell: The #GtkCList cell item to convert.
388 <!-- ##### USER_FUNCTION GtkCListCompareFunc ##### -->
390 Function prototype for the compare function callback.
393 @clist: The #GtkCList that is affected.
394 @ptr1: A #gconstpointer to the first node to compare.
395 @ptr2: A #gconstpointer to the second node to compare.
396 @Returns: 0 if the nodes are equal, less than 0 if the first node should
397 come before the second, and greater than 1 if the second come before the
401 <!-- ##### STRUCT GtkCListColumn ##### -->
403 A structure that the #GtkCList widget uses to keep track of information
421 <!-- ##### STRUCT GtkCListRow ##### -->
423 A structure that the #GtkCList widget uses to keep track of information
438 <!-- ##### STRUCT GtkCellText ##### -->
440 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
450 <!-- ##### STRUCT GtkCellPixmap ##### -->
452 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
453 that contain a GdkPixmap.
463 <!-- ##### STRUCT GtkCellPixText ##### -->
465 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
466 that contain a combination of text and a GdkPixmap.
478 <!-- ##### STRUCT GtkCellWidget ##### -->
480 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
481 that contain another widget.
490 <!-- ##### STRUCT GtkCell ##### -->
492 A generic structure that the #GtkCList widget uses to keep track of the
493 contents of each of its cells.
502 <!-- ##### STRUCT GtkCListCellInfo ##### -->
504 A simple structure that the #GtkCList widget uses to keep track
505 of the location of a cell.
511 <!-- ##### STRUCT GtkCListDestInfo ##### -->
513 A simple structure that the #GtkCList widget uses to track
514 a cell for a drag operation.
520 <!-- ##### ENUM GtkCListDragPos ##### -->
522 An enumeration for drag operations.
525 @GTK_CLIST_DRAG_NONE:
526 @GTK_CLIST_DRAG_BEFORE:
527 @GTK_CLIST_DRAG_INTO:
528 @GTK_CLIST_DRAG_AFTER:
530 <!-- ##### FUNCTION gtk_clist_new ##### -->
532 Creates a new #GtkCList widget for use.
535 @columns: The number of columns the #GtkCList should have.
536 @Returns: A pointer to a new GtkCList object.
539 <!-- ##### FUNCTION gtk_clist_new_with_titles ##### -->
541 Creates a new #GtkCList widget with column titles for use.
544 @columns: The number of columns the #GtkCList should have.
545 @titles: A string array of titles for the widget. There should be
546 enough strings in the array for the specified number of columns.
547 @Returns: A pointer to a new GtkCList object.
550 <!-- ##### FUNCTION gtk_clist_set_shadow_type ##### -->
552 Sets the shadow type for the specified CList. Changing this value
553 will cause the #GtkCList to update its visuals.
556 @clist: The #GtkCList to affect.
557 @type: The GtkShadowType desired.
560 <!-- ##### FUNCTION gtk_clist_set_selection_mode ##### -->
562 Sets the selection mode for the specified CList. This allows you to
563 set whether only one or more than one item can be selected at a time
564 in the widget. Note that setting the widget's selection mode to one
565 of GTK_SELECTION_BROWSE or GTK_SELECTION_SINGLE will cause all the
566 items in the #GtkCList to become deselected.
569 @clist: The #GtkCList to affect.
570 @mode: The GtkSelectionMode type to set for this CList.
573 <!-- ##### FUNCTION gtk_clist_freeze ##### -->
575 Causes the #GtkCList to stop updating its visuals until a matching call to
576 gtk_clist_thaw() is made. This function is useful if a lot of changes
577 will be made to the widget that may cause a lot of visual updating to
578 occur. Note that calls to gtk_clist_freeze() can be nested.
581 @clist: The #GtkCList to freeze.
584 <!-- ##### FUNCTION gtk_clist_thaw ##### -->
586 Causes the specified #GtkCList to allow visual updates.
589 @clist: The #GtkCList to thaw.
592 <!-- ##### FUNCTION gtk_clist_column_titles_show ##### -->
594 This function causes the #GtkCList to show its column titles, if
595 they are not already showing.
598 @clist: The #GtkCList to affect.
601 <!-- ##### FUNCTION gtk_clist_column_titles_hide ##### -->
603 Causes the #GtkCList to hide its column titles, if they are currently
607 @clist: The #GtkCList to affect.
610 <!-- ##### FUNCTION gtk_clist_column_title_active ##### -->
612 Sets the specified column in the #GtkCList to become selectable. You can
613 then respond to events from the user clicking on a title button, and take
617 @clist: The #GtkCList to affect.
618 @column: The column to make active, counting from 0.
621 <!-- ##### FUNCTION gtk_clist_column_title_passive ##### -->
623 Causes the specified column title button to become passive, i.e., does
624 not respond to events, such as the user clicking on it.
627 @clist: The #GtkCList to affect.
628 @column: The column to make passive, counting from 0.
631 <!-- ##### FUNCTION gtk_clist_column_titles_active ##### -->
633 Causes all column title buttons to become active. This is the same
634 as calling gtk_clist_column_title_active() for each column.
637 @clist: The #GtkCList to affect.
640 <!-- ##### FUNCTION gtk_clist_column_titles_passive ##### -->
642 Causes all column title buttons to become passive. This is the same
643 as calling gtk_clist_column_title_passive() for each column.
646 @clist: The #GtkCList to affect.
649 <!-- ##### FUNCTION gtk_clist_set_column_title ##### -->
651 Sets the title for the specified column.
654 @clist: The #GtkCList to affect.
655 @column: The column whose title should be changed.
656 @title: A string to be the column's title.
659 <!-- ##### FUNCTION gtk_clist_set_column_widget ##### -->
661 Sets a widget to be used as the specified column's title. This
662 can be used to place a pixmap or something else as the column
663 title, instead of the standard text.
666 @clist: The #GtkCList to affect.
667 @column: The column whose title should be a widget.
668 @widget: A pointer to a previously create widget.
671 <!-- ##### FUNCTION gtk_clist_set_column_justification ##### -->
673 Sets the justification to be used for all text in the specified
677 @clist: The #GtkCList to affect.
678 @column: The column which should be affected.
679 @justification: A GtkJustification value for the column.
682 <!-- ##### FUNCTION gtk_clist_set_column_visibility ##### -->
684 Allows you to set whether a specified column in the #GtkCList should
685 be hidden or shown. Note that at least one column must always be
686 showing, so attempting to hide the last visible column will be
690 @clist: The #GtkCList to affect.
691 @column: The column to set visibility.
692 @visible: %TRUE or %FALSE.
695 <!-- ##### FUNCTION gtk_clist_set_column_resizeable ##### -->
697 Lets you specify whether a specified column should be resizeable
698 by the user. Note that turning on resizeability for the column will
699 automatically shut off auto-resizing, but turning off resizeability
700 will NOT turn on auto-resizing. This must be done manually via a
701 call to gtk_clist_set_column_auto_resize().
704 @clist: The #GtkCList to affect.
705 @column: The column on which to set resizeability.
706 @resizeable: %TRUE or %FALSE.
709 <!-- ##### FUNCTION gtk_clist_set_column_auto_resize ##### -->
711 Lets you specify whether a column should be automatically resized
712 by the widget when data is added or removed. Enabling auto-resize
713 on a column explicity disallows user-resizing of the column.
716 @clist: The #GtkCList to affect.
717 @column: The column on which to set auto-resizing.
718 @auto_resize: %TRUE or %FALSE.
721 <!-- ##### FUNCTION gtk_clist_optimal_column_width ##### -->
723 Gets the required width in pixels that is needed to show
724 everything in the specified column.
727 @clist: The #GtkCList to check.
728 @column: The column to check.
729 @Returns: The required width in pixels for the column.
732 <!-- ##### FUNCTION gtk_clist_set_column_width ##### -->
734 Causes the column specified for the #GtkCList to be set to
738 @clist: The #GtkCList to affect.
739 @column: The column to set the width.
740 @width: The width, in pixels.
743 <!-- ##### FUNCTION gtk_clist_set_column_min_width ##### -->
745 Causes the column specified to have a minimum width, preventing
746 the user from resizing it smaller than that specified.
749 @clist: The #GtkCList to affect.
750 @column: The column to set the minimum width.
751 @min_width: The width, in pixels.
754 <!-- ##### FUNCTION gtk_clist_set_column_max_width ##### -->
756 Causes the column specified to have a maximum width, preventing
757 the user from resizing it larger than that specified.
760 @clist: The #GtkCList to affect.
761 @column: The column to set the maximum width.
762 @max_width: The width, in pixels.
765 <!-- ##### FUNCTION gtk_clist_set_row_height ##### -->
767 Causes the #GtkCList to have a specified height for its
768 rows. Setting the row height to 0 allows the #GtkCList to adjust
769 automatically to data in the row.
772 @clist: The #GtkCList to affect.
773 @height: The height, in pixels.
776 <!-- ##### FUNCTION gtk_clist_moveto ##### -->
778 Tells the CList widget to visually move to the specified
782 @clist: The #GtkCList to affect.
783 @row: The row to which to move.
784 @column: The column to which to move.
785 @row_align: A value between 0 and 1 that describes the positioning of
786 the row in relation to the viewable area of the CList's contents.
787 @col_align: A value between 0 and 1 that describes the positioning of
788 the column in relation to the viewable area of the CList's contents.
791 <!-- ##### FUNCTION gtk_clist_row_is_visible ##### -->
793 Checks how the specified row is visible.
796 @clist: The #GtkCList to affect.
797 @row: The row to query.
798 @Returns: A #GtkVisibility value that tells you how the row is visible.
801 <!-- ##### FUNCTION gtk_clist_get_cell_type ##### -->
803 Checks the type of cell at the location specified.
806 @clist: The #GtkCList to affect.
807 @row: The row of the cell.
808 @column: The column of the cell.
809 @Returns: A #GtkCellType value describing the cell.
812 <!-- ##### FUNCTION gtk_clist_set_text ##### -->
814 Sets the displayed text in the specified cell.
817 @clist: The #GtkCList to affect.
818 @row: The row of the cell.
819 @column: The column of the cell.
820 @text: The text to set in the cell.
823 <!-- ##### FUNCTION gtk_clist_get_text ##### -->
825 Gets the text for the specified cell.
828 @clist: The #GtkCList to affect.
829 @row: The row to query.
830 @column: The column to query.
831 @text: A pointer to a pointer to store the text.
832 @Returns: 1 if the cell's text could be retrieved, 0 otherwise.
835 <!-- ##### FUNCTION gtk_clist_set_pixmap ##### -->
837 Sets a pixmap for the specified cell.
840 @clist: The #GtkCList to affect.
841 @row: The row of the cell.
842 @column: The column of the cell.
843 @pixmap: A pointer to a #GdkPixmap to place in the cell.
844 @mask: A pointer to a #GdkBitmap mask for the cell.
847 <!-- ##### FUNCTION gtk_clist_get_pixmap ##### -->
849 Gets the pixmap and bitmap mask of the specified cell. The returned mask value can be NULL.
852 @clist: The #GtkCList to affect.
853 @row: The row of the cell.
854 @column: The column of the cell.
855 @pixmap: A pointer to a pointer to store the cell's #GdkPixmap.
856 @mask: A pointer to a pointer to store the cell's #GdkBitmap mask.
857 @Returns: 1 if the cell's pixmap could be retrieved, 0 otherwise.
860 <!-- ##### FUNCTION gtk_clist_set_pixtext ##### -->
862 Sets text and a pixmap/bitmap on the specified cell.
865 @clist: The #GtkCList to affect.
866 @row: The row of the cell.
867 @column: The column of the cell.
868 @text: The text to set in the cell.
869 @spacing: The spacing between the cell's text and pixmap.
870 @pixmap: A pointer to a #GdkPixmap for the cell.
871 @mask: A pointer to a #GdkBitmap mask for the cell.
874 <!-- ##### FUNCTION gtk_clist_get_pixtext ##### -->
876 Gets the text, pixmap and bitmap mask for the specified cell.
879 @clist: The #GtkCList to affect.
880 @row: The row to query.
881 @column: The column to query.
882 @text: A pointer to a pointer to store the text.
883 @spacing: A pointer to a #guint8 to store the spacing.
884 @pixmap: A pointer to a #GdkPixmap pointer to store the cell's pixmap.
885 @mask: A pointer to a #GdkBitmap pointer to store the cell's bitmap mask.
886 @Returns: 1 if the retrieval was successful, 0 otherwise.
889 <!-- ##### FUNCTION gtk_clist_set_foreground ##### -->
891 Sets the foreground color for the specified row.
894 @clist: The #GtkCList to affect.
895 @row: The row to affect.
896 @color: A pointer to a #GdkColor structure.
899 <!-- ##### FUNCTION gtk_clist_set_background ##### -->
901 Sets the background color for the specified row.
904 @clist: The #GtkCList to affect.
905 @row: The row to affect.
906 @color: A pointer to a #GdkColor structure.
909 <!-- ##### FUNCTION gtk_clist_set_cell_style ##### -->
911 Sets the style for the specified cell.
914 @clist: The #GtkCList to affect.
915 @row: The row of the cell.
916 @column: The column of the cell.
917 @style: A pointer to a #GtkStyle structure.
920 <!-- ##### FUNCTION gtk_clist_get_cell_style ##### -->
922 Gets the current style of the specified cell.
925 @clist: The #GtkCList to affect.
926 @row: The row of the cell.
927 @column: The column of the cell.
928 @Returns: A #GtkStyle object.
931 <!-- ##### FUNCTION gtk_clist_set_row_style ##### -->
933 Sets the style for all cells in the specified row.
936 @clist: The #GtkCList to affect.
937 @row: The row to affect.
938 @style: A pointer to a #GtkStyle to set.
941 <!-- ##### FUNCTION gtk_clist_get_row_style ##### -->
943 Gets the style set for the specified row.
946 @clist: The #GtkCList to affect.
947 @row: The row to query.
948 @Returns: The #GtkStyle of the row.
951 <!-- ##### FUNCTION gtk_clist_set_shift ##### -->
953 Sets the vertical and horizontal shift of the specified cell.
956 @clist: The #GtkCList to affect.
957 @row: The row of the cell.
958 @column: The column of the cell.
959 @vertical: The value to set for the vertical shift.
960 @horizontal: The value to set for the vertical shift.
963 <!-- ##### FUNCTION gtk_clist_set_selectable ##### -->
965 Sets whether the specified row is selectable or not.
968 @clist: The #GtkCList to affect.
969 @row: The row to affect.
970 @selectable: %TRUE or %FALSE.
973 <!-- ##### FUNCTION gtk_clist_get_selectable ##### -->
975 Gets whether the specified row is selectable or not.
978 @clist: The #GtkCList to affect.
979 @row: The row to query.
980 @Returns: A #gboolean value.
983 <!-- ##### FUNCTION gtk_clist_prepend ##### -->
985 Adds a row to the CList at the top.
988 @clist: The #GtkCList to affect.
989 @text: An array of strings to add.
990 @Returns: The number of the row added.
993 <!-- ##### FUNCTION gtk_clist_append ##### -->
995 Adds a row to the CList at the bottom.
998 @clist: The #GtkCList to affect.
999 @text: An array of strings to add.
1000 @Returns: The number of the row added.
1003 <!-- ##### FUNCTION gtk_clist_insert ##### -->
1005 Adds a row of text to the CList at the specified position.
1008 @clist: The #GtkCList to affect.
1009 @row: The row where the text should be inserted.
1010 @text: An array of string to add.
1011 @Returns: The number of the row added.
1014 <!-- ##### FUNCTION gtk_clist_remove ##### -->
1016 Removes the specified row from the CList.
1019 @clist: The #GtkCList to affect.
1020 @row: The row to remove.
1023 <!-- ##### FUNCTION gtk_clist_set_row_data ##### -->
1025 Sets data for the specified row. This is the same as calling gtk_clist_set_row_data_full(clist, row, data, NULL).
1028 @clist: The #GtkCList to affect.
1029 @row: The row to affect.
1030 @data: The data to set for the row.
1033 <!-- ##### FUNCTION gtk_clist_set_row_data_full ##### -->
1035 Sets the data for specified row, with a callback when the row is destroyed.
1038 @clist: The #GtkCList to affect.
1039 @row: The row to affect.
1040 @data: The data to set for the row.
1041 @destroy: A #GtkDestroyNotify function to be called when the row is destroyed.
1044 <!-- ##### FUNCTION gtk_clist_get_row_data ##### -->
1046 Gets the currently set data for the specified row.
1049 @clist: The #GtkCList to affect.
1050 @row: The row to query.
1051 @Returns: The data set for the row.
1054 <!-- ##### FUNCTION gtk_clist_find_row_from_data ##### -->
1056 Searches the CList for the row with the specified data.
1059 @clist: The #GtkCList to search.
1060 @data: The data to search for a match.
1061 @Returns: The number of the matching row, or -1 if no match could be found.
1064 <!-- ##### FUNCTION gtk_clist_select_row ##### -->
1066 Selects the specified row. Causes the "select-row" signal to be emitted for the specified row and column.
1069 @clist: The #GtkCList to affect.
1070 @row: The row to select.
1071 @column: The column to select.
1074 <!-- ##### FUNCTION gtk_clist_unselect_row ##### -->
1076 Unselects the specified row. Causes the "unselect-row" signal to be emitted for the specified row and column.
1079 @clist: The #GtkCList to affect.
1080 @row: The row to select.
1081 @column: The column to select.
1084 <!-- ##### FUNCTION gtk_clist_undo_selection ##### -->
1086 Undoes the last selection for an "extended selection mode" CList.
1089 @clist: The #GtkCList to affect.
1092 <!-- ##### FUNCTION gtk_clist_clear ##### -->
1094 Removes all the CList's rows.
1097 @clist: The #GtkCList to affect.
1100 <!-- ##### FUNCTION gtk_clist_get_selection_info ##### -->
1102 Gets the row and column at the specified pixel position in the CList.
1105 @clist: The #GtkCList to affect.
1106 @x: The horizontal pixel position to check.
1107 @y: The vertical pixel position to check..
1108 @row: Pointer to a #gint to store the row value.
1109 @column: Pointer to a #gint to store the column value.
1110 @Returns: 1 if row/column is returned and in range, 0 otherwise.
1113 <!-- ##### FUNCTION gtk_clist_select_all ##### -->
1115 Selects all rows in the CList. This function has no affect for a
1116 CList in "single" or "browse" selection mode.
1119 @clist: The #GtkCList to affect.
1122 <!-- ##### FUNCTION gtk_clist_unselect_all ##### -->
1124 Unselects all rows in the CList.
1127 @clist: The #GtkCList to affect.
1130 <!-- ##### FUNCTION gtk_clist_swap_rows ##### -->
1132 Swaps the two specified rows with each other.
1135 @clist: The #GtkCList to affect.
1136 @row1: Number of the first row.
1137 @row2: Number of the second row.
1140 <!-- ##### FUNCTION gtk_clist_set_compare_func ##### -->
1142 Sets the compare function of the #GtkClist to @cmp_func. If @cmp_func is NULL,
1143 then the default compare function is used. The default compare function sorts
1144 ascending or with the type set by gtk_clist_set_sort_type() by the column set
1145 by gtk_clist_set_sort_column().
1148 @clist: The #GtkCList to affect.
1149 @cmp_func: The #GtkCompareFunction to use.
1152 <!-- ##### FUNCTION gtk_clist_set_sort_column ##### -->
1154 Sets the sort column of the clist. The sort column is used by the
1155 default compare function to determine which column to sort by.
1158 @clist: The #GtkCList to affect.
1159 @column: The column to sort by
1162 <!-- ##### FUNCTION gtk_clist_set_sort_type ##### -->
1164 Sets the sort type of the #GtkClist. This is either GTK_SORT_ASCENDING for
1165 ascening sort or GTK_SORT_DESCENDING for descending sort.
1168 @clist: The #GtkCList to affect.
1169 @sort_type: the #GtkSortType to use
1172 <!-- ##### FUNCTION gtk_clist_sort ##### -->
1174 Sorts the #GtkClist according to the current compare function, which
1175 can be set with the gtk_clist_set_compare_func() function.
1178 @clist: The #GtkCList to sort.
1181 <!-- ##### FUNCTION gtk_clist_set_auto_sort ##### -->
1183 Turns on or off auto sort of the #GtkCList. If auto sort is on, then the CList will be resorted when a row is inserted into the CList.
1186 @clist: The #GtkCList to affect.
1187 @auto_sort: whether auto sort should be on or off
1190 <!-- ##### FUNCTION gtk_clist_columns_autosize ##### -->
1192 Auto-sizes all columns in the CList and returns the total width of the CList.
1195 @clist: The #GtkCList to affect.
1196 @Returns: The total width of the CList.
1199 <!-- ##### FUNCTION gtk_clist_get_column_title ##### -->
1201 Gets the current title of the specified column
1204 @clist: The #GtkCList to affect.
1205 @column: The column to query.
1206 @Returns: The title of the column.
1209 <!-- ##### FUNCTION gtk_clist_get_column_widget ##### -->
1211 Gets the widget in the column header for the specified column.
1214 @clist: The #GtkCList to affect.
1215 @column: The column to query.
1216 @Returns: Pointer to a #GtkWidget for the column header.
1219 <!-- ##### FUNCTION gtk_clist_get_hadjustment ##### -->
1221 Gets the #GtkAdjustment currently being used for the horizontal
1225 @clist: The #GtkCList to check.
1226 @Returns: A #GtkAdjustment object, or NULL if none is currently
1230 <!-- ##### FUNCTION gtk_clist_get_vadjustment ##### -->
1232 Gets the #GtkAdjustment currently being used for the vertical
1236 @clist: The #GtkCList to check.
1237 @Returns: A #GtkAdjustment object, or NULL if none is currently
1241 <!-- ##### FUNCTION gtk_clist_row_move ##### -->
1243 Allows you to move a row from one position to another in the
1247 @clist: The #GtkCList to affect.
1248 @source_row: The original position of the row to move.
1249 @dest_row: The position to which the row should be moved.
1252 <!-- ##### FUNCTION gtk_clist_set_button_actions ##### -->
1254 Sets the action(s) that the specified mouse button will have
1258 @clist: The #GtkCList to affect.
1259 @button: The mouse button to set. The values here, unlike in the
1260 rest of GTK+ start from 0. For instance, the right mouse
1261 button, which is 3 elsewhere, should be given as 2 here.
1262 @button_actions: A logically OR'd value of #GtkButtonAction values
1266 <!-- ##### FUNCTION gtk_clist_set_hadjustment ##### -->
1268 Allows you to set the #GtkAdjustment to be used for the horizontal
1269 aspect of the #GtkCList widget.
1272 @clist: The #GtkCList to affect.
1273 @adjustment: A pointer to a #GtkAdjustment widget, or NULL.
1276 <!-- ##### FUNCTION gtk_clist_set_reorderable ##### -->
1278 Sets whether the CList's rows are re-orderable using drag-and-drop.
1281 @clist: The #GtkCList to affect.
1282 @reorderable: %TRUE or %FALSE.
1285 <!-- ##### FUNCTION gtk_clist_set_use_drag_icons ##### -->
1287 Determines whether the #GtkClist should use icons when
1288 doing drag-and-drop operations.
1291 @clist: The #GtkCList to affect.
1292 @use_icons: %TRUE or %FALSE.
1295 <!-- ##### FUNCTION gtk_clist_set_vadjustment ##### -->
1297 Allows you to set the #GtkAdjustment to be used for the vertical
1298 aspect of the #GtkCList widget.
1301 @clist: The #GtkCList to affect.
1302 @adjustment: A pointer to a #GtkAdjustment widget, or NULL.