b31e220597f19bd29b4ce5f665d9763f4c31073c
[claws.git] / src / gtk / gtkcmclist.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
3  * Copyright (C) 1997-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 /*
22  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
23  * file for a list of people on the GTK+ Team.  See the ChangeLog
24  * files for a list of changes.  These files are distributed with
25  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
26  */
27
28 #ifndef __GTK_CMCLIST_H__
29 #define __GTK_CMCLIST_H__
30
31 #include <gdk/gdk.h>
32 #include <gtk/gtk.h>
33
34
35 G_BEGIN_DECLS
36
37
38 /* clist flags */
39 enum {
40   GTK_CMCLIST_IN_DRAG             = 1 <<  0,
41   GTK_CMCLIST_ROW_HEIGHT_SET      = 1 <<  1,
42   GTK_CMCLIST_SHOW_TITLES         = 1 <<  2,
43   /* Unused */
44   GTK_CMCLIST_ADD_MODE            = 1 <<  4,
45   GTK_CMCLIST_AUTO_SORT           = 1 <<  5,
46   GTK_CMCLIST_AUTO_RESIZE_BLOCKED = 1 <<  6,
47   GTK_CMCLIST_REORDERABLE         = 1 <<  7,
48   GTK_CMCLIST_USE_DRAG_ICONS      = 1 <<  8,
49   GTK_CMCLIST_DRAW_DRAG_LINE      = 1 <<  9,
50   GTK_CMCLIST_DRAW_DRAG_RECT      = 1 << 10
51 }; 
52
53 /* cell types */
54 typedef enum
55 {
56   GTK_CMCELL_EMPTY,
57   GTK_CMCELL_TEXT,
58   GTK_CMCELL_PIXBUF,
59   GTK_CMCELL_PIXTEXT,
60   GTK_CMCELL_WIDGET
61 } GtkCMCellType;
62
63 typedef enum
64 {
65   GTK_CMCLIST_DRAG_NONE,
66   GTK_CMCLIST_DRAG_BEFORE,
67   GTK_CMCLIST_DRAG_INTO,
68   GTK_CMCLIST_DRAG_AFTER
69 } GtkCMCListDragPos;
70
71 typedef enum
72 {
73   GTK_CMBUTTON_IGNORED = 0,
74   GTK_CMBUTTON_SELECTS = 1 << 0,
75   GTK_CMBUTTON_DRAGS   = 1 << 1,
76   GTK_CMBUTTON_EXPANDS = 1 << 2
77 } GtkCMButtonAction;
78
79 #define GTK_TYPE_CMCLIST            (gtk_cmclist_get_type ())
80 #define GTK_CMCLIST(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CMCLIST, GtkCMCList))
81 #define GTK_CMCLIST_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CMCLIST, GtkCMCListClass))
82 #define GTK_IS_CMCLIST(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CMCLIST))
83 #define GTK_IS_CMCLIST_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CMCLIST))
84 #define GTK_CMCLIST_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CMCLIST, GtkCMCListClass))
85
86
87 #define GTK_CMCLIST_FLAGS(clist)             (GTK_CMCLIST (clist)->flags)
88 #define GTK_CMCLIST_SET_FLAG(clist,flag)     (GTK_CMCLIST_FLAGS (clist) |= (GTK_ ## flag))
89 #define GTK_CMCLIST_UNSET_FLAG(clist,flag)   (GTK_CMCLIST_FLAGS (clist) &= ~(GTK_ ## flag))
90
91 #define GTK_CMCLIST_IN_DRAG(clist)           (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_IN_DRAG)
92 #define GTK_CMCLIST_ROW_HEIGHT_SET(clist)    (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_ROW_HEIGHT_SET)
93 #define GTK_CMCLIST_SHOW_TITLES(clist)       (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_SHOW_TITLES)
94 #define GTK_CMCLIST_ADD_MODE(clist)          (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_ADD_MODE)
95 #define GTK_CMCLIST_AUTO_SORT(clist)         (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_AUTO_SORT)
96 #define GTK_CMCLIST_AUTO_RESIZE_BLOCKED(clist) (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_AUTO_RESIZE_BLOCKED)
97 #define GTK_CMCLIST_REORDERABLE(clist)       (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_REORDERABLE)
98 #define GTK_CMCLIST_USE_DRAG_ICONS(clist)    (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_USE_DRAG_ICONS)
99 #define GTK_CMCLIST_DRAW_DRAG_LINE(clist)    (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_DRAW_DRAG_LINE)
100 #define GTK_CMCLIST_DRAW_DRAG_RECT(clist)    (GTK_CMCLIST_FLAGS (clist) & GTK_CMCLIST_DRAW_DRAG_RECT)
101
102 #define GTK_CMCLIST_ROW(_glist_) ((GtkCMCListRow *)((_glist_)->data))
103
104 /* pointer casting for cells */
105 #define GTK_CMCELL_TEXT(cell)     (((GtkCMCellText *) &(cell)))
106 #define GTK_CMCELL_PIXBUF(cell)   (((GtkCMCellPixbuf *) &(cell)))
107 #define GTK_CMCELL_PIXTEXT(cell)  (((GtkCMCellPixText *) &(cell)))
108 #define GTK_CMCELL_WIDGET(cell)   (((GtkCMCellWidget *) &(cell)))
109
110 typedef struct _GtkCMCList GtkCMCList;
111 typedef struct _GtkCMCListClass GtkCMCListClass;
112 typedef struct _GtkCMCListColumn GtkCMCListColumn;
113 typedef struct _GtkCMCListRow GtkCMCListRow;
114
115 typedef struct _GtkCMCell GtkCMCell;
116 typedef struct _GtkCMCellText GtkCMCellText;
117 typedef struct _GtkCMCellPixbuf GtkCMCellPixbuf;
118 typedef struct _GtkCMCellPixText GtkCMCellPixText;
119 typedef struct _GtkCMCellWidget GtkCMCellWidget;
120
121 typedef gint (*GtkCMCListCompareFunc) (GtkCMCList     *clist,
122                                      gconstpointer ptr1,
123                                      gconstpointer ptr2);
124
125 typedef struct _GtkCMCListCellInfo GtkCMCListCellInfo;
126 typedef struct _GtkCMCListDestInfo GtkCMCListDestInfo;
127
128 struct _GtkCMCListCellInfo
129 {
130   gint row;
131   gint column;
132 };
133
134 struct _GtkCMCListDestInfo
135 {
136   GtkCMCListCellInfo cell;
137   GtkCMCListDragPos  insert_pos;
138 };
139
140 struct _GtkCMCList
141 {
142   GtkContainer container;
143   
144   guint16 flags;
145   
146 #if !GLIB_CHECK_VERSION(2,10,0)
147   GMemChunk *row_mem_chunk;
148   GMemChunk *cell_mem_chunk;
149 #else
150   gpointer reserved1;
151   gpointer reserved2;
152 #endif
153   guint freeze_count;
154   
155   /* allocation rectangle after the conatiner_border_width
156    * and the width of the shadow border */
157   GdkRectangle internal_allocation;
158   
159   /* rows */
160   gint rows;
161   gint row_height;
162   GList *row_list;
163   GList *row_list_end;
164   
165   /* columns */
166   gint columns;
167   GdkRectangle column_title_area;
168   GdkWindow *title_window;
169   
170   /* dynamicly allocated array of column structures */
171   GtkCMCListColumn *column;
172   
173   /* the scrolling window and its height and width to
174    * make things a little speedier */
175   GdkWindow *clist_window;
176   gint clist_window_width;
177   gint clist_window_height;
178   
179   /* offsets for scrolling */
180   gint hoffset;
181   gint voffset;
182   
183   /* border shadow style */
184   GtkShadowType shadow_type;
185   
186   /* the list's selection mode (gtkenums.h) */
187   GtkSelectionMode selection_mode;
188   
189   /* list of selected rows */
190   GList *selection;
191   GList *selection_end;
192   
193   GList *undo_selection;
194   GList *undo_unselection;
195   gint undo_anchor;
196   
197   /* mouse buttons */
198   guint8 button_actions[5];
199
200   guint8 drag_button;
201
202   /* dnd */
203   GtkCMCListCellInfo click_cell;
204
205   /* scroll adjustments */
206   GtkAdjustment *hadjustment;
207   GtkAdjustment *vadjustment;
208   
209   /* cursor used to indicate dragging */
210   GdkCursor *cursor_drag;
211   
212   /* the current x-pixel location of the xor-drag line */
213   gint x_drag;
214   
215   /* focus handling */
216   gint focus_row;
217
218   gint focus_header_column;
219   
220   /* dragging the selection */
221   gint anchor;
222   GtkStateType anchor_state;
223   gint drag_pos;
224   gint htimer;
225   gint vtimer;
226   
227   GtkSortType sort_type;
228   GtkCMCListCompareFunc compare;
229   gint sort_column;
230
231   gint drag_highlight_row;
232   GtkCMCListDragPos drag_highlight_pos;
233 };
234
235 struct _GtkCMCListClass
236 {
237   GtkContainerClass parent_class;
238   
239   void  (*set_scroll_adjustments) (GtkCMCList       *clist,
240                                    GtkAdjustment  *hadjustment,
241                                    GtkAdjustment  *vadjustment);
242   void   (*refresh)             (GtkCMCList       *clist);
243   void   (*select_row)          (GtkCMCList       *clist,
244                                  gint            row,
245                                  gint            column,
246                                  GdkEvent       *event);
247   void   (*unselect_row)        (GtkCMCList       *clist,
248                                  gint            row,
249                                  gint            column,
250                                  GdkEvent       *event);
251   void   (*row_move)            (GtkCMCList       *clist,
252                                  gint            source_row,
253                                  gint            dest_row);
254   void   (*click_column)        (GtkCMCList       *clist,
255                                  gint            column);
256   void   (*resize_column)       (GtkCMCList       *clist,
257                                  gint            column,
258                                  gint            width);
259   void   (*toggle_focus_row)    (GtkCMCList       *clist);
260   void   (*select_all)          (GtkCMCList       *clist);
261   void   (*unselect_all)        (GtkCMCList       *clist);
262   void   (*undo_selection)      (GtkCMCList       *clist);
263   void   (*start_selection)     (GtkCMCList       *clist);
264   void   (*end_selection)       (GtkCMCList       *clist);
265   void   (*extend_selection)    (GtkCMCList       *clist,
266                                  GtkScrollType   scroll_type,
267                                  gfloat          position,
268                                  gboolean        auto_start_selection);
269   void   (*scroll_horizontal)   (GtkCMCList       *clist,
270                                  GtkScrollType   scroll_type,
271                                  gfloat          position);
272   void   (*scroll_vertical)     (GtkCMCList       *clist,
273                                  GtkScrollType   scroll_type,
274                                  gfloat          position);
275   void   (*toggle_add_mode)     (GtkCMCList       *clist);
276   void   (*abort_column_resize) (GtkCMCList       *clist);
277   void   (*resync_selection)    (GtkCMCList       *clist,
278                                  GdkEvent       *event);
279   GList* (*selection_find)      (GtkCMCList       *clist,
280                                  gint            row_number,
281                                  GList          *row_list_element);
282   void   (*draw_row)            (GtkCMCList       *clist,
283                                  GdkRectangle   *area,
284                                  gint            row,
285                                  GtkCMCListRow    *clist_row);
286   void   (*draw_drag_highlight) (GtkCMCList        *clist,
287                                  GtkCMCListRow     *target_row,
288                                  gint             target_row_number,
289                                  GtkCMCListDragPos  drag_pos);
290   void   (*clear)               (GtkCMCList       *clist);
291   void   (*fake_unselect_all)   (GtkCMCList       *clist,
292                                  gint            row);
293   void   (*sort_list)           (GtkCMCList       *clist);
294   gint   (*insert_row)          (GtkCMCList       *clist,
295                                  gint            row,
296                                  gchar          *text[]);
297   void   (*remove_row)          (GtkCMCList       *clist,
298                                  gint            row);
299   void   (*set_cell_contents)   (GtkCMCList       *clist,
300                                  GtkCMCListRow    *clist_row,
301                                  gint            column,
302                                  GtkCMCellType     type,
303                                  const gchar    *text,
304                                  guint8          spacing,
305                                  GdkPixbuf      *pixbuf);
306   void   (*cell_size_request)   (GtkCMCList       *clist,
307                                  GtkCMCListRow    *clist_row,
308                                  gint            column,
309                                  GtkRequisition *requisition);
310
311 };
312
313 struct _GtkCMCListColumn
314 {
315   gchar *title;
316   GdkRectangle area;
317   
318   GtkWidget *button;
319   GdkWindow *window;
320   
321   gint width;
322   gint min_width;
323   gint max_width;
324   GtkJustification justification;
325   
326   guint visible        : 1;  
327   guint width_set      : 1;
328   guint resizeable     : 1;
329   guint auto_resize    : 1;
330   guint button_passive : 1;
331 };
332
333 struct _GtkCMCListRow
334 {
335   GtkCMCell *cell;
336   GtkStateType state;
337   
338   GdkColor foreground;
339   GdkColor background;
340   
341   GtkStyle *style;
342
343   gpointer data;
344   GDestroyNotify destroy;
345   
346   guint fg_set     : 1;
347   guint bg_set     : 1;
348   guint selectable : 1;
349 };
350
351 /* Cell Structures */
352 struct _GtkCMCellText
353 {
354   GtkCMCellType type;
355   
356   gint16 vertical;
357   gint16 horizontal;
358   
359   GtkStyle *style;
360
361   gchar *text;
362 };
363
364 struct _GtkCMCellPixbuf
365 {
366   GtkCMCellType type;
367   
368   gint16 vertical;
369   gint16 horizontal;
370   
371   GtkStyle *style;
372
373   GdkPixbuf *pixbuf;
374 };
375
376 struct _GtkCMCellPixText
377 {
378   GtkCMCellType type;
379   
380   gint16 vertical;
381   gint16 horizontal;
382   
383   GtkStyle *style;
384
385   gchar *text;
386   guint8 spacing;
387   GdkPixbuf *pixbuf;
388 };
389
390 struct _GtkCMCellWidget
391 {
392   GtkCMCellType type;
393   
394   gint16 vertical;
395   gint16 horizontal;
396   
397   GtkStyle *style;
398
399   GtkWidget *widget;
400 };
401
402 struct _GtkCMCell
403 {
404   GtkCMCellType type;
405   
406   gint16 vertical;
407   gint16 horizontal;
408   
409   GtkStyle *style;
410
411   union {
412     gchar *text;
413     
414     struct {
415       GdkPixbuf *pixbuf;
416     } pm;
417     
418     struct {
419       gchar *text;
420       guint8 spacing;
421       GdkPixbuf *pixbuf;
422     } pt;
423     
424     GtkWidget *widget;
425   } u;
426 };
427
428 GType gtk_cmclist_get_type (void);
429
430 /* create a new GtkCMCList */
431 GtkWidget* gtk_cmclist_new             (gint   columns);
432 GtkWidget* gtk_cmclist_new_with_titles (gint   columns,
433                                       gchar *titles[]);
434
435 /* set adjustments of clist */
436 void gtk_cmclist_set_hadjustment (GtkCMCList      *clist,
437                                 GtkAdjustment *adjustment);
438 void gtk_cmclist_set_vadjustment (GtkCMCList      *clist,
439                                 GtkAdjustment *adjustment);
440
441 /* get adjustments of clist */
442 GtkAdjustment* gtk_cmclist_get_hadjustment (GtkCMCList *clist);
443 GtkAdjustment* gtk_cmclist_get_vadjustment (GtkCMCList *clist);
444
445 /* set the border style of the clist */
446 void gtk_cmclist_set_shadow_type (GtkCMCList      *clist,
447                                 GtkShadowType  type);
448
449 /* set the clist's selection mode */
450 void gtk_cmclist_set_selection_mode (GtkCMCList         *clist,
451                                    GtkSelectionMode  mode);
452
453 /* enable clists reorder ability */
454 void gtk_cmclist_set_reorderable (GtkCMCList *clist,
455                                 gboolean  reorderable);
456 void gtk_cmclist_set_use_drag_icons (GtkCMCList *clist,
457                                    gboolean  use_icons);
458 void gtk_cmclist_set_button_actions (GtkCMCList *clist,
459                                    guint     button,
460                                    guint8    button_actions);
461
462 /* freeze all visual updates of the list, and then thaw the list after
463  * you have made a number of changes and the updates wil occure in a
464  * more efficent mannor than if you made them on a unfrozen list
465  */
466 void gtk_cmclist_freeze (GtkCMCList *clist);
467 void gtk_cmclist_thaw   (GtkCMCList *clist);
468
469 /* show and hide the column title buttons */
470 void gtk_cmclist_column_titles_show (GtkCMCList *clist);
471 void gtk_cmclist_column_titles_hide (GtkCMCList *clist);
472
473 /* set the column title to be a active title (responds to button presses, 
474  * prelights, and grabs keyboard focus), or passive where it acts as just
475  * a title
476  */
477 void gtk_cmclist_column_title_active   (GtkCMCList *clist,
478                                       gint      column);
479 void gtk_cmclist_column_title_passive  (GtkCMCList *clist,
480                                       gint      column);
481 void gtk_cmclist_column_titles_active  (GtkCMCList *clist);
482 void gtk_cmclist_column_titles_passive (GtkCMCList *clist);
483
484 /* set the title in the column title button */
485 void gtk_cmclist_set_column_title (GtkCMCList    *clist,
486                                  gint         column,
487                                  const gchar *title);
488
489 /* returns the title of column. Returns NULL if title is not set */
490 gchar * gtk_cmclist_get_column_title (GtkCMCList *clist,
491                                     gint      column);
492
493 /* set a widget instead of a title for the column title button */
494 void gtk_cmclist_set_column_widget (GtkCMCList  *clist,
495                                   gint       column,
496                                   GtkWidget *widget);
497
498 /* returns the column widget */
499 GtkWidget * gtk_cmclist_get_column_widget (GtkCMCList *clist,
500                                          gint      column);
501
502 /* set the justification on a column */
503 void gtk_cmclist_set_column_justification (GtkCMCList         *clist,
504                                          gint              column,
505                                          GtkJustification  justification);
506
507 /* set visibility of a column */
508 void gtk_cmclist_set_column_visibility (GtkCMCList *clist,
509                                       gint      column,
510                                       gboolean  visible);
511
512 /* enable/disable column resize operations by mouse */
513 void gtk_cmclist_set_column_resizeable (GtkCMCList *clist,
514                                       gint      column,
515                                       gboolean  resizeable);
516
517 /* resize column automatically to its optimal width */
518 void gtk_cmclist_set_column_auto_resize (GtkCMCList *clist,
519                                        gint      column,
520                                        gboolean  auto_resize);
521
522 gint gtk_cmclist_columns_autosize (GtkCMCList *clist);
523
524 /* return the optimal column width, i.e. maximum of all cell widths */
525 gint gtk_cmclist_optimal_column_width (GtkCMCList *clist,
526                                      gint      column);
527
528 /* set the pixel width of a column; this is a necessary step in
529  * creating a CList because otherwise the column width is chozen from
530  * the width of the column title, which will never be right
531  */
532 void gtk_cmclist_set_column_width (GtkCMCList *clist,
533                                  gint      column,
534                                  gint      width);
535
536 /* set column minimum/maximum width. min/max_width < 0 => no restriction */
537 void gtk_cmclist_set_column_min_width (GtkCMCList *clist,
538                                      gint      column,
539                                      gint      min_width);
540 void gtk_cmclist_set_column_max_width (GtkCMCList *clist,
541                                      gint      column,
542                                      gint      max_width);
543
544 /* change the height of the rows, the default (height=0) is
545  * the hight of the current font.
546  */
547 void gtk_cmclist_set_row_height (GtkCMCList *clist,
548                                guint     height);
549
550 /* scroll the viewing area of the list to the given column and row;
551  * row_align and col_align are between 0-1 representing the location the
552  * row should appear on the screnn, 0.0 being top or left, 1.0 being
553  * bottom or right; if row or column is -1 then then there is no change
554  */
555 void gtk_cmclist_moveto (GtkCMCList *clist,
556                        gint      row,
557                        gint      column,
558                        gfloat    row_align,
559                        gfloat    col_align);
560
561 /* returns whether the row is visible */
562 GtkVisibility gtk_cmclist_row_is_visible (GtkCMCList *clist,
563                                         gint      row);
564
565 /* returns the cell type */
566 GtkCMCellType gtk_cmclist_get_cell_type (GtkCMCList *clist,
567                                      gint      row,
568                                      gint      column);
569
570 /* sets a given cell's text, replacing its current contents */
571 void gtk_cmclist_set_text (GtkCMCList    *clist,
572                          gint         row,
573                          gint         column,
574                          const gchar *text);
575
576 /* for the "get" functions, any of the return pointer can be
577  * NULL if you are not interested
578  */
579 gint gtk_cmclist_get_text (GtkCMCList  *clist,
580                          gint       row,
581                          gint       column,
582                          gchar    **text);
583
584 /* sets a given cell's pixbuf, replacing its current contents */
585 void gtk_cmclist_set_pixbuf (GtkCMCList  *clist,
586                            gint       row,
587                            gint       column,
588                            GdkPixbuf *pixbuf);
589
590 gint gtk_cmclist_get_pixbuf (GtkCMCList   *clist,
591                            gint        row,
592                            gint        column,
593                            GdkPixbuf **pixbuf);
594
595 /* sets a given cell's pixbuf and text, replacing its current contents */
596 void gtk_cmclist_set_pixtext (GtkCMCList    *clist,
597                             gint         row,
598                             gint         column,
599                             const gchar *text,
600                             guint8       spacing,
601                             GdkPixbuf   *pixbuf);
602
603 gint gtk_cmclist_get_pixtext (GtkCMCList   *clist,
604                             gint        row,
605                             gint        column,
606                             gchar     **text,
607                             guint8     *spacing,
608                             GdkPixbuf **pixbuf);
609
610 /* sets the foreground color of a row, the color must already
611  * be allocated
612  */
613 void gtk_cmclist_set_foreground (GtkCMCList       *clist,
614                                gint            row,
615                                const GdkColor *color);
616
617 /* sets the background color of a row, the color must already
618  * be allocated
619  */
620 void gtk_cmclist_set_background (GtkCMCList       *clist,
621                                gint            row,
622                                const GdkColor *color);
623
624 /* set / get cell styles */
625 void gtk_cmclist_set_cell_style (GtkCMCList *clist,
626                                gint      row,
627                                gint      column,
628                                GtkStyle *style);
629
630 GtkStyle *gtk_cmclist_get_cell_style (GtkCMCList *clist,
631                                     gint      row,
632                                     gint      column);
633
634 void gtk_cmclist_set_row_style (GtkCMCList *clist,
635                               gint      row,
636                               GtkStyle *style);
637
638 GtkStyle *gtk_cmclist_get_row_style (GtkCMCList *clist,
639                                    gint      row);
640
641 /* this sets a horizontal and vertical shift for drawing
642  * the contents of a cell; it can be positive or negitive;
643  * this is particulary useful for indenting items in a column
644  */
645 void gtk_cmclist_set_shift (GtkCMCList *clist,
646                           gint      row,
647                           gint      column,
648                           gint      vertical,
649                           gint      horizontal);
650
651 /* set/get selectable flag of a single row */
652 void gtk_cmclist_set_selectable (GtkCMCList *clist,
653                                gint      row,
654                                gboolean  selectable);
655 gboolean gtk_cmclist_get_selectable (GtkCMCList *clist,
656                                    gint      row);
657
658 /* prepend/append returns the index of the row you just added,
659  * making it easier to append and modify a row
660  */
661 gint gtk_cmclist_prepend (GtkCMCList    *clist,
662                         gchar       *text[]);
663 gint gtk_cmclist_append  (GtkCMCList    *clist,
664                         gchar       *text[]);
665
666 /* inserts a row at index row and returns the row where it was
667  * actually inserted (may be different from "row" in auto_sort mode)
668  */
669 gint gtk_cmclist_insert (GtkCMCList    *clist,
670                        gint         row,
671                        gchar       *text[]);
672
673 /* removes row at index row */
674 void gtk_cmclist_remove (GtkCMCList *clist,
675                        gint      row);
676
677 /* sets a arbitrary data pointer for a given row */
678 void gtk_cmclist_set_row_data (GtkCMCList *clist,
679                              gint      row,
680                              gpointer  data);
681
682 /* sets a data pointer for a given row with destroy notification */
683 void gtk_cmclist_set_row_data_full (GtkCMCList         *clist,
684                                   gint              row,
685                                   gpointer          data,
686                                   GDestroyNotify  destroy);
687
688 /* returns the data set for a row */
689 gpointer gtk_cmclist_get_row_data (GtkCMCList *clist,
690                                  gint      row);
691
692 /* givin a data pointer, find the first (and hopefully only!)
693  * row that points to that data, or -1 if none do
694  */
695 gint gtk_cmclist_find_row_from_data (GtkCMCList *clist,
696                                    gpointer  data);
697
698 /* force selection of a row */
699 void gtk_cmclist_select_row (GtkCMCList *clist,
700                            gint      row,
701                            gint      column);
702
703 /* force unselection of a row */
704 void gtk_cmclist_unselect_row (GtkCMCList *clist,
705                              gint      row,
706                              gint      column);
707
708 /* undo the last select/unselect operation */
709 void gtk_cmclist_undo_selection (GtkCMCList *clist);
710
711 /* clear the entire list -- this is much faster than removing
712  * each item with gtk_cmclist_remove
713  */
714 void gtk_cmclist_clear (GtkCMCList *clist);
715
716 /* return the row column corresponding to the x and y coordinates,
717  * the returned values are only valid if the x and y coordinates
718  * are respectively to a window == clist->clist_window
719  */
720 gint gtk_cmclist_get_selection_info (GtkCMCList *clist,
721                                    gint      x,
722                                    gint      y,
723                                    gint     *row,
724                                    gint     *column);
725
726 /* in multiple or extended mode, select all rows */
727 void gtk_cmclist_select_all (GtkCMCList *clist);
728
729 /* in all modes except browse mode, deselect all rows */
730 void gtk_cmclist_unselect_all (GtkCMCList *clist);
731
732 /* swap the position of two rows */
733 void gtk_cmclist_swap_rows (GtkCMCList *clist,
734                           gint      row1,
735                           gint      row2);
736
737 /* move row from source_row position to dest_row position */
738 void gtk_cmclist_row_move (GtkCMCList *clist,
739                          gint      source_row,
740                          gint      dest_row);
741
742 /* sets a compare function different to the default */
743 void gtk_cmclist_set_compare_func (GtkCMCList            *clist,
744                                  GtkCMCListCompareFunc  cmp_func);
745
746 /* the column to sort by */
747 void gtk_cmclist_set_sort_column (GtkCMCList *clist,
748                                 gint      column);
749
750 /* how to sort : ascending or descending */
751 void gtk_cmclist_set_sort_type (GtkCMCList    *clist,
752                               GtkSortType  sort_type);
753
754 /* sort the list with the current compare function */
755 void gtk_cmclist_sort (GtkCMCList *clist);
756
757 /* Automatically sort upon insertion */
758 void gtk_cmclist_set_auto_sort (GtkCMCList *clist,
759                               gboolean  auto_sort);
760
761 /* Private function for clist, ctree */
762
763 PangoLayout *_gtk_cmclist_create_cell_layout (GtkCMCList       *clist,
764                                             GtkCMCListRow    *clist_row,
765                                             gint            column);
766
767
768 G_END_DECLS
769
770
771 #endif                          /* __GTK_CMCLIST_H__ */