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_DUMPDIALOG_H 45 #define GTK_DUMPDIALOG_H 46 47 #include <glib.h> 48 #include <glib-object.h> 49 50 #include <gtk/gtk.h> 51 52 #include <visu_dump.h> 53 #include <coreTools/toolFileFormat.h> 54 55 G_BEGIN_DECLS 56 /** 57 * VISU_TYPE_UI_DUMP_DIALOG: 58 * 59 * Return the associated #GType to the VisuUiDumpDialog objects. 60 */ 61 #define VISU_TYPE_UI_DUMP_DIALOG (visu_ui_dump_dialog_get_type ()) 62 /** 63 * VISU_UI_DUMP_DIALOG: 64 * @obj: the widget to cast. 65 * 66 * Cast the given object to a #VisuUiDumpDialog object. 67 */ 68 #define VISU_UI_DUMP_DIALOG(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VISU_TYPE_UI_DUMP_DIALOG, VisuUiDumpDialog)) 69 /** 70 * VISU_UI_DUMP_DIALOG_CLASS: 71 * @klass: the class to cast. 72 * 73 * Cast the given class to a #VisuUiDumpDialogClass object. 74 */ 75 #define VISU_UI_DUMP_DIALOG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VISU_TYPE_UI_DUMP_DIALOG, VisuUiDumpDialogClass)) 76 /** 77 * VISU_IS_UI_DUMP_DIALOG: 78 * @obj: the object to test. 79 * 80 * Return if the given object is a valid #VisuUiDumpDialog object. 81 */ 82 #define VISU_IS_UI_DUMP_DIALOG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VISU_TYPE_UI_DUMP_DIALOG)) 83 /** 84 * VISU_IS_UI_DUMP_DIALOG_CLASS: 85 * @klass: the class to test. 86 * 87 * Return if the given class is a valid #VisuUiDumpDialogClass class. 88 */ 89 #define VISU_IS_UI_DUMP_DIALOG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VISU_TYPE_UI_DUMP_DIALOG)) 90 /** 91 * VISU_UI_DUMP_DIALOG_GET_CLASS: 92 * @obj: the widget to get the class of. 93 * 94 * Get the class of the given object. 95 */ 96 #define VISU_UI_DUMP_DIALOG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_TYPE_UI_DUMP_DIALOG, VisuUiDumpDialogClass)) 97 98 /** 99 * VisuUiDumpDialog 100 * 101 * Private structure to store informations of a #VisuUiDumpDialog object. 102 */ 103 typedef struct _VisuUiDumpDialog VisuUiDumpDialog; 104 /** 105 * VisuUiDumpDialogClass 106 * 107 * Private structure to store informations of a #VisuUiDumpDialogClass object. 108 */ 109 typedef struct _VisuUiDumpDialogClass VisuUiDumpDialogClass; 110 111 /** 112 * visu_ui_dump_dialog_get_type 113 * 114 * #GType are unique numbers to identify objects. 115 * 116 * Returns: the #GType associated with #VisuUiDumpDialog objects. 117 */ 118 GType visu_ui_dump_dialog_get_type (void); 119 GtkWidget* visu_ui_dump_dialog_new(VisuData *dataObj, GtkWindow *parent, 120 const gchar *suggestedFilename, 121 gint suggestedWidth, gint suggestedHeight); 122 123 /** 124 * visu_ui_dump_dialog_getFilename: 125 * @dialog: a #VisuUiDumpDialog object. 126 * 127 * Retrieve the chosen filename. 128 * 129 * Returns: a read-only string. 130 */ 131 gchar* visu_ui_dump_dialog_getFilename(VisuUiDumpDialog *dialog); 132 /** 133 * visu_ui_dump_dialog_getType: 134 * @dialog: a #VisuUiDumpDialog object. 135 * 136 * Retrieve the chosen VisuDump. 137 * 138 * Returns: (transfer none): the selected format (ToolFileFormat and write method). 139 */ 140 VisuDump* visu_ui_dump_dialog_getType(VisuUiDumpDialog *dialog); 141 /** 142 * visu_ui_dump_dialog_getProgressBar: 143 * @dialog: a #VisuUiDumpDialog object. 144 * 145 * Retrieve interesting widget. 146 * 147 * Returns: (transfer none): a pointer to the progress bar. 148 */ 149 GtkProgressBar* visu_ui_dump_dialog_getProgressBar(VisuUiDumpDialog *dialog); 150 /** 151 * visu_ui_dump_dialog_getCancelButton: 152 * @dialog: a #VisuUiDumpDialog object. 153 * 154 * Retrieve interesting widget. 155 * 156 * Returns: (transfer none): a pointer to the cancel button. 157 */ 158 GtkButton* visu_ui_dump_dialog_getCancelButton(VisuUiDumpDialog *dialog); 159 /** 160 * visu_ui_dump_dialog_getWidth: 161 * @dialog: a #VisuUiDumpDialog object. 162 * 163 * Retrieve request image size. 164 * 165 * Returns: the width value. 166 */ 167 gint visu_ui_dump_dialog_getWidth(VisuUiDumpDialog *dialog); 168 /** 169 * visu_ui_dump_dialog_getHeight: 170 * @dialog: a #VisuUiDumpDialog object. 171 * 172 * Retrieve request image size. 173 * 174 * Returns: the height value. 175 */ 176 gint visu_ui_dump_dialog_getHeight(VisuUiDumpDialog *dialog); 177 /** 178 * visu_ui_dump_dialog_start: 179 * @dialog: a #VisuUiDumpDialog object. 180 * 181 * Make the file chooser part insensitive during dump, only the 182 * progress bar and the abort button are kept sensitive. 183 */ 184 void visu_ui_dump_dialog_start(VisuUiDumpDialog *dialog); 185 /** 186 * visu_ui_dump_dialog_stop: 187 * @dialog: a #VisuUiDumpDialog object. 188 * 189 * Return the filechooser to a sensitive state. 190 */ 191 void visu_ui_dump_dialog_stop(VisuUiDumpDialog *dialog); 192 193 194 G_END_DECLS 195 196 #endif 197