Added column list widget GtkCList. -Jay Painter

gtk/Makefile.am

@@ -16,6 +16,7 @@ libgtk_la_SOURCES = \
 	gtkbutton.c		\
 	gtkcheckbutton.c	\
 	gtkcheckmenuitem.c	\
+	gtkclist.c		\
 	gtkcolorsel.c		\
 	gtkcontainer.c		\
 	gtkcurve.c		\
@@ -103,6 +104,7 @@ gtkinclude_HEADERS = \
 	gtkbutton.h		\
 	gtkcheckbutton.h	\
 	gtkcheckmenuitem.h	\
+	gtkclist.h		\
 	gtkcolorsel.h		\
 	gtkcontainer.h		\
 	gtkcurve.h		\

gtk/gtk.h

@@ -31,6 +31,7 @@
 #include <gtk/gtkbutton.h>
 #include <gtk/gtkcheckbutton.h>
 #include <gtk/gtkcheckmenuitem.h>
+#include <gtk/gtkclist.h>
 #include <gtk/gtkcolorsel.h>
 #include <gtk/gtkcontainer.h>
 #include <gtk/gtkcurve.h>

gtk/gtkclist.h

@@ -0,0 +1,405 @@
+/* GTK - The GIMP Toolkit
+ * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
+ * Copyright (C) 1997-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the Free
+ * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+#ifndef __GTK_CLIST_H__
+#define __GTK_CLIST_H__
+
+#include <gdk/gdk.h>
+#include <gtk/gtksignal.h>
+#include <gtk/gtkalignment.h>
+#include <gtk/gtklabel.h>
+#include <gtk/gtkbutton.h>
+#include <gtk/gtkhscrollbar.h>
+#include <gtk/gtkvscrollbar.h>
+
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif				/* __cplusplus */
+
+/* clist flags */
+enum                    
+{
+  CLIST_FROZEN          = 1 << 0,                                     
+  CLIST_IN_DRAG         = 1 << 1,                                        
+  CLIST_ROW_HEIGHT_SET  = 1 << 2
+}; 
+
+/* cell types */
+typedef enum
+{
+  GTK_CELL_EMPTY,
+  GTK_CELL_TEXT,
+  GTK_CELL_PIXMAP,
+  GTK_CELL_PIXTEXT,
+  GTK_CELL_WIDGET
+} GtkCellType;
+
+#define GTK_CLIST(obj)          GTK_CHECK_CAST (obj, gtk_clist_get_type (), GtkCList)
+#define GTK_CLIST_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, gtk_clist_get_type (), GtkCListClass)
+#define GTK_IS_CLIST(obj)       GTK_CHECK_TYPE (obj, gtk_clist_get_type ())
+
+#define GTK_CLIST_FLAGS(clist)             (GTK_CLIST (clist)->flags)
+#define GTK_CLIST_SET_FLAGS(clist,flag)    (GTK_CLIST_FLAGS (clist) |= (flag))
+#define GTK_CLIST_UNSET_FLAGS(clist,flag)  (GTK_CLIST_FLAGS (clist) &= ~(flag))
+
+#define GTK_CLIST_FROZEN(clist)            (GTK_CLIST_FLAGS (clist) & CLIST_FROZEN)
+#define GTK_CLIST_IN_DRAG(clist)           (GTK_CLIST_FLAGS (clist) & CLIST_IN_DRAG)
+#define GTK_CLIST_ROW_HEIGHT_SET(clist)    (GTK_CLIST_FLAGS (clist) & CLIST_ROW_HEIGHT_SET)
+
+/* pointer casting for cells */
+#define GTK_CELL_TEXT(cell)     (((GtkCellText *) &(cell)))
+#define GTK_CELL_PIXMAP(cell)   (((GtkCellPixmap *) &(cell)))
+#define GTK_CELL_PIXTEXT(cell)  (((GtkCellPixText *) &(cell)))
+#define GTK_CELL_WIDGET(cell)   (((GtkCellWidget *) &(cell)))
+
+typedef struct _GtkCList GtkCList;
+typedef struct _GtkCListClass GtkCListClass;
+typedef struct _GtkCListColumn GtkCListColumn;
+typedef struct _GtkCListRow GtkCListRow;
+
+typedef struct _GtkCell GtkCell;
+typedef struct _GtkCellText GtkCellText;
+typedef struct _GtkCellPixmap GtkCellPixmap;
+typedef struct _GtkCellPixText GtkCellPixText;
+typedef struct _GtkCellWidget GtkCellWidget;
+
+struct _GtkCList
+{
+  GtkContainer container;
+  
+  guint8 flags;
+
+  /* allocation rectangle after the conatiner_border_width
+   * and the width of the shadow border */
+  GdkRectangle internal_allocation;
+  
+  /* memory chunks */
+  GMemChunk *row_mem_chunk;
+  GMemChunk *cell_mem_chunk;
+
+  /* rows */
+  gint rows;
+  gint row_center_offset;
+  gint row_height;
+  GList *row_list;
+  GList *row_list_end;
+  
+  /* columns */
+  gint columns;
+  GdkRectangle column_title_area;
+  GdkWindow *title_window;
+  
+  /* dynamicly allocated array of column structures */
+  GtkCListColumn *column;
+  
+  /*the scrolling window and it's height and width to
+   * make things a little speedier */
+  GdkWindow *clist_window;
+  gint clist_window_width;
+  gint clist_window_height;
+  
+  /* offsets for scrolling */
+  gint hoffset;
+  gint voffset;
+  
+  /* border shadow style */
+  GtkShadowType shadow_type;
+  
+  /* the list's selection mode (gtkenums.h) */
+  GtkSelectionMode selection_mode;
+
+  /* scrollbars */
+  GtkWidget *vscrollbar;
+  GtkWidget *hscrollbar;
+  guint8 vscrollbar_policy;
+  guint8 hscrollbar_policy;
+
+  /* xor GC for the verticle drag line */
+  GdkGC *xor_gc;
+
+  /* gc for drawing unselected cells */
+  GdkGC *fg_gc;
+  GdkGC *bg_gc;
+
+  /* cursor used to indicate dragging */
+  GdkCursor *cursor_drag;
+
+  /* the current x-pixel location of the xor-drag line */
+  gint x_drag;
+};
+
+struct _GtkCListClass
+{
+  GtkContainerClass parent_class;
+  
+  void (*select_row) (GtkCList * clist,
+		      gint row,
+		      gint column,
+		      GdkEventButton * event);
+  void (*unselect_row) (GtkCList * clist,
+			gint row,
+			gint column,
+			GdkEventButton * event);
+  void (*click_column) (GtkCList * clist,
+			gint column);
+};
+
+struct _GtkCListColumn
+{
+  gchar *title;
+  GdkRectangle area;
+  
+  GtkWidget *button;
+  gint width;
+  GtkJustification justification;
+};
+
+struct _GtkCListRow
+{
+  GtkCell *cell;
+  GtkStateType state;
+
+  GdkColor foreground;
+  GdkColor background;
+
+  gpointer data;
+};
+
+/* Cell Structures */
+struct _GtkCellText
+{
+  GtkCellType type;
+  
+  gint verticle;
+  gint horizontal;
+  
+  gchar *text;
+};
+
+struct _GtkCellPixmap
+{
+  GtkCellType type;
+  
+  gint verticle;
+  gint horizontal;
+  
+  GdkPixmap *pixmap;
+  GdkBitmap *mask;
+};
+
+struct _GtkCellPixText
+{
+  GtkCellType type;
+  
+  gint verticle;
+  gint horizontal;
+  
+  gchar *text;
+  guint8 spacing;
+  GdkPixmap *pixmap;
+  GdkBitmap *mask;
+};
+
+struct _GtkCellWidget
+{
+  GtkCellType type;
+  
+  gint verticle;
+  gint horizontal;
+  
+  GtkWidget *widget;
+};
+
+struct _GtkCell
+{
+  GtkCellType type;
+
+  gint verticle;
+  gint horizontal;
+
+  union {
+    gchar *text;
+
+    struct {
+      GdkPixmap *pixmap;
+      GdkBitmap *mask;
+    } pm;
+
+    struct {
+      gchar *text;
+      guint8 spacing;
+      GdkPixmap *pixmap;
+      GdkBitmap *mask;
+    } pt;
+
+    GtkWidget *widget;
+  } u;
+};
+
+guint gtk_clist_get_type (void);
+
+/* create a new GtkCList */
+GtkWidget *gtk_clist_new (int columns,
+			  gchar * titles[]);
+
+/* set the border style of the clist */
+void gtk_clist_set_border (GtkCList * clist,
+			   GtkShadowType border);
+
+/* set the clist's selection mode */
+void gtk_clist_set_selection_mode (GtkCList * clist,
+				   GtkSelectionMode mode);
+
+/* set policy on the scrollbar, to either show them all the time
+ * or show them only when they are needed, ie., when there is more than one page
+ * of information */
+void gtk_clist_set_policy (GtkCList * clist,
+			   GtkPolicyType vscrollbar_policy,
+			   GtkPolicyType hscrollbar_policy);
+
+/* freeze all visual updates of the list, and then thaw the list after you have made
+ * a number of changes and the updates wil occure in a more efficent mannor than if
+ * you made them on a unfrozen list */
+void gtk_clist_freeze (GtkCList * clist);
+void gtk_clist_thaw (GtkCList * clist);
+
+/* set the title in the column title button */
+void gtk_clist_set_column_title (GtkCList * clist,
+				 gint column,
+				 gchar * title);
+
+/* set a widget instead of a title for the column title button */
+void gtk_clist_set_column_widget (GtkCList * clist,
+				  gint column,
+				  GtkWidget * widget);
+
+/* set the justification on a column */
+void gtk_clist_set_column_justification (GtkCList * clist,
+					 gint column,
+					 GtkJustification justification);
+
+/* set the pixel width of a column; this is a necessary step in
+ * creating a CList because otherwise the column width is chozen from
+ * the width of the column title, which will never be right */
+void gtk_clist_set_column_width (GtkCList * clist,
+				 gint column,
+				 gint width);
+
+/* change the height of the rows, the default is the hight of the current
+ * font */
+void gtk_clist_set_row_height (GtkCList * clist,
+			       gint height);
+
+/* scroll the viewing area of the list to the given column
+ * and row; row_align and col_align are between 0-1 representing the
+ * location the row should appear on the screnn, 0.0 being top or left,
+ * 1.0 being bottom or right */
+void gtk_clist_moveto (GtkCList * clist,
+		       gint row,
+		       gint column,
+		       gfloat row_align,
+		       gfloat col_align);
+
+/* sets a given cell's text, replacing it's current contents */
+void gtk_clist_set_text (GtkCList * clist,
+			 gint row,
+			 gint column,
+			 gchar * text);
+
+/* sets a given cell's pixmap, replacing it's current contents */
+void gtk_clist_set_pixmap (GtkCList * clist,
+			   gint row,
+			   gint column,
+			   GdkPixmap * pixmap,
+			   GdkBitmap * mask);
+
+/* sets a given cell's pixmap and text, replacing it's current contents */
+void gtk_clist_set_pixtext (GtkCList * clist,
+			    gint row,
+			    gint column,
+			    gchar * text,
+			    guint8 spacing,
+			    GdkPixmap * pixmap,
+			    GdkBitmap * mask);
+
+/* sets the foreground color of a row, the colar must already
+ * be allocated */
+void gtk_clist_set_foreground (GtkCList * clist,
+			       gint row,
+			       GdkColor * color);
+
+/* sets the background color of a row, the colar must already
+ * be allocated */
+void gtk_clist_set_background (GtkCList * clist,
+			       gint row,
+			       GdkColor * color);
+
+/* this sets a horizontal and verticle shift for drawing
+ * the contents of a cell; it can be positive or negitive; this is
+ * partuculary useful for indenting items in a column */
+void gtk_clist_set_shift (GtkCList * clist,
+			  gint row,
+			  gint column,
+			  gint verticle,
+			  gint horizontal);
+
+/* append returns the index of the row you just added, making
+ * it easier to append and modify a row */
+gint gtk_clist_append (GtkCList * clist,
+		       gchar * text[]);
+
+/* inserts a row at index row */
+void gtk_clist_insert (GtkCList * clist,
+		       gint row,
+		       gchar * text[]);
+
+/* removes row at index row */
+void gtk_clist_remove (GtkCList * clist,
+		       gint row);
+
+/* sets a arbitrary data pointer for a given row */
+void gtk_clist_set_row_data (GtkCList * clist,
+			     gint row,
+			     gpointer data);
+
+/* returns the data set for a row */
+gpointer gtk_clist_get_row_data (GtkCList * clist,
+				 gint row);
+
+/* force selection of a row */
+void gtk_clist_select_row (GtkCList * clist,
+			   gint row,
+			   gint column);
+
+/* force unselection of a row */
+void gtk_clist_unselect_row (GtkCList * clist,
+			     gint row,
+			     gint column);
+
+/* clear the entire list -- this is much faster than removing each item 
+ * with gtk_clist_remove */
+void gtk_clist_clear (GtkCList * clist);
+
+#ifdef __cplusplus
+}
+#endif				/* __cplusplus */
+
+
+#endif				/* __GTK_CLIST_H__ */

