Main Page | Alphabetical List | Compound List | File List | Compound Members | File Members

gtkxtreeview.h File Reference

#include <inttypes.h>
#include <glib.h>
#include <glib-object.h>

Include dependency graph for gtkxtreeview.h:

Include dependency graph

Go to the source code of this file.

Defines

#define GTK_XTREE_VIEW_TYPE   (gtk_xtree_view_get_type ())
#define GTK_XTREE_VIEW(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_XTREE_VIEW_TYPE, GtkXTreeView))
#define GTK_XTREE_VIEW_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_XTREE_VIEW_TYPE, GtkXTreeViewClass))
#define IS_GTK_XTREE_VIEW(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_XTREE_VIEW_TYPE))
#define IS_GTK_XTREE_VIEW_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_XTREE_VIEW_TYPE))

Typedefs

typedef _GtkXTreeView GtkXTreeView
typedef _GtkXTreeViewClass GtkXTreeViewClass
typedef gboolean(* GtkXTreeViewRowDataFunc )(void *iterator, guint col_id, void **content, gchar **attribute, gpointer data)
typedef void(* GtkXTreeViewRowParamsFunc )(void *iterator, gboolean *has_children, guint *depth, gpointer data)
typedef gboolean(* GtkXTreeViewDataIteratorFunc )(void **iterator, gboolean is_next, gboolean sibling_first, guint sort_col_id, GtkSortType sort_order, gpointer data)
typedef gboolean(* GtkXTreeViewMatchFunc )(void *iterator, gpointer data)

Enumerations

enum  GtkXColumnType { GTK_XCOLUMN_TYPE_TEXT, GTK_XCOLUMN_TYPE_PIXBUF, GTK_XCOLUMN_TYPE_STOCKID }

Functions

GType gtk_xtree_view_get_type (void)
GtkWidget * gtk_xtree_view_new (void)
gboolean gtk_xtree_view_insert_column (GtkXTreeView *xtv, guint col, guint col_id, GtkXColumnType type, gboolean is_sortable, GtkSortType sort_order, GtkWidget *title_widget, gchar *title_string)
gboolean gtk_xtree_view_set_sort_column (GtkXTreeView *xtv, guint col_id, GtkSortType sort_order)
void gtk_xtree_view_set_column_width (GtkXTreeView *xtv, guint col_id, guint width)
void gtk_xtree_view_set_expansible_column (GtkXTreeView *xtv, guint col_id)
void gtk_xtree_view_set_expander_column (GtkXTreeView *xtv, guint col_id)
void gtk_xtree_view_set_row_data_func (GtkXTreeView *xtv, GtkXTreeViewRowDataFunc func, gpointer data)
void gtk_xtree_view_set_row_params_func (GtkXTreeView *xtv, GtkXTreeViewRowParamsFunc func, gpointer data)
void gtk_xtree_view_set_data_iterator_func (GtkXTreeView *xtv, GtkXTreeViewDataIteratorFunc func, gpointer data)
void gtk_xtree_view_update_all (GtkXTreeView *xtv)
void gtk_xtree_view_update_row (GtkXTreeView *xtv, void *iterator)
void gtk_xtree_view_update_cell (GtkXTreeView *xtv, void *iterator, guint col_id)
void gtk_xtree_view_set_first_row (GtkXTreeView *xtv, void *iterator)
void gtk_xtree_view_set_length (GtkXTreeView *xtv, guint length)
void gtk_xtree_view_freeze (GtkXTreeView *xtv)
void gtk_xtree_view_thaw (GtkXTreeView *xtv)
void gtk_xtree_view_update (GtkXTreeView *xtv)
void * gtk_xtree_view_get_focused (GtkXTreeView *xtv)
gboolean gtk_xtree_view_find_cell (GtkXTreeView *xtv, gint x, gint y, void **iterator, gint *row, gint *col_id, gboolean *expander)
uint32_t gtk_xtree_view_get_selection (GtkXTreeView *xtv, void ***selection)
void gtk_xtree_view_reset (GtkXTreeView *xtv)
void gtk_xtree_view_clear_selection (GtkXTreeView *xtv)
uint32_t gtk_xtree_view_select_all (GtkXTreeView *xtv, void ***selection)
uint32_t gtk_xtree_view_invert_selection (GtkXTreeView *xtv, void ***selection)
void gtk_xtree_view_set_match_func (GtkXTreeView *xtv, GtkXTreeViewMatchFunc func, gpointer data)
gboolean gtk_xtree_view_next_match (GtkXTreeView *xtv, gboolean activate_match)
gboolean gtk_xtree_view_prev_match (GtkXTreeView *xtv, gboolean activate_match)
uint32_t gtk_xtree_view_select_all_matches (GtkXTreeView *xtv, gboolean new_selection)
void gtk_xtree_view_activate_focused (GtkXTreeView *xtv, guint state)
gboolean gtk_xtree_view_toggle_node (GtkXTreeView *xtv, void *iterator)
gboolean gtk_xtree_view_expand_node (GtkXTreeView *xtv, void *iterator)
gboolean gtk_xtree_view_collapse_node (GtkXTreeView *xtv, void *iterator)

