SpinBox.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/SpinBox.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_SpinBox_h
#define __PCL_SpinBox_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Control.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SpinBox : public Control
{
public:
 
   SpinBox( Control& parent = Control::Null() );
 
   ~SpinBox() override
   {
   }
 
   int Value() const;
 
   void SetValue( int v );
 
   double NormalizedValue() const;
 
   void SetNormalizedValue( double f );
 
   void GetRange( int& minValue, int& maxValue ) const;
 
   int MinValue() const
   {
      int m, dum; GetRange( m, dum ); return m;
   }
 
   int MaxValue() const
   {
      int dum, m; GetRange( dum, m ); return m;
   }
 
   void SetRange( int minValue, int maxValue );
 
   void SetMinValue( int m )
   {
      SetRange( m, MaxValue() );
   }
 
   void SetMaxValue( int m )
   {
      SetRange( MinValue(), m );
   }
 
   int StepSize() const;
 
   void SetStepSize( int );
 
   bool IsWrappingEnabled() const;
 
   void EnableWrapping( bool = true );
 
   void DisableWrapping( bool disable = true )
   {
      EnableWrapping( !disable );
   }
 
   bool IsEditable() const;
 
   void SetEditable( bool = true );
 
   String Prefix() const;
 
   void SetPrefix( const String& prefix );
 
   void ClearPrefix()
   {
      SetPrefix( String() );
   }
 
   String Suffix() const;
 
   void SetSuffix( const String& );
 
   void ClearSuffix()
   {
      SetSuffix( String() );
   }
 
   String MinimumValueText() const;
 
   void SetMinimumValueText( const String& );
 
   void ClearMinimumValueText()
   {
      SetMinimumValueText( String() );
   }
 
   bool IsRightAligned() const;
 
   bool IsLeftAligned() const
   {
      return !IsRightAligned();
   }
 
   void SetRightAlignment( bool = true );
 
   void SetLeftAlignment( bool left = true )
   {
      SetRightAlignment( !left );
   }
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnValueUpdated( SpinBox& sender, int value );
   // void OnRangeUpdated( SpinBox& sender, int minValue, int maxValue );
 
   using value_event_handler = void (Control::*)( SpinBox& sender, int value );
 
   using range_event_handler = void (Control::*)( SpinBox& sender, int minValue, int maxValue );
 
   void OnValueUpdated( value_event_handler handler, Control& receiver );
 
   void OnRangeUpdated( range_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      value_event_handler onValueUpdated = nullptr;
      range_event_handler onRangeUpdated = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
   friend class SpinBoxEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_SpinBox_h
 
// ----------------------------------------------------------------------------
// EOF pcl/SpinBox.h - Released 2024-06-18T15:48:54Z