Sizer.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/Sizer.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_Sizer_h
#define __PCL_Sizer_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/UIObject.h>
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace Align
{
   enum value_type
   {
      Expand,
      Left,
      Top     = Left,
      Right,
      Bottom  = Right,
      Center,
      Default = Expand
   };
}
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
class PCL_CLASS Control;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Sizer : public UIObject
{
public:
 
   using item_alignment = Align::value_type;
 
   Sizer( bool vertical );
 
   ~Sizer() override
   {
   }
 
   void EnsureUnique() override
   {
      // Sizers are unique objects by definition
   }
 
   static Sizer& Null();
 
   Control& ParentControl() const;
 
   bool IsVertical() const;
 
   bool IsHorizontal() const
   {
      return !IsVertical();
   }
 
   int NumberOfItems() const;
 
   int IndexOf( const Sizer& s ) const;
 
   int IndexOf( const Control& c ) const;
 
   bool Contains( const Sizer& s ) const
   {
      return IndexOf( s ) >= 0;
   }
 
   bool Contains( const Control& c ) const
   {
      return IndexOf( c ) >= 0;
   }
 
   void Add( Sizer& s, int stretchFactor = 0 );
 
   void Add( Control& c, int stretchFactor = 0, item_alignment align = Align::Default );
 
   void AddSpacing( int size, bool autoScaling = true );
 
   void AddScaledSpacing( int size )
   {
      AddSpacing( size, true );
   }
 
   void AddUnscaledSpacing( int size )
   {
      AddSpacing( size, false );
   }
 
   void AddStretch( int stretchFactor = 100 );
 
   void Insert( int index, Sizer& s, int stretchFactor = 0 );
 
   void Insert( int index, Control& c, int stretchFactor = 0, item_alignment align = Align::Default );
 
   void InsertSpacing( int index, int size, bool autoScaling = true );
 
   void InsertScaledSpacing( int index, int size )
   {
      InsertSpacing( index, size, true );
   }
 
   void InsertUnscaledSpacing( int index, int size )
   {
      InsertSpacing( index, size, false );
   }
 
   void InsertStretch( int index, int stretchFactor = 100 );
 
   void Remove( Sizer& s );
 
   void Remove( Control& c );
 
   void SetStretchFactor( Sizer& s, int stretch );
 
   void SetStretchFactor( Control& c, int stretch );
 
   void SetAlignment( Sizer& s, item_alignment align );
 
   void SetAlignment( Control& c, item_alignment align );
 
   int Margin( bool autoScaling = true ) const;
 
   void SetMargin( int margin, bool autoScaling = true );
 
   int Spacing( bool autoScaling = true ) const;
 
   void SetSpacing( int spacing, bool autoScaling = true );
 
   double DisplayPixelRatio() const;
 
   int LogicalPixelsToPhysical( int size ) const
   {
      return RoundInt( DisplayPixelRatio()*size );
   }
 
   int PhysicalPixelsToLogical( int size ) const
   {
      return RoundInt( size/DisplayPixelRatio() );
   }
 
private:
 
   Sizer( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class Control;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS HorizontalSizer : public Sizer
{
public:
 
   using item_alignment = Sizer::item_alignment;
 
   HorizontalSizer()
      : Sizer( false/*vertical*/ )
   {
   }
 
   ~HorizontalSizer() override
   {
   }
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS VerticalSizer : public Sizer
{
public:
 
   using item_alignment = Sizer::item_alignment;
 
   VerticalSizer()
      : Sizer( true/*vertical*/ )
   {
   }
 
   ~VerticalSizer() override
   {
   }
};
 
// ----------------------------------------------------------------------------
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_Sizer_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Sizer.h - Released 2024-01-13T15:47:58Z