GL Studio C++ Runtime API
message.h
Go to the documentation of this file.
1/// \file message.h
2/// \brief The Message functions. Implements Messages to the user in the form
3/// of pop-up dialog boxes, using FLTK windows.
4///
5/// \par Copyright Information
6///
7/// Copyright (c) 2017 by The DiSTI Corporation.<br>
8/// 12249 Science Drive; Suite 300<br>
9/// Orlando, Florida 32826<br>
10/// USA<br>
11/// <br>
12/// All rights reserved.<br>
13///
14/// This Software contains proprietary trade secrets of DiSTI and may not be
15/// reproduced, in whole or part, in any form, or by any means of electronic,
16/// mechanical, or otherwise, without the written permission of DiSTI. Said
17/// permission may be derived through the purchase of applicable DiSTI product
18/// licenses which detail the distribution rights of this content and any
19/// Derivative Works based on this or other copyrighted DiSTI Software.
20///
21/// NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
22/// AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
23/// PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
24/// AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
25/// IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
26/// PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
27///
28/// LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
29/// IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
30/// INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
31/// DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
32/// INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
33/// INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
34/// OF SUCH DAMAGES. DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
35/// EXCEED FIVE DOLLARS (US$5.00).
36///
37/// The aforementioned terms and restrictions are governed by the laws of the
38/// State of Florida and the United States of America.
39
40#ifndef INCLUDED_MESSAGE_H
41#define INCLUDED_MESSAGE_H
42
43#include "gls_include.h"
44
45#if defined( GLS_EDITOR_CODE ) && !defined( ALLOW_EDITOR_CODE_TO_USE_MESSAGE_H )
46# error "Editor code should not include message.h which uses FLTK. Use editor_message.h instead."
47#endif
48#include "disti_include.h"
50
51#include <stdlib.h>
52
53namespace disti
54{
55class MessageDialogs;
56
57/// Set the current dialogs to use.
58/// \param dlgs The new dialogs to use.
59DISTI_EXPORT void SetMessageDialogs( MessageDialogs* dlgs );
60
61/// Suppresses popup messages when false, defaults to true.
62DISTI_EXPORT void EnableDialogs( bool );
63
64/// \return Whether or not dialogs are enabled.
65DISTI_EXPORT bool AreDialogsEnabled();
66
67/// Suppresses popup messages when false, defaults to true.
68/// Deprecated function. Use EnableDialogs() instead.
69DISTI_DEPRECATED( "Use EnableDialogs() instead." )
70DISTI_EXPORT void PopupsUseCommandLine( bool );
71
72/// Deprecated function. Use AreDialogsEnabled() instead.
73/// \return whether or not dialogs are enabled
74DISTI_DEPRECATED( "Use AreDialogsEnabled() instead." )
75DISTI_EXPORT bool PopupsUseCommandLine();
76
77/// Creates and shows a pop-up dialog box and displays a text string and (1)
78/// button labeled 'OK'. An 'i' (information) icon is displayed.
79/// \param s The text string to display.
80DISTI_EXPORT void MsgBox( const char* s, ... );
81
82/// Creates and shows a pop-up dialog box and displays a text string and (1)
83/// button labeled 'OK'. An exclamation icon is displayed.
84/// \param s The text string to display.
85DISTI_EXPORT void Error( const char* s, ... );
86
87/// Creates and shows a pop-up dialog box and displays a text string and (1)
88/// button labeled 'OK'. An exclamation icon is displayed. This version
89/// does not use varargs for formatting.
90/// \param s The text string to display.
91DISTI_EXPORT void Error_NoVarArg( const char* s );
92
93/// Creates and shows a pop-up dialog box and displays a text string and (2)
94/// buttons labeled 'Yes' and 'No'. A question mark icon is displayed.
95/// \param s The text string to display.
96/// \return Equals 1 if user pressed 'Yes', otherwise 0.
97DISTI_EXPORT int Question( const char* s, ... );
98
99/// Creates and shows a pop-up dialog box and displays a text string and up
100/// to (3) buttons labeled according to the last three input parameters. To
101/// hide any of the buttons, pass a NULL string to the corresponding param.
102/// A question icon is displayed.
103/// \param b0 The label for button 0 (ESC is shortcut for this Right button).
104/// \param b1 The label for button 1 (RET is shortcut for this Center button).
105/// \param b2 The label for button 3 (left-most button).
106/// \param s The text string to display.
107/// \return Equals 0 if b0 pressed, 1 if b1 pressed, 2 if b2 pressed.
108DISTI_EXPORT int Choice( const char* b0, const char* b1, const char* b2, const char* s, ... );
109
110/// Creates and shows a pop-up dialog box and displays a text string and up
111/// to (3) buttons labeled according to the last three input parameters. To
112/// hide any of the buttons, pass a NULL string to the corresponding param.
113/// A question icon is displayed.
114/// \param b0 The label for button 0 (ESC is shortcut for this Right button).
115/// \param b1 The label for button 1 (RET is shortcut for this Center button).
116/// \param b2 The label for button 3 (left-most button).
117/// \param defaultChoice The value returned when in command-line mode.
118/// \param s The text string to display.
119/// \return Equals 0 if b0 pressed, 1 if b1 pressed, 2 if b2 pressed.
120DISTI_EXPORT int ChoiceWithDefault( const char* b0, const char* b1, const char* b2, const int defaultChoice, const char* s, ... );
121
122} // namespace disti
123
124#endif
Definition: message_dialogs.h:50
A file for all GL Studio files to include.
Macros and helper code to determine what subset of C++11/14/17 is available.
#define DISTI_DEPRECATED(msg)
Defines whether this compiler supports the C++14 deprecated attribute.
Definition: gls_cpp_lang_support.h:487
A file for all GL Studio files to include.
Definition: bmpimage.h:46
void MsgBox(const char *s,...)
int Question(const char *s,...)
void PopupsUseCommandLine(bool)
void EnableDialogs(bool)
Suppresses popup messages when false, defaults to true.
int Choice(const char *b0, const char *b1, const char *b2, const char *s,...)
bool AreDialogsEnabled()
void Error(const char *s,...)
void SetMessageDialogs(MessageDialogs *dlgs)
int ChoiceWithDefault(const char *b0, const char *b1, const char *b2, const int defaultChoice, const char *s,...)
void Error_NoVarArg(const char *s)