gtk/testgtk.c

@@ -1558,6 +1558,108 @@ create_list ()
     gtk_widget_destroy (window);
 }
 
+void
+create_clist ()
+{
+  gint i;
+  static GtkWidget *window = NULL;
+
+  static char *titles[] =
+  {
+    "Title 0",
+    "Title 1",
+    "Title 2",
+    "Title 3",
+    "Title 4",
+    "Title 5",
+    "Title 6"
+  };
+  static int columns = sizeof (titles) / sizeof (titles[0]);
+
+  GtkWidget *box1;
+  GtkWidget *box2;
+  GtkWidget *clist;
+  GtkWidget *button;
+  GtkWidget *separator;
+
+
+  if (!window)
+    {
+      window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+
+      gtk_signal_connect (GTK_OBJECT (window), "destroy",
+			  GTK_SIGNAL_FUNC(destroy_window),
+			  &window);
+      gtk_signal_connect (GTK_OBJECT (window), "delete_event",
+			  GTK_SIGNAL_FUNC(destroy_window),
+			  &window);
+
+      gtk_window_set_title (GTK_WINDOW (window), "clist");
+      gtk_container_border_width (GTK_CONTAINER (window), 0);
+
+
+      box1 = gtk_vbox_new (FALSE, 0);
+      gtk_container_add (GTK_CONTAINER (window), box1);
+      gtk_widget_show (box1);
+
+
+      box2 = gtk_vbox_new (FALSE, 10);
+      gtk_container_border_width (GTK_CONTAINER (box2), 10);
+      gtk_box_pack_start (GTK_BOX (box1), box2, TRUE, TRUE, 0);
+      gtk_widget_show (box2);
+
+
+      clist = gtk_clist_new (columns, titles);
+
+      gtk_clist_set_row_height (GTK_CLIST (clist), 20);
+      
+      for (i = 0; i < columns; i++)
+	gtk_clist_set_column_width (GTK_CLIST (clist), i, 50);
+
+      gtk_clist_set_selection_mode (GTK_CLIST (clist), GTK_SELECTION_BROWSE);
+
+      gtk_clist_set_policy (GTK_CLIST (clist), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
+
+      gtk_clist_set_column_justification (GTK_CLIST (clist), 1, GTK_JUSTIFY_RIGHT);
+      gtk_clist_set_column_justification (GTK_CLIST (clist), 2, GTK_JUSTIFY_RIGHT);
+
+      for (i = 0; i < 100; i++)
+	gtk_clist_append (GTK_CLIST (clist), titles);
+
+
+      gtk_container_border_width (GTK_CONTAINER (clist), 5);
+      gtk_box_pack_start (GTK_BOX (box2), clist, TRUE, TRUE, 0);
+      gtk_widget_show (clist);
+
+
+      separator = gtk_hseparator_new ();
+      gtk_box_pack_start (GTK_BOX (box1), separator, FALSE, TRUE, 0);
+      gtk_widget_show (separator);
+
+      box2 = gtk_vbox_new (FALSE, 10);
+      gtk_container_border_width (GTK_CONTAINER (box2), 10);
+      gtk_box_pack_start (GTK_BOX (box1), box2, FALSE, TRUE, 0);
+      gtk_widget_show (box2);
+
+      button = gtk_button_new_with_label ("close");
+      gtk_signal_connect_object (GTK_OBJECT (button), "clicked",
+				 GTK_SIGNAL_FUNC(gtk_widget_destroy),
+				 GTK_OBJECT (window));
+
+      gtk_box_pack_start (GTK_BOX (box2), button, TRUE, TRUE, 0);
+      GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
+      gtk_widget_grab_default (button);
+
+      gtk_widget_show (button);
+    }
+
+  if (!GTK_WIDGET_VISIBLE (window))
+    gtk_widget_show (window);
+  else
+    gtk_widget_destroy (window);
+
+}
+
 void
 color_selection_ok (GtkWidget               *w,
                     GtkColorSelectionDialog *cs)
@@ -3529,6 +3631,7 @@ create_main_window ()
       { "drawing areas", NULL },
       { "entry", create_entry },
       { "list", create_list },
+      { "clist", create_clist},
       { "color selection", create_color_selection },
       { "file selection", create_file_selection },
       { "dialog", create_dialog },

gtk/testgtkrc

@@ -28,8 +28,8 @@ style "scale"
 
 style "button"
 {
-  fg[PRELIGHT] = { 1.0, 1.0, 1.0 }
+#  fg[PRELIGHT] = { 1.0, 1.0, 1.0 }
-  bg[PRELIGHT] = { 0, 0, 0.75 }
+#  bg[PRELIGHT] = { 0, 0, 0.75 }
 }
 
 style "main_button" = "button"
@@ -61,7 +61,7 @@ style "curve"
   fg[NORMAL] = { 58000, 0, 0 }			# red
 }
 