Define Documentation

#define GTK_XTREE_VIEW (  obj   )     (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_XTREE_VIEW_TYPE, GtkXTreeView))
 

#define GTK_XTREE_VIEW_CLASS (  klass   )     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_XTREE_VIEW_TYPE, GtkXTreeViewClass))
 

#define GTK_XTREE_VIEW_TYPE   (gtk_xtree_view_get_type ())
 

#define IS_GTK_XTREE_VIEW (  obj   )     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_XTREE_VIEW_TYPE))
 

#define IS_GTK_XTREE_VIEW_CLASS (  klass   )     (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_XTREE_VIEW_TYPE))
 

Typedef Documentation

typedef struct _GtkXTreeView GtkXTreeView
 

typedef struct _GtkXTreeViewClass GtkXTreeViewClass
 

typedef gboolean(* GtkXTreeViewDataIteratorFunc)(void **iterator, gboolean is_next, gboolean sibling_first, guint sort_col_id, GtkSortType sort_order, gpointer data)
 

A function to traverse the data, step by step on a certain direction

Parameters:
iterator the starting point
whether we want the next iterator or the previous one
sibling_first whether we do not iterate through children when next iterator is requested or whether we return previous sibling or our parent when previous iterator is requested
sort_column_id the id of the sorting column
sort_order the sort order
Returns:
TRUE if next iterator was found and iterator is changed; FALSE if no other iterator was found, and iterator is not changed
The idea is that the user can better sort its data and optionnally cache sorting results When the widget issues a "sort-changed" signal, the user must catch it and sort its data so that when the next time this function is called it is ready to return the requested iterator Example: 1 1.1 1.2 1.2.1 1.2.2 1.2.2.1 1.2.3 NEXT SAME_LEVEL ITERATOR=1.2.2 ITERATOR=1.2.1 TRUE FALSE 1.2.2.1 1.2.2 TRUE TRUE 1.2.3 1.2.2 FALSE FALSE 1.2 1.2 FALSE TRUE 1.2.1 1.2 So to move one row down, next = TRUE, same_level = FALSE up, next = FALSE, same_level = TRUE

typedef gboolean(* GtkXTreeViewMatchFunc)(void *iterator, gpointer data)
 

The matching function to search an item This function is called by gtk_xtree_view_activate_next_match() gtk_xtree_view_activate_prev_match() and gtk_xtree_view_select_all_matches()

typedef gboolean(* GtkXTreeViewRowDataFunc)(void *iterator, guint col_id, void **content, gchar **attribute, gpointer data)
 

The function that returns the data associated with a row

Parameters:
iterator a pointer to the data
col the column ID for which data is needed.
text a place holder which will contain the pointer to the data
attribute a place holder which will contain the name of the attribute that should be used to display the data

typedef void(* GtkXTreeViewRowParamsFunc)(void *iterator, gboolean *has_children, guint *depth, gpointer data)
 

Get a params of a node: whether it has children, and its depth in the tree

Enumeration Type Documentation

enum GtkXColumnType
 

Enumeration values:
GTK_XCOLUMN_TYPE_TEXT 
GTK_XCOLUMN_TYPE_PIXBUF 
GTK_XCOLUMN_TYPE_STOCKID 

Function Documentation

void gtk_xtree_view_activate_focused (  GtkXTreeView *  xtv,
guint  state
) 
 

void gtk_xtree_view_clear_selection (  GtkXTreeView *  xtv  ) 
 

gboolean gtk_xtree_view_collapse_node (  GtkXTreeView *  xtv,
void *  iterator
) 
 

