Button.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Button.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_Button_h
#define __PCL_Button_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/Control.h>
#include <pcl/Bitmap.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace CheckState
{
   enum value_type
   {
      Unchecked,  // the item is not checked
      Checked,    // the item is checked
      ThirdState  // the check box is in its 'third state'
   };
}
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Button : public Control
{
public:
 
   using check_state = CheckState::value_type;
 
   ~Button() override
   {
   }
 
   String Text() const;
 
   void SetText( const String& );
 
   Bitmap Icon() const;
 
   void SetIcon( const Bitmap& );
 
   void GetIconSize( int& width, int& height ) const;
 
   int IconWidth() const
   {
      int width, dum; GetIconSize( width, dum ); return width;
   }
 
   int IconHeight() const
   {
      int dum, height; GetIconSize( dum, height ); return height;
   }
 
   void SetIconSize( int width, int height );
 
   void SetIconSize( int size )
   {
      SetIconSize( size, size );
   }
 
   void GetScaledIconSize( int& width, int& height ) const
   {
      GetIconSize( width, height ); width = PhysicalPixelsToLogical( width ); height = PhysicalPixelsToLogical( height );
   }
 
   int ScaledIconWidth() const
   {
      int width, dum; GetIconSize( width, dum ); return PhysicalPixelsToLogical( width );
   }
 
   int ScaledIconHeight() const
   {
      int dum, height; GetIconSize( dum, height ); return PhysicalPixelsToLogical( height );
   }
 
   void SetScaledIconSize( int width, int height )
   {
      SetIconSize( LogicalPixelsToPhysical( width ), LogicalPixelsToPhysical( height ) );
   }
 
   void SetScaledIconSize( int size )
   {
      size = LogicalPixelsToPhysical( size );
      SetIconSize( size, size );
   }
 
   virtual bool IsPushable() const = 0;
 
   bool IsPushed() const;
 
   void SetPushed( bool = true );
 
   void Push()
   {
      SetPushed( true );
   }
 
   void Unpush()
   {
      SetPushed( false );
   }
 
   virtual bool IsCheckable() const = 0;
 
   bool IsChecked() const;
 
   void SetChecked( bool = true );
 
   void Check()
   {
      SetChecked( true );
   }
 
   void Uncheck()
   {
      SetChecked( false );
   }
 
   check_state State() const;
 
   void SetState( check_state );
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnClick( Button& sender, bool checked );
   // void OnPress( Button& sender );
   // void OnRelease( Button& sender );
   // void OnCheck( Button& sender, Button::check_state state );
 
   using click_event_handler = void (Control::*)( Button& sender, bool checked );
 
   using press_event_handler = void (Control::*)( Button& sender );
 
   using check_event_handler = void (Control::*)( Button& sender, Button::check_state state );
 
   void OnClick( click_event_handler handler, Control& receiver );
 
   void OnPress( press_event_handler handler, Control& receiver );
 
   void OnRelease( press_event_handler handler, Control& receiver );
 
   void OnCheck( check_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      click_event_handler onClick   = nullptr;
      press_event_handler onPress   = nullptr;
      press_event_handler onRelease = nullptr;
      check_event_handler onCheck   = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
protected:
 
   Button( void* h ) : Control( h )
   {
   }
 
   friend class ButtonEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_Button_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Button.h - Released 2024-06-18T15:48:54Z