xmessage-dialog.h

Go to the documentation of this file.

/*
 *                           0BSD 
 * 
 *                    BSD Zero Clause License
 * 
 *  Copyright (c) 2019 Hermann Meyer
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted.
 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 *
 */
 
#pragma once
 
#ifndef XMESSAGE_DIALOG_H_
#define XMESSAGE_DIALOG_H_
 
#include "xwidgets.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum {
    INFO_BOX,
    WARNING_BOX,
    ERROR_BOX,
    QUESTION_BOX,
    SELECTION_BOX,
    ENTRY_BOX,
};
 
typedef struct {
    int response;
    int message_type;
    unsigned int width;
    unsigned int height;
    unsigned int lin;
    Widget_t *text_entry;
    Pixmap *icon;
    char **message;
    unsigned int sel;
    char **choices;
} MessageBox;
 
/**
 * @brief open_message_dialog  - open a non blocking dialog window,
 * lines in message chould be separated by the character "|"
 * choices for the SELECTION_BOX should be separated as well with the
 * character "|". message and/or choices could be NULL when not needed.
 * To fetch the response of a dialog, connect to the dialog_callback 
 * supported "styles" been
 * \n
 * INFO_BOX - a message dialog display a info text
 * \n
 * WARNING_BOX - a message dialog display a warning
 * \n
 * ERROR_BOX - a message dialog display a error message
 * \n
 * QUESTION_BOX - a no/yes dialog message
 * \n
 * SELECTION_BOX - a dialog to select between multiple options
 * \n
 * ENTRY_BOX - a dialog to get text input
 * @return Widget_t*           - pointer to the Widget_t struct
 */
 
Widget_t *open_message_dialog(Widget_t *w, int style, const char *title,
                              const char *message, const char *choices);
 
#ifdef __cplusplus
}
#endif
 
#endif //XMESSAGE_DIALOG_H_