dialog.h

Go to the documentation of this file.

#ifndef __DIALOG_H__
#define __DIALOG_H__

/**
 * File Name  : dialog.h
 *
 * Description: The dialog functions 
 */

/*
 * This file is part of popupmenu.
 *
 * popupmenu 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.
 *
 * popupmenu 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */


//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

#include <liberipc/eripc.h>

G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------- 


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------


//============================================================================
// Public Functions
//============================================================================

/**---------------------------------------------------------------------------
 *
 * Name : dialog_create
 *
 * @brief Initialize dialogs for later use
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void dialog_create(void);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_wait_show
 *
 * @brief Show busy/wait popup dialog (with animation)
 *
 * @param message Text to show in dialog
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void dialog_wait_show(const char *message);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_wait_close
 *
 * @brief Close busy/wait popup dialog
 *
 * @param --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void dialog_wait_close(void);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_message_info
 *
 * @brief Show popup dialog with message and OK button
 *
 * @param type The type of message being displayed in the dialog
 * @param title Text to show as window title, NULL to leave blank
 * @param message Text to show in dialog
 * @param context
 * @param message_id
 *
 * @return GtkWidget pointer to dialog
 *
 *--------------------------------------------------------------------------*/
GtkWidget *dialog_message_info(GtkMessageType type,
                               const char *title, 
                               const char *message,
                               eripc_context_t *context,
                               const char *message_id);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_message_confirm
 *
 * @brief Show modal popup dialog with confirmation request (YES/NO)
 *
 * @param title Text to show as window title, NULL to leave blank
 * @param message Text to show in dialog
 * @param context
 * @param message_id
 * @param button_no
 * @param button_yes
 *
 * @return TRUE when confirmed by used, FALSE otherwise
 *
 *--------------------------------------------------------------------------*/
gboolean dialog_message_confirm(const char *title, 
                                const char *message, 
                                eripc_context_t *context,
                                const char *message_id,
                                const char *button_no,
                                const char *button_yes);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_message_confirm_close
 *
 * @brief Close modal popup dialog with confirmation request (YES/NO)
 *
 * @param --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void dialog_message_confirm_close(void);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_splash_remove
 *
 * @brief Remove the splash screen
 *
 * @return TRUE for success, FALSE otherwise
 *
 *--------------------------------------------------------------------------*/
gboolean dialog_splash_remove(void);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_splash_show
 *
 * @brief Show a splash screen
 *
 * @param type Splash to show ("usbconnect" or "shutdown")
 *
 * @return TRUE for success, FALSE otherwise
 *
 *--------------------------------------------------------------------------*/
gboolean dialog_splash_show(const char *type);

/**---------------------------------------------------------------------------
 *
 * Name : dialog_message_info_close
 *
 * @brief Close message info popup dialog
 *
 * @param --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void dialog_message_info_close(void);

void dialog_rotated(const char *orientation);

G_END_DECLS

#endif /* __DIALOG_H__ */