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.
10 It can display data in nicely aligned vertical columns, with titles
11 at the top of the list.
14 GtkCList has been deprecated since GTK+ 2.0 and should not be used
15 in newly written code. Use #GtkTreeView instead.
18 <!-- ##### SECTION See_Also ##### -->
23 <!-- ##### SECTION Stability_Level ##### -->
26 <!-- ##### STRUCT GtkCList ##### -->
28 This is the embodiment of the #GtkCList widget. This structure contains
29 only private data, and should be accessed only via the CList API.
33 <!-- ##### SIGNAL GtkCList::abort-column-resize ##### -->
35 This signal is emitted when a column resize is aborted.
38 @clist: the object which received the signal.
40 <!-- ##### SIGNAL GtkCList::click-column ##### -->
42 This signal is emitted when a column title is clicked.
45 @clist: The object which received the signal.
46 @column: The number of the column.
48 <!-- ##### SIGNAL GtkCList::end-selection ##### -->
50 This signal is emitted when a selection ends in a
51 multiple selection CList.
54 @clist: the object which received the signal.
56 <!-- ##### SIGNAL GtkCList::extend-selection ##### -->
58 This signal is emitted when the selection is extended.
61 @clist: the object which received the signal.
62 @scroll_type: A #GtkScrollType value of any scrolling operation the
63 occured during the selection.
64 @position: A value between 0.0 and 1.0.
65 @auto_start_selection: %TRUE or %FALSE.
67 <!-- ##### SIGNAL GtkCList::resize-column ##### -->
69 This signal is emitted when a column is resized.
72 @clist: The object which received the signal.
73 @column: The number of the column
74 @width: The new width of the column.
76 <!-- ##### SIGNAL GtkCList::row-move ##### -->
78 This signal is emitted when a row is moved.
81 @clist: The object which received the signal.
82 @arg1: The source position of the row.
83 @arg2: The destination position of the row.
85 <!-- ##### SIGNAL GtkCList::scroll-horizontal ##### -->
87 This signal is emitted when the CList is scrolled horizontally.
90 @clist: the object which received the signal.
91 @scroll_type: A #GtkScrollType value of how the scroll operation occured.
92 @position: a value between 0.0 and 1.0.
94 <!-- ##### SIGNAL GtkCList::scroll-vertical ##### -->
96 This signal is emitted when the CList is scrolled vertically.
99 @clist: the object which received the signal.
100 @scroll_type: A #GtkScrollType value of how the scroll operation occured.
101 @position: A value between 0.0 and 1.0.
103 <!-- ##### SIGNAL GtkCList::select-all ##### -->
105 This signal is emitted when all the rows are selected in a CList.
108 @clist: the object which received the signal.
110 <!-- ##### SIGNAL GtkCList::select-row ##### -->
112 This signal is emitted when the user selects a row in the list.
113 It is emitted for every row that is selected in a multi-selection or
114 by calling gtk_clist_select_all().
117 @clist: The object which received the signal.
118 @row: The row selected.
119 @column: The column where the selection occured.
120 @event: A #GdkEvent structure for the selection.
122 <!-- ##### SIGNAL GtkCList::set-scroll-adjustments ##### -->
127 @clist: the object which received the signal.
131 <!-- ##### SIGNAL GtkCList::start-selection ##### -->
133 This signal is emitted when a drag-selection is started in
134 a multiple-selection CList.
137 @clist: the object which received the signal.
139 <!-- ##### SIGNAL GtkCList::toggle-add-mode ##### -->
141 This signal is emitted when "add mode" is toggled.
144 @clist: the object which received the signal.
146 <!-- ##### SIGNAL GtkCList::toggle-focus-row ##### -->
151 @clist: The object which received the signal.
153 <!-- ##### SIGNAL GtkCList::undo-selection ##### -->
155 This signal is emitted when an undo selection occurs in the CList,
156 probably via calling gtk_clist_undo_selection().
159 @clist: the object which received the signal.
161 <!-- ##### SIGNAL GtkCList::unselect-all ##### -->
163 This signal is emitted when all rows are unselected in a CList.
166 @clist: the object which received the signal.
168 <!-- ##### SIGNAL GtkCList::unselect-row ##### -->
170 This signal is emitted when the user unselects a row in the list.
171 It is emitted for every row that is unselected in a multi-selection or
172 by calling gtk_clist_unselect_all(). It is also emitted for the
173 previously selected row in a "single" or "browse" mode CList.
176 @clist: The object which received the signal.
177 @row: The selected row
178 @column: The column where the selection occured.
181 <!-- ##### ARG GtkCList:n-columns ##### -->
183 An integer value for a column.
186 <!-- ##### ARG GtkCList:reorderable ##### -->
188 A boolean value for determining if the user can re-order the CList's
192 <!-- ##### ARG GtkCList:row-height ##### -->
194 An integer value representing the height of a row in pixels.
197 <!-- ##### ARG GtkCList:selection-mode ##### -->
199 Sets the type of selection mode for the CList.
202 <!-- ##### ARG GtkCList:shadow-type ##### -->
204 Sets the shadowing for the CList.
207 <!-- ##### ARG GtkCList:sort-type ##### -->
212 <!-- ##### ARG GtkCList:titles-active ##### -->
214 A boolean value for setting whether the column titles can be
218 <!-- ##### ARG GtkCList:use-drag-icons ##### -->
220 A boolean value for setting whether to use icons during drag
224 <!-- ##### ENUM GtkCellType ##### -->
226 Identifies the type of element in the current cell of the CList. Cells can
227 contain text, pixmaps, or both. Unfortunately support for %GTK_CELL_WIDGET
237 <!-- ##### ENUM GtkButtonAction ##### -->
239 Values for specifying what mouse button events a CList will
248 <!-- ##### MACRO GTK_CLIST_FLAGS ##### -->
250 Reads the current flags of the specified CList.
253 @clist: The #GtkCList widget from which to get the flags
256 <!-- ##### MACRO GTK_CLIST_SET_FLAG ##### -->
258 A macro to set a particular flag for the specified CList.
261 @clist: The #GtkCList widget to affect.
262 @flag: A single #GtkCList flag to set. NOTE: Do not add the GTK_ prefix.
265 <!-- ##### MACRO GTK_CLIST_UNSET_FLAG ##### -->
267 A macro to clear a particular flag for the specified CList.
270 @clist: The #GtkCList widget to affect.
271 @flag: A single #GtkCList flag to clear. NOTE: Do not add the GTK_ prefix.
274 <!-- ##### MACRO GTK_CLIST_IN_DRAG ##### -->
276 A macro to check whether the #GtkCList is in "drag mode."
279 @clist: The #GtkCList to check.
282 <!-- ##### MACRO GTK_CLIST_ROW_HEIGHT_SET ##### -->
284 A macro to check whether the #GtkCList's row height is set.
287 @clist: The #GtkCList to check.
290 <!-- ##### MACRO GTK_CLIST_SHOW_TITLES ##### -->
292 A macro to check whether the flag for showing the
293 widget's column titles is set.
296 @clist: The #GtkCList widget to check.
299 <!-- ##### MACRO GTK_CLIST_ADD_MODE ##### -->
301 A macro to test whether the CList is in "add mode."
304 @clist: The #GtkCList widget to check.
307 <!-- ##### MACRO GTK_CLIST_AUTO_SORT ##### -->
309 A macro to test whether the CList has automatic sorting
313 @clist: The #GtkCList widget to check.
316 <!-- ##### MACRO GTK_CLIST_AUTO_RESIZE_BLOCKED ##### -->
318 A macro to check if automatic resizing of columns is blocked.
321 @clist: The #GtkCList widget to check.
324 <!-- ##### MACRO GTK_CLIST_REORDERABLE ##### -->
326 A macro to test if the CList's columns are re-orderable
329 @clist: The #GtkCList widget to check.
332 <!-- ##### MACRO GTK_CLIST_USE_DRAG_ICONS ##### -->
334 A macro to check if the USE_DRAG_ICONS property is enabled.
337 @clist: The #GtkCList widget to check.
340 <!-- ##### MACRO GTK_CLIST_DRAW_DRAG_LINE ##### -->
342 A macro to check if the DRAW_DRAG_LINE property is enabled.
345 @clist: The #GtkCList widget to check.
348 <!-- ##### MACRO GTK_CLIST_DRAW_DRAG_RECT ##### -->
350 A macro to check if the DRAW_DRAG_RECT property is enabled.
353 @clist: The #GtkCList widget to check.
356 <!-- ##### MACRO GTK_CLIST_ROW ##### -->
358 A macro to cast a GList element to a CListRow pointer.
361 @_glist_: The GList element to convert.
364 <!-- ##### MACRO GTK_CELL_TEXT ##### -->
366 A macro to cast a generic #GtkCList cell item to a GtkCellText pointer.
369 @cell: The #GtkCList cell item to convert.
372 <!-- ##### MACRO GTK_CELL_PIXMAP ##### -->
374 A macro to cast a generic #GtkCList cell item to a GtkCellPixmap pointer.
377 @cell: The #GtkCList cell item to convert.
380 <!-- ##### MACRO GTK_CELL_PIXTEXT ##### -->
382 A macro to cast a generic #GtkCList cell item to a GtkCellPixText pointer.
385 @cell: The #GtkCList cell item to convert.
388 <!-- ##### MACRO GTK_CELL_WIDGET ##### -->
390 A macro to cast a generic #GtkCList cell item to a GtkCellWidget pointer.
393 @cell: The #GtkCList cell item to convert.
396 <!-- ##### USER_FUNCTION GtkCListCompareFunc ##### -->
398 Function prototype for the compare function callback.
401 @clist: The #GtkCList that is affected.
402 @ptr1: A #gconstpointer to the first node to compare.
403 @ptr2: A #gconstpointer to the second node to compare.
404 @Returns: 0 if the nodes are equal, less than 0 if the first node should
405 come before the second, and greater than 1 if the second come before the
409 <!-- ##### STRUCT GtkCListColumn ##### -->
411 A structure that the #GtkCList widget uses to keep track of information
429 <!-- ##### STRUCT GtkCListRow ##### -->
431 A structure that the #GtkCList widget uses to keep track of information
446 <!-- ##### STRUCT GtkCellText ##### -->
448 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
458 <!-- ##### STRUCT GtkCellPixmap ##### -->
460 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
461 that contain a GdkPixmap.
471 <!-- ##### STRUCT GtkCellPixText ##### -->
473 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
474 that contain a combination of text and a GdkPixmap.
486 <!-- ##### STRUCT GtkCellWidget ##### -->
488 A structure that the #GtkCList widget uses to keep track of #GtkCList cells
489 that contain another widget.
498 <!-- ##### STRUCT GtkCell ##### -->
500 A generic structure that the #GtkCList widget uses to keep track of the
501 contents of each of its cells.
510 <!-- ##### STRUCT GtkCListCellInfo ##### -->
512 A simple structure that the #GtkCList widget uses to keep track
513 of the location of a cell.
519 <!-- ##### STRUCT GtkCListDestInfo ##### -->
521 A simple structure that the #GtkCList widget uses to track
522 a cell for a drag operation.
528 <!-- ##### ENUM GtkCListDragPos ##### -->
530 An enumeration for drag operations.
533 @GTK_CLIST_DRAG_NONE:
534 @GTK_CLIST_DRAG_BEFORE:
535 @GTK_CLIST_DRAG_INTO:
536 @GTK_CLIST_DRAG_AFTER:
538 <!-- ##### FUNCTION gtk_clist_new ##### -->
540 Creates a new #GtkCList widget for use.
543 @columns: The number of columns the #GtkCList should have.
544 @Returns: A pointer to a new GtkCList object.
547 <!-- ##### FUNCTION gtk_clist_new_with_titles ##### -->
549 Creates a new #GtkCList widget with column titles for use.
552 @columns: The number of columns the #GtkCList should have.
553 @titles: A string array of titles for the widget. There should be
554 enough strings in the array for the specified number of columns.
555 @Returns: A pointer to a new GtkCList object.
558 <!-- ##### FUNCTION gtk_clist_set_shadow_type ##### -->
560 Sets the shadow type for the specified CList. Changing this value
561 will cause the #GtkCList to update its visuals.
564 @clist: The #GtkCList to affect.
565 @type: The GtkShadowType desired.
568 <!-- ##### FUNCTION gtk_clist_set_selection_mode ##### -->
570 Sets the selection mode for the specified CList. This allows you to
571 set whether only one or more than one item can be selected at a time
572 in the widget. Note that setting the widget's selection mode to one
573 of GTK_SELECTION_BROWSE or GTK_SELECTION_SINGLE will cause all the
574 items in the #GtkCList to become deselected.
577 @clist: The #GtkCList to affect.
578 @mode: The GtkSelectionMode type to set for this CList.
581 <!-- ##### FUNCTION gtk_clist_freeze ##### -->
583 Causes the #GtkCList to stop updating its visuals until a matching call to
584 gtk_clist_thaw() is made. This function is useful if a lot of changes
585 will be made to the widget that may cause a lot of visual updating to
586 occur. Note that calls to gtk_clist_freeze() can be nested.
589 @clist: The #GtkCList to freeze.
592 <!-- ##### FUNCTION gtk_clist_thaw ##### -->
594 Causes the specified #GtkCList to allow visual updates.
597 @clist: The #GtkCList to thaw.
600 <!-- ##### FUNCTION gtk_clist_column_titles_show ##### -->
602 This function causes the #GtkCList to show its column titles, if
603 they are not already showing.
606 @clist: The #GtkCList to affect.
609 <!-- ##### FUNCTION gtk_clist_column_titles_hide ##### -->
611 Causes the #GtkCList to hide its column titles, if they are currently
615 @clist: The #GtkCList to affect.
618 <!-- ##### FUNCTION gtk_clist_column_title_active ##### -->
620 Sets the specified column in the #GtkCList to become selectable. You can
621 then respond to events from the user clicking on a title button, and take
625 @clist: The #GtkCList to affect.
626 @column: The column to make active, counting from 0.
629 <!-- ##### FUNCTION gtk_clist_column_title_passive ##### -->
631 Causes the specified column title button to become passive, i.e., does
632 not respond to events, such as the user clicking on it.
635 @clist: The #GtkCList to affect.
636 @column: The column to make passive, counting from 0.
639 <!-- ##### FUNCTION gtk_clist_column_titles_active ##### -->
641 Causes all column title buttons to become active. This is the same
642 as calling gtk_clist_column_title_active() for each column.
645 @clist: The #GtkCList to affect.
648 <!-- ##### FUNCTION gtk_clist_column_titles_passive ##### -->
650 Causes all column title buttons to become passive. This is the same
651 as calling gtk_clist_column_title_passive() for each column.
654 @clist: The #GtkCList to affect.
657 <!-- ##### FUNCTION gtk_clist_set_column_title ##### -->
659 Sets the title for the specified column.
662 @clist: The #GtkCList to affect.
663 @column: The column whose title should be changed.
664 @title: A string to be the column's title.
667 <!-- ##### FUNCTION gtk_clist_set_column_widget ##### -->
669 Sets a widget to be used as the specified column's title. This
670 can be used to place a pixmap or something else as the column
671 title, instead of the standard text.
674 @clist: The #GtkCList to affect.
675 @column: The column whose title should be a widget.
676 @widget: A pointer to a previously create widget.
679 <!-- ##### FUNCTION gtk_clist_set_column_justification ##### -->
681 Sets the justification to be used for all text in the specified
685 @clist: The #GtkCList to affect.
686 @column: The column which should be affected.
687 @justification: A GtkJustification value for the column.
690 <!-- ##### FUNCTION gtk_clist_set_column_visibility ##### -->
692 Allows you to set whether a specified column in the #GtkCList should
693 be hidden or shown. Note that at least one column must always be
694 showing, so attempting to hide the last visible column will be
698 @clist: The #GtkCList to affect.
699 @column: The column to set visibility.
700 @visible: %TRUE or %FALSE.
703 <!-- ##### FUNCTION gtk_clist_set_column_resizeable ##### -->
705 Lets you specify whether a specified column should be resizeable
706 by the user. Note that turning on resizeability for the column will
707 automatically shut off auto-resizing, but turning off resizeability
708 will NOT turn on auto-resizing. This must be done manually via a
709 call to gtk_clist_set_column_auto_resize().
712 @clist: The #GtkCList to affect.
713 @column: The column on which to set resizeability.
714 @resizeable: %TRUE or %FALSE.
717 <!-- ##### FUNCTION gtk_clist_set_column_auto_resize ##### -->
719 Lets you specify whether a column should be automatically resized
720 by the widget when data is added or removed. Enabling auto-resize
721 on a column explicity disallows user-resizing of the column.
724 @clist: The #GtkCList to affect.
725 @column: The column on which to set auto-resizing.
726 @auto_resize: %TRUE or %FALSE.
729 <!-- ##### FUNCTION gtk_clist_optimal_column_width ##### -->
731 Gets the required width in pixels that is needed to show
732 everything in the specified column.
735 @clist: The #GtkCList to check.
736 @column: The column to check.
737 @Returns: The required width in pixels for the column.
740 <!-- ##### FUNCTION gtk_clist_set_column_width ##### -->
742 Causes the column specified for the #GtkCList to be set to
746 @clist: The #GtkCList to affect.
747 @column: The column to set the width.
748 @width: The width, in pixels.
751 <!-- ##### FUNCTION gtk_clist_set_column_min_width ##### -->
753 Causes the column specified to have a minimum width, preventing
754 the user from resizing it smaller than that specified.
757 @clist: The #GtkCList to affect.
758 @column: The column to set the minimum width.
759 @min_width: The width, in pixels.
762 <!-- ##### FUNCTION gtk_clist_set_column_max_width ##### -->
764 Causes the column specified to have a maximum width, preventing
765 the user from resizing it larger than that specified.
768 @clist: The #GtkCList to affect.
769 @column: The column to set the maximum width.
770 @max_width: The width, in pixels.
773 <!-- ##### FUNCTION gtk_clist_set_row_height ##### -->
775 Causes the #GtkCList to have a specified height for its
776 rows. Setting the row height to 0 allows the #GtkCList to adjust
777 automatically to data in the row.
780 @clist: The #GtkCList to affect.
781 @height: The height, in pixels.
784 <!-- ##### FUNCTION gtk_clist_moveto ##### -->
786 Tells the CList widget to visually move to the specified
790 @clist: The #GtkCList to affect.
791 @row: The row to which to move.
792 @column: The column to which to move.
793 @row_align: A value between 0 and 1 that describes the positioning of
794 the row in relation to the viewable area of the CList's contents.
795 @col_align: A value between 0 and 1 that describes the positioning of
796 the column in relation to the viewable area of the CList's contents.
799 <!-- ##### FUNCTION gtk_clist_row_is_visible ##### -->
801 Checks how the specified row is visible.
804 @clist: The #GtkCList to affect.
805 @row: The row to query.
806 @Returns: A #GtkVisibility value that tells you how the row is visible.
809 <!-- ##### FUNCTION gtk_clist_get_cell_type ##### -->
811 Checks the type of cell at the location specified.
814 @clist: The #GtkCList to affect.
815 @row: The row of the cell.
816 @column: The column of the cell.
817 @Returns: A #GtkCellType value describing the cell.
820 <!-- ##### FUNCTION gtk_clist_set_text ##### -->
822 Sets the displayed text in the specified cell.
825 @clist: The #GtkCList to affect.
826 @row: The row of the cell.
827 @column: The column of the cell.
828 @text: The text to set in the cell.
831 <!-- ##### FUNCTION gtk_clist_get_text ##### -->
833 Gets the text for the specified cell.
836 @clist: The #GtkCList to affect.
837 @row: The row to query.
838 @column: The column to query.
839 @text: A pointer to a pointer to store the text.
840 @Returns: 1 if the cell's text could be retrieved, 0 otherwise.
843 <!-- ##### FUNCTION gtk_clist_set_pixmap ##### -->
845 Sets a pixmap for the specified cell.
848 @clist: The #GtkCList to affect.
849 @row: The row of the cell.
850 @column: The column of the cell.
851 @pixmap: A pointer to a #GdkPixmap to place in the cell.
852 @mask: A pointer to a #GdkBitmap mask for the cell.
855 <!-- ##### FUNCTION gtk_clist_get_pixmap ##### -->
857 Gets the pixmap and bitmap mask of the specified cell. The returned mask value can be NULL.
860 @clist: The #GtkCList to affect.
861 @row: The row of the cell.
862 @column: The column of the cell.
863 @pixmap: A pointer to a pointer to store the cell's #GdkPixmap.
864 @mask: A pointer to a pointer to store the cell's #GdkBitmap mask.
865 @Returns: 1 if the cell's pixmap could be retrieved, 0 otherwise.
868 <!-- ##### FUNCTION gtk_clist_set_pixtext ##### -->
870 Sets text and a pixmap/bitmap on the specified cell.
873 @clist: The #GtkCList to affect.
874 @row: The row of the cell.
875 @column: The column of the cell.
876 @text: The text to set in the cell.
877 @spacing: The spacing between the cell's text and pixmap.
878 @pixmap: A pointer to a #GdkPixmap for the cell.
879 @mask: A pointer to a #GdkBitmap mask for the cell.
882 <!-- ##### FUNCTION gtk_clist_get_pixtext ##### -->
884 Gets the text, pixmap and bitmap mask for the specified cell.
887 @clist: The #GtkCList to affect.
888 @row: The row to query.
889 @column: The column to query.
890 @text: A pointer to a pointer to store the text.
891 @spacing: A pointer to a #guint8 to store the spacing.
892 @pixmap: A pointer to a #GdkPixmap pointer to store the cell's pixmap.
893 @mask: A pointer to a #GdkBitmap pointer to store the cell's bitmap mask.
894 @Returns: 1 if the retrieval was successful, 0 otherwise.
897 <!-- ##### FUNCTION gtk_clist_set_foreground ##### -->
899 Sets the foreground color for the specified row.
902 @clist: The #GtkCList to affect.
903 @row: The row to affect.
904 @color: A pointer to a #GdkColor structure.
907 <!-- ##### FUNCTION gtk_clist_set_background ##### -->
909 Sets the background color for the specified row.
912 @clist: The #GtkCList to affect.
913 @row: The row to affect.
914 @color: A pointer to a #GdkColor structure.
917 <!-- ##### FUNCTION gtk_clist_set_cell_style ##### -->
919 Sets the style for the specified cell.
922 @clist: The #GtkCList to affect.
923 @row: The row of the cell.
924 @column: The column of the cell.
925 @style: A pointer to a #GtkStyle structure.
928 <!-- ##### FUNCTION gtk_clist_get_cell_style ##### -->
930 Gets the current style of the specified cell.
933 @clist: The #GtkCList to affect.
934 @row: The row of the cell.
935 @column: The column of the cell.
936 @Returns: A #GtkStyle object.
939 <!-- ##### FUNCTION gtk_clist_set_row_style ##### -->
941 Sets the style for all cells in the specified row.
944 @clist: The #GtkCList to affect.
945 @row: The row to affect.
946 @style: A pointer to a #GtkStyle to set.
949 <!-- ##### FUNCTION gtk_clist_get_row_style ##### -->
951 Gets the style set for the specified row.
954 @clist: The #GtkCList to affect.
955 @row: The row to query.
956 @Returns: The #GtkStyle of the row.
959 <!-- ##### FUNCTION gtk_clist_set_shift ##### -->
961 Sets the vertical and horizontal shift of the specified cell.
964 @clist: The #GtkCList to affect.
965 @row: The row of the cell.
966 @column: The column of the cell.
967 @vertical: The value to set for the vertical shift.
968 @horizontal: The value to set for the vertical shift.
971 <!-- ##### FUNCTION gtk_clist_set_selectable ##### -->
973 Sets whether the specified row is selectable or not.
976 @clist: The #GtkCList to affect.
977 @row: The row to affect.
978 @selectable: %TRUE or %FALSE.
981 <!-- ##### FUNCTION gtk_clist_get_selectable ##### -->
983 Gets whether the specified row is selectable or not.
986 @clist: The #GtkCList to affect.
987 @row: The row to query.
988 @Returns: A #gboolean value.
991 <!-- ##### FUNCTION gtk_clist_prepend ##### -->
993 Adds a row to the CList at the top.
996 @clist: The #GtkCList to affect.
997 @text: An array of strings to add.
998 @Returns: The number of the row added.
1001 <!-- ##### FUNCTION gtk_clist_append ##### -->
1003 Adds a row to the CList at the bottom.
1006 @clist: The #GtkCList to affect.
1007 @text: An array of strings to add.
1008 @Returns: The number of the row added.
1011 <!-- ##### FUNCTION gtk_clist_insert ##### -->
1013 Adds a row of text to the CList at the specified position.
1016 @clist: The #GtkCList to affect.
1017 @row: The row where the text should be inserted.
1018 @text: An array of string to add.
1019 @Returns: The number of the row added.
1022 <!-- ##### FUNCTION gtk_clist_remove ##### -->
1024 Removes the specified row from the CList.
1027 @clist: The #GtkCList to affect.
1028 @row: The row to remove.
1031 <!-- ##### FUNCTION gtk_clist_set_row_data ##### -->
1033 Sets data for the specified row. This is the same as calling gtk_clist_set_row_data_full(clist, row, data, NULL).
1036 @clist: The #GtkCList to affect.
1037 @row: The row to affect.
1038 @data: The data to set for the row.
1041 <!-- ##### FUNCTION gtk_clist_set_row_data_full ##### -->
1043 Sets the data for specified row, with a callback when the row is destroyed.
1046 @clist: The #GtkCList to affect.
1047 @row: The row to affect.
1048 @data: The data to set for the row.
1049 @destroy: A #GtkDestroyNotify function to be called when the row is destroyed.
1052 <!-- ##### FUNCTION gtk_clist_get_row_data ##### -->
1054 Gets the currently set data for the specified row.
1057 @clist: The #GtkCList to affect.
1058 @row: The row to query.
1059 @Returns: The data set for the row.
1062 <!-- ##### FUNCTION gtk_clist_find_row_from_data ##### -->
1064 Searches the CList for the row with the specified data.
1067 @clist: The #GtkCList to search.
1068 @data: The data to search for a match.
1069 @Returns: The number of the matching row, or -1 if no match could be found.
1072 <!-- ##### FUNCTION gtk_clist_select_row ##### -->
1074 Selects the specified row. Causes the "select-row" signal to be emitted for the specified row and column.
1077 @clist: The #GtkCList to affect.
1078 @row: The row to select.
1079 @column: The column to select.
1082 <!-- ##### FUNCTION gtk_clist_unselect_row ##### -->
1084 Unselects the specified row. Causes the "unselect-row" signal to be emitted for the specified row and column.
1087 @clist: The #GtkCList to affect.
1088 @row: The row to select.
1089 @column: The column to select.
1092 <!-- ##### FUNCTION gtk_clist_undo_selection ##### -->
1094 Undoes the last selection for an "extended selection mode" CList.
1097 @clist: The #GtkCList to affect.
1100 <!-- ##### FUNCTION gtk_clist_clear ##### -->
1102 Removes all the CList's rows.
1105 @clist: The #GtkCList to affect.
1108 <!-- ##### FUNCTION gtk_clist_get_selection_info ##### -->
1110 Gets the row and column at the specified pixel position in the CList.
1113 @clist: The #GtkCList to affect.
1114 @x: The horizontal pixel position to check.
1115 @y: The vertical pixel position to check..
1116 @row: Pointer to a #gint to store the row value.
1117 @column: Pointer to a #gint to store the column value.
1118 @Returns: 1 if row/column is returned and in range, 0 otherwise.
1121 <!-- ##### FUNCTION gtk_clist_select_all ##### -->
1123 Selects all rows in the CList. This function has no affect for a
1124 CList in "single" or "browse" selection mode.
1127 @clist: The #GtkCList to affect.
1130 <!-- ##### FUNCTION gtk_clist_unselect_all ##### -->
1132 Unselects all rows in the CList.
1135 @clist: The #GtkCList to affect.
1138 <!-- ##### FUNCTION gtk_clist_swap_rows ##### -->
1140 Swaps the two specified rows with each other.
1143 @clist: The #GtkCList to affect.
1144 @row1: Number of the first row.
1145 @row2: Number of the second row.
1148 <!-- ##### FUNCTION gtk_clist_set_compare_func ##### -->
1150 Sets the compare function of the #GtkClist to @cmp_func. If @cmp_func is NULL,
1151 then the default compare function is used. The default compare function sorts
1152 ascending or with the type set by gtk_clist_set_sort_type() by the column set
1153 by gtk_clist_set_sort_column().
1156 @clist: The #GtkCList to affect.
1157 @cmp_func: The #GtkCompareFunction to use.
1160 <!-- ##### FUNCTION gtk_clist_set_sort_column ##### -->
1162 Sets the sort column of the clist. The sort column is used by the
1163 default compare function to determine which column to sort by.
1166 @clist: The #GtkCList to affect.
1167 @column: The column to sort by
1170 <!-- ##### FUNCTION gtk_clist_set_sort_type ##### -->
1172 Sets the sort type of the #GtkClist. This is either GTK_SORT_ASCENDING for
1173 ascening sort or GTK_SORT_DESCENDING for descending sort.
1176 @clist: The #GtkCList to affect.
1177 @sort_type: the #GtkSortType to use
1180 <!-- ##### FUNCTION gtk_clist_sort ##### -->
1182 Sorts the #GtkClist according to the current compare function, which
1183 can be set with the gtk_clist_set_compare_func() function.
1186 @clist: The #GtkCList to sort.
1189 <!-- ##### FUNCTION gtk_clist_set_auto_sort ##### -->
1191 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.
1194 @clist: The #GtkCList to affect.
1195 @auto_sort: whether auto sort should be on or off
1198 <!-- ##### FUNCTION gtk_clist_columns_autosize ##### -->
1200 Auto-sizes all columns in the CList and returns the total width of the CList.
1203 @clist: The #GtkCList to affect.
1204 @Returns: The total width of the CList.
1207 <!-- ##### FUNCTION gtk_clist_get_column_title ##### -->
1209 Gets the current title of the specified column
1212 @clist: The #GtkCList to affect.
1213 @column: The column to query.
1214 @Returns: The title of the column.
1217 <!-- ##### FUNCTION gtk_clist_get_column_widget ##### -->
1219 Gets the widget in the column header for the specified column.
1222 @clist: The #GtkCList to affect.
1223 @column: The column to query.
1224 @Returns: Pointer to a #GtkWidget for the column header.
1227 <!-- ##### FUNCTION gtk_clist_get_hadjustment ##### -->
1229 Gets the #GtkAdjustment currently being used for the horizontal
1233 @clist: The #GtkCList to check.
1234 @Returns: A #GtkAdjustment object, or NULL if none is currently
1238 <!-- ##### FUNCTION gtk_clist_get_vadjustment ##### -->
1240 Gets the #GtkAdjustment currently being used for the vertical
1244 @clist: The #GtkCList to check.
1245 @Returns: A #GtkAdjustment object, or NULL if none is currently
1249 <!-- ##### FUNCTION gtk_clist_row_move ##### -->
1251 Allows you to move a row from one position to another in the
1255 @clist: The #GtkCList to affect.
1256 @source_row: The original position of the row to move.
1257 @dest_row: The position to which the row should be moved.
1260 <!-- ##### FUNCTION gtk_clist_set_button_actions ##### -->
1262 Sets the action(s) that the specified mouse button will have
1266 @clist: The #GtkCList to affect.
1267 @button: The mouse button to set. The values here, unlike in the
1268 rest of GTK+ start from 0. For instance, the right mouse
1269 button, which is 3 elsewhere, should be given as 2 here.
1270 @button_actions: A logically OR'd value of #GtkButtonAction values
1274 <!-- ##### FUNCTION gtk_clist_set_hadjustment ##### -->
1276 Allows you to set the #GtkAdjustment to be used for the horizontal
1277 aspect of the #GtkCList widget.
1280 @clist: The #GtkCList to affect.
1281 @adjustment: A pointer to a #GtkAdjustment widget, or NULL.
1284 <!-- ##### FUNCTION gtk_clist_set_reorderable ##### -->
1286 Sets whether the CList's rows are re-orderable using drag-and-drop.
1289 @clist: The #GtkCList to affect.
1290 @reorderable: %TRUE or %FALSE.
1293 <!-- ##### FUNCTION gtk_clist_set_use_drag_icons ##### -->
1295 Determines whether the #GtkClist should use icons when
1296 doing drag-and-drop operations.
1299 @clist: The #GtkCList to affect.
1300 @use_icons: %TRUE or %FALSE.
1303 <!-- ##### FUNCTION gtk_clist_set_vadjustment ##### -->
1305 Allows you to set the #GtkAdjustment to be used for the vertical
1306 aspect of the #GtkCList widget.
1309 @clist: The #GtkCList to affect.
1310 @adjustment: A pointer to a #GtkAdjustment widget, or NULL.