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   /* xor GC for the vertical drag line */
 210   GdkGC *xor_gc;
 211
 212   /* gc for drawing unselected cells */
 213   GdkGC *fg_gc;
 214   GdkGC *bg_gc;
 215
 216   /* cursor used to indicate dragging */
 217   GdkCursor *cursor_drag;
 218
 219   /* the current x-pixel location of the xor-drag line */
 220   gint x_drag;
 221
 222   /* focus handling */
 223   gint focus_row;
 224
 225   gint focus_header_column;
 226
 227   /* dragging the selection */
 228   gint anchor;
 229   GtkStateType anchor_state;
 230   gint drag_pos;
 231   gint htimer;
 232   gint vtimer;
 233
 234   GtkSortType sort_type;
 235   GtkCMCListCompareFunc compare;
 236   gint sort_column;
 237
 238   gint drag_highlight_row;
 239   GtkCMCListDragPos drag_highlight_pos;
 240 };
 241
 242 struct _GtkCMCListClass
 243 {
 244   GtkContainerClass parent_class;
 245
 246   void  (*set_scroll_adjustments) (GtkCMCList       *clist,
 247                                    GtkAdjustment  *hadjustment,
 248                                    GtkAdjustment  *vadjustment);
 249   void   (*refresh)             (GtkCMCList       *clist);
 250   void   (*select_row)          (GtkCMCList       *clist,
 251                                  gint            row,
 252                                  gint            column,
 253                                  GdkEvent       *event);
 254   void   (*unselect_row)        (GtkCMCList       *clist,
 255                                  gint            row,
 256                                  gint            column,
 257                                  GdkEvent       *event);
 258   void   (*row_move)            (GtkCMCList       *clist,
 259                                  gint            source_row,
 260                                  gint            dest_row);
 261   void   (*click_column)        (GtkCMCList       *clist,
 262                                  gint            column);
 263   void   (*resize_column)       (GtkCMCList       *clist,
 264                                  gint            column,
 265                                  gint            width);
 266   void   (*toggle_focus_row)    (GtkCMCList       *clist);
 267   void   (*select_all)          (GtkCMCList       *clist);
 268   void   (*unselect_all)        (GtkCMCList       *clist);
 269   void   (*undo_selection)      (GtkCMCList       *clist);
 270   void   (*start_selection)     (GtkCMCList       *clist);
 271   void   (*end_selection)       (GtkCMCList       *clist);
 272   void   (*extend_selection)    (GtkCMCList       *clist,
 273                                  GtkScrollType   scroll_type,
 274                                  gfloat          position,
 275                                  gboolean        auto_start_selection);
 276   void   (*scroll_horizontal)   (GtkCMCList       *clist,
 277                                  GtkScrollType   scroll_type,
 278                                  gfloat          position);
 279   void   (*scroll_vertical)     (GtkCMCList       *clist,
 280                                  GtkScrollType   scroll_type,
 281                                  gfloat          position);
 282   void   (*toggle_add_mode)     (GtkCMCList       *clist);
 283   void   (*abort_column_resize) (GtkCMCList       *clist);
 284   void   (*resync_selection)    (GtkCMCList       *clist,
 285                                  GdkEvent       *event);
 286   GList* (*selection_find)      (GtkCMCList       *clist,
 287                                  gint            row_number,
 288                                  GList          *row_list_element);
 289   void   (*draw_row)            (GtkCMCList       *clist,
 290                                  GdkRectangle   *area,
 291                                  gint            row,
 292                                  GtkCMCListRow    *clist_row);
 293   void   (*draw_drag_highlight) (GtkCMCList        *clist,
 294                                  GtkCMCListRow     *target_row,
 295                                  gint             target_row_number,
 296                                  GtkCMCListDragPos  drag_pos);
 297   void   (*clear)               (GtkCMCList       *clist);
 298   void   (*fake_unselect_all)   (GtkCMCList       *clist,
 299                                  gint            row);
 300   void   (*sort_list)           (GtkCMCList       *clist);
 301   gint   (*insert_row)          (GtkCMCList       *clist,
 302                                  gint            row,
 303                                  gchar          *text[]);
 304   void   (*remove_row)          (GtkCMCList       *clist,
 305                                  gint            row);
 306   void   (*set_cell_contents)   (GtkCMCList       *clist,
 307                                  GtkCMCListRow    *clist_row,
 308                                  gint            column,
 309                                  GtkCMCellType     type,
 310                                  const gchar    *text,
 311                                  guint8          spacing,
 312                                  GdkPixbuf      *pixbuf);
 313   void   (*cell_size_request)   (GtkCMCList       *clist,
 314                                  GtkCMCListRow    *clist_row,
 315                                  gint            column,
 316                                  GtkRequisition *requisition);
 317
 318 };
 319
 320 struct _GtkCMCListColumn
 321 {
 322   gchar *title;
 323   GdkRectangle area;
 324
 325   GtkWidget *button;
 326   GdkWindow *window;
 327
 328   gint width;
 329   gint min_width;
 330   gint max_width;
 331   GtkJustification justification;
 332
 333   guint visible        : 1;
 334   guint width_set      : 1;
 335   guint resizeable     : 1;
 336   guint auto_resize    : 1;
 337   guint button_passive : 1;
 338 };
 339
 340 struct _GtkCMCListRow
 341 {
 342   GtkCMCell *cell;
 343   GtkStateType state;
 344
 345   GdkColor foreground;
 346   GdkColor background;
 347
 348   GtkStyle *style;
 349
 350   gpointer data;
 351   GDestroyNotify destroy;
 352
 353   guint fg_set     : 1;
 354   guint bg_set     : 1;
 355   guint selectable : 1;
 356 };
 357
 358 /* Cell Structures */
 359 struct _GtkCMCellText
 360 {
 361   GtkCMCellType type;
 362
 363   gint16 vertical;
 364   gint16 horizontal;
 365
 366   GtkStyle *style;
 367
 368   gchar *text;
 369 };
 370
 371 struct _GtkCMCellPixbuf
 372 {
 373   GtkCMCellType type;
 374
 375   gint16 vertical;
 376   gint16 horizontal;
 377
 378   GtkStyle *style;
 379
 380   GdkPixbuf *pixbuf;
 381 };
 382
 383 struct _GtkCMCellPixText
 384 {
 385   GtkCMCellType type;
 386
 387   gint16 vertical;
 388   gint16 horizontal;
 389
 390   GtkStyle *style;
 391
 392   gchar *text;
 393   guint8 spacing;
 394   GdkPixbuf *pixbuf;
 395 };
 396
 397 struct _GtkCMCellWidget
 398 {
 399   GtkCMCellType type;
 400
 401   gint16 vertical;
 402   gint16 horizontal;
 403
 404   GtkStyle *style;
 405
 406   GtkWidget *widget;
 407 };
 408
 409 struct _GtkCMCell
 410 {
 411   GtkCMCellType type;
 412
 413   gint16 vertical;
 414   gint16 horizontal;
 415
 416   GtkStyle *style;
 417
 418   union {
 419     gchar *text;
 420
 421     struct {
 422       GdkPixbuf *pixbuf;
 423     } pm;
 424
 425     struct {
 426       gchar *text;
 427       guint8 spacing;
 428       GdkPixbuf *pixbuf;
 429     } pt;
 430
 431     GtkWidget *widget;
 432   } u;
 433 };
 434
 435 GType gtk_cmclist_get_type (void);
 436
 437 /* create a new GtkCMCList */
 438 GtkWidget* gtk_cmclist_new             (gint   columns);
 439 GtkWidget* gtk_cmclist_new_with_titles (gint   columns,
 440                                       gchar *titles[]);
 441
 442 /* set adjustments of clist */
 443 void gtk_cmclist_set_hadjustment (GtkCMCList      *clist,
 444                                 GtkAdjustment *adjustment);
 445 void gtk_cmclist_set_vadjustment (GtkCMCList      *clist,
 446                                 GtkAdjustment *adjustment);
 447
 448 /* get adjustments of clist */
 449 GtkAdjustment* gtk_cmclist_get_hadjustment (GtkCMCList *clist);
 450 GtkAdjustment* gtk_cmclist_get_vadjustment (GtkCMCList *clist);
 451
 452 /* set the border style of the clist */
 453 void gtk_cmclist_set_shadow_type (GtkCMCList      *clist,
 454                                 GtkShadowType  type);
 455
 456 /* set the clist's selection mode */
 457 void gtk_cmclist_set_selection_mode (GtkCMCList         *clist,
 458                                    GtkSelectionMode  mode);
 459
 460 /* enable clists reorder ability */
 461 void gtk_cmclist_set_reorderable (GtkCMCList *clist,
 462                                 gboolean  reorderable);
 463 void gtk_cmclist_set_use_drag_icons (GtkCMCList *clist,
 464                                    gboolean  use_icons);
 465 void gtk_cmclist_set_button_actions (GtkCMCList *clist,
 466                                    guint     button,
 467                                    guint8    button_actions);
 468
 469 /* freeze all visual updates of the list, and then thaw the list after
 470  * you have made a number of changes and the updates wil occure in a
 471  * more efficent mannor than if you made them on a unfrozen list
 472  */
 473 void gtk_cmclist_freeze (GtkCMCList *clist);
 474 void gtk_cmclist_thaw   (GtkCMCList *clist);
 475
 476 /* show and hide the column title buttons */
 477 void gtk_cmclist_column_titles_show (GtkCMCList *clist);
 478 void gtk_cmclist_column_titles_hide (GtkCMCList *clist);
 479
 480 /* set the column title to be a active title (responds to button presses,
 481  * prelights, and grabs keyboard focus), or passive where it acts as just
 482  * a title
 483  */
 484 void gtk_cmclist_column_title_active   (GtkCMCList *clist,
 485                                       gint      column);
 486 void gtk_cmclist_column_title_passive  (GtkCMCList *clist,
 487                                       gint      column);
 488 void gtk_cmclist_column_titles_active  (GtkCMCList *clist);
 489 void gtk_cmclist_column_titles_passive (GtkCMCList *clist);
 490
 491 /* set the title in the column title button */
 492 void gtk_cmclist_set_column_title (GtkCMCList    *clist,
 493                                  gint         column,
 494                                  const gchar *title);
 495
 496 /* returns the title of column. Returns NULL if title is not set */
 497 gchar * gtk_cmclist_get_column_title (GtkCMCList *clist,
 498                                     gint      column);
 499
 500 /* set a widget instead of a title for the column title button */
 501 void gtk_cmclist_set_column_widget (GtkCMCList  *clist,
 502                                   gint       column,
 503                                   GtkWidget *widget);
 504
 505 /* returns the column widget */
 506 GtkWidget * gtk_cmclist_get_column_widget (GtkCMCList *clist,
 507                                          gint      column);
 508
 509 /* set the justification on a column */
 510 void gtk_cmclist_set_column_justification (GtkCMCList         *clist,
 511                                          gint              column,
 512                                          GtkJustification  justification);
 513
 514 /* set visibility of a column */
 515 void gtk_cmclist_set_column_visibility (GtkCMCList *clist,
 516                                       gint      column,
 517                                       gboolean  visible);
 518
 519 /* enable/disable column resize operations by mouse */
 520 void gtk_cmclist_set_column_resizeable (GtkCMCList *clist,
 521                                       gint      column,
 522                                       gboolean  resizeable);
 523
 524 /* resize column automatically to its optimal width */
 525 void gtk_cmclist_set_column_auto_resize (GtkCMCList *clist,
 526                                        gint      column,
 527                                        gboolean  auto_resize);
 528
 529 gint gtk_cmclist_columns_autosize (GtkCMCList *clist);
 530
 531 /* return the optimal column width, i.e. maximum of all cell widths */
 532 gint gtk_cmclist_optimal_column_width (GtkCMCList *clist,
 533                                      gint      column);
 534
 535 /* set the pixel width of a column; this is a necessary step in
 536  * creating a CList because otherwise the column width is chozen from
 537  * the width of the column title, which will never be right
 538  */
 539 void gtk_cmclist_set_column_width (GtkCMCList *clist,
 540                                  gint      column,
 541                                  gint      width);
 542
 543 /* set column minimum/maximum width. min/max_width < 0 => no restriction */
 544 void gtk_cmclist_set_column_min_width (GtkCMCList *clist,
 545                                      gint      column,
 546                                      gint      min_width);
 547 void gtk_cmclist_set_column_max_width (GtkCMCList *clist,
 548                                      gint      column,
 549                                      gint      max_width);
 550
 551 /* change the height of the rows, the default (height=0) is
 552  * the hight of the current font.
 553  */
 554 void gtk_cmclist_set_row_height (GtkCMCList *clist,
 555                                guint     height);
 556
 557 /* scroll the viewing area of the list to the given column and row;
 558  * row_align and col_align are between 0-1 representing the location the
 559  * row should appear on the screnn, 0.0 being top or left, 1.0 being
 560  * bottom or right; if row or column is -1 then then there is no change
 561  */
 562 void gtk_cmclist_moveto (GtkCMCList *clist,
 563                        gint      row,
 564                        gint      column,
 565                        gfloat    row_align,
 566                        gfloat    col_align);
 567
 568 /* returns whether the row is visible */
 569 GtkVisibility gtk_cmclist_row_is_visible (GtkCMCList *clist,
 570                                         gint      row);
 571
 572 /* returns the cell type */
 573 GtkCMCellType gtk_cmclist_get_cell_type (GtkCMCList *clist,
 574                                      gint      row,
 575                                      gint      column);
 576
 577 /* sets a given cell's text, replacing its current contents */
 578 void gtk_cmclist_set_text (GtkCMCList    *clist,
 579                          gint         row,
 580                          gint         column,
 581                          const gchar *text);
 582
 583 /* for the "get" functions, any of the return pointer can be
 584  * NULL if you are not interested
 585  */
 586 gint gtk_cmclist_get_text (GtkCMCList  *clist,
 587                          gint       row,
 588                          gint       column,
 589                          gchar    **text);
 590
 591 /* sets a given cell's pixbuf, replacing its current contents */
 592 void gtk_cmclist_set_pixbuf (GtkCMCList  *clist,
 593                            gint       row,
 594                            gint       column,
 595                            GdkPixbuf *pixbuf);
 596
 597 gint gtk_cmclist_get_pixbuf (GtkCMCList   *clist,
 598                            gint        row,
 599                            gint        column,
 600                            GdkPixbuf **pixbuf);
 601
 602 /* sets a given cell's pixbuf and text, replacing its current contents */
 603 void gtk_cmclist_set_pixtext (GtkCMCList    *clist,
 604                             gint         row,
 605                             gint         column,
 606                             const gchar *text,
 607                             guint8       spacing,
 608                             GdkPixbuf   *pixbuf);
 609
 610 gint gtk_cmclist_get_pixtext (GtkCMCList   *clist,
 611                             gint        row,
 612                             gint        column,
 613                             gchar     **text,
 614                             guint8     *spacing,
 615                             GdkPixbuf **pixbuf);
 616
 617 /* sets the foreground color of a row, the color must already
 618  * be allocated
 619  */
 620 void gtk_cmclist_set_foreground (GtkCMCList       *clist,
 621                                gint            row,
 622                                const GdkColor *color);
 623
 624 /* sets the background color of a row, the color must already
 625  * be allocated
 626  */
 627 void gtk_cmclist_set_background (GtkCMCList       *clist,
 628                                gint            row,
 629                                const GdkColor *color);
 630
 631 /* set / get cell styles */
 632 void gtk_cmclist_set_cell_style (GtkCMCList *clist,
 633                                gint      row,
 634                                gint      column,
 635                                GtkStyle *style);
 636
 637 GtkStyle *gtk_cmclist_get_cell_style (GtkCMCList *clist,
 638                                     gint      row,
 639                                     gint      column);
 640
 641 void gtk_cmclist_set_row_style (GtkCMCList *clist,
 642                               gint      row,
 643                               GtkStyle *style);
 644
 645 GtkStyle *gtk_cmclist_get_row_style (GtkCMCList *clist,
 646                                    gint      row);
 647
 648 /* this sets a horizontal and vertical shift for drawing
 649  * the contents of a cell; it can be positive or negitive;
 650  * this is particulary useful for indenting items in a column
 651  */
 652 void gtk_cmclist_set_shift (GtkCMCList *clist,
 653                           gint      row,
 654                           gint      column,
 655                           gint      vertical,
 656                           gint      horizontal);
 657
 658 /* set/get selectable flag of a single row */
 659 void gtk_cmclist_set_selectable (GtkCMCList *clist,
 660                                gint      row,
 661                                gboolean  selectable);
 662 gboolean gtk_cmclist_get_selectable (GtkCMCList *clist,
 663                                    gint      row);
 664
 665 /* prepend/append returns the index of the row you just added,
 666  * making it easier to append and modify a row
 667  */
 668 gint gtk_cmclist_prepend (GtkCMCList    *clist,
 669                         gchar       *text[]);
 670 gint gtk_cmclist_append  (GtkCMCList    *clist,
 671                         gchar       *text[]);
 672
 673 /* inserts a row at index row and returns the row where it was
 674  * actually inserted (may be different from "row" in auto_sort mode)
 675  */
 676 gint gtk_cmclist_insert (GtkCMCList    *clist,
 677                        gint         row,
 678                        gchar       *text[]);
 679
 680 /* removes row at index row */
 681 void gtk_cmclist_remove (GtkCMCList *clist,
 682                        gint      row);
 683
 684 /* sets a arbitrary data pointer for a given row */
 685 void gtk_cmclist_set_row_data (GtkCMCList *clist,
 686                              gint      row,
 687                              gpointer  data);
 688
 689 /* sets a data pointer for a given row with destroy notification */
 690 void gtk_cmclist_set_row_data_full (GtkCMCList         *clist,
 691                                   gint              row,
 692                                   gpointer          data,
 693                                   GDestroyNotify  destroy);
 694
 695 /* returns the data set for a row */
 696 gpointer gtk_cmclist_get_row_data (GtkCMCList *clist,
 697                                  gint      row);
 698
 699 /* givin a data pointer, find the first (and hopefully only!)
 700  * row that points to that data, or -1 if none do
 701  */
 702 gint gtk_cmclist_find_row_from_data (GtkCMCList *clist,
 703                                    gpointer  data);
 704
 705 /* force selection of a row */
 706 void gtk_cmclist_select_row (GtkCMCList *clist,
 707                            gint      row,
 708                            gint      column);
 709
 710 /* force unselection of a row */
 711 void gtk_cmclist_unselect_row (GtkCMCList *clist,
 712                              gint      row,
 713                              gint      column);
 714
 715 /* undo the last select/unselect operation */
 716 void gtk_cmclist_undo_selection (GtkCMCList *clist);
 717
 718 /* clear the entire list -- this is much faster than removing
 719  * each item with gtk_cmclist_remove
 720  */
 721 void gtk_cmclist_clear (GtkCMCList *clist);
 722
 723 /* return the row column corresponding to the x and y coordinates,
 724  * the returned values are only valid if the x and y coordinates
 725  * are respectively to a window == clist->clist_window
 726  */
 727 gint gtk_cmclist_get_selection_info (GtkCMCList *clist,
 728                                    gint      x,
 729                                    gint      y,
 730                                    gint     *row,
 731                                    gint     *column);
 732
 733 /* in multiple or extended mode, select all rows */
 734 void gtk_cmclist_select_all (GtkCMCList *clist);
 735
 736 /* in all modes except browse mode, deselect all rows */
 737 void gtk_cmclist_unselect_all (GtkCMCList *clist);
 738
 739 /* swap the position of two rows */
 740 void gtk_cmclist_swap_rows (GtkCMCList *clist,
 741                           gint      row1,
 742                           gint      row2);
 743
 744 /* move row from source_row position to dest_row position */
 745 void gtk_cmclist_row_move (GtkCMCList *clist,
 746                          gint      source_row,
 747                          gint      dest_row);
 748
 749 /* sets a compare function different to the default */
 750 void gtk_cmclist_set_compare_func (GtkCMCList            *clist,
 751                                  GtkCMCListCompareFunc  cmp_func);
 752
 753 /* the column to sort by */
 754 void gtk_cmclist_set_sort_column (GtkCMCList *clist,
 755                                 gint      column);
 756
 757 /* how to sort : ascending or descending */
 758 void gtk_cmclist_set_sort_type (GtkCMCList    *clist,
 759                               GtkSortType  sort_type);
 760
 761 /* sort the list with the current compare function */
 762 void gtk_cmclist_sort (GtkCMCList *clist);
 763
 764 /* Automatically sort upon insertion */
 765 void gtk_cmclist_set_auto_sort (GtkCMCList *clist,
 766                               gboolean  auto_sort);
 767
 768 /* Private function for clist, ctree */
 769
 770 PangoLayout *_gtk_cmclist_create_cell_layout (GtkCMCList       *clist,
 771                                             GtkCMCListRow    *clist_row,
 772                                             gint            column);
 773
 774
 775 G_END_DECLS
 776
 777
 778 #endif                          /* __GTK_CMCLIST_H__ */