MessageBox.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/MessageBox.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_MessageBox_h
#define __PCL_MessageBox_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/String.h>
 
#ifndef __PCL_MSGBOX_DONT_REMOVE_PREVIOUS_DECLARATION
/*
 * Remove conflicting identifiers from Win32 SDK headers.
 *
 * Unfortunately, MessageBox is #defined as a macro in winuser.h, and this may
 * cause problems with our code on Windows platforms.
 *
 * If for some eccentric reason you really want to use the Win32 API MessageBox
 * function (why should you?), then call either MessageBoxA() or MessageBoxW().
 */
#  ifdef MessageBox
#    undef MessageBox
#  endif
#endif
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace StdIcon
{
   enum value_type
   {
      NoIcon,
      Question,
      Information,
      Warning,
      Error,
 
      NumberOfStandardIcons
   };
}
 
// ----------------------------------------------------------------------------
 
namespace StdButton
{
   enum value_type
   {
      NoButton,
      Ok,
      Cancel,
      Yes,
      No,
      Abort,
      Retry,
      Ignore,
      YesToAll,
      NoToAll,
 
      NumberOfStandardButtons
   };
}
 
// ----------------------------------------------------------------------------
 
class MessageBoxPrivate;
 
class PCL_CLASS MessageBox
{
public:
 
   using std_icon = StdIcon::value_type;
 
   using std_button = StdButton::value_type;
 
   MessageBox( const String& text             = String(),
               const String& caption          = String(), // default caption
               std_icon      icon             = StdIcon::NoIcon,
               std_button    button0          = StdButton::Ok,
               std_button    button1          = StdButton::NoButton,
               std_button    button2          = StdButton::NoButton,
               int           defaultButtonIdx = 0,
               int           escapeButtonIdx  = -1 ); // escape cancels dialog
 
   virtual ~MessageBox();
 
   std_button Execute();
 
   std_button Result() const;
 
   String Text() const;
 
   void SetText( const String& text );
 
   String Caption() const;
 
   void SetCaption( const String& text );
 
   std_icon Icon() const;
 
   void SetIcon( std_icon icon );
 
   std_button FirstButton() const;
 
   void SetFirstButton( std_button button );
 
   std_button SecondButton() const;
 
   void SetSecondButton( std_button button );
 
   std_button ThirdButton() const;
 
   void SetThirdButton( std_button button );
 
   int DefaultButtonIndex() const;
 
   void SetDefaultButtonIndex( int index );
 
   int EscapeButtonIndex() const;
 
   void SetEscapeButtonIndex( int index );
 
private:
 
   AutoPointer<MessageBoxPrivate> p;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_MessageBox_h
 
// ----------------------------------------------------------------------------
// EOF pcl/MessageBox.h - Released 2024-06-18T15:48:54Z