1 /*   EXTRAITS DE LA LICENCE
2 	Copyright CEA, contributeurs : Luc BILLARD et Damien
3 	CALISTE, laboratoire L_Sim, (2001-2005)
4 
5 	Adresse mèl :
6 	BILLARD, non joignable par mèl ;
7 	CALISTE, damien P caliste AT cea P fr.
8 
9 	Ce logiciel est un programme informatique servant à visualiser des
10 	structures atomiques dans un rendu pseudo-3D.
11 
12 	Ce logiciel est régi par la licence CeCILL soumise au droit français et
13 	respectant les principes de diffusion des logiciels libres. Vous pouvez
14 	utiliser, modifier et/ou redistribuer ce programme sous les conditions
15 	de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
16 	sur le site "http://www.cecill.info".
17 
18 	Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
19 	pris connaissance de la licence CeCILL, et que vous en avez accepté les
20 	termes (cf. le fichier Documentation/licence.fr.txt fourni avec ce logiciel).
21 */
22 
23 /*   LICENCE SUM UP
24 	Copyright CEA, contributors : Luc BILLARD et Damien
25 	CALISTE, laboratoire L_Sim, (2001-2005)
26 
27 	E-mail address:
28 	BILLARD, not reachable any more ;
29 	CALISTE, damien P caliste AT cea P fr.
30 
31 	This software is a computer program whose purpose is to visualize atomic
32 	configurations in 3D.
33 
34 	This software is governed by the CeCILL  license under French law and
35 	abiding by the rules of distribution of free software.  You can  use,
36 	modify and/ or redistribute the software under the terms of the CeCILL
37 	license as circulated by CEA, CNRS and INRIA at the following URL
38 	"http://www.cecill.info".
39 
40 	The fact that you are presently reading this means that you have had
41 	knowledge of the CeCILL license and that you accept its terms. You can
42 	find a copy of this licence shipped with this software at Documentation/licence.en.txt.
43 */
44 #ifndef PANELBROWSER_H
45 #define PANELBROWSER_H
46 
47 #include <glib.h>
48 #include <gtk/gtk.h>
49 
50 #include <extraGtkFunctions/gtk_toolPanelWidget.h>
51 
52 /**
53  * VISU_UI_PANEL_BROWSER_PREVIOUS:
54  *
55  * Value that give the direction when the selector is moved around file list.
56  * See visu_ui_panel_browser_getNextSelected().
57  */
58 #define VISU_UI_PANEL_BROWSER_PREVIOUS 0
59 /**
60  * VISU_UI_PANEL_BROWSER_NEXT:
61  *
62  * Value that give the direction when the selector is moved around file list.
63  * See visu_ui_panel_browser_getNextSelected().
64  */
65 #define VISU_UI_PANEL_BROWSER_NEXT     1
66 
67 /**
68  * visu_ui_panel_browser_init: (skip)
69  *
70  * Should be used in the list declared in externalModules.h to be loaded by
71  * V_Sim on start-up. This routine will create the #VisuUiPanel handling
72  * the browser.
73  *
74  * Returns: a newly created #VisuUiPanel object.
75  */
76 VisuUiPanel* visu_ui_panel_browser_init();
77 
78 /**
79  * visu_ui_panel_browser_getNextSelected:
80  * @path: a pointer to returned the path of the newly selected file ;
81  * @iterSelected: a pointer to store the newly selected iter ;
82  * @direction: VISU_UI_PANEL_BROWSER_NEXT or VISU_UI_PANEL_BROWSER_PREVIOUS.
83  *
84  * Change the selected file in the browser given the direction.
85  *
86  * Returns: TRUE if one exists.
87  */
88 gboolean visu_ui_panel_browser_getNextSelected(GtkTreePath **path,
89 				      GtkTreeIter *iterSelected, int direction);
90 /**
91  * visu_ui_panel_browser_getCurrentSelected:
92  * @path: a pointer to returned the path of the currently selected file ;
93  * @iterSelected: a pointer to store the currently selected iter.
94  *
95  * Get iter and path of the currently sleected file.
96  *
97  * Returns: TRUE if one exists.
98  */
99 gboolean visu_ui_panel_browser_getCurrentSelected(GtkTreePath **path,
100 					 GtkTreeIter *iterSelected);
101 /**
102  * visu_ui_panel_browser_setCurrentDirectory:
103  * @dir: the path of a directory.
104  *
105  * Change the directory for the browser. The directory is not parsed immediately
106  * but only when the subpanel becomes visible.
107  */
108 void visu_ui_panel_browser_setCurrentDirectory(const gchar *dir);
109 /**
110  * visu_ui_panel_browser_setCurrentDirectories:
111  * @dirs: a NULL terminated array of directories to be loaded.
112  *
113  * Change the directories for the browser. It is the same routine than
114  * visu_ui_panel_browser_setCurrentDirectory(), but several directories can be loaded
115  * at once. But internally, contrary to visu_ui_panel_browser_setCurrentDirectory()
116  * the given array must not be freed since it is not copied.
117  */
118 void visu_ui_panel_browser_setCurrentDirectories(gchar **dirs);
119 
120 void visu_ui_panel_browser_setMessage(const gchar* message, GtkMessageType message_type);
121 
122 
123 #endif
124 
125