index, gtk-- homepage

class Gtk_CList

#include <gtk--/clist.h>
Multi-column list widget designed to handle very much data without performance problems
Base classes: Gtk_Container

Public member index

Protected member index

Public member descriptions

set_border

void Gtk_CList::set_border(GtkShadowType border);

set the border style of the clist

valid choices are: GTK_SHADOW_NONE, GTK_SHADOW_IN, GTK_SHADOW_OUT, GTK_SHADOW_ETCHED_IN, GTK_SHADOW_ETCHED_OUT


set_selection_mode

void Gtk_CList::set_selection_mode(GtkSelectionMode mode);

set the clist's selection mode

set_policy

void Gtk_CList::set_policy(GtkPolicyType vscrollbar_policy, GtkPolicyType hscrollbar_policy);

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

valid choices are: GTK_POLICY_ALWAYS, GTK_POLICY_AUTOMATIC


freeze

void Gtk_CList::freeze(void);

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

thaw

void Gtk_CList::thaw(void);

thaw the list (see freeze)

column_titles_show

void Gtk_CList::column_titles_show(void);

show the column title buttons

column_titles_hide

void Gtk_CList::column_titles_hide(void);

hide the column title buttons

column_title_active

void Gtk_CList::column_title_active(gint column);

set the column title to be a active title (responds to button presses, prelights, and grabs keyboard focus)

column_title_passive

void Gtk_CList::column_title_passive(gint column);

set the column title to be passive where it acts as just a title

column_titles_active

void Gtk_CList::column_titles_active(void);

set the column titles to be a active (respond to button presses, prelight, and grab keyboard focus)

column_titles_passive

void Gtk_CList::column_titles_passive(void);

set the column titles to be passive where they act as just a title

set_column_title

void Gtk_CList::set_column_title(gint column, const gchar *title);

set the title in the column title button

set_column_widget

void Gtk_CList::set_column_widget(gint column, Gtk_Widget *widget);

set a widget instead of a title for the column title button

set_column_justification

void Gtk_CList::set_column_justification(gint column, GtkJustification justification);

set the justification on a column

valid choices are: GTK_JUSTIFY_LEFT, GTK_JUSTIFY_RIGHT, GTK_JUSTIFY_CENTER, GTK_JUSTIFY_FILL


set_column_width

void Gtk_CList::set_column_width(gint column, gint width);

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

set_row_height

void Gtk_CList::set_row_height(gint height);

change the height of the rows, the default is the hight of the current font

moveto

void Gtk_CList::moveto(gint row, gint column, gfloat row_align, gfloat col_align);

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; if row or column is -1 then then there is no change

row_is_visible

bool Gtk_CList::row_is_visible(gint row);

returns whether the row is visible

get_cell_type

GtkCellType Gtk_CList::get_cell_type(gint row, gint column);

returns the cell type, which is one of GTK_CELL_EMPTY, GTK_CELL_TEXT, GTK_CELL_PIXMAP, GTK_CELL_PIXTEXT, GTK_CELL_WIDGET

set_text

void Gtk_CList::set_text(gint row, gint column, const gchar *text);

sets a given cell's text, replacing it's current contents

get_text

gint Gtk_CList::get_text(gint row, gint column, gchar **text);

returns 1 on success

set_pixmap

void Gtk_CList::set_pixmap(gint row, gint column, GdkPixmap *pixmap, GdkBitmap *mask);

sets a given cell's pixmap, replacing it's current contents

get_pixmap

gint Gtk_CList::get_pixmap(gint row, gint column, GdkPixmap **pixmap, GdkBitmap **mask);

returns 1 on success any of the return pointer can be NULL if you are not interested

set_pixtext

void Gtk_CList::set_pixtext(gint row, gint column, const gchar *text, guint8 spacing, GdkPixmap *pixmap, GdkBitmap *mask);

sets a given cell's pixmap and text, replacing it's current contents

get_pixtext

gint Gtk_CList::get_pixtext(gint row, gint column, gchar **text, guint8 *spacing, GdkPixmap **pixmap, GdkBitmap **mask);

any of the return pointer can be NULL if you are not interested

set_foreground

void Gtk_CList::set_foreground(gint row, GdkColor *color);

sets the foreground color of a row, the color must already be allocated

set_background

void Gtk_CList::set_background(gint row, GdkColor *color);

sets the background color of a row, the color must already be allocated

set_shift

void Gtk_CList::set_shift(gint row, gint column, gint vertical, gint horizontal);

this sets a horizontal and vertical shift for drawing the contents of a cell; it can be positive or negitive; this is partuculary useful for indenting items in a column

append

gint Gtk_CList::append(gchar * text[]);

append returns the index of the row you just added, making it easier to append and modify a row

insert_row

void Gtk_CList::insert_row(gint row, gchar *text[]);

inserts a row at index row Note: this is gtk_clist_insert() in gtk, but renamed here to insert_row()

remove_row

void Gtk_CList::remove_row(gint row);

removes row at index row Note: this is gtk_clist_remove() in gtk, but renamed here to remove_row()

set_row_data

void Gtk_CList::set_row_data(gint row, gpointer data);

sets a arbitrary data pointer for a given row

get_row_data

gpointer Gtk_CList::get_row_data(gint row);

returns the data set for a row

set_row_data_full

void Gtk_CList::set_row_data_full(gint row, gpointer data, GtkDestroyNotify destroy);

sets a data pointer for a given row with destroy notification

find_row_from_data

gint Gtk_CList::find_row_from_data(gpointer data);

given a data pointer, find the first (and hopefully only!) row that points to that data, or -1 if none do

cause_select_row

void Gtk_CList::cause_select_row(gint row, gint column);

force selection of a row

cause_unselect_row

void Gtk_CList::cause_unselect_row(gint row, gint column);

force unselection of a row

clear

void Gtk_CList::clear();

clear the entire list -- this is much faster than removing each item with remove.

get_selection_info

gint Gtk_CList::get_selection_info(gint x, gint y, gint *row, gint *column);

return the row column corresponding to the x and y coordinates

reference and pointer style available


select_row

Signal_proxyN<void,widgettype,gint,gint,GdkEventButton*> Gtk_CList::select_row;

signal emitted on row selection (row, column, event)

unselect_row

Signal_proxyN<void,widgettype,gint,gint,GdkEventButton*> Gtk_CList::unselect_row;

signal emitted on row unselection (row, column, event)

click_column

Signal_proxyN<void,widgettype,gint> Gtk_CList::click_column;

signal emitted by clicking on a title ? (column)

Protected member descriptions

(pages generated by PERCEPS -script.)