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 #define HIDDEN_TYPES_NAME "diagram-tree-hidden-types"
  31
  32 /* the diagram tree adt */
  33 typedef struct _DiagramTree DiagramTree;
  34
  35
  36 /* sort types */
  37 typedef enum {
  38   DIA_TREE_SORT_NAME,
  39   DIA_TREE_SORT_TYPE,
  40   DIA_TREE_SORT_INSERT
  41 } DiagramTreeSortType;
  42
  43
  44
  45 /* create a new tree with a list of already open diagrams */
  46 extern DiagramTree*
  47 diagram_tree_new(GList *diagrams, GtkWindow *window,
  48                  DiagramTreeSortType dia_sort,
  49                  DiagramTreeSortType obj_sort);
  50
  51 /* delete a tree (the widget is destroyed, but not the diagrams */
  52 extern void
  53 diagram_tree_delete(DiagramTree *tree);
  54
  55 /* add a diagram to the tree */
  56 extern void
  57 diagram_tree_add(DiagramTree *tree, Diagram *diagram);
  58
  59 /* remove a diagram from the tree */
  60 extern void
  61 diagram_tree_remove(DiagramTree *tree, Diagram *diagram);
  62
  63 /* update a diagram in the tree */
  64 extern void
  65 diagram_tree_update_all(DiagramTree *tree);
  66
  67 extern void
  68 diagram_tree_update(DiagramTree *tree, Diagram *diagram);
  69
  70 extern void
  71 diagram_tree_update_name(DiagramTree *tree, Diagram *diagram);
  72
  73 /* add/remove an object in a diagram already contained in the tree */
  74 extern void
  75 diagram_tree_add_object(DiagramTree *tree, Diagram *diagram, DiaObject *object);
  76
  77 extern void
  78 diagram_tree_add_objects(DiagramTree *tree, Diagram *diagram, GList *objects);
  79
  80 extern void
  81 diagram_tree_remove_object(DiagramTree *tree, DiaObject *object);
  82
  83 extern void
  84 diagram_tree_remove_objects(DiagramTree *tree, GList *objects);
  85
  86 extern void
  87 diagram_tree_update_object(DiagramTree *tree, Diagram *diagram,
  88                            DiaObject *object);
  89
  90 /* operations on the last clicked node */
  91 extern void
  92 diagram_tree_raise(DiagramTree *tree);
  93
  94 extern void
  95 diagram_tree_show_properties(const DiagramTree *tree);
  96
  97 extern const gchar * /* hidden type */
  98 diagram_tree_hide_type(DiagramTree *tree);
  99
 100 extern void
 101 diagram_tree_hide_explicit_type(DiagramTree *tree, const gchar *type);
 102
 103 extern void
 104 diagram_tree_unhide_type(DiagramTree *tree, const gchar *type);
 105
 106 extern void
 107 diagram_tree_sort_objects(DiagramTree *tree, DiagramTreeSortType type);
 108
 109 extern void
 110 diagram_tree_sort_all_objects(DiagramTree *tree, DiagramTreeSortType type);
 111
 112 extern void
 113 diagram_tree_sort_diagrams(DiagramTree *tree, DiagramTreeSortType type);
 114
 115 extern void
 116 diagram_tree_set_object_sort_type(DiagramTree *tree, DiagramTreeSortType type);
 117
 118 extern void
 119 diagram_tree_set_diagram_sort_type(DiagramTree *tree, DiagramTreeSortType type);
 120
 121 extern DiagramTreeSortType
 122 diagram_tree_diagram_sort_type(const DiagramTree *tree);
 123
 124 extern DiagramTreeSortType
 125 diagram_tree_object_sort_type(const DiagramTree *tree);
 126
 127 /* get the tree widget */
 128 extern GtkWidget*
 129 diagram_tree_widget(const DiagramTree *tree);
 130
 131
 132 #endif /* DIAGRAM_TREE_H */