NumericControl.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/NumericControl.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_NumericControl_h
#define __PCL_NumericControl_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Atomic.h>
#include <pcl/AutoPointer.h>
#include <pcl/Control.h>
#include <pcl/Edit.h>
#include <pcl/Label.h>
#include <pcl/Sizer.h>
#include <pcl/Slider.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS NumericEdit : public Control
{
public:
 
   HorizontalSizer sizer; 
   Label           label; 
   Edit            edit;  
 
   NumericEdit( Control& parent = Null() );
 
   ~NumericEdit() override
   {
   }
 
   double Value() const
   {
      return m_value;
   }
 
   void SetValue( double );
 
   String ValueAsString( double ) const;
 
   String ValueAsString() const
   {
      return ValueAsString( m_value );
   }
 
   int MinEditWidth() const;
 
   void AdjustEditWidth();
 
   bool IsReal() const
   {
      return m_real;
   }
 
   void SetReal( bool real = true );
 
   void SetInteger( bool integer = true )
   {
      SetReal( !integer );
   }
 
   double LowerBound() const
   {
      return m_lowerBound;
   }
 
   double UpperBound() const
   {
      return m_upperBound;
   }
 
   virtual void SetRange( double lower, double upper );
 
   int Precision() const
   {
      return m_precision;
   }
 
   void SetPrecision( int n );
 
   bool IsFixedPrecision() const
   {
      return m_fixed;
   }
 
   void EnableFixedPrecision( bool enable = true );
 
   void DisableFixedPrecision( bool disable = true )
   {
      EnableFixedPrecision( !disable );
   }
 
   bool IsScientificNotation() const
   {
      return m_scientific;
   }
 
   void EnableScientificNotation( bool enable = true );
 
   void DisableScientificNotation( bool disable = true )
   {
      EnableScientificNotation( !disable );
   }
 
   int ScientificNotationTriggerExponent() const
   {
      return m_sciTriggerExp;
   }
 
   void SetScientificNotationTriggerExponent( int exp10 );
 
   bool IsFixedSign() const
   {
      return m_sign;
   }
 
   void EnableFixedSign( bool enable = true );
 
   void DisableFixedSign( bool disable = true )
   {
      EnableFixedSign( !disable );
   }
 
   bool IsAutoAdjustEditWidth() const
   {
      return m_autoEditWidth;
   }
 
   void EnableAutoAdjustEditWidth( bool enable = true )
   {
      if ( (m_autoEditWidth = enable) != false )
         AdjustEditWidth();
   }
 
   void DisableAutoAdjustEditWidth( bool disable = true )
   {
      EnableAutoAdjustEditWidth( !disable );
   }
 
   bool IsValidatingRegExpEnabled() const
   {
      return m_useRegExp;
   }
 
   void EnableValidatingRegExp( bool enable = true )
   {
      m_useRegExp = enable;
      UpdateRegExp();
   }
 
   void DisableValidatingRegExp( bool disable = true )
   {
      EnableValidatingRegExp( !disable );
   }
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnValueUpdated( NumericControl& sender, double value );
 
   using value_event_handler = void (Control::*)( NumericEdit& sender, double value );
 
   void OnValueUpdated( value_event_handler, Control& );
 
protected:
 
   struct EventHandlers
   {
      value_event_handler onValueUpdated         = nullptr;
      Control*            onValueUpdatedReceiver = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
   double m_value = 0;            // current value
   double m_lowerBound = 0;       // acceptable range, lower bound
   double m_upperBound = 1;       // acceptable range, upper bound
   int    m_precision = 6;        // number of decimal digits in non-sci mode, [0,16]
   bool   m_real = true;          // whether this is a real or integer parameter
   bool   m_fixed = false;        // precision is literal instead of significant digits?
   bool   m_scientific = false;   // scientific notation enabled?
   bool   m_sign = false;         // always show a sign character
   bool   m_autoEditWidth = true; // set width of edit control automatically
   int    m_sciTriggerExp = -1;   // exponent (of ten) to trigger sci notation
   bool   m_useRegExp = true;     // use validating regular expressions
 
   PCL_MEMBER_REENTRANCY_GUARD( EditCompleted )
 
   virtual void UpdateControls();
 
   virtual void EditCompleted( Edit& );
   virtual void KeyPressed( Control&, int, unsigned, bool& );
   virtual void ReturnPressed( Edit& );
   virtual void GetFocus( Control& );
   virtual void LoseFocus( Control& );
   virtual void MousePress( Control&, const pcl::Point&, int, unsigned, unsigned );
 
   int PrecisionForValue( double ) const;
   bool UseScientific( double ) const;
   void UpdateRegExp();
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS NumericControl : public NumericEdit
{
public:
 
   HorizontalSlider slider;   
 
   NumericControl( Control& parent = Null() );
 
   ~NumericControl() override
   {
   }
 
   void SetRange( double lower, double upper ) override;
 
   bool IsExponentialResponse() const
   {
      return m_exponential;
   }
 
   void EnableExponentialResponse( bool enable = true );
 
   void DisableExponentialResponse( bool disable = true )
   {
      EnableExponentialResponse( !disable );
   }
 
protected:
 
   void UpdateControls() override;
 
   virtual void ValueUpdated( Slider&, int );
   void KeyPressed( Control&, int, unsigned, bool& ) override;
   void GetFocus( Control& ) override;
 
private:
 
   bool m_exponential = false;
 
   double SliderValueToControl( int ) const;
   int ControlValueToSlider( double ) const;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_NumericControl_h
 
// ----------------------------------------------------------------------------
// EOF pcl/NumericControl.h - Released 2024-06-18T15:48:54Z