| GL Studio C++ Runtime API

message.h
Go to the documentation of this file.
1/*! \file
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 11301 Corporate Blvd; Suite 100<br>
9 Orlando, Florida 32817<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*/
41#ifndef INCLUDED_MESSAGE_H
42#define INCLUDED_MESSAGE_H
43
44#include "gls_include.h"
45
46#if defined( GLS_EDITOR_CODE ) && !defined( ALLOW_EDITOR_CODE_TO_USE_MESSAGE_H )
47# error "Editor code should not include message.h which uses FLTK. Use editor_message.h instead."
48#endif
49#include "disti_include.h"
50#include "gls_cpp_lang_support.h"
51
52#include <stdlib.h>
53
54 namespace disti
55{
56 class MessageDialogs;
57
58/// Set the current dialogs to use.
59/// \param dlgs The new dialogs to use.
60 DISTI_EXPORT void SetMessageDialogs( MessageDialogs* dlgs );
61
62/// Suppresses popup messages when false, defaults to true.
63 DISTI_EXPORT void EnableDialogs( bool );
64
65/// \return Whether or not dialogs are enabled.
66 DISTI_EXPORT bool AreDialogsEnabled();
67
68/// Suppresses popup messages when false, defaults to true.
69/// Deprecated function. Use EnableDialogs() instead.
70 DISTI_DEPRECATED( "Use EnableDialogs() instead." )
71DISTI_EXPORT void PopupsUseCommandLine( bool );
72
73/// Deprecated function. Use AreDialogsEnabled() instead.
74/// \return whether or not dialogs are enabled
75 DISTI_DEPRECATED( "Use AreDialogsEnabled() instead." )
76DISTI_EXPORT bool PopupsUseCommandLine();
77
78/// Creates and shows a pop-up dialog box and displays a text string and (1)
79/// button labeled 'OK'. An 'i' (information) icon is displayed.
80/// \param s The text string to display.
81 DISTI_EXPORT void MsgBox( const char* s, ... );
82
83/// Creates and shows a pop-up dialog box and displays a text string and (1)
84/// button labeled 'OK'. An exclamation icon is displayed.
85/// \param s The text string to display.
86 DISTI_EXPORT void Error( const char* s, ... );
87
88/// Creates and shows a pop-up dialog box and displays a text string and (1)
89/// button labeled 'OK'. An exclamation icon is displayed. This version
90/// does not use varargs for formatting.
91/// \param s The text string to display.
92 DISTI_EXPORT void Error_NoVarArg( const char* s );
93
94/// Creates and shows a pop-up dialog box and displays a text string and (2)
95/// buttons labeled 'Yes' and 'No'. A question mark icon is displayed.
96/// \param s The text string to display.
97/// \return Equals 1 if user pressed 'Yes', otherwise 0.
98 DISTI_EXPORT int Question( const char* s, ... );
99
100/// Creates and shows a pop-up dialog box and displays a text string and up
101/// to (3) buttons labeled according to the last three input parameters. To
102/// hide any of the buttons, pass a NULL string to the corresponding param.
103/// A question icon is displayed.
104/// \param b0 The label for button 0 (ESC is shortcut for this Right button).
105/// \param b1 The label for button 1 (RET is shortcut for this Center button).
106/// \param b2 The label for button 3 (left-most button).
107/// \param s The text string to display.
108/// \return Equals 0 if b0 pressed, 1 if b1 pressed, 2 if b2 pressed.
109 DISTI_EXPORT int Choice( const char* b0, const char* b1, const char* b2, const char* s, ... );
110
111/// Creates and shows a pop-up dialog box and displays a text string and up
112/// to (3) buttons labeled according to the last three input parameters. To
113/// hide any of the buttons, pass a NULL string to the corresponding param.
114/// A question icon is displayed.
115/// \param b0 The label for button 0 (ESC is shortcut for this Right button).
116/// \param b1 The label for button 1 (RET is shortcut for this Center button).
117/// \param b2 The label for button 3 (left-most button).
118/// \param defaultChoice The value returned when in command-line mode.
119/// \param s The text string to display.
120/// \return Equals 0 if b0 pressed, 1 if b1 pressed, 2 if b2 pressed.
121 DISTI_EXPORT int ChoiceWithDefault( const char* b0, const char* b1, const char* b2, const int defaultChoice, const char* s, ... );
122
123} // namespace disti
124
125#endif
disti::MessageDialogs
Definition: message_dialogs.h:51
disti_include.h
A file for all GL Studio files to include.
gls_cpp_lang_support.h
Macros and helper code to determine what subset of C++11/14/17 is available.
DISTI_DEPRECATED
#define DISTI_DEPRECATED(msg)
Defines whether this compiler supports the C++14 deprecated attribute.
Definition: gls_cpp_lang_support.h:488
gls_include.h
A file for all GL Studio files to include.
disti
Definition: bmpimage.h:47
disti::MsgBox
void MsgBox(const char *s,...)
disti::Question
int Question(const char *s,...)
disti::PopupsUseCommandLine
void PopupsUseCommandLine(bool)
disti::EnableDialogs
void EnableDialogs(bool)
Suppresses popup messages when false, defaults to true.
disti::Choice
int Choice(const char *b0, const char *b1, const char *b2, const char *s,...)
disti::AreDialogsEnabled
bool AreDialogsEnabled()
disti::Error
void Error(const char *s,...)
disti::SetMessageDialogs
void SetMessageDialogs(MessageDialogs *dlgs)
disti::ChoiceWithDefault
int ChoiceWithDefault(const char *b0, const char *b1, const char *b2, const int defaultChoice, const char *s,...)
disti::Error_NoVarArg
void Error_NoVarArg(const char *s)