-widget_class "*" style "default"
+#widget_class "*" style "default"
 widget_class "GtkWindow" style "window"
 widget_class "GtkDialog" style "window"
 widget_class "GtkFileSelection" style "window"

tests/testgtk.c

@@ -1558,6 +1558,108 @@ create_list ()
     gtk_widget_destroy (window);
 }
 
+void
+create_clist ()
+{
+  gint i;
+  static GtkWidget *window = NULL;
+
+  static char *titles[] =
+  {
+    "Title 0",
+    "Title 1",
+    "Title 2",
+    "Title 3",
+    "Title 4",
+    "Title 5",
+    "Title 6"
+  };
+  static int columns = sizeof (titles) / sizeof (titles[0]);
+
+  GtkWidget *box1;
+  GtkWidget *box2;
+  GtkWidget *clist;
+  GtkWidget *button;
+  GtkWidget *separator;
+
+
+  if (!window)
+    {
+      window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+
+      gtk_signal_connect (GTK_OBJECT (window), "destroy",
+			  GTK_SIGNAL_FUNC(destroy_window),
+			  &window);
+      gtk_signal_connect (GTK_OBJECT (window), "delete_event",
+			  GTK_SIGNAL_FUNC(destroy_window),
+			  &window);
+
+      gtk_window_set_title (GTK_WINDOW (window), "clist");
+      gtk_container_border_width (GTK_CONTAINER (window), 0);
+
+
+      box1 = gtk_vbox_new (FALSE, 0);
+      gtk_container_add (GTK_CONTAINER (window), box1);
+      gtk_widget_show (box1);
+
+
+      box2 = gtk_vbox_new (FALSE, 10);
+      gtk_container_border_width (GTK_CONTAINER (box2), 10);
+      gtk_box_pack_start (GTK_BOX (box1), box2, TRUE, TRUE, 0);
+      gtk_widget_show (box2);
+
+
+      clist = gtk_clist_new (columns, titles);
+
+      gtk_clist_set_row_height (GTK_CLIST (clist), 20);
+      
+      for (i = 0; i < columns; i++)
+	gtk_clist_set_column_width (GTK_CLIST (clist), i, 50);
+
+      gtk_clist_set_selection_mode (GTK_CLIST (clist), GTK_SELECTION_BROWSE);
+
+      gtk_clist_set_policy (GTK_CLIST (clist), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
+
+      gtk_clist_set_column_justification (GTK_CLIST (clist), 1, GTK_JUSTIFY_RIGHT);
+      gtk_clist_set_column_justification (GTK_CLIST (clist), 2, GTK_JUSTIFY_RIGHT);
+
+      for (i = 0; i < 100; i++)
+	gtk_clist_append (GTK_CLIST (clist), titles);
+
+
+      gtk_container_border_width (GTK_CONTAINER (clist), 5);
+      gtk_box_pack_start (GTK_BOX (box2), clist, TRUE, TRUE, 0);
+      gtk_widget_show (clist);
+
+
+      separator = gtk_hseparator_new ();
+      gtk_box_pack_start (GTK_BOX (box1), separator, FALSE, TRUE, 0);
+      gtk_widget_show (separator);
+
+      box2 = gtk_vbox_new (FALSE, 10);
+      gtk_container_border_width (GTK_CONTAINER (box2), 10);
+      gtk_box_pack_start (GTK_BOX (box1), box2, FALSE, TRUE, 0);
+      gtk_widget_show (box2);
+
+      button = gtk_button_new_with_label ("close");
+      gtk_signal_connect_object (GTK_OBJECT (button), "clicked",
+				 GTK_SIGNAL_FUNC(gtk_widget_destroy),
+				 GTK_OBJECT (window));
+
+      gtk_box_pack_start (GTK_BOX (box2), button, TRUE, TRUE, 0);
+      GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
+      gtk_widget_grab_default (button);
+
+      gtk_widget_show (button);
+    }
+
+  if (!GTK_WIDGET_VISIBLE (window))
+    gtk_widget_show (window);
+  else
+    gtk_widget_destroy (window);
+
+}
+
 void
 color_selection_ok (GtkWidget               *w,
                     GtkColorSelectionDialog *cs)
@@ -3529,6 +3631,7 @@ create_main_window ()
       { "drawing areas", NULL },
       { "entry", create_entry },
       { "list", create_list },
+      { "clist", create_clist},
       { "color selection", create_color_selection },
       { "file selection", create_file_selection },
       { "dialog", create_dialog },

tests/testgtkrc

@@ -28,8 +28,8 @@ style "scale"
 
 style "button"
 {
-  fg[PRELIGHT] = { 1.0, 1.0, 1.0 }
+#  fg[PRELIGHT] = { 1.0, 1.0, 1.0 }
-  bg[PRELIGHT] = { 0, 0, 0.75 }
+#  bg[PRELIGHT] = { 0, 0, 0.75 }
 }
 
 style "main_button" = "button"
@@ -61,7 +61,7 @@ style "curve"
   fg[NORMAL] = { 58000, 0, 0 }			# red
 }
 
-widget_class "*" style "default"
+#widget_class "*" style "default"
 widget_class "GtkWindow" style "window"
 widget_class "GtkDialog" style "window"
 widget_class "GtkFileSelection" style "window"