aboutsummaryrefslogblamecommitdiffstats
path: root/widgets/e-table/e-tree-model.h
blob: 7b8d86826f6ad604ab2fb53b4d5bac1a110d142f (plain) (tree)
1
2
3
4
5
6




                                                                           
                                  






                                                                                                
                        


                         


                                                                                    









                                                      
                                                                       

                                                                       






                                                                                                            
 
                                                                              




                                                                      



                                                                                                 



                  


                                                                                                   



                                         
                                                       

                                    

                                                            
                                                                             



                                                                             

                                                                                                                          
















                                                                                                            
                                                                                   









                                                                                                            

                            
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
#ifndef _E_TREE_MODEL_H_
#define _E_TREE_MODEL_H_

#include "e-table-model.h"
#include "gdk-pixbuf/gdk-pixbuf.h"

#define E_TREE_MODEL_TYPE        (e_tree_model_get_type ())
#define E_TREE_MODEL(o)          (GTK_CHECK_CAST ((o), E_TREE_MODEL_TYPE, ETreeModel))
#define E_TREE_MODEL_CLASS(k)    (GTK_CHECK_CLASS_CAST((k), E_TREE_MODEL_TYPE, ETreeModelClass))
#define E_IS_TREE_MODEL(o)       (GTK_CHECK_TYPE ((o), E_TREE_MODEL_TYPE))
#define E_IS_TREE_MODEL_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_TREE_MODEL_TYPE))

typedef GNode ETreePath;

typedef struct {
    ETableModel base;
    GNode      *root;
    gboolean   root_visible;
    GArray     *row_array; /* used in the mapping between ETable and our tree */
} ETreeModel;

typedef struct {
    ETableModelClass parent_class;

    /*
     * Virtual methods
     */
    ETreePath *(*get_root)      (ETreeModel *etm);

    ETreePath *(*get_parent)    (ETreeModel *etm, ETreePath* node);
    ETreePath *(*get_next)      (ETreeModel *etm, ETreePath* node);
    ETreePath *(*get_prev)      (ETreeModel *etm, ETreePath* node);
    guint      (*get_children)         (ETreeModel *etm, ETreePath* node, ETreePath ***paths);

    gboolean   (*is_expanded)          (ETreeModel *etm, ETreePath* node);
    gboolean   (*is_visible)           (ETreeModel *etm, ETreePath* node);
    void       (*set_expanded)         (ETreeModel *etm, ETreePath* node, gboolean expanded);
    void       (*set_expanded_recurse) (ETreeModel *etm, ETreePath *node, gboolean expanded);
    void       (*set_expanded_level)   (ETreeModel *etm, ETreePath *node, gboolean expanded, int level);

    GdkPixbuf *(*icon_at)              (ETreeModel *etm, ETreePath* node);
    ETreePath* (*node_at_row)          (ETreeModel *etm, int row);

    /*
     * ETable analogs
     */
    void      *(*value_at)      (ETreeModel *etm, ETreePath* node, int col);
    void       (*set_value_at)  (ETreeModel *etm, ETreePath* node, int col, const void *val);
    gboolean   (*is_editable)   (ETreeModel *etm, ETreePath* node, int col);


    /*
     * Signals
     */
    void       (*node_changed)  (ETreeModel *etm, ETreePath *node);
    void       (*node_inserted) (ETreeModel *etm, ETreePath *parent, ETreePath *inserted_node);
    void       (*node_removed)  (ETreeModel *etm, ETreePath *parent, ETreePath *removed_node);

} ETreeModelClass;

GtkType     e_tree_model_get_type (void);
void        e_tree_model_construct (ETreeModel *etree);
ETreeModel *e_tree_model_new (void);

/* tree traversal operations */
ETreePath *e_tree_model_get_root        (ETreeModel *etree);
ETreePath *e_tree_model_node_get_parent (ETreeModel *etree, ETreePath *path);
ETreePath *e_tree_model_node_get_next   (ETreeModel *etree, ETreePath *path);
ETreePath *e_tree_model_node_get_prev   (ETreeModel *etree, ETreePath *path);

/* node operations */
ETreePath *e_tree_model_node_insert        (ETreeModel *etree, ETreePath *parent, int position, gpointer node_data);
ETreePath *e_tree_model_node_insert_before (ETreeModel *etree, ETreePath *parent, ETreePath *sibling, gpointer node_data);
gpointer   e_tree_model_node_remove        (ETreeModel *etree, ETreePath *path);

/* node accessors */
gboolean e_tree_model_node_is_root                 (ETreeModel *etree, ETreePath *path);
gboolean e_tree_model_node_is_expandable           (ETreeModel *etree, ETreePath *path);
gboolean e_tree_model_node_is_expanded             (ETreeModel *etree, ETreePath *path);
gboolean e_tree_model_node_is_visible              (ETreeModel *etree, ETreePath *path);
void     e_tree_model_node_set_expanded            (ETreeModel *etree, ETreePath *path, gboolean expanded);
void     e_tree_model_node_set_expanded_recurse    (ETreeModel *etree, ETreePath *path, gboolean expanded);
guint    e_tree_model_node_get_children            (ETreeModel *etree, ETreePath *path, ETreePath ***paths);
guint    e_tree_model_node_depth                   (ETreeModel *etree, ETreePath *path);
guint    e_tree_model_node_num_visible_descendents (ETreeModel *etm, ETreePath *node);
gpointer e_tree_model_node_get_data                (ETreeModel *etm, ETreePath *node);
void     e_tree_model_node_set_data                (ETreeModel *etm, ETreePath *node, gpointer node_data);

/* display oriented routines */
ETreePath *e_tree_model_node_at_row           (ETreeModel *etree, int row);
GdkPixbuf *e_tree_model_icon_of_node          (ETreeModel *etree, ETreePath *path);
int        e_tree_model_row_of_node           (ETreeModel *etree, ETreePath *path);
void       e_tree_model_root_node_set_visible (ETreeModel *etree, gboolean visible);
gboolean   e_tree_model_root_node_is_visible  (ETreeModel *etree);

/*
** Routines for emitting signals on the ETreeModel
*/
void  e_tree_model_node_changed  (ETreeModel *tree_model, ETreePath *node);
void  e_tree_model_node_inserted (ETreeModel *tree_model, ETreePath *parent_node, ETreePath *inserted_node);
void  e_tree_model_node_removed  (ETreeModel *tree_model, ETreePath *parent_node, ETreePath *removed_node);

#endif /* _E_TREE_MODEL_H */