1 /*
2  * Copyright (C) 2009 - 2011 Vivien Malerba <malerba@gnome-db.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA  02110-1301, USA.
18  */
19 
20 #ifndef __GDA_TREE_MGR_TABLES_H__
21 #define __GDA_TREE_MGR_TABLES_H__
22 
23 #include <libgda/gda-connection.h>
24 #include "gda-tree-manager.h"
25 
26 G_BEGIN_DECLS
27 
28 #define GDA_TYPE_TREE_MGR_TABLES            (gda_tree_mgr_tables_get_type())
29 #define GDA_TREE_MGR_TABLES(obj)            (G_TYPE_CHECK_INSTANCE_CAST (obj, GDA_TYPE_TREE_MGR_TABLES, GdaTreeMgrTables))
30 #define GDA_TREE_MGR_TABLES_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST (klass, GDA_TYPE_TREE_MGR_TABLES, GdaTreeMgrTablesClass))
31 #define GDA_IS_TREE_MGR_TABLES(obj)         (G_TYPE_CHECK_INSTANCE_TYPE(obj, GDA_TYPE_TREE_MGR_TABLES))
32 #define GDA_IS_TREE_MGR_TABLES_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GDA_TYPE_TREE_MGR_TABLES))
33 #define GDA_TREE_MGR_TABLES_GET_CLASS(o)    (G_TYPE_INSTANCE_GET_CLASS ((o), GDA_TYPE_TREE_MGR_TABLES, GdaTreeMgrTablesClass))
34 
35 typedef struct _GdaTreeMgrTables GdaTreeMgrTables;
36 typedef struct _GdaTreeMgrTablesPriv GdaTreeMgrTablesPriv;
37 typedef struct _GdaTreeMgrTablesClass GdaTreeMgrTablesClass;
38 
39 struct _GdaTreeMgrTables {
40 	GdaTreeManager        object;
41 	GdaTreeMgrTablesPriv *priv;
42 };
43 
44 struct _GdaTreeMgrTablesClass {
45 	GdaTreeManagerClass   object_class;
46 };
47 
48 /**
49  * SECTION:gda-tree-mgr-tables
50  * @short_description: A tree manager which creates a node for each table in a schema
51  * @title: GdaTreeMgrTables
52  * @stability: Stable
53  * @see_also:
54  *
55  * The #GdaTreeMgrTables is a #GdaTreeManager object which creates a node for
56  * each table in a database schema.
57  *
58  * It uses the #GdaMetaStore associated to a #GdaConnection to get the tables list
59  * in database schema; it's up to the
60  * caller to make sure the data in the #GdaMetaStore is up to date.
61  *
62  * The #GdaConnection to be used needs to be specified when the object is created. The
63  * schema can however be specified when the object is created, and if not, is
64  * fetched from the #GdaTreeNode below which the nodes will be placed (using
65  * gda_tree_node_fetch_attribute()).
66  */
67 
68 GType              gda_tree_mgr_tables_get_type                 (void) G_GNUC_CONST;
69 GdaTreeManager*    gda_tree_mgr_tables_new                      (GdaConnection *cnc, const gchar *schema);
70 
71 G_END_DECLS
72 
73 #endif
74