GtkCList
A multi-columned scrolling list widget.
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.
This is the embodiment of the #GtkCList widget. This structure contains
only private data, and should be accessed only via the CList API.
This signal is emitted when a column resize is aborted.
@clist: the object which received the signal.
This signal is emitted when a column title is clicked.
@clist: The object which received the signal.
@column: The number of the column.
This signal is emitted when a selection ends in a
multiple selection CList.
@clist: the object which received the signal.
This signal is emitted when the selection is extended.
@clist: the object which received the signal.
@scroll_type: A #GtkScrollType value of any scrolling operation the
occured during the selection.
@position: A value between 0.0 and 1.0.
@auto_start_selection: %TRUE or %FALSE.
This signal is emitted when a column is resized.
@clist: The object which received the signal.
@column: The number of the column
@width: The new width of the column.
This signal is emitted when a row is moved.
@clist: The object which received the signal.
@arg1: The source position of the row.
@arg2: The destination position of the row.
This signal is emitted when the CList is scrolled horizontally.
@clist: the object which received the signal.
@scroll_type: A #GtkScrollType value of how the scroll operation occured.
@position: a value between 0.0 and 1.0.
This signal is emitted when the CList is scrolled vertically.
@clist: the object which received the signal.
@scroll_type: A #GtkScrollType value of how the scroll operation occured.
@position: A value between 0.0 and 1.0.
This signal is emitted when all the rows are selected in a CList.
@clist: the object which received the signal.
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().
@clist: The object which received the signal.
@row: The row selected.
@column: The column where the selection occured.
@event: A #GdkEvent structure for the selection.
@clist: the object which received the signal.
@arg1:
@arg2:
This signal is emitted when a drag-selection is started in
a multiple-selection CList.
@clist: the object which received the signal.
This signal is emitted when "add mode" is toggled.
@clist: the object which received the signal.
@clist: The object which received the signal.
This signal is emitted when an undo selection occurs in the CList,
probably via calling gtk_clist_undo_selection().
@clist: the object which received the signal.
This signal is emitted when all rows are unselected in a CList.
@clist: the object which received the signal.
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.
@clist: The object which received the signal.
@row: The selected row
@column: The column where the selection occured.
@event:
An integer value for a column.
A boolean value for determining if the user can re-order the CList's
columns.
An integer value representing the height of a row in pixels.
Sets the type of selection mode for the CList.
Sets the shadowing for the CList.
A boolean value for setting whether the column titles can be
clicked.
A boolean value for setting whether to use icons during drag
operations.
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.
@GTK_CELL_EMPTY:
@GTK_CELL_TEXT:
@GTK_CELL_PIXMAP:
@GTK_CELL_PIXTEXT:
@GTK_CELL_WIDGET:
Values for specifying what mouse button events a CList will
react to.
@GTK_BUTTON_IGNORED:
@GTK_BUTTON_SELECTS:
@GTK_BUTTON_DRAGS:
@GTK_BUTTON_EXPANDS:
Reads the current flags of the specified CList.
@clist: The #GtkCList widget from which to get the flags
A macro to set a particular flag for the specified CList.
@clist: The #GtkCList widget to affect.
@flag: A single #GtkCList flag to set. NOTE: Do not add the GTK_ prefix.
A macro to clear a particular flag for the specified CList.
@clist: The #GtkCList widget to affect.
@flag: A single #GtkCList flag to clear. NOTE: Do not add the GTK_ prefix.
A macro to check whether the #GtkCList is in "drag mode."
@clist: The #GtkCList to check.
A macro to check whether the #GtkCList's row height is set.
@clist: The #GtkCList to check.
A macro to check whether the flag for showing the
widget's column titles is set.
@clist: The #GtkCList widget to check.
A macro to test whether the CList is in "add mode."
@clist: The #GtkCList widget to check.
A macro to test whether the CList has automatic sorting
switched on.
@clist: The #GtkCList widget to check.
A macro to check if automatic resizing of columns is blocked.
@clist: The #GtkCList widget to check.
A macro to test if the CList's columns are re-orderable
@clist: The #GtkCList widget to check.
A macro to check if the USE_DRAG_ICONS property is enabled.
@clist: The #GtkCList widget to check.
A macro to check if the DRAW_DRAG_LINE property is enabled.
@clist: The #GtkCList widget to check.
A macro to check if the DRAW_DRAG_RECT property is enabled.
@clist: The #GtkCList widget to check.
A macro to cast a GList element to a CListRow pointer.
@_glist_: The GList element to convert.
A macro to cast a generic #GtkCList cell item to a GtkCellText pointer.
@cell: The #GtkCList cell item to convert.
A macro to cast a generic #GtkCList cell item to a GtkCellPixmap pointer.
@cell: The #GtkCList cell item to convert.
A macro to cast a generic #GtkCList cell item to a GtkCellPixText pointer.
@cell: The #GtkCList cell item to convert.
A macro to cast a generic #GtkCList cell item to a GtkCellWidget pointer.
@cell: The #GtkCList cell item to convert.
Function prototype for the compare function callback.
@clist: The #GtkCList that is affected.
@ptr1: A #gconstpointer to the first node to compare.
@ptr2: 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.
A structure that the #GtkCList widget uses to keep track of information
about its columns.
@title:
@area:
@button:
@window:
@width:
@min_width:
@max_width:
@justification:
@visible:
@width_set:
@resizeable:
@auto_resize:
@button_passive:
A structure that the #GtkCList widget uses to keep track of information
about its rows.
@cell:
@state:
@foreground:
@background:
@style:
@data:
@destroy:
@fg_set:
@bg_set:
@selectable:
A structure that the #GtkCList widget uses to keep track of #GtkCList cells
that contain text.
@type:
@vertical:
@horizontal:
@style:
@text:
A structure that the #GtkCList widget uses to keep track of #GtkCList cells
that contain a GdkPixmap.
@type:
@vertical:
@horizontal:
@style:
@pixmap:
@mask:
A structure that the #GtkCList widget uses to keep track of #GtkCList cells
that contain a combination of text and a GdkPixmap.
@type:
@vertical:
@horizontal:
@style:
@text:
@spacing:
@pixmap:
@mask:
A structure that the #GtkCList widget uses to keep track of #GtkCList cells
that contain another widget.
@type:
@vertical:
@horizontal:
@style:
@widget:
A generic structure that the #GtkCList widget uses to keep track of the
contents of each of its cells.
@type:
@vertical:
@horizontal:
@style:
@widget:
A simple structure that the #GtkCList widget uses to keep track
of the location of a cell.
@row:
@column:
A simple structure that the #GtkCList widget uses to track
a cell for a drag operation.
@cell:
@insert_pos:
An enumeration for drag operations.
@GTK_CLIST_DRAG_NONE:
@GTK_CLIST_DRAG_BEFORE:
@GTK_CLIST_DRAG_INTO:
@GTK_CLIST_DRAG_AFTER:
Creates a new #GtkCList widget for use.
@columns: The number of columns the #GtkCList should have.
@Returns: A pointer to a new GtkCList object.
Creates a new #GtkCList widget with column titles for use.
@columns: The number of columns the #GtkCList should have.
@titles: 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.
Sets the shadow type for the specified CList. Changing this value
will cause the #GtkCList to update its visuals.
@clist: The #GtkCList to affect.
@type: The GtkShadowType desired.
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.
@clist: The #GtkCList to affect.
@mode: The GtkSelectionMode type to set for this CList.
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.
@clist: The #GtkCList to freeze.
Causes the specified #GtkCList to allow visual updates.
@clist: The #GtkCList to thaw.
This function causes the #GtkCList to show its column titles, if
they are not already showing.
@clist: The #GtkCList to affect.
Causes the #GtkCList to hide its column titles, if they are currently
showing.
@clist: The #GtkCList to affect.
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.
@clist: The #GtkCList to affect.
@column: The column to make active, counting from 0.
Causes the specified column title button to become passive, i.e., does
not respond to events, such as the user clicking on it.
@clist: The #GtkCList to affect.
@column: The column to make passive, counting from 0.
Causes all column title buttons to become active. This is the same
as calling gtk_clist_column_title_active() for each column.
@clist: The #GtkCList to affect.
Causes all column title buttons to become passive. This is the same
as calling gtk_clist_column_title_passive() for each column.
@clist: The #GtkCList to affect.
Sets the title for the specified column.
@clist: The #GtkCList to affect.
@column: The column whose title should be changed.
@title: A string to be the column's title.
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.
@clist: The #GtkCList to affect.
@column: The column whose title should be a widget.
@widget: A pointer to a previously create widget.
Sets the justification to be used for all text in the specified
column.
@clist: The #GtkCList to affect.
@column: The column which should be affected.
@justification: A GtkJustification value for the column.
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.
@clist: The #GtkCList to affect.
@column: The column to set visibility.
@visible: %TRUE or %FALSE.
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().
@clist: The #GtkCList to affect.
@column: The column on which to set resizeability.
@resizeable: %TRUE or %FALSE.
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.
@clist: The #GtkCList to affect.
@column: The column on which to set auto-resizing.
@auto_resize: %TRUE or %FALSE.
Gets the required width in pixels that is needed to show
everything in the specified column.
@clist: The #GtkCList to check.
@column: The column to check.
@Returns: The required width in pixels for the column.
Causes the column specified for the #GtkCList to be set to
a specified width.
@clist: The #GtkCList to affect.
@column: The column to set the width.
@width: The width, in pixels.
Causes the column specified to have a minimum width, preventing
the user from resizing it smaller than that specified.
@clist: The #GtkCList to affect.
@column: The column to set the minimum width.
@min_width: The width, in pixels.
Causes the column specified to have a maximum width, preventing
the user from resizing it larger than that specified.
@clist: The #GtkCList to affect.
@column: The column to set the maximum width.
@max_width: The width, in pixels.
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.
@clist: The #GtkCList to affect.
@height: The height, in pixels.
Tells the CList widget to visually move to the specified
row and column.
@clist: The #GtkCList to affect.
@row: The row to which to move.
@column: The column to which to move.
@row_align: A value between 0 and 1 that describes the positioning of
the row in relation to the viewable area of the CList's contents.
@col_align: A value between 0 and 1 that describes the positioning of
the column in relation to the viewable area of the CList's contents.
Checks how the specified row is visible.
@clist: The #GtkCList to affect.
@row: The row to query.
@Returns: A #GtkVisibility value that tells you how the row is visible.
Checks the type of cell at the location specified.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@Returns: A #GtkCellType value describing the cell.
Sets the displayed text in the specified cell.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@text: The text to set in the cell.
Gets the text for the specified cell.
@clist: The #GtkCList to affect.
@row: The row to query.
@column: The column to query.
@text: A pointer to a pointer to store the text.
@Returns: 1 if the cell's text could be retrieved, 0 otherwise.
Sets a pixmap for the specified cell.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@pixmap: A pointer to a #GdkPixmap to place in the cell.
@mask: A pointer to a #GdkBitmap mask for the cell.
Gets the pixmap and bitmap mask of the specified cell. The returned mask value can be NULL.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@pixmap: A pointer to a pointer to store the cell's #GdkPixmap.
@mask: A pointer to a pointer to store the cell's #GdkBitmap mask.
@Returns: 1 if the cell's pixmap could be retrieved, 0 otherwise.
Sets text and a pixmap/bitmap on the specified cell.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@text: The text to set in the cell.
@spacing: The spacing between the cell's text and pixmap.
@pixmap: A pointer to a #GdkPixmap for the cell.
@mask: A pointer to a #GdkBitmap mask for the cell.
Gets the text, pixmap and bitmap mask for the specified cell.
@clist: The #GtkCList to affect.
@row: The row to query.
@column: The column to query.
@text: A pointer to a pointer to store the text.
@spacing: A pointer to a #guint8 to store the spacing.
@pixmap: A pointer to a #GdkPixmap pointer to store the cell's pixmap.
@mask: A pointer to a #GdkBitmap pointer to store the cell's bitmap mask.
@Returns: 1 if the retrieval was successful, 0 otherwise.
Sets the foreground color for the specified row.
@clist: The #GtkCList to affect.
@row: The row to affect.
@color: A pointer to a #GdkColor structure.
Sets the background color for the specified row.
@clist: The #GtkCList to affect.
@row: The row to affect.
@color: A pointer to a #GdkColor structure.
Sets the style for the specified cell.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@style: A pointer to a #GtkStyle structure.
Gets the current style of the specified cell.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@Returns: A #GtkStyle object.
Sets the style for all cells in the specified row.
@clist: The #GtkCList to affect.
@row: The row to affect.
@style: A pointer to a #GtkStyle to set.
Gets the style set for the specified row.
@clist: The #GtkCList to affect.
@row: The row to query.
@Returns: The #GtkStyle of the row.
Sets the vertical and horizontal shift of the specified cell.
@clist: The #GtkCList to affect.
@row: The row of the cell.
@column: The column of the cell.
@vertical: The value to set for the vertical shift.
@horizontal: The value to set for the vertical shift.
Sets whether the specified row is selectable or not.
@clist: The #GtkCList to affect.
@row: The row to affect.
@selectable: %TRUE or %FALSE.
Gets whether the specified row is selectable or not.
@clist: The #GtkCList to affect.
@row: The row to query.
@Returns: A #gboolean value.
Adds a row to the CList at the top.
@clist: The #GtkCList to affect.
@text: An array of strings to add.
@Returns: The number of the row added.
Adds a row to the CList at the bottom.
@clist: The #GtkCList to affect.
@text: An array of strings to add.
@Returns: The number of the row added.
Adds a row of text to the CList at the specified position.
@clist: The #GtkCList to affect.
@row: The row where the text should be inserted.
@text: An array of string to add.
@Returns: The number of the row added.
Removes the specified row from the CList.
@clist: The #GtkCList to affect.
@row: The row to remove.
Sets data for the specified row. This is the same as calling gtk_clist_set_row_data_full(clist, row, data, NULL).
@clist: The #GtkCList to affect.
@row: The row to affect.
@data: The data to set for the row.
Sets the data for specified row, with a callback when the row is destroyed.
@clist: The #GtkCList to affect.
@row: The row to affect.
@data: The data to set for the row.
@destroy: A #GtkDestroyNotify function to be called when the row is destroyed.
Gets the currently set data for the specified row.
@clist: The #GtkCList to affect.
@row: The row to query.
@Returns: The data set for the row.
Searches the CList for the row with the specified data.
@clist: The #GtkCList to search.
@data: The data to search for a match.
@Returns: The number of the matching row, or -1 if no match could be found.
Selects the specified row. Causes the "select-row" signal to be emitted for the specified row and column.
@clist: The #GtkCList to affect.
@row: The row to select.
@column: The column to select.
Unselects the specified row. Causes the "unselect-row" signal to be emitted for the specified row and column.
@clist: The #GtkCList to affect.
@row: The row to select.
@column: The column to select.
Undoes the last selection for an "extended selection mode" CList.
@clist: The #GtkCList to affect.
Removes all the CList's rows.
@clist: The #GtkCList to affect.
Gets the row and column at the specified pixel position in the CList.
@clist: The #GtkCList to affect.
@x: The horizontal pixel position to check.
@y: The vertical pixel position to check..
@row: Pointer to a #gint to store the row value.
@column: Pointer to a #gint to store the column value.
@Returns: 1 if row/column is returned and in range, 0 otherwise.
Selects all rows in the CList. This function has no affect for a
CList in "single" or "browse" selection mode.
@clist: The #GtkCList to affect.
Unselects all rows in the CList.
@clist: The #GtkCList to affect.
Swaps the two specified rows with each other.
@clist: The #GtkCList to affect.
@row1: Number of the first row.
@row2: Number of the second row.
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().
@clist: The #GtkCList to affect.
@cmp_func: The #GtkCompareFunction to use.
Sets the sort column of the clist. The sort column is used by the
default compare function to determine which column to sort by.
@clist: The #GtkCList to affect.
@column: The column to sort by
Sets the sort type of the #GtkClist. This is either GTK_SORT_ASCENDING for
ascening sort or GTK_SORT_DESCENDING for descending sort.
@clist: The #GtkCList to affect.
@sort_type: the #GtkSortType to use
Sorts the #GtkClist according to the current compare function, which
can be set with the gtk_clist_set_compare_func() function.
@clist: The #GtkCList to sort.
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.
@clist: The #GtkCList to affect.
@auto_sort: whether auto sort should be on or off
Auto-sizes all columns in the CList and returns the total width of the CList.
@clist: The #GtkCList to affect.
@Returns: The total width of the CList.
Gets the current title of the specified column
@clist: The #GtkCList to affect.
@column: The column to query.
@Returns: The title of the column.
Gets the widget in the column header for the specified column.
@clist: The #GtkCList to affect.
@column: The column to query.
@Returns: Pointer to a #GtkWidget for the column header.
Gets the #GtkAdjustment currently being used for the horizontal
aspect.
@clist: The #GtkCList to check.
@Returns: A #GtkAdjustment object, or NULL if none is currently
being used.
Gets the #GtkAdjustment currently being used for the vertical
aspect.
@clist: The #GtkCList to check.
@Returns: A #GtkAdjustment object, or NULL if none is currently
being used.
Allows you to move a row from one position to another in the
list.
@clist: The #GtkCList to affect.
@source_row: The original position of the row to move.
@dest_row: The position to which the row should be moved.
Sets the action(s) that the specified mouse button will have
on the CList.
@clist: The #GtkCList to affect.
@button: 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.
@button_actions: A logically OR'd value of #GtkButtonAction values
for the button.
Allows you to set the #GtkAdjustment to be used for the horizontal
aspect of the #GtkCList widget.
@clist: The #GtkCList to affect.
@adjustment: A pointer to a #GtkAdjustment widget, or NULL.
Sets whether the CList's rows are re-orderable using drag-and-drop.
@clist: The #GtkCList to affect.
@reorderable: %TRUE or %FALSE.
Determines whether the #GtkClist should use icons when
doing drag-and-drop operations.
@clist: The #GtkCList to affect.
@use_icons: %TRUE or %FALSE.
Allows you to set the #GtkAdjustment to be used for the vertical
aspect of the #GtkCList widget.
@clist: The #GtkCList to affect.
@adjustment: A pointer to a #GtkAdjustment widget, or NULL.