SectionBar.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/SectionBar.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_SectionBar_h
#define __PCL_SectionBar_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/CheckBox.h>
#include <pcl/Control.h>
#include <pcl/Label.h>
#include <pcl/Sizer.h>
#include <pcl/ToolButton.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SectionBar : public Control
{
public:
 
   SectionBar( Control& parent = Null() );
 
   ~SectionBar() override;
 
   const Control& Section() const
   {
      return (m_section != nullptr) ? *m_section : Control::Null();
   }
 
   Control& Section()
   {
      return (m_section != nullptr) ? *m_section : Control::Null();
   }
 
   void SetSection( Control& );
 
   String Title() const
   {
      return Title_Label.Text();
   }
 
   void SetTitle( const String& title )
   {
      Title_Label.SetText( title );
   }
 
   bool HasTitleCheckBox() const
   {
      return !Title_CheckBox.IsNull();
   }
 
   void EnableTitleCheckBox( bool = true );
 
   void DisableTitleCheckBox( bool disable = true )
   {
      EnableTitleCheckBox( !disable );
   }
 
   bool IsChecked() const
   {
      return !Title_CheckBox.IsNull() && Title_CheckBox->IsChecked();
   }
 
   void SetChecked( bool checked = true );
 
   void Check()
   {
      SetChecked( true );
   }
 
   void Uncheck()
   {
      SetChecked( false );
   }
 
   bool IsEnabled() const override
   {
      return Title_Label.IsEnabled();
   }
 
   void Enable( bool enabled = true ) override;
 
   void SetSectionVisible( bool visible = true );
 
   void ShowSection()
   {
      SetSectionVisible( true );
   }
 
   void HideSection()
   {
      SetSectionVisible( false );
   }
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnToggleSection( SectionBar& sender, Control& section, bool start );
 
   using section_event_handler = void (Control::*)( SectionBar& sender, Control& section, bool start );
 
   void OnToggleSection( section_event_handler handler, Control& receiver );
 
   using check_event_handler = void (Control::*)( SectionBar& sender, bool checked );
 
   void OnCheck( check_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      section_event_handler onToggleSection         = nullptr;
      Control*              onToggleSectionReceiver = nullptr;
 
      check_event_handler   onCheck                 = nullptr;
      Control*              onCheckReceiver         = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
   Control*                   m_section = nullptr;
 
   VerticalSizer         Global_Sizer;
      HorizontalSizer       Title_Sizer;
         Label                 Title_Label;
         AutoPointer<CheckBox> Title_CheckBox; // non-null for a checkable SectionBar
         ToolButton            Title_ToolButton;
 
   void ButtonClick( Button&, bool );
   void MousePress( Control&, const pcl::Point&, int, unsigned, unsigned );
   void ControlShow( Control& );
   void ControlHide( Control& );
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_SectionBar_h
 
// ----------------------------------------------------------------------------
// EOF pcl/SectionBar.h - Released 2024-01-13T15:47:58Z