#ifndef __GTK_TREE_VIEW_H__
#define __GTK_TREE_VIEW_H__
+#include <gtk/gtkwidget.h>
#include <gtk/gtkcontainer.h>
#include <gtk/gtktreemodel.h>
#include <gtk/gtktreeviewcolumn.h>
+#include <gtk/gtkdnd.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
-#define GTK_TYPE_TREE_VIEW (gtk_tree_view_get_type ())
-#define GTK_TREE_VIEW(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
-#define GTK_TREE_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
-#define GTK_IS_TREE_VIEW(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_VIEW))
-#define GTK_IS_TREE_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_VIEW))
+typedef enum
+{
+ /* drop before/after this row */
+ GTK_TREE_VIEW_DROP_BEFORE,
+ GTK_TREE_VIEW_DROP_AFTER,
+ /* drop as a child of this row (with fallback to before or after
+ * if into is not possible)
+ */
+ GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
+ GTK_TREE_VIEW_DROP_INTO_OR_AFTER
+} GtkTreeViewDropPosition;
-typedef struct _GtkTreeView GtkTreeView;
-typedef struct _GtkTreeViewClass GtkTreeViewClass;
-typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
+#define GTK_TYPE_TREE_VIEW (gtk_tree_view_get_type ())
+#define GTK_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
+#define GTK_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
+#define GTK_IS_TREE_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW))
+#define GTK_IS_TREE_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW))
+#define GTK_TREE_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
+typedef struct _GtkTreeView GtkTreeView;
+typedef struct _GtkTreeViewClass GtkTreeViewClass;
+typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
typedef struct _GtkTreeSelection GtkTreeSelection;
typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
-
struct _GtkTreeView
{
GtkContainer parent;
{
GtkContainerClass parent_class;
- void (*set_scroll_adjustments) (GtkTreeView *tree_view,
- GtkAdjustment *hadjustment,
- GtkAdjustment *vadjustment);
- gint (*expand_row) (GtkTreeView *tree_view,
- GtkTreeNode node);
+ void (* set_scroll_adjustments) (GtkTreeView *tree_view,
+ GtkAdjustment *hadjustment,
+ GtkAdjustment *vadjustment);
+ void (* row_activated) (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewColumn *column);
+ gboolean (* test_expand_row) (GtkTreeView *tree_view,
+ GtkTreeIter *iter,
+ GtkTreePath *path);
+ gboolean (* test_collapse_row) (GtkTreeView *tree_view,
+ GtkTreeIter *iter,
+ GtkTreePath *path);
+ void (* row_expanded) (GtkTreeView *tree_view,
+ GtkTreeIter *iter,
+ GtkTreePath *path);
+ void (* row_collapsed) (GtkTreeView *tree_view,
+ GtkTreeIter *iter,
+ GtkTreePath *path);
+ void (* columns_changed) (GtkTreeView *tree_view);
+ void (* cursor_changed) (GtkTreeView *tree_view);
+
+ /* Key Binding signals */
+ gboolean (* move_cursor) (GtkTreeView *tree_view,
+ GtkMovementStep step,
+ gint count);
+ gboolean (* select_all) (GtkTreeView *tree_view);
+ gboolean (* unselect_all) (GtkTreeView *tree_view);
+ gboolean (* select_cursor_row) (GtkTreeView *tree_view,
+ gboolean start_editing);
+ gboolean (* toggle_cursor_row) (GtkTreeView *tree_view);
+ gboolean (* expand_collapse_cursor_row) (GtkTreeView *tree_view,
+ gboolean logical,
+ gboolean expand,
+ gboolean open_all);
+ gboolean (* select_cursor_parent) (GtkTreeView *tree_view);
+ gboolean (* start_interactive_search) (GtkTreeView *tree_view);
+
+ /* Padding for future expansion */
+ void (*_gtk_reserved0) (void);
+ void (*_gtk_reserved1) (void);
+ void (*_gtk_reserved2) (void);
+ void (*_gtk_reserved3) (void);
+ void (*_gtk_reserved4) (void);
};
+
+typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_view,
+ GtkTreeViewColumn *column,
+ GtkTreeViewColumn *prev_column,
+ GtkTreeViewColumn *next_column,
+ gpointer data);
+typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ gpointer user_data);
+typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model,
+ gint column,
+ const gchar *key,
+ GtkTreeIter *iter,
+ gpointer search_data);
+
+
/* Creators */
-GtkType gtk_tree_view_get_type (void);
-GtkWidget *gtk_tree_view_new (void);
-GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
-GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
-void gtk_tree_view_set_model (GtkTreeView *tree_view,
- GtkTreeModel *tree_model);
-GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
-GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *layout);
-void gtk_tree_view_set_hadjustment (GtkTreeView *layout,
- GtkAdjustment *adjustment);
-GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *layout);
-void gtk_tree_view_set_vadjustment (GtkTreeView *layout,
- GtkAdjustment *adjustment);
-gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
-void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
- gboolean headers_visible);
-void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
-void gtk_tree_view_set_headers_active (GtkTreeView *tree_view,
- gboolean active);
-gint gtk_tree_view_append_column (GtkTreeView *tree_view,
- GtkTreeViewColumn *column);
-gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
- GtkTreeViewColumn *column);
-gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
- GtkTreeViewColumn *column,
- gint position);
-GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
- gint n);
+GType gtk_tree_view_get_type (void);
+GtkWidget *gtk_tree_view_new (void);
+GtkWidget *gtk_tree_view_new_with_model (GtkTreeModel *model);
+
+/* Accessors */
+GtkTreeModel *gtk_tree_view_get_model (GtkTreeView *tree_view);
+void gtk_tree_view_set_model (GtkTreeView *tree_view,
+ GtkTreeModel *model);
+GtkTreeSelection *gtk_tree_view_get_selection (GtkTreeView *tree_view);
+GtkAdjustment *gtk_tree_view_get_hadjustment (GtkTreeView *tree_view);
+void gtk_tree_view_set_hadjustment (GtkTreeView *tree_view,
+ GtkAdjustment *adjustment);
+GtkAdjustment *gtk_tree_view_get_vadjustment (GtkTreeView *tree_view);
+void gtk_tree_view_set_vadjustment (GtkTreeView *tree_view,
+ GtkAdjustment *adjustment);
+gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view);
+void gtk_tree_view_set_headers_visible (GtkTreeView *tree_view,
+ gboolean headers_visible);
+void gtk_tree_view_columns_autosize (GtkTreeView *tree_view);
+void gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
+ gboolean setting);
+void gtk_tree_view_set_rules_hint (GtkTreeView *tree_view,
+ gboolean setting);
+gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view);
+
+/* Column funtions */
+gint gtk_tree_view_append_column (GtkTreeView *tree_view,
+ GtkTreeViewColumn *column);
+gint gtk_tree_view_remove_column (GtkTreeView *tree_view,
+ GtkTreeViewColumn *column);
+gint gtk_tree_view_insert_column (GtkTreeView *tree_view,
+ GtkTreeViewColumn *column,
+ gint position);
+gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view,
+ gint position,
+ const gchar *title,
+ GtkCellRenderer *cell,
+ ...);
+gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view,
+ gint position,
+ const gchar *title,
+ GtkCellRenderer *cell,
+ GtkTreeCellDataFunc func,
+ gpointer data,
+ GDestroyNotify dnotify);
+GtkTreeViewColumn *gtk_tree_view_get_column (GtkTreeView *tree_view,
+ gint n);
+GList *gtk_tree_view_get_columns (GtkTreeView *tree_view);
+void gtk_tree_view_move_column_after (GtkTreeView *tree_view,
+ GtkTreeViewColumn *column,
+ GtkTreeViewColumn *base_column);
+void gtk_tree_view_set_expander_column (GtkTreeView *tree_view,
+ GtkTreeViewColumn *column);
+GtkTreeViewColumn *gtk_tree_view_get_expander_column (GtkTreeView *tree_view);
+void gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view,
+ GtkTreeViewColumnDropFunc func,
+ gpointer user_data,
+ GtkDestroyNotify destroy);
/* Actions */
-void gtk_tree_view_move_to (GtkTreeView *tree_view,
- GtkTreePath *path,
- GtkTreeViewColumn *column,
- gfloat row_align,
- gfloat col_align);
-void gtk_tree_view_expand_all (GtkTreeView *tree_view);
-void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
+void gtk_tree_view_scroll_to_point (GtkTreeView *tree_view,
+ gint tree_x,
+ gint tree_y);
+void gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewColumn *column,
+ gboolean use_align,
+ gfloat row_align,
+ gfloat col_align);
+void gtk_tree_view_row_activated (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewColumn *column);
+void gtk_tree_view_expand_all (GtkTreeView *tree_view);
+void gtk_tree_view_collapse_all (GtkTreeView *tree_view);
+void gtk_tree_view_expand_to_path (GtkTreeView *tree_view,
+ GtkTreePath *path);
+gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ gboolean open_all);
+gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view,
+ GtkTreePath *path);
+void gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view,
+ GtkTreeViewMappingFunc func,
+ gpointer data);
+gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view,
+ GtkTreePath *path);
+void gtk_tree_view_set_reorderable (GtkTreeView *tree_view,
+ gboolean reorderable);
+gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view);
+void gtk_tree_view_set_cursor (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewColumn *focus_column,
+ gboolean start_editing);
+void gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewColumn *focus_column,
+ GtkCellRenderer *focus_cell,
+ gboolean start_editing);
+void gtk_tree_view_get_cursor (GtkTreeView *tree_view,
+ GtkTreePath **path,
+ GtkTreeViewColumn **focus_column);
+
+
+/* Layout information */
+GdkWindow *gtk_tree_view_get_bin_window (GtkTreeView *tree_view);
+gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view,
+ gint x,
+ gint y,
+ GtkTreePath **path,
+ GtkTreeViewColumn **column,
+ gint *cell_x,
+ gint *cell_y);
+void gtk_tree_view_get_cell_area (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewColumn *column,
+ GdkRectangle *rect);
+void gtk_tree_view_get_background_area (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewColumn *column,
+ GdkRectangle *rect);
+void gtk_tree_view_get_visible_rect (GtkTreeView *tree_view,
+ GdkRectangle *visible_rect);
+void gtk_tree_view_widget_to_tree_coords (GtkTreeView *tree_view,
+ gint wx,
+ gint wy,
+ gint *tx,
+ gint *ty);
+void gtk_tree_view_tree_to_widget_coords (GtkTreeView *tree_view,
+ gint tx,
+ gint ty,
+ gint *wx,
+ gint *wy);
+
+/* Drag-and-Drop support */
+void gtk_tree_view_enable_model_drag_source (GtkTreeView *tree_view,
+ GdkModifierType start_button_mask,
+ const GtkTargetEntry *targets,
+ gint n_targets,
+ GdkDragAction actions);
+void gtk_tree_view_enable_model_drag_dest (GtkTreeView *tree_view,
+ const GtkTargetEntry *targets,
+ gint n_targets,
+ GdkDragAction actions);
+void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
+void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view);
+
+
+/* These are useful to implement your own custom stuff. */
+void gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ GtkTreeViewDropPosition pos);
+void gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view,
+ GtkTreePath **path,
+ GtkTreeViewDropPosition *pos);
+gboolean gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view,
+ gint drag_x,
+ gint drag_y,
+ GtkTreePath **path,
+ GtkTreeViewDropPosition *pos);
+GdkPixmap *gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view,
+ GtkTreePath *path);
+
+/* Interactive search */
+void gtk_tree_view_set_enable_search (GtkTreeView *tree_view,
+ gboolean enable_search);
+gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view);
+gint gtk_tree_view_get_search_column (GtkTreeView *tree_view);
+void gtk_tree_view_set_search_column (GtkTreeView *tree_view,
+ gint column);
+GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view);
+void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view,
+ GtkTreeViewSearchEqualFunc search_equal_func,
+ gpointer search_user_data,
+ GtkDestroyNotify search_destroy);
+
+/* This function should really never be used. It is just for use by ATK.
+ */
+typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
+ GtkTreePath *path,
+ gint children,
+ gpointer user_data);
+void gtk_tree_view_set_destroy_count_func (GtkTreeView *tree_view,
+ GtkTreeDestroyCountFunc func,
+ gpointer data,
+ GtkDestroyNotify destroy);
#ifdef __cplusplus
projects / ~andy / gtk / blobdiff