GNU Info

(gtk.info)GtkCList

---

Next: GtkColorSelection Prev: GtkCheckMenuItem Up: Widgets

---

Enter node , (file) or (file)node

The compound list widget
========================

Description
-----------

   A list of rows of columns, with a title row.  You can insert rows,
and delete rows.  The user can scroll around and select a row.  Derived
from Note: GtkContainer.  Cells can be empty, have a text and/or
pixmap, or be a widget.

Options
-------

Signals
-------

Functions
---------

 - Function: guint gtk_clist_get_type (void)
     Returns the `GtkCList' type identifier.

 - Function: GtkWidget* gtk_clist_new (int COLUMNS)
     Create a new `GtkCList' initializing it with the value COLUMNS.
     The new widget is returned as a pointer to a `GtkWidget' object.
     `NULL' is returned on failure.

 - Function: GtkWidget* gtk_clist_new_with_titles (int COLUMNS, gchar
          *TITLES[])

 - Function: void gtk_clist_set_border (GtkCList *CLIST, GtkShadowType
          BORDER)
     Set the border style of the CLIST to the shadow type BORDER.

 - Function: void gtk_clist_set_selection_mode (GtkCList *CLIST
          GtkSelectionMode MODE)
     Set the selection mode on the CLIST to the MODE selection mode.

 - Function: void gtk_clist_set_policy (GtkCList *CLIST, GtkPolicyType
          VSCROLLBAR_POLICY, GtkPolicyType HSCROLLBAR_POLICY)
     Set the policy on the scrollbars on the CLIST to VSCROLLBAR_POLICY
     and HSCROLLBAR_POLICY.

 - Function: void gtk_clist_freeze (GtkCList *CLIST)
     Stop all visual updates of the CLIST. Useful for when making a
     large number of changes to a `GtkCList'.

 - Function: void gtk_clist_thaw (GtkCList *CLIST)
     Allow all visual updates of the CLIST to resume.

 - Function: void gtk_clist_column_titles_show (GtkCList *CLIST)
     Show the column title buttons on the CLIST.

 - Function: void gtk_clist_column_titles_hide (GtkCList *CLIST)
     Hide the column title buttons on the CLIST.

 - Function: void gtk_clist_set_column_title (GtkCList *CLIST, gint
          COLUMN, gchar *TITLE)
     Set the title in column COLUMN of the CLIST button to TITLE.

 - Function: void gtk_clist_set_column_widget (GtkCList *CLIST, gint
          COLUMN, GtkWidget *WIDGET)
     Set the WIDGET instead of the title button for the column COLUMN
     in the CLIST.

 - Function: void gtk_clist_set_column_justification (GtkCList *CLIST,
          gint COLUMN, GtkJustification JUSTIFICATION)
     Set the COLUMN's justification, in the CLIST to JUSTIFICATION.

 - Function: void gtk_clist_set_column_width (GtkCList *CLIST, gint
          COLUMN, gint WIDTH)
     Set the pixel width of column COLUMN in the `GtkCList' CLIST to
     WIDTH. This function is a necessary step in creating a `GtkCList'
     because otherwise the column width is chosen from the width of the
     column title, which is almost never correct.

 - Function: void gtk_clist_set_row_height (GtkCList *CLIST, gint
          HEIGHT)
     Change the height of the rows in the CLIST to HEIGHT. The default
     is the height of the current font.

 - Function: void gtk_clist_moveto (GtkCList *CLIST, gint ROW,
          gintCOLUMN, gfloat ROW_ALIGN, gfloat COL_ALIGN)
     Scroll the viewing area of the `GtkClist' in CLIST to COLUMN and
     ROW. The ROW_ALIGN and COL_ALIGN are between zero and one,
     representing the location the row should appear on screen. Setting
     ROW_ALIGN or the COL_ALIGN to 0.0 will be the top or left of the
     viewing area. Setting the ROW_ALIGN or COL_ALIGN to 1.0 will be
     the bottom or right of the viewing area. If the ROW or COLUMN is
     -1 then there is no change.

 - Function: void gtk_clist_set_text (GtkCList *CLIST, gint ROW, gint
          COLUMN, gchar *TEXT)
     Set a given cell's text, located by the ROW and COLUMN, to TEXT
     replacing its current contents.

 - Function: void gtk_clist_set_pixmap (GtkCList *CLIST, gint ROW, gint
          COLUMN, GdkPixmap *PIXMAP, GdkBitmap *MASK)
     Set a given cell's text, located by the COLUMN and ROW arguments,
     to the pixmap described by the PIXMAP argument using the MASK as
     its mask. The current contents of the cell will be replaced.

 - Function: void gtk_clist_setpixtext (GtkCList *CLIST, gint ROW, gint
          COLUMN, gchar *TEXT, guint8 SPACING, GdkPixmap *PIXMAP,
          GdkBitmap *MASK)
     Set a given cell's text and pixmap, located by the ROW and COLUMN
     arguments, to the text and pixmap described by the PIXMAP and TEXT
     arguments. The MASK will be used for the pixmap mask and the
     SPACING argument specifies the spacing between the two.

 - Function: void gtk_clist_set_foreground (GtkCList *CLIST, gint ROW,
          GdkColor *COLOR)
     Set the foreground color of row ROW to COLOR in the `GtkCList'
     CLIST. The COLOR must already be allocated.

 - Function: void gtk_clist_set_background (GtkCList *CLIST, gint ROW,
          GdkColor *COLOR)
     Set the background color of row ROW to COLOR in the `GtkCList'
     pointed to by CLIST. The color must be previously allocated.

 - Function: void gtk_clist_set_shift (GtkCList *CLIST, gint ROW, gint
          COLUMN, gint VERTICAL, gint HORIZONTAL)
     Set the horizontal and vertical shift for drawing the contents of
     the cell located at ROW and COLUMN. The VERTICAL and HORIZONTAL
     arguments can be positive or negative.

 - Function: gint gtk_clist_append (GtkCList *CLIST, gchar *TEXT[])
     Append the given text, in the TEXT[] argument,  to the `GtkCList'
     pointed to by the CLIST. The return value is the index of the row
     that was just added.

 - Function: void gtk_clist_insert (GtkCList *CLIST, gint ROW, gchar
          *TEXT[])
     Insert a row into the `GtkCList' pointed to by CLIST at row ROW
     with the text in TEXT[].

 - Function: void gtk_clist_remove (GtkCList *CLIST, gint ROW)
     Remove row index ROW from the CLIST.

 - Function: void gtk_clist_set_row_data (GtkCList *CLIST, gint ROW,
          gpointer DATA)
     Will set an arbitrary data pointer, DATA, for row ROW in the
     `GtkCList' pointed to by CLIST.

 - Function: gpointer gtk_clist_get_row_data (GtkCList *CLIST, gint ROW)
     Return the data that was set for row ROW from the `GtkCList'
     pointed to by CLIST. `NULL' is returned if no data was set.

 - Function: void gtk_clist_select_row (GtkCList *CLIST, gint ROW, gint
          COLUMN)
     Force selection of a row, located by ROW and COLUMN, in the
     `GtkCList' pointed to by CLIST.

 - Function: void gtk_clist_unselect_row (GtkCList *CLIST, gint ROW,
          gint COLUMN)
     Force the unselection of a row, located by ROW and COLUMN, in the
     `GtkCList' pointed to by CLIST.

 - Function: void gtk_clist_clear (GtkCList *CLIST)
     Clear the entire contents of the `GtkCList' pointed to by CLIST.
     This is much faster then removing each item separately with
     `gtk_clist_remove'.

 - Function: GtkCList* GTK_CLIST (gpointer OBJ)
     Cast a generic pointer to `GtkCList*'. Note: Standard Macros, for
     more info.

 - Function: GtkCListClass* GTK_CLIST_CLASS (gpointer CLASS)
     Cast a generic pointer to `GtkCListClass*'. Note: Standard
     Macros, for more info.

 - Function: gint GTK_IS_CLIST (gpointer OBJ)
     Determine if a generic pointer refers to a `GtkCList' object.
     Note: Standard Macros, for more info.