app/diagram_tree.h

   1 /* Dia -- a diagram creation/manipulation program
   2  * Copyright (C) 1998 Alexander Larsson
   3  *
   4  * diagram_tree.h : a tree showing open diagrams
   5  * Copyright (C) 2001 Jose A Ortega Ruiz
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  *
  21  */
  22
  23
  24 #ifndef DIAGRAM_TREE_H
  25 #define DIAGRAM_TREE_H
  26
  27 #include <gtk/gtk.h>
  28 #include "diagram.h"
  29
  30 /* the diagram tree adt */
  31 typedef struct _DiagramTree DiagramTree;
  32
  33
  34 /* sort types */
  35 typedef enum {
  36   DIA_TREE_SORT_NAME,
  37   DIA_TREE_SORT_TYPE,
  38   DIA_TREE_SORT_INSERT
  39 } DiagramTreeSortType;
  40
  41
  42
  43 /* create a new tree with a list of already open diagrams */
  44 extern DiagramTree*
  45 diagram_tree_new(GList *diagrams, GtkWindow *window,
  46                  DiagramTreeSortType dia_sort,
  47                  DiagramTreeSortType obj_sort);
  48
  49 /* delete a tree (the widget is destroyed, but not the diagrams */
  50 extern void
  51 diagram_tree_delete(DiagramTree *tree);
  52
  53 /* add a diagram to the tree */
  54 extern void
  55 diagram_tree_add(DiagramTree *tree, Diagram *diagram);
  56
  57 /* remove a diagram from the tree */
  58 extern void
  59 diagram_tree_remove(DiagramTree *tree, Diagram *diagram);
  60
  61 /* update a diagram in the tree */
  62 extern void
  63 diagram_tree_update_all(DiagramTree *tree);
  64
  65 extern void
  66 diagram_tree_update(DiagramTree *tree, Diagram *diagram);
  67
  68 extern void
  69 diagram_tree_update_name(DiagramTree *tree, Diagram *diagram);
  70
  71 /* add/remove an object in a diagram already contained in the tree */
  72 extern void
  73 diagram_tree_add_object(DiagramTree *tree, Diagram *diagram, Object *object);
  74
  75 extern void
  76 diagram_tree_add_objects(DiagramTree *tree, Diagram *diagram, GList *objects);
  77
  78 extern void
  79 diagram_tree_remove_object(DiagramTree *tree, Object *object);
  80
  81 extern void
  82 diagram_tree_remove_objects(DiagramTree *tree, GList *objects);
  83
  84 extern void
  85 diagram_tree_update_object(DiagramTree *tree, Diagram *diagram,
  86                            Object *object);
  87
  88 /* operations on the last clicked node */
  89 extern void
  90 diagram_tree_raise(DiagramTree *tree);
  91
  92 extern void
  93 diagram_tree_show_properties(const DiagramTree *tree);
  94
  95 extern const gchar * /* hidden type */
  96 diagram_tree_hide_type(DiagramTree *tree);
  97
  98 extern void
  99 diagram_tree_hide_explicit_type(DiagramTree *tree, const gchar *type);
 100
 101 extern void
 102 diagram_tree_unhide_type(DiagramTree *tree, const gchar *type);
 103
 104 extern void
 105 diagram_tree_sort_objects(DiagramTree *tree, DiagramTreeSortType type);
 106
 107 extern void
 108 diagram_tree_sort_all_objects(DiagramTree *tree, DiagramTreeSortType type);
 109
 110 extern void
 111 diagram_tree_sort_diagrams(DiagramTree *tree, DiagramTreeSortType type);
 112
 113 extern void
 114 diagram_tree_set_object_sort_type(DiagramTree *tree, DiagramTreeSortType type);
 115
 116 extern void
 117 diagram_tree_set_diagram_sort_type(DiagramTree *tree, DiagramTreeSortType type);
 118
 119 extern DiagramTreeSortType
 120 diagram_tree_diagram_sort_type(const DiagramTree *tree);
 121
 122 extern DiagramTreeSortType
 123 diagram_tree_object_sort_type(const DiagramTree *tree);
 124
 125 /* get the tree widget */
 126 extern GtkWidget*
 127 diagram_tree_widget(const DiagramTree *tree);
 128
 129
 130 #endif /* DIAGRAM_TREE_H */