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 GTK_INTERACTIVE_H
45 #define GTK_INTERACTIVE_H
46 
47 #include <gtk/gtk.h>
48 
49 #include "gtk_main.h"
50 #include "gtk_renderingWindowWidget.h"
51 
52 /**
53  * VisuUiInteractiveActionId:
54  * @VISU_UI_ACTION_OBSERVE: interactive session is observe ;
55  * @VISU_UI_ACTION_PICK: interactive session is pick ;
56  * @VISU_UI_ACTION_MOVE: interactive session is geometry changes.
57  * @VISU_UI_ACTION_N_PRESET: private.
58  *
59  * Possibe actions.
60  */
61 typedef enum
62   {
63     VISU_UI_ACTION_OBSERVE,
64     VISU_UI_ACTION_PICK,
65     VISU_UI_ACTION_MOVE,
66     /*< private >*/
67     VISU_UI_ACTION_N_PRESET
68   } VisuUiInteractiveActionId;
69 
70 /**
71  * VisuUiInteractiveBuild:
72  * @main: the main interface.
73  * @label: a location to store the name of the tab ;
74  * @help: a location to store the help message to be shown at the
75  * bottom of the window ;
76  * @radio: a location on the radio button that will be toggled when
77  * the desired action is used.
78  *
79  * One can create new tab in the interactive dialog window by
80  * providing routines with this prototype.
81  *
82  * Returns: a new container to be include as a tab in the interactive
83  * dialog window.
84  */
85 typedef GtkWidget* (*VisuUiInteractiveBuild)(VisuUiMain *main, gchar **label,
86                                              gchar **help, GtkWidget **radio);
87 /**
88  * VisuUiInteractiveStartStop:
89  * @window: the rendering window that starts or stops the interaction
90  * defined in the tab.
91  *
92  * Routines of this prototype are called each time the interactive
93  * mode should be changed.
94  */
95 typedef void (*VisuUiInteractiveStartStop)(VisuUiRenderingWindow *window);
96 
97 guint visu_ui_interactive_addAction(VisuUiInteractiveBuild build,
98 			       VisuUiInteractiveStartStop start,
99 			       VisuUiInteractiveStartStop stop);
100 
101 void visu_ui_interactive_init();
102 void visu_ui_interactive_toggle(void);
103 
104 void visu_ui_interactive_initBuild(VisuUiMain *main);
105 
106 void visu_ui_interactive_start(VisuUiRenderingWindow *window);
107 void visu_ui_interactive_stop(VisuUiRenderingWindow *window);
108 
109 void visu_ui_interactive_setMessage(const gchar *message, GtkMessageType type);
110 void visu_ui_interactive_unsetMessage();
111 
112 #endif
113