message.h

Go to the documentation of this file.

/*! \file
  \brief  The Message functions.  Implements Messages to the user in the form
  of pop-up dialog boxes, using FLTK windows.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
#ifndef INCLUDED_MESSAGE_H
#define INCLUDED_MESSAGE_H
 
#include "gls_include.h"
 
#if defined( GLS_EDITOR_CODE ) && !defined( ALLOW_EDITOR_CODE_TO_USE_MESSAGE_H )
#    error "Editor code should not include message.h which uses FLTK. Use editor_message.h instead."
#endif
#include "disti_include.h"
#include "gls_cpp_lang_support.h"
 
#include <stdlib.h>
 
namespace disti
{
class MessageDialogs;
 
/// Set the current dialogs to use.
/// \param dlgs The new dialogs to use.
DISTI_EXPORT void SetMessageDialogs( MessageDialogs* dlgs );
 
/// Suppresses popup messages when false, defaults to true.
DISTI_EXPORT void EnableDialogs( bool );
 
/// \return Whether or not dialogs are enabled.
DISTI_EXPORT bool AreDialogsEnabled();
 
/// Suppresses popup messages when false, defaults to true.
/// Deprecated function. Use EnableDialogs() instead.
DISTI_DEPRECATED( "Use EnableDialogs() instead." )
DISTI_EXPORT void PopupsUseCommandLine( bool );
 
/// Deprecated function. Use AreDialogsEnabled() instead.
/// \return whether or not dialogs are enabled
DISTI_DEPRECATED( "Use AreDialogsEnabled() instead." )
DISTI_EXPORT bool PopupsUseCommandLine();
 
/// Creates and shows a pop-up dialog box and displays a text string and (1)
/// button labeled 'OK'. An 'i' (information) icon is displayed.
/// \param s The text string to display.
DISTI_EXPORT void MsgBox( const char* s, ... );
 
/// Creates and shows a pop-up dialog box and displays a text string and (1)
/// button labeled 'OK'. An exclamation icon is displayed.
/// \param s The text string to display.
DISTI_EXPORT void Error( const char* s, ... );
 
/// Creates and shows a pop-up dialog box and displays a text string and (1)
/// button labeled 'OK'.  An exclamation icon is displayed. This version
/// does not use varargs for formatting.
/// \param s The text string to display.
DISTI_EXPORT void Error_NoVarArg( const char* s );
 
/// Creates and shows a pop-up dialog box and displays a text string and (2)
/// buttons labeled 'Yes' and 'No'. A question mark icon is displayed.
/// \param s The text string to display.
/// \return Equals 1 if user pressed 'Yes', otherwise 0.
DISTI_EXPORT int Question( const char* s, ... );
 
/// Creates and shows a pop-up dialog box and displays a text string and up
/// to (3) buttons labeled according to the last three input parameters. To
/// hide any of the buttons, pass a NULL string to the corresponding param.
/// A question icon is displayed.
/// \param b0 The label for button 0 (ESC is shortcut for this Right button).
/// \param b1 The label for button 1 (RET is shortcut for this Center button).
/// \param b2 The label for button 3 (left-most button).
/// \param s The text string to display.
/// \return Equals 0 if b0 pressed, 1 if b1 pressed, 2 if b2 pressed.
DISTI_EXPORT int Choice( const char* b0, const char* b1, const char* b2, const char* s, ... );
 
/// Creates and shows a pop-up dialog box and displays a text string and up
/// to (3) buttons labeled according to the last three input parameters. To
/// hide any of the buttons, pass a NULL string to the corresponding param.
/// A question icon is displayed.
/// \param b0 The label for button 0 (ESC is shortcut for this Right button).
/// \param b1 The label for button 1 (RET is shortcut for this Center button).
/// \param b2 The label for button 3 (left-most button).
/// \param defaultChoice The value returned when in command-line mode.
/// \param s The text string to display.
/// \return Equals 0 if b0 pressed, 1 if b1 pressed, 2 if b2 pressed.
DISTI_EXPORT int ChoiceWithDefault( const char* b0, const char* b1, const char* b2, const int defaultChoice, const char* s, ... );
 
} // namespace disti
 
#endif