TabBox.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/TabBox.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_TabBox_h
#define __PCL_TabBox_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Bitmap.h>
#include <pcl/Control.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace TabPosition
{
   enum value_type
   {
      Top,     // Tabs are located at the top side of the tab box control
      Bottom   // Tabs are located at the bottom side of the tab box control
   };
}
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS TabBox : public Control
{
public:
 
   using tab_position = TabPosition::value_type;
 
   TabBox( Control& parent = Control::Null() );
 
   ~TabBox() override
   {
   }
 
   int NumberOfPages() const;
 
   int CurrentPageIndex() const;
 
   void SetCurrentPageIndex( int index );
 
   void SelectPage( int index )
   {
      SetCurrentPageIndex( index );
   }
 
   Control& CurrentPageControl() const;
 
   Control& PageControlByIndex( int index ) const;
 
   void InsertPage( int index, Control& page, const String& label, const Bitmap& icon = Bitmap::Null() );
 
   void AddPage( Control& page, const String& label, const Bitmap& icon = Bitmap::Null() )
   {
      InsertPage( NumberOfPages(), page, label, icon );
   }
 
   void RemovePage( int idx );
 
   tab_position TabPosition() const;
 
   void SetTabPosition( tab_position pos );
 
   bool IsPageEnabled( int index ) const;
 
   void EnablePage( int index, bool enable = true );
 
   void DisablePage( int index, bool disable = true )
   {
      EnablePage( index, !disable );
   }
 
   String PageLabel( int idx ) const;
 
   void SetPageLabel( int idx, const String& );
 
   void ClearPageLabel( int idx )
   {
      SetPageLabel( idx, String() );
   }
 
   Bitmap PageIcon( int idx ) const;
 
   void SetPageIcon( int idx, const Bitmap& );
 
   void ClearPageIcon( int idx )
   {
      SetPageIcon( idx, Bitmap::Null() );
   }
 
   String PageToolTip( int idx ) const;
 
   void SetPageToolTip( int idx, const String& );
 
   void ClearPageToolTip( int idx )
   {
      SetPageToolTip( idx, String() );
   }
 
   Control& LeftControl() const;
 
   Control& RightControl() const;
 
   void SetControls( Control& left, Control& right );
 
   void SetLeftControl( Control& w )
   {
      SetControls( w, RightControl() );
   }
 
   void SetRightControl( Control& w )
   {
      SetControls( LeftControl(), w );
   }
 
   void ClearLeftControl()
   {
      SetLeftControl( Control::Null() );
   }
 
   void ClearRightControl()
   {
      SetRightControl( Control::Null() );
   }
 
   void ClearControls()
   {
      SetControls( Control::Null(), Control::Null() );
   }
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnPageSelected( TabBox& sender, int pageIndex );
 
   using page_event_handler = void (Control::*)( TabBox& sender, int pageIndex );
 
   void OnPageSelected( page_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      page_event_handler onPageSelected = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
   friend class TabBoxEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_TabBox_h
 
// ----------------------------------------------------------------------------
// EOF pcl/TabBox.h - Released 2024-06-18T15:48:54Z