/* Ekiga -- A VoIP and Video-Conferencing application
 * Copyright (C) 2000-2009 Damien Sandras <dsandras@seconix.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *
 * Ekiga is licensed under the GPL license and as a special exception,
 * you have permission to link or otherwise combine this program with the
 * programs OPAL, OpenH323 and PWLIB, and distribute the combination,
 * without applying the requirements of the GNU GPL to the OPAL, OpenH323
 * and PWLIB programs, as long as you do follow the requirements of the
 * GNU GPL for all the rest of the software thus combined.
 */


/*
 *  Authors: Damien Sandras <dsandras@seconix.com>
 *           Jorn Baayen <jorn@nl.linux.com>
 *           Kenneth Christiansen <kenneth@gnu.org>
 *           Julien Puydt <jpuydt@free.fr>
 */

/*
 *                         dialog.h  -  description
 *                         ------------------------
 *   begin                : Mon Jun 17 2002
 *   copyright            : (C) 2000-2006 by Damien Sandras
 *   description          : This file contains all the functions needed to
 *                          to create dialogs for GnomeMeeting.
 */


#ifndef __GM_DIALOG_H
#define __GM_DIALOG_H

#include <stdarg.h>

G_BEGIN_DECLS


/**
 * gnomemeeting_threads_dialog_show:
 *
 * @widget: the dialog to show
 *
 * Shows the dialog from a thread. Using that function instead of 
 * gtk_widget_show is required for Win32 to work around GTK+ problems when
 * a widget has to be shown from a thread.
 **/
void gnomemeeting_threads_dialog_show (GtkWidget *);


/**
 * gnomemeeting_threads_dialog_show_all:
 *
 * @widget: the dialog to show
 *
 * Shows the dialog from a thread. Using that function instead of 
 * gtk_widget_show is required for Win32 to work around GTK+ problems when
 * a widget has to be shown from a thread.
 **/
void gnomemeeting_threads_dialog_show_all (GtkWidget *);


/**
 * gnomemeeting_threads_dialog_hide:
 *
 * @widget: the dialog to hide
 *
 * Hides the dialog from a thread. Using that function instead of 
 * gtk_widget_hide is required for Win32 to work around GTK+ problems when
 * a widget has to be hidden from a thread.
 **/
void gnomemeeting_threads_dialog_hide (GtkWidget *);


/**
 * gnomemeeting_threads_widget_destroy:
 *
 * @widget: the widget to destroy
 *
 * Destroys the widget from a thread. Using that function instead of 
 * gtk_widget_destroy is required for Win32 to work around GTK+ problems when
 * a widget has to be destroyed from a thread.
 **/
void gnomemeeting_threads_widget_destroy (GtkWidget *);


/**
 * gnomemeeting_warning_dialog_on_widget:
 *
 * @parent: The parent of the dialog
 * @key: The key representing the setting 
 * @format: String containing printf like syntax.
 * @ ...  : Variables of different kinds called from the 
 *          format line.
 *
 * Only shows a dialog if the users has not clicked on
 * 'Do not show this dialog again' for the same key. 
 *
 * This can be useful in certain situations. For instance
 * you might have a toggle button for a setting that is not
 * allowed to change while the app is in a certain state.
 * When you change the toggle it checks if the change is 
 * allowed or else it calls this function associating it  
 * with the toggle button. If the user chooses to ignore 
 * the dialog in the rest of the session, then this dialog 
 * will not popup with new calls to this function when 
 * associating with the same toggle button.
 *
 * This function only works in the current session.
 **/
GtkWidget *gnomemeeting_warning_dialog_on_widget (GtkWindow *, 
						  const char *,
						  const char *,
						  const char *,
						  ...) G_GNUC_PRINTF(4,5);


/**
 * gnomemeeting_error_dialog:
 *
 * @parent is parent window.
 *
 * Constructs and shows an error dialog.
 **/
GtkWidget *gnomemeeting_error_dialog (GtkWindow *parent,
				      const char *,
				      const char *format,
				      ...) G_GNUC_PRINTF(3,4);


/**
 * gnomemeeting_warning_dialog:
 *
 * @parent is parent window.
 *
 * Constructs and shows a warning dialog.
 **/
GtkWidget *gnomemeeting_warning_dialog (GtkWindow *parent,
					const char *,
					const char *format,
					...) G_GNUC_PRINTF(3,4);


/**
 * gnomemeeting_message_dialog:
 *
 * @parent is parent window.
 *
 * Constructs and shows a message dialog.
 **/
GtkWidget *gnomemeeting_message_dialog (GtkWindow *parent,
					const char *,
					const char *format,
					...) G_GNUC_PRINTF(3,4);


/**
 * gnomemeeting_progress_dialog:
 *
 * @parent is parent window.
 *
 * Constructs and shows a progress dialog.
 **/
GtkWidget *gnomemeeting_progress_dialog (GtkWindow *parent,
					 const char *,
					 const char *format,
					 ...) G_GNUC_PRINTF(3,4);

G_END_DECLS

#endif /* __GM_DIALOG_H */