Pileus Git - ~andy/gtk/blob - gtk/gtkclist.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 Library 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  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the Free
  17  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  */
  19 #ifndef __GTK_CLIST_H__
  20 #define __GTK_CLIST_H__
  21
  22 #include <gdk/gdk.h>
  23 #include <gtk/gtksignal.h>
  24 #include <gtk/gtkalignment.h>
  25 #include <gtk/gtklabel.h>
  26 #include <gtk/gtkbutton.h>
  27 #include <gtk/gtkhscrollbar.h>
  28 #include <gtk/gtkvscrollbar.h>
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #endif                          /* __cplusplus */
  34
  35 /* clist flags */
  36 enum
  37 {
  38   CLIST_FROZEN          = 1 << 0,
  39   CLIST_IN_DRAG         = 1 << 1,
  40   CLIST_ROW_HEIGHT_SET  = 1 << 2,
  41   CLIST_SHOW_TITLES     = 1 << 3
  42 };
  43
  44 /* cell types */
  45 typedef enum
  46 {
  47   GTK_CELL_EMPTY,
  48   GTK_CELL_TEXT,
  49   GTK_CELL_PIXMAP,
  50   GTK_CELL_PIXTEXT,
  51   GTK_CELL_WIDGET
  52 } GtkCellType;
  53
  54 #define GTK_CLIST(obj)          GTK_CHECK_CAST (obj, gtk_clist_get_type (), GtkCList)
  55 #define GTK_CLIST_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, gtk_clist_get_type (), GtkCListClass)
  56 #define GTK_IS_CLIST(obj)       GTK_CHECK_TYPE (obj, gtk_clist_get_type ())
  57
  58 #define GTK_CLIST_FLAGS(clist)             (GTK_CLIST (clist)->flags)
  59 #define GTK_CLIST_SET_FLAGS(clist,flag)    (GTK_CLIST_FLAGS (clist) |= (flag))
  60 #define GTK_CLIST_UNSET_FLAGS(clist,flag)  (GTK_CLIST_FLAGS (clist) &= ~(flag))
  61
  62 #define GTK_CLIST_FROZEN(clist)            (GTK_CLIST_FLAGS (clist) & CLIST_FROZEN)
  63 #define GTK_CLIST_IN_DRAG(clist)           (GTK_CLIST_FLAGS (clist) & CLIST_IN_DRAG)
  64 #define GTK_CLIST_ROW_HEIGHT_SET(clist)    (GTK_CLIST_FLAGS (clist) & CLIST_ROW_HEIGHT_SET)
  65 #define GTK_CLIST_SHOW_TITLES(clist)       (GTK_CLIST_FLAGS (clist) & CLIST_SHOW_TITLES)
  66
  67 /* pointer casting for cells */
  68 #define GTK_CELL_TEXT(cell)     (((GtkCellText *) &(cell)))
  69 #define GTK_CELL_PIXMAP(cell)   (((GtkCellPixmap *) &(cell)))
  70 #define GTK_CELL_PIXTEXT(cell)  (((GtkCellPixText *) &(cell)))
  71 #define GTK_CELL_WIDGET(cell)   (((GtkCellWidget *) &(cell)))
  72
  73 typedef struct _GtkCList GtkCList;
  74 typedef struct _GtkCListClass GtkCListClass;
  75 typedef struct _GtkCListColumn GtkCListColumn;
  76 typedef struct _GtkCListRow GtkCListRow;
  77
  78 typedef struct _GtkCell GtkCell;
  79 typedef struct _GtkCellText GtkCellText;
  80 typedef struct _GtkCellPixmap GtkCellPixmap;
  81 typedef struct _GtkCellPixText GtkCellPixText;
  82 typedef struct _GtkCellWidget GtkCellWidget;
  83
  84 struct _GtkCList
  85 {
  86   GtkContainer container;
  87
  88   guint8 flags;
  89
  90   /* allocation rectangle after the conatiner_border_width
  91    * and the width of the shadow border */
  92   GdkRectangle internal_allocation;
  93
  94   /* memory chunks */
  95   GMemChunk *row_mem_chunk;
  96   GMemChunk *cell_mem_chunk;
  97
  98   /* rows */
  99   gint rows;
 100   gint row_center_offset;
 101   gint row_height;
 102   GList *row_list;
 103   GList *row_list_end;
 104
 105   /* columns */
 106   gint columns;
 107   GdkRectangle column_title_area;
 108   GdkWindow *title_window;
 109
 110   /* dynamicly allocated array of column structures */
 111   GtkCListColumn *column;
 112
 113   /*the scrolling window and it's height and width to
 114    * make things a little speedier */
 115   GdkWindow *clist_window;
 116   gint clist_window_width;
 117   gint clist_window_height;
 118
 119   /* offsets for scrolling */
 120   gint hoffset;
 121   gint voffset;
 122
 123   /* border shadow style */
 124   GtkShadowType shadow_type;
 125
 126   /* the list's selection mode (gtkenums.h) */
 127   GtkSelectionMode selection_mode;
 128
 129   /* list of selected rows */
 130   GList *selection;
 131
 132   /* scrollbars */
 133   GtkWidget *vscrollbar;
 134   GtkWidget *hscrollbar;
 135   guint8 vscrollbar_policy;
 136   guint8 hscrollbar_policy;
 137
 138   /* xor GC for the verticle drag line */
 139   GdkGC *xor_gc;
 140
 141   /* gc for drawing unselected cells */
 142   GdkGC *fg_gc;
 143   GdkGC *bg_gc;
 144
 145   /* cursor used to indicate dragging */
 146   GdkCursor *cursor_drag;
 147
 148   /* the current x-pixel location of the xor-drag line */
 149   gint x_drag;
 150 };
 151
 152 struct _GtkCListClass
 153 {
 154   GtkContainerClass parent_class;
 155
 156   void (*select_row) (GtkCList * clist,
 157                       gint row,
 158                       gint column,
 159                       GdkEventButton * event);
 160   void (*unselect_row) (GtkCList * clist,
 161                         gint row,
 162                         gint column,
 163                         GdkEventButton * event);
 164   void (*click_column) (GtkCList * clist,
 165                         gint column);
 166
 167   gint scrollbar_spacing;
 168 };
 169
 170 struct _GtkCListColumn
 171 {
 172   gchar *title;
 173   GdkRectangle area;
 174
 175   GtkWidget *button;
 176   GdkWindow *window;
 177
 178   gint width;
 179   GtkJustification justification;
 180 };
 181
 182 struct _GtkCListRow
 183 {
 184   GtkCell *cell;
 185   GtkStateType state;
 186
 187   GdkColor foreground;
 188   GdkColor background;
 189
 190   gpointer data;
 191 };
 192
 193 /* Cell Structures */
 194 struct _GtkCellText
 195 {
 196   GtkCellType type;
 197
 198   gint verticle;
 199   gint horizontal;
 200
 201   gchar *text;
 202 };
 203
 204 struct _GtkCellPixmap
 205 {
 206   GtkCellType type;
 207
 208   gint verticle;
 209   gint horizontal;
 210
 211   GdkPixmap *pixmap;
 212   GdkBitmap *mask;
 213 };
 214
 215 struct _GtkCellPixText
 216 {
 217   GtkCellType type;
 218
 219   gint verticle;
 220   gint horizontal;
 221
 222   gchar *text;
 223   guint8 spacing;
 224   GdkPixmap *pixmap;
 225   GdkBitmap *mask;
 226 };
 227
 228 struct _GtkCellWidget
 229 {
 230   GtkCellType type;
 231
 232   gint verticle;
 233   gint horizontal;
 234
 235   GtkWidget *widget;
 236 };
 237
 238 struct _GtkCell
 239 {
 240   GtkCellType type;
 241
 242   gint verticle;
 243   gint horizontal;
 244
 245   union {
 246     gchar *text;
 247
 248     struct {
 249       GdkPixmap *pixmap;
 250       GdkBitmap *mask;
 251     } pm;
 252
 253     struct {
 254       gchar *text;
 255       guint8 spacing;
 256       GdkPixmap *pixmap;
 257       GdkBitmap *mask;
 258     } pt;
 259
 260     GtkWidget *widget;
 261   } u;
 262 };
 263
 264 guint gtk_clist_get_type (void);
 265
 266 /* create a new GtkCList */
 267 GtkWidget *gtk_clist_new (int columns);
 268 GtkWidget *gtk_clist_new_with_titles (int columns,
 269                                       gchar * titles[]);
 270
 271 /* set the border style of the clist */
 272 void gtk_clist_set_border (GtkCList * clist,
 273                            GtkShadowType border);
 274
 275 /* set the clist's selection mode */
 276 void gtk_clist_set_selection_mode (GtkCList * clist,
 277                                    GtkSelectionMode mode);
 278
 279 /* set policy on the scrollbar, to either show them all the time
 280  * or show them only when they are needed, ie., when there is more than one page
 281  * of information */
 282 void gtk_clist_set_policy (GtkCList * clist,
 283                            GtkPolicyType vscrollbar_policy,
 284                            GtkPolicyType hscrollbar_policy);
 285
 286 /* freeze all visual updates of the list, and then thaw the list after you have made
 287  * a number of changes and the updates wil occure in a more efficent mannor than if
 288  * you made them on a unfrozen list */
 289 void gtk_clist_freeze (GtkCList * clist);
 290 void gtk_clist_thaw (GtkCList * clist);
 291
 292 /* show and hide the column title buttons */
 293 void gtk_clist_column_titles_show (GtkCList * clist);
 294 void gtk_clist_column_titles_hide (GtkCList * clist);
 295
 296 /* set the title in the column title button */
 297 void gtk_clist_set_column_title (GtkCList * clist,
 298                                  gint column,
 299                                  gchar * title);
 300
 301 /* set a widget instead of a title for the column title button */
 302 void gtk_clist_set_column_widget (GtkCList * clist,
 303                                   gint column,
 304                                   GtkWidget * widget);
 305
 306 /* set the justification on a column */
 307 void gtk_clist_set_column_justification (GtkCList * clist,
 308                                          gint column,
 309                                          GtkJustification justification);
 310
 311 /* set the pixel width of a column; this is a necessary step in
 312  * creating a CList because otherwise the column width is chozen from
 313  * the width of the column title, which will never be right */
 314 void gtk_clist_set_column_width (GtkCList * clist,
 315                                  gint column,
 316                                  gint width);
 317
 318 /* change the height of the rows, the default is the hight of the current
 319  * font */
 320 void gtk_clist_set_row_height (GtkCList * clist,
 321                                gint height);
 322
 323 /* scroll the viewing area of the list to the given column
 324  * and row; row_align and col_align are between 0-1 representing the
 325  * location the row should appear on the screnn, 0.0 being top or left,
 326  * 1.0 being bottom or right; if row or column is -1 then then there
 327  * is no change */
 328 void gtk_clist_moveto (GtkCList * clist,
 329                        gint row,
 330                        gint column,
 331                        gfloat row_align,
 332                        gfloat col_align);
 333
 334 /* sets a given cell's text, replacing it's current contents */
 335 void gtk_clist_set_text (GtkCList * clist,
 336                          gint row,
 337                          gint column,
 338                          gchar * text);
 339
 340 /* sets a given cell's pixmap, replacing it's current contents */
 341 void gtk_clist_set_pixmap (GtkCList * clist,
 342                            gint row,
 343                            gint column,
 344                            GdkPixmap * pixmap,
 345                            GdkBitmap * mask);
 346
 347 /* sets a given cell's pixmap and text, replacing it's current contents */
 348 void gtk_clist_set_pixtext (GtkCList * clist,
 349                             gint row,
 350                             gint column,
 351                             gchar * text,
 352                             guint8 spacing,
 353                             GdkPixmap * pixmap,
 354                             GdkBitmap * mask);
 355
 356 /* sets the foreground color of a row, the colar must already
 357  * be allocated */
 358 void gtk_clist_set_foreground (GtkCList * clist,
 359                                gint row,
 360                                GdkColor * color);
 361
 362 /* sets the background color of a row, the colar must already
 363  * be allocated */
 364 void gtk_clist_set_background (GtkCList * clist,
 365                                gint row,
 366                                GdkColor * color);
 367
 368 /* this sets a horizontal and verticle shift for drawing
 369  * the contents of a cell; it can be positive or negitive; this is
 370  * partuculary useful for indenting items in a column */
 371 void gtk_clist_set_shift (GtkCList * clist,
 372                           gint row,
 373                           gint column,
 374                           gint verticle,
 375                           gint horizontal);
 376
 377 /* append returns the index of the row you just added, making
 378  * it easier to append and modify a row */
 379 gint gtk_clist_append (GtkCList * clist,
 380                        gchar * text[]);
 381
 382 /* inserts a row at index row */
 383 void gtk_clist_insert (GtkCList * clist,
 384                        gint row,
 385                        gchar * text[]);
 386
 387 /* removes row at index row */
 388 void gtk_clist_remove (GtkCList * clist,
 389                        gint row);
 390
 391 /* sets a arbitrary data pointer for a given row */
 392 void gtk_clist_set_row_data (GtkCList * clist,
 393                              gint row,
 394                              gpointer data);
 395
 396 /* returns the data set for a row */
 397 gpointer gtk_clist_get_row_data (GtkCList * clist,
 398                                  gint row);
 399
 400 /* force selection of a row */
 401 void gtk_clist_select_row (GtkCList * clist,
 402                            gint row,
 403                            gint column);
 404
 405 /* force unselection of a row */
 406 void gtk_clist_unselect_row (GtkCList * clist,
 407                              gint row,
 408                              gint column);
 409
 410 /* clear the entire list -- this is much faster than removing each item
 411  * with gtk_clist_remove */
 412 void gtk_clist_clear (GtkCList * clist);
 413
 414 #ifdef __cplusplus
 415 }
 416 #endif                          /* __cplusplus */
 417
 418
 419 #endif                          /* __GTK_CLIST_H__ */