ScrollBox.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/ScrollBox.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_ScrollBox_h
#define __PCL_ScrollBox_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Frame.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ScrollBox : public Frame
{
public:
 
   ScrollBox( Control& parent = Control::Null() );
 
   ~ScrollBox() override
   {
   }
 
   bool IsHorizontalScrollBarVisible() const;
 
   bool IsVerticalScrollBarVisible() const;
 
   void ShowScrollBars( bool showHorz = true, bool showVert = true );
 
   void HideScrollBars( bool hideHorz = true, bool hideVert = true )
   {
      ShowScrollBars( !hideHorz, !hideVert );
   }
 
   void ShowHorizontalScrollBar( bool show = true )
   {
      ShowScrollBars( show, IsVerticalScrollBarVisible() );
   }
 
   void HideHorizontalScrollBar( bool hide = true )
   {
      ShowHorizontalScrollBar( !hide );
   }
 
   void ShowVerticalScrollBar( bool show = true )
   {
      ShowScrollBars( IsHorizontalScrollBarVisible(), show );
   }
 
   void HideVerticalScrollBar( bool hide = true )
   {
      ShowVerticalScrollBar( !hide );
   }
 
   bool IsHorizontalAutoScrollEnabled() const;
 
   bool IsVerticalAutoScrollEnabled() const;
 
   void EnableAutoScroll( bool enableHorz = true, bool enableVert = true );
 
   void DisableAutoScroll( bool disableHorz = true, bool disableVert = true )
   {
      EnableAutoScroll( !disableHorz, !disableVert );
   }
 
   void GetHorizontalScrollRange( int& minPos, int& maxPos ) const;
 
   void GetVerticalScrollRange( int& minPos, int& maxPos ) const;
 
   int MinHorizontalScrollPosition() const
   {
      int minPos, dum; GetHorizontalScrollRange( minPos, dum ); return minPos;
   }
 
   int MaxHorizontalScrollPosition() const
   {
      int dum, maxPos; GetHorizontalScrollRange( dum, maxPos ); return maxPos;
   }
 
   int MinVerticalScrollPosition() const
   {
      int minPos, dum; GetVerticalScrollRange( minPos, dum ); return minPos;
   }
 
   int MaxVerticalScrollPosition() const
   {
      int dum, maxPos; GetVerticalScrollRange( dum, maxPos ); return maxPos;
   }
 
   void SetHorizontalScrollRange( int minPos, int maxPos );
 
   void SetVerticalScrollRange( int minPos, int maxPos );
 
   int PageWidth() const;
 
   int PageHeight() const;
 
   void SetPageSize( int width, int height );
 
   void SetPageWidth( int width )
   {
      SetPageSize( width, PageHeight() );
   }
 
   void SetPageHeight( int height )
   {
      SetPageSize( PageWidth(), height );
   }
 
   int LineWidth() const;
 
   int LineHeight() const;
 
   void SetLineSize( int width, int height );
 
   void SetLineWidth( int width )
   {
      SetLineSize( width, LineHeight() );
   }
 
   void SetLineHeight( int height )
   {
      SetLineSize( LineWidth(), height );
   }
 
   pcl::Point ScrollPosition() const;
 
   int HorizontalScrollPosition() const
   {
      pcl::Point pos = ScrollPosition(); return pos.x;
   }
 
   int VerticalScrollPosition() const
   {
      pcl::Point pos = ScrollPosition(); return pos.y;
   }
 
   void SetScrollPosition( const pcl::Point& pos )
   {
      SetScrollPosition( pos.x, pos.y );
   }
 
   void SetScrollPosition( int horzPos, int vertPos );
 
   void SetHorizontalScrollPosition( int horzPos )
   {
      SetScrollPosition( horzPos, VerticalScrollPosition() );
   }
 
   void SetVerticalScrollPosition( int vertPos )
   {
      SetScrollPosition( HorizontalScrollPosition(), vertPos );
   }
 
   bool IsHorizontalTrackingEnabled() const;
 
   bool IsVerticalTrackingEnabled() const;
 
   void EnableTracking( bool enableHorz = true, bool enableVert = true );
 
   void EnableHorizontalTracking( bool enableHorz = true )
   {
      EnableTracking( enableHorz, IsVerticalTrackingEnabled() );
   }
 
   void EnableVerticalTracking( bool enableVert = true )
   {
      EnableTracking( IsHorizontalTrackingEnabled(), enableVert );
   }
 
   void DisableTracking( bool disableHorz = true, bool disableVert = true )
   {
      EnableTracking( !disableHorz, !disableVert );
   }
 
   void DisableHorizontalTracking( bool disableHorz = true )
   {
      EnableTracking( !disableHorz, IsVerticalTrackingEnabled() );
   }
 
   void DisableVerticalTracking( bool disableVert = true )
   {
      EnableTracking( IsHorizontalTrackingEnabled(), !disableVert );
   }
 
   const Control& Viewport() const
   {
      return m_viewport;
   }
 
   Control& Viewport()
   {
      return m_viewport;
   }
 
   // -------------------------------------------------------------------------
   // Event handlers
   //
   // void OnHorizontalScrollPosUpdated( ScrollBox& sender, int horzPos );
   // void OnVerticalScrollPosUpdated( ScrollBox& sender, int vertPos );
   // void OnHorizontalScrollRangeUpdated( ScrollBox& sender, int minHorzPos, int maxHorzPos );
   // void OnVerticalScrollRangeUpdated( ScrollBox& sender, int minVertPos, int maxVertPos );
 
   using pos_event_handler = void (Control::*)( ScrollBox& sender, int pos );
 
   using range_event_handler = void (Control::*)( ScrollBox& sender, int minValue, int maxValue );
 
   void OnHorizontalScrollPosUpdated( pos_event_handler handler, Control& receiver );
 
   void OnVerticalScrollPosUpdated( pos_event_handler handler, Control& receiver );
 
   void OnHorizontalScrollRangeUpdated( range_event_handler handler, Control& receiver );
 
   void OnVerticalScrollRangeUpdated( range_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      pos_event_handler   onHorizontalScrollPosUpdated   = nullptr;
      pos_event_handler   onVerticalScrollPosUpdated     = nullptr;
      range_event_handler onHorizontalScrollRangeUpdated = nullptr;
      range_event_handler onVerticalScrollRangeUpdated   = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
protected:
 
   Control m_viewport;
 
   ScrollBox( void* );
 
   ScrollBox( void*, void* );
 
   friend class ScrollBoxEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_ScrollBox_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ScrollBox.h - Released 2024-06-18T15:48:54Z