GTK+ 2 Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
#include <gtk/gtk.h> struct GtkCList; enum GtkCellType; enum GtkButtonAction; #define GTK_CLIST_FLAGS (clist) #define GTK_CLIST_SET_FLAG (clist, flag) #define GTK_CLIST_UNSET_FLAG (clist, flag) #define GTK_CLIST_IN_DRAG (clist) #define GTK_CLIST_ROW_HEIGHT_SET (clist) #define GTK_CLIST_SHOW_TITLES (clist) #define GTK_CLIST_ADD_MODE (clist) #define GTK_CLIST_AUTO_SORT (clist) #define GTK_CLIST_AUTO_RESIZE_BLOCKED (clist) #define GTK_CLIST_REORDERABLE (clist) #define GTK_CLIST_USE_DRAG_ICONS (clist) #define GTK_CLIST_DRAW_DRAG_LINE (clist) #define GTK_CLIST_DRAW_DRAG_RECT (clist) #define GTK_CLIST_ROW (_glist_) #define GTK_CELL_TEXT (cell) #define GTK_CELL_PIXMAP (cell) #define GTK_CELL_PIXTEXT (cell) #define GTK_CELL_WIDGET (cell) gint (*GtkCListCompareFunc) (GtkCList *clist
,gconstpointer ptr1
,gconstpointer ptr2
); struct GtkCListColumn; struct GtkCListRow; struct GtkCellText; struct GtkCellPixmap; struct GtkCellPixText; struct GtkCellWidget; struct GtkCell; struct GtkCListCellInfo; struct GtkCListDestInfo; enum GtkCListDragPos; GtkWidget * gtk_clist_new (gint columns
); GtkWidget * gtk_clist_new_with_titles (gint columns
,gchar *titles[]
); void gtk_clist_set_shadow_type (GtkCList *clist
,GtkShadowType type
); void gtk_clist_set_selection_mode (GtkCList *clist
,GtkSelectionMode mode
); void gtk_clist_freeze (GtkCList *clist
); void gtk_clist_thaw (GtkCList *clist
); void gtk_clist_column_titles_show (GtkCList *clist
); void gtk_clist_column_titles_hide (GtkCList *clist
); void gtk_clist_column_title_active (GtkCList *clist
,gint column
); void gtk_clist_column_title_passive (GtkCList *clist
,gint column
); void gtk_clist_column_titles_active (GtkCList *clist
); void gtk_clist_column_titles_passive (GtkCList *clist
); void gtk_clist_set_column_title (GtkCList *clist
,gint column
,const gchar *title
); void gtk_clist_set_column_widget (GtkCList *clist
,gint column
,GtkWidget *widget
); void gtk_clist_set_column_justification (GtkCList *clist
,gint column
,GtkJustification justification
); void gtk_clist_set_column_visibility (GtkCList *clist
,gint column
,gboolean visible
); void gtk_clist_set_column_resizeable (GtkCList *clist
,gint column
,gboolean resizeable
); void gtk_clist_set_column_auto_resize (GtkCList *clist
,gint column
,gboolean auto_resize
); gint gtk_clist_optimal_column_width (GtkCList *clist
,gint column
); void gtk_clist_set_column_width (GtkCList *clist
,gint column
,gint width
); void gtk_clist_set_column_min_width (GtkCList *clist
,gint column
,gint min_width
); void gtk_clist_set_column_max_width (GtkCList *clist
,gint column
,gint max_width
); void gtk_clist_set_row_height (GtkCList *clist
,guint height
); void gtk_clist_moveto (GtkCList *clist
,gint row
,gint column
,gfloat row_align
,gfloat col_align
); GtkVisibility gtk_clist_row_is_visible (GtkCList *clist
,gint row
); GtkCellType gtk_clist_get_cell_type (GtkCList *clist
,gint row
,gint column
); void gtk_clist_set_text (GtkCList *clist
,gint row
,gint column
,const gchar *text
); gint gtk_clist_get_text (GtkCList *clist
,gint row
,gint column
,gchar **text
); void gtk_clist_set_pixmap (GtkCList *clist
,gint row
,gint column
,GdkPixmap *pixmap
,GdkBitmap *mask
); gint gtk_clist_get_pixmap (GtkCList *clist
,gint row
,gint column
,GdkPixmap **pixmap
,GdkBitmap **mask
); void gtk_clist_set_pixtext (GtkCList *clist
,gint row
,gint column
,const gchar *text
,guint8 spacing
,GdkPixmap *pixmap
,GdkBitmap *mask
); gint gtk_clist_get_pixtext (GtkCList *clist
,gint row
,gint column
,gchar **text
,guint8 *spacing
,GdkPixmap **pixmap
,GdkBitmap **mask
); void gtk_clist_set_foreground (GtkCList *clist
,gint row
,const GdkColor *color
); void gtk_clist_set_background (GtkCList *clist
,gint row
,const GdkColor *color
); void gtk_clist_set_cell_style (GtkCList *clist
,gint row
,gint column
,GtkStyle *style
); GtkStyle * gtk_clist_get_cell_style (GtkCList *clist
,gint row
,gint column
); void gtk_clist_set_row_style (GtkCList *clist
,gint row
,GtkStyle *style
); GtkStyle * gtk_clist_get_row_style (GtkCList *clist
,gint row
); void gtk_clist_set_shift (GtkCList *clist
,gint row
,gint column
,gint vertical
,gint horizontal
); void gtk_clist_set_selectable (GtkCList *clist
,gint row
,gboolean selectable
); gboolean gtk_clist_get_selectable (GtkCList *clist
,gint row
); gint gtk_clist_prepend (GtkCList *clist
,gchar *text[]
); gint gtk_clist_append (GtkCList *clist
,gchar *text[]
); gint gtk_clist_insert (GtkCList *clist
,gint row
,gchar *text[]
); void gtk_clist_remove (GtkCList *clist
,gint row
); void gtk_clist_set_row_data (GtkCList *clist
,gint row
,gpointer data
); void gtk_clist_set_row_data_full (GtkCList *clist
,gint row
,gpointer data
,GDestroyNotify destroy
); gpointer gtk_clist_get_row_data (GtkCList *clist
,gint row
); gint gtk_clist_find_row_from_data (GtkCList *clist
,gpointer data
); void gtk_clist_select_row (GtkCList *clist
,gint row
,gint column
); void gtk_clist_unselect_row (GtkCList *clist
,gint row
,gint column
); void gtk_clist_undo_selection (GtkCList *clist
); void gtk_clist_clear (GtkCList *clist
); gint gtk_clist_get_selection_info (GtkCList *clist
,gint x
,gint y
,gint *row
,gint *column
); void gtk_clist_select_all (GtkCList *clist
); void gtk_clist_unselect_all (GtkCList *clist
); void gtk_clist_swap_rows (GtkCList *clist
,gint row1
,gint row2
); void gtk_clist_set_compare_func (GtkCList *clist
,GtkCListCompareFunc cmp_func
); void gtk_clist_set_sort_column (GtkCList *clist
,gint column
); void gtk_clist_set_sort_type (GtkCList *clist
,GtkSortType sort_type
); void gtk_clist_sort (GtkCList *clist
); void gtk_clist_set_auto_sort (GtkCList *clist
,gboolean auto_sort
); gint gtk_clist_columns_autosize (GtkCList *clist
); gchar * gtk_clist_get_column_title (GtkCList *clist
,gint column
); GtkWidget * gtk_clist_get_column_widget (GtkCList *clist
,gint column
); GtkAdjustment * gtk_clist_get_hadjustment (GtkCList *clist
); GtkAdjustment * gtk_clist_get_vadjustment (GtkCList *clist
); void gtk_clist_row_move (GtkCList *clist
,gint source_row
,gint dest_row
); void gtk_clist_set_button_actions (GtkCList *clist
,guint button
,guint8 button_actions
); void gtk_clist_set_hadjustment (GtkCList *clist
,GtkAdjustment *adjustment
); void gtk_clist_set_reorderable (GtkCList *clist
,gboolean reorderable
); void gtk_clist_set_use_drag_icons (GtkCList *clist
,gboolean use_icons
); void gtk_clist_set_vadjustment (GtkCList *clist
,GtkAdjustment *adjustment
);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkCList +----GtkCTree
"n-columns" guint : Read / Write / Construct Only "reorderable" gboolean : Read / Write "row-height" guint : Read / Write "selection-mode" GtkSelectionMode : Read / Write "shadow-type" GtkShadowType : Read / Write "sort-type" GtkSortType : Read / Write "titles-active" gboolean : Read / Write "use-drag-icons" gboolean : Read / Write
"abort-column-resize" :Action
"click-column" :Run First
"end-selection" :Action
"extend-selection" :Action
"resize-column" :Run Last
"row-move" :Run Last
"scroll-horizontal" :Action
"scroll-vertical" :Action
"select-all" :Action
"select-row" :Run First
"set-scroll-adjustments" :Run Last
"start-selection" :Action
"toggle-add-mode" :Action
"toggle-focus-row" :Action
"undo-selection" :Action
"unselect-all" :Action
"unselect-row" :Run First
The GtkCList widget is a very useful multi-columned scrolling list. It can display data in nicely aligned vertical columns, with titles at the top of the list.
GtkCList has been deprecated since GTK+ 2.0 and should not be used in newly written code. Use GtkTreeView instead.
struct GtkCList;
GtkCList
is deprecated and should not be used in newly-written code.
This is the embodiment of the GtkCList widget. This structure contains only private data, and should be accessed only via the CList API.
typedef enum { GTK_CELL_EMPTY, GTK_CELL_TEXT, GTK_CELL_PIXMAP, GTK_CELL_PIXTEXT, GTK_CELL_WIDGET } GtkCellType;
GtkCellType
is deprecated and should not be used in newly-written code.
Identifies the type of element in the current cell of the CList. Cells can
contain text, pixmaps, or both. Unfortunately support for GTK_CELL_WIDGET
was never completed.
typedef enum { GTK_BUTTON_IGNORED = 0, GTK_BUTTON_SELECTS = 1 << 0, GTK_BUTTON_DRAGS = 1 << 1, GTK_BUTTON_EXPANDS = 1 << 2 } GtkButtonAction;
GtkButtonAction
is deprecated and should not be used in newly-written code.
Values for specifying what mouse button events a CList will react to.
#define GTK_CLIST_FLAGS(clist) (GTK_CLIST (clist)->flags)
GTK_CLIST_FLAGS
is deprecated and should not be used in newly-written code.
Reads the current flags of the specified CList.
|
The GtkCList widget from which to get the flags |
#define GTK_CLIST_SET_FLAG(clist,flag) (GTK_CLIST_FLAGS (clist) |= (GTK_ ## flag))
GTK_CLIST_SET_FLAG
is deprecated and should not be used in newly-written code.
A macro to set a particular flag for the specified CList.
#define GTK_CLIST_UNSET_FLAG(clist,flag) (GTK_CLIST_FLAGS (clist) &= ~(GTK_ ## flag))
GTK_CLIST_UNSET_FLAG
is deprecated and should not be used in newly-written code.
A macro to clear a particular flag for the specified CList.
#define GTK_CLIST_IN_DRAG(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_IN_DRAG)
GTK_CLIST_IN_DRAG
is deprecated and should not be used in newly-written code.
A macro to check whether the GtkCList is in "drag mode."
|
The GtkCList to check. |
#define GTK_CLIST_ROW_HEIGHT_SET(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_ROW_HEIGHT_SET)
GTK_CLIST_ROW_HEIGHT_SET
is deprecated and should not be used in newly-written code.
A macro to check whether the GtkCList's row height is set.
|
The GtkCList to check. |
#define GTK_CLIST_SHOW_TITLES(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_SHOW_TITLES)
GTK_CLIST_SHOW_TITLES
is deprecated and should not be used in newly-written code.
A macro to check whether the flag for showing the widget's column titles is set.
|
The GtkCList widget to check. |
#define GTK_CLIST_ADD_MODE(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_ADD_MODE)
GTK_CLIST_ADD_MODE
is deprecated and should not be used in newly-written code.
A macro to test whether the CList is in "add mode."
|
The GtkCList widget to check. |
#define GTK_CLIST_AUTO_SORT(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_AUTO_SORT)
GTK_CLIST_AUTO_SORT
is deprecated and should not be used in newly-written code.
A macro to test whether the CList has automatic sorting switched on.
|
The GtkCList widget to check. |
#define GTK_CLIST_AUTO_RESIZE_BLOCKED(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_AUTO_RESIZE_BLOCKED)
GTK_CLIST_AUTO_RESIZE_BLOCKED
is deprecated and should not be used in newly-written code.
A macro to check if automatic resizing of columns is blocked.
|
The GtkCList widget to check. |
#define GTK_CLIST_REORDERABLE(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_REORDERABLE)
GTK_CLIST_REORDERABLE
is deprecated and should not be used in newly-written code.
A macro to test if the CList's columns are re-orderable
|
The GtkCList widget to check. |
#define GTK_CLIST_USE_DRAG_ICONS(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_USE_DRAG_ICONS)
GTK_CLIST_USE_DRAG_ICONS
is deprecated and should not be used in newly-written code.
A macro to check if the USE_DRAG_ICONS property is enabled.
|
The GtkCList widget to check. |
#define GTK_CLIST_DRAW_DRAG_LINE(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_DRAW_DRAG_LINE)
GTK_CLIST_DRAW_DRAG_LINE
is deprecated and should not be used in newly-written code.
A macro to check if the DRAW_DRAG_LINE property is enabled.
|
The GtkCList widget to check. |
#define GTK_CLIST_DRAW_DRAG_RECT(clist) (GTK_CLIST_FLAGS (clist) & GTK_CLIST_DRAW_DRAG_RECT)
GTK_CLIST_DRAW_DRAG_RECT
is deprecated and should not be used in newly-written code.
A macro to check if the DRAW_DRAG_RECT property is enabled.
|
The GtkCList widget to check. |
#define GTK_CLIST_ROW(_glist_) ((GtkCListRow *)((_glist_)->data))
GTK_CLIST_ROW
is deprecated and should not be used in newly-written code.
A macro to cast a GList element to a CListRow pointer.
|
The GList element to convert. |
#define GTK_CELL_TEXT(cell) (((GtkCellText *) &(cell)))
GTK_CELL_TEXT
is deprecated and should not be used in newly-written code.
A macro to cast a generic GtkCList cell item to a GtkCellText pointer.
|
The GtkCList cell item to convert. |
#define GTK_CELL_PIXMAP(cell) (((GtkCellPixmap *) &(cell)))
GTK_CELL_PIXMAP
is deprecated and should not be used in newly-written code.
A macro to cast a generic GtkCList cell item to a GtkCellPixmap pointer.
|
The GtkCList cell item to convert. |
#define GTK_CELL_PIXTEXT(cell) (((GtkCellPixText *) &(cell)))
GTK_CELL_PIXTEXT
is deprecated and should not be used in newly-written code.
A macro to cast a generic GtkCList cell item to a GtkCellPixText pointer.
|
The GtkCList cell item to convert. |
#define GTK_CELL_WIDGET(cell) (((GtkCellWidget *) &(cell)))
GTK_CELL_WIDGET
is deprecated and should not be used in newly-written code.
A macro to cast a generic GtkCList cell item to a GtkCellWidget pointer.
|
The GtkCList cell item to convert. |
gint (*GtkCListCompareFunc) (GtkCList *clist
,gconstpointer ptr1
,gconstpointer ptr2
);
GtkCListCompareFunc
is deprecated and should not be used in newly-written code.
Function prototype for the compare function callback.
|
The GtkCList that is affected. |
|
A gconstpointer to the first node to compare. |
|
A gconstpointer to the second node to compare. |
Returns : |
0 if the nodes are equal, less than 0 if the first node should come before the second, and greater than 1 if the second come before the first. |
struct GtkCListColumn { gchar *title; GdkRectangle area; GtkWidget *button; GdkWindow *window; gint width; gint min_width; gint max_width; GtkJustification justification; guint visible : 1; guint width_set : 1; guint resizeable : 1; guint auto_resize : 1; guint button_passive : 1; };
GtkCListColumn
is deprecated and should not be used in newly-written code.
A structure that the GtkCList widget uses to keep track of information about its columns.
struct GtkCListRow { GtkCell *cell; GtkStateType state; GdkColor foreground; GdkColor background; GtkStyle *style; gpointer data; GDestroyNotify destroy; guint fg_set : 1; guint bg_set : 1; guint selectable : 1; };
GtkCListRow
is deprecated and should not be used in newly-written code.
A structure that the GtkCList widget uses to keep track of information about its rows.
struct GtkCellText { GtkCellType type; gint16 vertical; gint16 horizontal; GtkStyle *style; gchar *text; };
GtkCellText
is deprecated and should not be used in newly-written code.
A structure that the GtkCList widget uses to keep track of GtkCList cells that contain text.
struct GtkCellPixmap { GtkCellType type; gint16 vertical; gint16 horizontal; GtkStyle *style; GdkPixmap *pixmap; GdkBitmap *mask; };
GtkCellPixmap
is deprecated and should not be used in newly-written code.
A structure that the GtkCList widget uses to keep track of GtkCList cells that contain a GdkPixmap.
struct GtkCellPixText { GtkCellType type; gint16 vertical; gint16 horizontal; GtkStyle *style; gchar *text; guint8 spacing; GdkPixmap *pixmap; GdkBitmap *mask; };
GtkCellPixText
is deprecated and should not be used in newly-written code.
A structure that the GtkCList widget uses to keep track of GtkCList cells that contain a combination of text and a GdkPixmap.
struct GtkCellWidget { GtkCellType type; gint16 vertical; gint16 horizontal; GtkStyle *style; GtkWidget *widget; };
GtkCellWidget
is deprecated and should not be used in newly-written code.
A structure that the GtkCList widget uses to keep track of GtkCList cells that contain another widget.
struct GtkCell { GtkCellType type; gint16 vertical; gint16 horizontal; GtkStyle *style; union { gchar *text; struct { GdkPixmap *pixmap; GdkBitmap *mask; } pm; struct { gchar *text; guint8 spacing; GdkPixmap *pixmap; GdkBitmap *mask; } pt; GtkWidget *widget; } u; };
GtkCell
is deprecated and should not be used in newly-written code.
A generic structure that the GtkCList widget uses to keep track of the contents of each of its cells.
struct GtkCListCellInfo { gint row; gint column; };
GtkCListCellInfo
is deprecated and should not be used in newly-written code.
A simple structure that the GtkCList widget uses to keep track of the location of a cell.
struct GtkCListDestInfo { GtkCListCellInfo cell; GtkCListDragPos insert_pos; };
GtkCListDestInfo
is deprecated and should not be used in newly-written code.
A simple structure that the GtkCList widget uses to track a cell for a drag operation.
typedef enum { GTK_CLIST_DRAG_NONE, GTK_CLIST_DRAG_BEFORE, GTK_CLIST_DRAG_INTO, GTK_CLIST_DRAG_AFTER } GtkCListDragPos;
GtkCListDragPos
is deprecated and should not be used in newly-written code.
An enumeration for drag operations.
GtkWidget * gtk_clist_new (gint columns
);
gtk_clist_new
is deprecated and should not be used in newly-written code.
Creates a new GtkCList widget for use.
|
The number of columns the GtkCList should have. |
Returns : |
A pointer to a new GtkCList object. |
GtkWidget * gtk_clist_new_with_titles (gint columns
,gchar *titles[]
);
gtk_clist_new_with_titles
is deprecated and should not be used in newly-written code.
Creates a new GtkCList widget with column titles for use.
|
The number of columns the GtkCList should have. |
|
A string array of titles for the widget. There should be enough strings in the array for the specified number of columns. |
Returns : |
A pointer to a new GtkCList object. |
void gtk_clist_set_shadow_type (GtkCList *clist
,GtkShadowType type
);
gtk_clist_set_shadow_type
is deprecated and should not be used in newly-written code.
Sets the shadow type for the specified CList. Changing this value will cause the GtkCList to update its visuals.
|
The GtkCList to affect. |
|
The GtkShadowType desired. |
void gtk_clist_set_selection_mode (GtkCList *clist
,GtkSelectionMode mode
);
gtk_clist_set_selection_mode
is deprecated and should not be used in newly-written code.
Sets the selection mode for the specified CList. This allows you to set whether only one or more than one item can be selected at a time in the widget. Note that setting the widget's selection mode to one of GTK_SELECTION_BROWSE or GTK_SELECTION_SINGLE will cause all the items in the GtkCList to become deselected.
|
The GtkCList to affect. |
|
The GtkSelectionMode type to set for this CList. |
void gtk_clist_freeze (GtkCList *clist
);
gtk_clist_freeze
is deprecated and should not be used in newly-written code.
Causes the GtkCList to stop updating its visuals until a matching call to
gtk_clist_thaw()
is made. This function is useful if a lot of changes
will be made to the widget that may cause a lot of visual updating to
occur. Note that calls to gtk_clist_freeze()
can be nested.
|
The GtkCList to freeze. |
void gtk_clist_thaw (GtkCList *clist
);
gtk_clist_thaw
is deprecated and should not be used in newly-written code.
Causes the specified GtkCList to allow visual updates.
|
The GtkCList to thaw. |
void gtk_clist_column_titles_show (GtkCList *clist
);
gtk_clist_column_titles_show
is deprecated and should not be used in newly-written code.
This function causes the GtkCList to show its column titles, if they are not already showing.
|
The GtkCList to affect. |
void gtk_clist_column_titles_hide (GtkCList *clist
);
gtk_clist_column_titles_hide
is deprecated and should not be used in newly-written code.
Causes the GtkCList to hide its column titles, if they are currently showing.
|
The GtkCList to affect. |
void gtk_clist_column_title_active (GtkCList *clist
,gint column
);
gtk_clist_column_title_active
is deprecated and should not be used in newly-written code.
Sets the specified column in the GtkCList to become selectable. You can then respond to events from the user clicking on a title button, and take appropriate action.
|
The GtkCList to affect. |
|
The column to make active, counting from 0. |
void gtk_clist_column_title_passive (GtkCList *clist
,gint column
);
gtk_clist_column_title_passive
is deprecated and should not be used in newly-written code.
Causes the specified column title button to become passive, i.e., does not respond to events, such as the user clicking on it.
|
The GtkCList to affect. |
|
The column to make passive, counting from 0. |
void gtk_clist_column_titles_active (GtkCList *clist
);
gtk_clist_column_titles_active
is deprecated and should not be used in newly-written code.
Causes all column title buttons to become active. This is the same
as calling gtk_clist_column_title_active()
for each column.
|
The GtkCList to affect. |
void gtk_clist_column_titles_passive (GtkCList *clist
);
gtk_clist_column_titles_passive
is deprecated and should not be used in newly-written code.
Causes all column title buttons to become passive. This is the same
as calling gtk_clist_column_title_passive()
for each column.
|
The GtkCList to affect. |
void gtk_clist_set_column_title (GtkCList *clist
,gint column
,const gchar *title
);
gtk_clist_set_column_title
is deprecated and should not be used in newly-written code.
Sets the title for the specified column.
|
The GtkCList to affect. |
|
The column whose title should be changed. |
|
A string to be the column's title. |
void gtk_clist_set_column_widget (GtkCList *clist
,gint column
,GtkWidget *widget
);
gtk_clist_set_column_widget
is deprecated and should not be used in newly-written code.
Sets a widget to be used as the specified column's title. This can be used to place a pixmap or something else as the column title, instead of the standard text.
|
The GtkCList to affect. |
|
The column whose title should be a widget. |
|
A pointer to a previously create widget. |
void gtk_clist_set_column_justification (GtkCList *clist
,gint column
,GtkJustification justification
);
gtk_clist_set_column_justification
is deprecated and should not be used in newly-written code.
Sets the justification to be used for all text in the specified column.
|
The GtkCList to affect. |
|
The column which should be affected. |
|
A GtkJustification value for the column. |
void gtk_clist_set_column_visibility (GtkCList *clist
,gint column
,gboolean visible
);
gtk_clist_set_column_visibility
is deprecated and should not be used in newly-written code.
Allows you to set whether a specified column in the GtkCList should be hidden or shown. Note that at least one column must always be showing, so attempting to hide the last visible column will be ignored.
void gtk_clist_set_column_resizeable (GtkCList *clist
,gint column
,gboolean resizeable
);
gtk_clist_set_column_resizeable
is deprecated and should not be used in newly-written code.
Lets you specify whether a specified column should be resizeable
by the user. Note that turning on resizeability for the column will
automatically shut off auto-resizing, but turning off resizeability
will NOT turn on auto-resizing. This must be done manually via a
call to gtk_clist_set_column_auto_resize()
.
void gtk_clist_set_column_auto_resize (GtkCList *clist
,gint column
,gboolean auto_resize
);
gtk_clist_set_column_auto_resize
is deprecated and should not be used in newly-written code.
Lets you specify whether a column should be automatically resized by the widget when data is added or removed. Enabling auto-resize on a column explicity disallows user-resizing of the column.
gint gtk_clist_optimal_column_width (GtkCList *clist
,gint column
);
gtk_clist_optimal_column_width
is deprecated and should not be used in newly-written code.
Gets the required width in pixels that is needed to show everything in the specified column.
|
The GtkCList to check. |
|
The column to check. |
Returns : |
The required width in pixels for the column. |
void gtk_clist_set_column_width (GtkCList *clist
,gint column
,gint width
);
gtk_clist_set_column_width
is deprecated and should not be used in newly-written code.
Causes the column specified for the GtkCList to be set to a specified width.
|
The GtkCList to affect. |
|
The column to set the width. |
|
The width, in pixels. |
void gtk_clist_set_column_min_width (GtkCList *clist
,gint column
,gint min_width
);
gtk_clist_set_column_min_width
is deprecated and should not be used in newly-written code.
Causes the column specified to have a minimum width, preventing the user from resizing it smaller than that specified.
|
The GtkCList to affect. |
|
The column to set the minimum width. |
|
The width, in pixels. |
void gtk_clist_set_column_max_width (GtkCList *clist
,gint column
,gint max_width
);
gtk_clist_set_column_max_width
is deprecated and should not be used in newly-written code.
Causes the column specified to have a maximum width, preventing the user from resizing it larger than that specified.
|
The GtkCList to affect. |
|
The column to set the maximum width. |
|
The width, in pixels. |
void gtk_clist_set_row_height (GtkCList *clist
,guint height
);
gtk_clist_set_row_height
is deprecated and should not be used in newly-written code.
Causes the GtkCList to have a specified height for its rows. Setting the row height to 0 allows the GtkCList to adjust automatically to data in the row.
|
The GtkCList to affect. |
|
The height, in pixels. |
void gtk_clist_moveto (GtkCList *clist
,gint row
,gint column
,gfloat row_align
,gfloat col_align
);
gtk_clist_moveto
is deprecated and should not be used in newly-written code.
Tells the CList widget to visually move to the specified row and column.
|
The GtkCList to affect. |
|
The row to which to move. |
|
The column to which to move. |
|
A value between 0 and 1 that describes the positioning of the row in relation to the viewable area of the CList's contents. |
|
A value between 0 and 1 that describes the positioning of the column in relation to the viewable area of the CList's contents. |
GtkVisibility gtk_clist_row_is_visible (GtkCList *clist
,gint row
);
gtk_clist_row_is_visible
is deprecated and should not be used in newly-written code.
Checks how the specified row is visible.
|
The GtkCList to affect. |
|
The row to query. |
Returns : |
A GtkVisibility value that tells you how the row is visible. |
GtkCellType gtk_clist_get_cell_type (GtkCList *clist
,gint row
,gint column
);
gtk_clist_get_cell_type
is deprecated and should not be used in newly-written code.
Checks the type of cell at the location specified.
|
The GtkCList to affect. |
|
The row of the cell. |
|
The column of the cell. |
Returns : |
A GtkCellType value describing the cell. |
void gtk_clist_set_text (GtkCList *clist
,gint row
,gint column
,const gchar *text
);
gtk_clist_set_text
is deprecated and should not be used in newly-written code.
Sets the displayed text in the specified cell.
|
The GtkCList to affect. |
|
The row of the cell. |
|
The column of the cell. |
|
The text to set in the cell. |
gint gtk_clist_get_text (GtkCList *clist
,gint row
,gint column
,gchar **text
);
gtk_clist_get_text
is deprecated and should not be used in newly-written code.
Gets the text for the specified cell.
|
The GtkCList to affect. |
|
The row to query. |
|
The column to query. |
|
A pointer to a pointer to store the text. |
Returns : |
1 if the cell's text could be retrieved, 0 otherwise. |
void gtk_clist_set_pixmap (GtkCList *clist
,gint row
,gint column
,GdkPixmap *pixmap
,GdkBitmap *mask
);
gtk_clist_set_pixmap
is deprecated and should not be used in newly-written code.
Sets a pixmap for the specified cell.
gint gtk_clist_get_pixmap (GtkCList *clist
,gint row
,gint column
,GdkPixmap **pixmap
,GdkBitmap **mask
);
gtk_clist_get_pixmap
is deprecated and should not be used in newly-written code.
Gets the pixmap and bitmap mask of the specified cell. The returned mask value can be NULL.
void gtk_clist_set_pixtext (GtkCList *clist
,gint row
,gint column
,const gchar *text
,guint8 spacing
,GdkPixmap *pixmap
,GdkBitmap *mask
);
gtk_clist_set_pixtext
is deprecated and should not be used in newly-written code.
Sets text and a pixmap/bitmap on the specified cell.
gint gtk_clist_get_pixtext (GtkCList *clist
,gint row
,gint column
,gchar **text
,guint8 *spacing
,GdkPixmap **pixmap
,GdkBitmap **mask
);
gtk_clist_get_pixtext
is deprecated and should not be used in newly-written code.
Gets the text, pixmap and bitmap mask for the specified cell.
|
The GtkCList to affect. |
|
The row to query. |
|
The column to query. |
|
A pointer to a pointer to store the text. |
|
A pointer to a guint8 to store the spacing. |
|
A pointer to a GdkPixmap pointer to store the cell's pixmap. |
|
A pointer to a GdkBitmap pointer to store the cell's bitmap mask. |
Returns : |
1 if the retrieval was successful, 0 otherwise. |
void gtk_clist_set_foreground (GtkCList *clist
,gint row
,const GdkColor *color
);
gtk_clist_set_foreground
is deprecated and should not be used in newly-written code.
Sets the foreground color for the specified row.
void gtk_clist_set_background (GtkCList *clist
,gint row
,const GdkColor *color
);
gtk_clist_set_background
is deprecated and should not be used in newly-written code.
Sets the background color for the specified row.
void gtk_clist_set_cell_style (GtkCList *clist
,gint row
,gint column
,GtkStyle *style
);
gtk_clist_set_cell_style
is deprecated and should not be used in newly-written code.
Sets the style for the specified cell.
GtkStyle * gtk_clist_get_cell_style (GtkCList *clist
,gint row
,gint column
);
gtk_clist_get_cell_style
is deprecated and should not be used in newly-written code.
Gets the current style of the specified cell.
void gtk_clist_set_row_style (GtkCList *clist
,gint row
,GtkStyle *style
);
gtk_clist_set_row_style
is deprecated and should not be used in newly-written code.
Sets the style for all cells in the specified row.
GtkStyle * gtk_clist_get_row_style (GtkCList *clist
,gint row
);
gtk_clist_get_row_style
is deprecated and should not be used in newly-written code.
Gets the style set for the specified row.
void gtk_clist_set_shift (GtkCList *clist
,gint row
,gint column
,gint vertical
,gint horizontal
);
gtk_clist_set_shift
is deprecated and should not be used in newly-written code.
Sets the vertical and horizontal shift of the specified cell.
|
The GtkCList to affect. |
|
The row of the cell. |
|
The column of the cell. |
|
The value to set for the vertical shift. |
|
The value to set for the vertical shift. |
void gtk_clist_set_selectable (GtkCList *clist
,gint row
,gboolean selectable
);
gtk_clist_set_selectable
is deprecated and should not be used in newly-written code.
Sets whether the specified row is selectable or not.
gboolean gtk_clist_get_selectable (GtkCList *clist
,gint row
);
gtk_clist_get_selectable
is deprecated and should not be used in newly-written code.
Gets whether the specified row is selectable or not.
gint gtk_clist_prepend (GtkCList *clist
,gchar *text[]
);
gtk_clist_prepend
is deprecated and should not be used in newly-written code.
Adds a row to the CList at the top.
|
The GtkCList to affect. |
|
An array of strings to add. |
Returns : |
The number of the row added. |
gint gtk_clist_append (GtkCList *clist
,gchar *text[]
);
gtk_clist_append
is deprecated and should not be used in newly-written code.
Adds a row to the CList at the bottom.
|
The GtkCList to affect. |
|
An array of strings to add. |
Returns : |
The number of the row added. |
gint gtk_clist_insert (GtkCList *clist
,gint row
,gchar *text[]
);
gtk_clist_insert
is deprecated and should not be used in newly-written code.
Adds a row of text to the CList at the specified position.
|
The GtkCList to affect. |
|
The row where the text should be inserted. |
|
An array of string to add. |
Returns : |
The number of the row added. |
void gtk_clist_remove (GtkCList *clist
,gint row
);
gtk_clist_remove
is deprecated and should not be used in newly-written code.
Removes the specified row from the CList.
|
The GtkCList to affect. |
|
The row to remove. |
void gtk_clist_set_row_data (GtkCList *clist
,gint row
,gpointer data
);
gtk_clist_set_row_data
is deprecated and should not be used in newly-written code.
Sets data for the specified row. This is the same as calling gtk_clist_set_row_data_full(clist, row, data, NULL).
|
The GtkCList to affect. |
|
The row to affect. |
|
The data to set for the row. |
void gtk_clist_set_row_data_full (GtkCList *clist
,gint row
,gpointer data
,GDestroyNotify destroy
);
gtk_clist_set_row_data_full
is deprecated and should not be used in newly-written code.
Sets the data for specified row, with a callback when the row is destroyed.
|
The GtkCList to affect. |
|
The row to affect. |
|
The data to set for the row. |
|
A GtkDestroyNotify function to be called when the row is destroyed. |
gpointer gtk_clist_get_row_data (GtkCList *clist
,gint row
);
gtk_clist_get_row_data
is deprecated and should not be used in newly-written code.
Gets the currently set data for the specified row.
|
The GtkCList to affect. |
|
The row to query. |
Returns : |
The data set for the row. |
gint gtk_clist_find_row_from_data (GtkCList *clist
,gpointer data
);
gtk_clist_find_row_from_data
is deprecated and should not be used in newly-written code.
Searches the CList for the row with the specified data.
|
The GtkCList to search. |
|
The data to search for a match. |
Returns : |
The number of the matching row, or -1 if no match could be found. |
void gtk_clist_select_row (GtkCList *clist
,gint row
,gint column
);
gtk_clist_select_row
is deprecated and should not be used in newly-written code.
Selects the specified row. Causes the "select-row" signal to be emitted for the specified row and column.
|
The GtkCList to affect. |
|
The row to select. |
|
The column to select. |
void gtk_clist_unselect_row (GtkCList *clist
,gint row
,gint column
);
gtk_clist_unselect_row
is deprecated and should not be used in newly-written code.
Unselects the specified row. Causes the "unselect-row" signal to be emitted for the specified row and column.
|
The GtkCList to affect. |
|
The row to select. |
|
The column to select. |
void gtk_clist_undo_selection (GtkCList *clist
);
gtk_clist_undo_selection
is deprecated and should not be used in newly-written code.
Undoes the last selection for an "extended selection mode" CList.
|
The GtkCList to affect. |
void gtk_clist_clear (GtkCList *clist
);
gtk_clist_clear
is deprecated and should not be used in newly-written code.
Removes all the CList's rows.
|
The GtkCList to affect. |
gint gtk_clist_get_selection_info (GtkCList *clist
,gint x
,gint y
,gint *row
,gint *column
);
gtk_clist_get_selection_info
is deprecated and should not be used in newly-written code.
Gets the row and column at the specified pixel position in the CList.
void gtk_clist_select_all (GtkCList *clist
);
gtk_clist_select_all
is deprecated and should not be used in newly-written code.
Selects all rows in the CList. This function has no affect for a CList in "single" or "browse" selection mode.
|
The GtkCList to affect. |
void gtk_clist_unselect_all (GtkCList *clist
);
gtk_clist_unselect_all
is deprecated and should not be used in newly-written code.
Unselects all rows in the CList.
|
The GtkCList to affect. |
void gtk_clist_swap_rows (GtkCList *clist
,gint row1
,gint row2
);
gtk_clist_swap_rows
is deprecated and should not be used in newly-written code.
Swaps the two specified rows with each other.
|
The GtkCList to affect. |
|
Number of the first row. |
|
Number of the second row. |
void gtk_clist_set_compare_func (GtkCList *clist
,GtkCListCompareFunc cmp_func
);
gtk_clist_set_compare_func
is deprecated and should not be used in newly-written code.
Sets the compare function of the GtkClist to cmp_func
. If cmp_func
is NULL,
then the default compare function is used. The default compare function sorts
ascending or with the type set by gtk_clist_set_sort_type()
by the column set
by gtk_clist_set_sort_column()
.
|
The GtkCList to affect. |
|
The GtkCompareFunction to use. |
void gtk_clist_set_sort_column (GtkCList *clist
,gint column
);
gtk_clist_set_sort_column
is deprecated and should not be used in newly-written code.
Sets the sort column of the clist. The sort column is used by the default compare function to determine which column to sort by.
|
The GtkCList to affect. |
|
The column to sort by |
void gtk_clist_set_sort_type (GtkCList *clist
,GtkSortType sort_type
);
gtk_clist_set_sort_type
is deprecated and should not be used in newly-written code.
Sets the sort type of the GtkClist. This is either GTK_SORT_ASCENDING for ascening sort or GTK_SORT_DESCENDING for descending sort.
|
The GtkCList to affect. |
|
the GtkSortType to use |
void gtk_clist_sort (GtkCList *clist
);
gtk_clist_sort
is deprecated and should not be used in newly-written code.
Sorts the GtkClist according to the current compare function, which
can be set with the gtk_clist_set_compare_func()
function.
|
The GtkCList to sort. |
void gtk_clist_set_auto_sort (GtkCList *clist
,gboolean auto_sort
);
gtk_clist_set_auto_sort
is deprecated and should not be used in newly-written code.
Turns on or off auto sort of the GtkCList. If auto sort is on, then the CList will be resorted when a row is inserted into the CList.
|
The GtkCList to affect. |
|
whether auto sort should be on or off |
gint gtk_clist_columns_autosize (GtkCList *clist
);
gtk_clist_columns_autosize
is deprecated and should not be used in newly-written code.
Auto-sizes all columns in the CList and returns the total width of the CList.
|
The GtkCList to affect. |
Returns : |
The total width of the CList. |
gchar * gtk_clist_get_column_title (GtkCList *clist
,gint column
);
gtk_clist_get_column_title
is deprecated and should not be used in newly-written code.
Gets the current title of the specified column
|
The GtkCList to affect. |
|
The column to query. |
Returns : |
The title of the column. |
GtkWidget * gtk_clist_get_column_widget (GtkCList *clist
,gint column
);
gtk_clist_get_column_widget
is deprecated and should not be used in newly-written code.
Gets the widget in the column header for the specified column.
GtkAdjustment * gtk_clist_get_hadjustment (GtkCList *clist
);
gtk_clist_get_hadjustment
is deprecated and should not be used in newly-written code.
Gets the GtkAdjustment currently being used for the horizontal aspect.
|
The GtkCList to check. |
Returns : |
A GtkAdjustment object, or NULL if none is currently being used. |
GtkAdjustment * gtk_clist_get_vadjustment (GtkCList *clist
);
gtk_clist_get_vadjustment
is deprecated and should not be used in newly-written code.
Gets the GtkAdjustment currently being used for the vertical aspect.
|
The GtkCList to check. |
Returns : |
A GtkAdjustment object, or NULL if none is currently being used. |
void gtk_clist_row_move (GtkCList *clist
,gint source_row
,gint dest_row
);
gtk_clist_row_move
is deprecated and should not be used in newly-written code.
Allows you to move a row from one position to another in the list.
|
The GtkCList to affect. |
|
The original position of the row to move. |
|
The position to which the row should be moved. |
void gtk_clist_set_button_actions (GtkCList *clist
,guint button
,guint8 button_actions
);
gtk_clist_set_button_actions
is deprecated and should not be used in newly-written code.
Sets the action(s) that the specified mouse button will have on the CList.
|
The GtkCList to affect. |
|
The mouse button to set. The values here, unlike in the rest of GTK+ start from 0. For instance, the right mouse button, which is 3 elsewhere, should be given as 2 here. |
|
A logically OR'd value of GtkButtonAction values for the button. |
void gtk_clist_set_hadjustment (GtkCList *clist
,GtkAdjustment *adjustment
);
gtk_clist_set_hadjustment
is deprecated and should not be used in newly-written code.
Allows you to set the GtkAdjustment to be used for the horizontal aspect of the GtkCList widget.
|
The GtkCList to affect. |
|
A pointer to a GtkAdjustment widget, or NULL. |
void gtk_clist_set_reorderable (GtkCList *clist
,gboolean reorderable
);
gtk_clist_set_reorderable
is deprecated and should not be used in newly-written code.
Sets whether the CList's rows are re-orderable using drag-and-drop.
void gtk_clist_set_use_drag_icons (GtkCList *clist
,gboolean use_icons
);
gtk_clist_set_use_drag_icons
is deprecated and should not be used in newly-written code.
Determines whether the GtkClist should use icons when doing drag-and-drop operations.
void gtk_clist_set_vadjustment (GtkCList *clist
,GtkAdjustment *adjustment
);
gtk_clist_set_vadjustment
is deprecated and should not be used in newly-written code.
Allows you to set the GtkAdjustment to be used for the vertical aspect of the GtkCList widget.
|
The GtkCList to affect. |
|
A pointer to a GtkAdjustment widget, or NULL. |
"n-columns"
property"n-columns" guint : Read / Write / Construct Only
An integer value for a column.
Default value: 0
"reorderable"
property"reorderable" gboolean : Read / Write
A boolean value for determining if the user can re-order the CList's columns.
Default value: FALSE
"row-height"
property"row-height" guint : Read / Write
An integer value representing the height of a row in pixels.
Default value: 0
"selection-mode"
property"selection-mode" GtkSelectionMode : Read / Write
Sets the type of selection mode for the CList.
Default value: GTK_SELECTION_NONE
"shadow-type"
property"shadow-type" GtkShadowType : Read / Write
Sets the shadowing for the CList.
Default value: GTK_SHADOW_NONE
"titles-active"
property"titles-active" gboolean : Read / Write
A boolean value for setting whether the column titles can be clicked.
Default value: FALSE
"use-drag-icons"
property"use-drag-icons" gboolean : Read / Write
A boolean value for setting whether to use icons during drag operations.
Default value: FALSE
"abort-column-resize"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
This signal is emitted when a column resize is aborted.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"click-column"
signalvoid user_function (GtkCList *clist,
gint arg1,
gpointer user_data) : Run First
This signal is emitted when a column title is clicked.
|
The object which received the signal. |
|
The number of the column. |
|
user data set when the signal handler was connected. |
"end-selection"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
This signal is emitted when a selection ends in a multiple selection CList.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"extend-selection"
signalvoid user_function (GtkCList *clist,
GtkScrollType arg1,
gfloat arg2,
gboolean arg3,
gpointer user_data) : Action
This signal is emitted when the selection is extended.
|
the object which received the signal. |
|
A GtkScrollType value of any scrolling operation the occured during the selection. |
|
A value between 0.0 and 1.0. |
|
TRUE or FALSE . |
|
user data set when the signal handler was connected. |
"resize-column"
signalvoid user_function (GtkCList *clist,
gint arg1,
gint arg2,
gpointer user_data) : Run Last
This signal is emitted when a column is resized.
|
The object which received the signal. |
|
The number of the column |
|
The new width of the column. |
|
user data set when the signal handler was connected. |
"row-move"
signalvoid user_function (GtkCList *clist,
gint arg1,
gint arg2,
gpointer user_data) : Run Last
This signal is emitted when a row is moved.
|
The object which received the signal. |
|
The source position of the row. |
|
The destination position of the row. |
|
user data set when the signal handler was connected. |
"scroll-horizontal"
signalvoid user_function (GtkCList *clist,
GtkScrollType arg1,
gfloat arg2,
gpointer user_data) : Action
This signal is emitted when the CList is scrolled horizontally.
|
the object which received the signal. |
|
A GtkScrollType value of how the scroll operation occured. |
|
a value between 0.0 and 1.0. |
|
user data set when the signal handler was connected. |
"scroll-vertical"
signalvoid user_function (GtkCList *clist,
GtkScrollType arg1,
gfloat arg2,
gpointer user_data) : Action
This signal is emitted when the CList is scrolled vertically.
|
the object which received the signal. |
|
A GtkScrollType value of how the scroll operation occured. |
|
A value between 0.0 and 1.0. |
|
user data set when the signal handler was connected. |
"select-all"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
This signal is emitted when all the rows are selected in a CList.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"select-row"
signalvoid user_function (GtkCList *clist,
gint arg1,
gint arg2,
GdkEvent *arg3,
gpointer user_data) : Run First
This signal is emitted when the user selects a row in the list.
It is emitted for every row that is selected in a multi-selection or
by calling gtk_clist_select_all()
.
|
The object which received the signal. |
|
The row selected. |
|
The column where the selection occured. |
|
A GdkEvent structure for the selection. |
|
user data set when the signal handler was connected. |
"set-scroll-adjustments"
signalvoid user_function (GtkCList *clist,
GtkAdjustment *arg1,
GtkAdjustment *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"start-selection"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
This signal is emitted when a drag-selection is started in a multiple-selection CList.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"toggle-add-mode"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
This signal is emitted when "add mode" is toggled.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"toggle-focus-row"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
|
The object which received the signal. |
|
user data set when the signal handler was connected. |
"undo-selection"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
This signal is emitted when an undo selection occurs in the CList,
probably via calling gtk_clist_undo_selection()
.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"unselect-all"
signalvoid user_function (GtkCList *clist,
gpointer user_data) : Action
This signal is emitted when all rows are unselected in a CList.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"unselect-row"
signalvoid user_function (GtkCList *clist,
gint arg1,
gint arg2,
GdkEvent *arg3,
gpointer user_data) : Run First
This signal is emitted when the user unselects a row in the list.
It is emitted for every row that is unselected in a multi-selection or
by calling gtk_clist_unselect_all()
. It is also emitted for the
previously selected row in a "single" or "browse" mode CList.
|
The object which received the signal. |
|
The selected row |
|
The column where the selection occured. |
|
user data set when the signal handler was connected. |