ProgressDialog.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/ProgressDialog.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_ProgressDialog_h
#define __PCL_ProgressDialog_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Dialog.h>
#include <pcl/Label.h>
#include <pcl/PushButton.h>
#include <pcl/Sizer.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ProgressDialog : public Dialog
{
public:
 
   ProgressDialog( const String& text = String(),
                   const String& title = String(),
                   size_type lowerBound = 0, size_type upperBound = 100,
                   Control& parent = Control::Null() );
 
   void SetTitle( const String& title );
 
   void SetRange( size_type lowerBound, size_type upperBound );
 
   void SetUnbounded()
   {
      SetRange( 0, 0 );
   }
 
   size_type LowerBound() const
   {
      return m_lowerBound;
   }
 
   size_type UpperBound() const
   {
      return m_upperBound;
   }
 
   void SetText( const String& text );
 
   void SetValue( size_type value );
 
   void Increment()
   {
      SetValue( m_value + 1 );
   }
 
   bool IsCanceled() const
   {
      return m_canceled;
   }
 
   void EnableCancelButton( bool enable = true );
 
   void DisableCancelButton( bool disable = true )
   {
      EnableCancelButton( !disable );
   }
 
   bool IsCancelButtonEnabled() const
   {
      return m_cancelButton.IsVisible();
   }
 
protected:
 
   class ProgressBar : public Control
   {
   public:
 
      ProgressBar();
 
   private:
 
      double    m_value = 0; // only if bounded, in [0,1]
      size_type m_step = 0;  // only if unbounded, in [0,Width()-1]
      bool      m_bounded = true;
 
      void e_Paint( Control&, const Rect& );
 
      friend class ProgressDialog;
   };
 
   size_type   m_lowerBound = 0;
   size_type   m_upperBound = 100;
   size_type   m_value = 0;
   bool        m_canceled = false;
   Label       m_infoLabel;
   ProgressBar m_progressBar;
   PushButton  m_cancelButton;
 
   void e_Click( Button& sender, bool checked );
   void e_Close( Control& sender, bool& allowClose );
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ProgressDialog_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ProgressDialog.h - Released 2024-06-18T15:48:54Z