PHP Editor Review - Gtk Manual Gtk gtkclist

GtkCList

A multi-columned scrolling list widget.

Object Hierarchy

GtkObject
`-- GtkWidget
`-- GtkContainer
`-- GtkCList

Direct subclasses

GtkCTree

Description

A GtkCList allows you to display tabular data in rows, divided into multiple columns.

Note that is it not possible to create new columns after the widget has been instantiated. A workaround is to create a number of columns and hide the ones you don't need.

GtkCList has been deprecated since GTK+ 2.0 and should not be used in newly written code.

Constructor

GtkCList (int columns, Array titles]);
-- Creates a new GtkCList object

Methods

set_hadjustment()
Allows you to set the GtkAdjustment to be used for the horizontal aspect of the GtkCList widget.
set_vadjustment()
Allows you to set the GtkAdjustment to be used for the vertical aspect of the GtkCList widget.
get_hadjustment()
Gets the GtkAdjustment currently being used for the horizontal aspect.
get_vadjustment()
Gets the GtkAdjustment currently being used for the vertical aspect.
set_shadow_type()
Set the outer border (shadow) of the widget
set_selection_mode()
Sets the selection mode for the specified CList.
set_reorderable()
Sets whether the CList's rows are re-orderable using drag-and-drop.
set_use_drag_icons()
Determines whether the GtkCList should use icons when doing drag-and-drop operations.
set_button_actions()
Sets the action(s) that the specified mouse button will have on the list.
freeze()
Causes the GtkCList to stop updating its visuals.
thaw()
Causes the specified GtkCList to allow visual updates.
column_titles_show()
Makes the column titles visible.
column_titles_hide()
Hides the column titles.
column_title_active()
Sets the specified column to become selectable.
column_title_passive()
Causes the specified column title button to not respond to events.
column_titles_active()
Causes all column title buttons to become active.
column_titles_passive()
Causes all column title buttons to become passive.
set_column_title()
Set the title of the specified column.
get_column_title()
Returns the title of the specified column.
set_column_widget()
Sets a widget to be used as the specified column's title.
get_column_widget()
Returns the custom widget for the given column.
set_column_justification()
Sets the justification to be used for all text in the specified column.
set_column_visibility()
Allows you to set whether a specified column in the GtkCList should be hidden or shown.
set_column_resizeable()
Lets you specify whether a specified column should be resizeable by the user.
set_column_auto_resize()
Lets you specify whether a column should be automatically resized by the widget when data is added or removed.
columns_autosize()
Auto-sizes all columns in the CList and returns the total width of the CList.
optimal_column_width()
Gets the required width in pixels that is needed to show everything in the specified column.
set_column_width()
Causes the column specified to be set to a specified width.
set_column_min_width()
Causes the column specified to have a minimum width.
set_column_max_width()
Causes the column specified to have a maximum width.
set_row_height()
Causes the GtkCList to have a specified height for its rows.
moveto()
Tells the CList widget to visually move to the specified row and column.
row_is_visible()
Checks how the specified row is visible.
get_cell_type()
Checks the type of cell at the location specified.
set_text()
Sets the displayed text in the specified cell.
get_text()
Gets the text for the specified cell.
set_pixmap()
Sets a pixmap for the specified cell.
set_pixtext()
Sets text and a pixmap/bitmap on the specified cell.
set_foreground()
Sets the foreground color for the specified row.
set_background()
Sets the background color for the specified row.
set_cell_style()
Sets the style for the specified cell.
get_cell_style()
Gets the current style of the specified cell.
set_row_style()
Sets the style for all cells in the specified row.
get_row_style()
Gets the style set for the specified row.
set_shift()
Sets the vertical and horizontal shift of the specified cell.
set_selectable()
Sets whether the specified row is selectable or not.
get_selectable()
Gets whether the specified row is selectable or not.
prepend()
Adds a row to the list at the top.
append()
Adds a row to the list at the bottom.
insert()
Adds a row of text to the list at the specified position.
remove()
Removes the specified row from the list.
select_row()
Selects the specified row.
unselect_row()
Unselects the specified row.
undo_selection()
Undoes the last selection for an "extended selection mode" list.
clear()
Removes all the rows.
select_all()
Selects all rows in the CList.
unselect_all()
Unselects all rows in the list.
swap_rows()
Swaps the two specified rows with each other.
row_move()
Allows you to move a row from one position to another in the list.
set_sort_column()
Sets the sort column of the clist.
set_sort_type()
Sets the sort type of the GtkClist.
sort()
Sorts the list.
set_auto_sort()
Turns on or off auto sort of the GtkCList.

Signals

"select-row"
This signal is emitted when the user selects a row in the list.
"unselect-row"
This signal is emitted when the user unselects a row in the list.
"row-move"
This signal is emitted when a row is moved.
"click-column"
This signal is emitted when a column title is clicked.
"resize-column"
This signal is emitted when a column is resized.

Properties

focus_row:
Number of the row having the focus.
rows:
Returns the number of rows.
row_list:
Returns all rows in the list.
selection:
Array of selected rows.
selection_mode:
Returns the current selection mode.
sort_column:
The current row after which the list shall be sorted.
sort_type:
The current sort type (order).