gboolean gtk_xtree_view_expand_node (  GtkXTreeView *  xtv,
void *  iterator
) 
 

gboolean gtk_xtree_view_find_cell (  GtkXTreeView *  xtv,
gint  x,
gint  y,
void **  iterator,
gint *  row,
gint *  col_id,
gboolean *  expander
) 
 

void gtk_xtree_view_freeze (  GtkXTreeView *  xtv  ) 
 

void* gtk_xtree_view_get_focused (  GtkXTreeView *  xtv  ) 
 

uint32_t gtk_xtree_view_get_selection (  GtkXTreeView *  xtv,
void ***  selection
) 
 

GType gtk_xtree_view_get_type (  void   ) 
 

gboolean gtk_xtree_view_insert_column (  GtkXTreeView *  xtv,
guint  col,
guint  col_id,
GtkXColumnType  type,
gboolean  is_sortable,
GtkSortType  sort_order,
GtkWidget *  title_widget,
gchar *  title_string
) 
 

Insert a new column

Parameters:
col column number where the new column will be inserted. 0 to prepend.
type the type of the column GTK_XCOLUMN_TYPE_TEXT, GTK_XCOLUMN_TYPE_PIXBUF
column_id a user provided id to identify the column without its number
title_widget a widget that will put before the column title_string
title_string the title of the column

uint32_t gtk_xtree_view_invert_selection (  GtkXTreeView *  xtv,
void ***  selection
) 
 

GtkWidget* gtk_xtree_view_new (  void   ) 
 

gboolean gtk_xtree_view_next_match (  GtkXTreeView *  xtv,
gboolean  activate_match
) 
 

gboolean gtk_xtree_view_prev_match (  GtkXTreeView *  xtv,
gboolean  activate_match
) 
 

void gtk_xtree_view_reset (  GtkXTreeView *  xtv  ) 
 

uint32_t gtk_xtree_view_select_all (  GtkXTreeView *  xtv,
void ***  selection
) 
 

uint32_t gtk_xtree_view_select_all_matches (  GtkXTreeView *  xtv,
gboolean  new_selection
) 
 

void gtk_xtree_view_set_column_width (  GtkXTreeView *  xtv,
guint  col_id,
guint  width
) 
 

void gtk_xtree_view_set_data_iterator_func (  GtkXTreeView *  xtv,
GtkXTreeViewDataIteratorFunc  func,
gpointer  data
) 
 

void gtk_xtree_view_set_expander_column (  GtkXTreeView *  xtv,
guint  col_id
) 
 

void gtk_xtree_view_set_expansible_column (  GtkXTreeView *  xtv,
guint  col_id
) 
 

void gtk_xtree_view_set_first_row (  GtkXTreeView *  xtv,
void *  iterator
) 
 

void gtk_xtree_view_set_length (  GtkXTreeView *  xtv,
guint  length
) 
 

void gtk_xtree_view_set_match_func (  GtkXTreeView *  xtv,
GtkXTreeViewMatchFunc  func,
gpointer  data
) 
 

void gtk_xtree_view_set_row_data_func (  GtkXTreeView *  xtv,
GtkXTreeViewRowDataFunc  func,
gpointer  data
) 
 

Set the function that will return the row content

Parameters:
func the function
data a user data passed to func

void gtk_xtree_view_set_row_params_func (  GtkXTreeView *  xtv,
GtkXTreeViewRowParamsFunc  func,
gpointer  data
) 
 

gboolean gtk_xtree_view_set_sort_column (  GtkXTreeView *  xtv,
guint  col_id,
GtkSortType  sort_order
) 
 

Returns:
TRUE if sort has changed, FALSE if it was already set

void gtk_xtree_view_thaw (  GtkXTreeView *  xtv  ) 
 

gboolean gtk_xtree_view_toggle_node (  GtkXTreeView *  xtv,
void *  iterator
) 
 

void gtk_xtree_view_update (  GtkXTreeView *  xtv  ) 
 

void gtk_xtree_view_update_all (  GtkXTreeView *  xtv  ) 
 

void gtk_xtree_view_update_cell (  GtkXTreeView *  xtv,
void *  iterator,
guint  col_id
) 
 

void gtk_xtree_view_update_row (  GtkXTreeView *  xtv,
void *  iterator
) 
 

Generated on Wed Oct 22 15:52:28 2003 for XetPan by doxygen 1.3.2