GlobalSettings.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/GlobalSettings.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_GlobalSettings_h
#define __PCL_GlobalSettings_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Color.h>
#include <pcl/String.h>
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
#include <pcl/Font.h>
#endif
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace GlobalVariableType
{
   enum value_type
   {
      Undefined,  // The requested global variable doesn't exist
      Flag,       // bool
      Integer,    // int
      Unsigned,   // unsigned
      Real,       // double
      Color,      // RGBA (= uint32)
      Font,       // Font
      String      // String
   };
}
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS PixInsightSettings
{
public:
 
   using variable_type = GlobalVariableType::value_type;
 
   PixInsightSettings() = delete;
 
   PixInsightSettings( const PixInsightSettings& ) = delete;
 
   PixInsightSettings& operator =( const PixInsightSettings& ) = delete;
 
   virtual ~PixInsightSettings() = delete;
 
   static variable_type GlobalVariableType( const IsoString& globalId );
 
   static bool IsGlobalVariableDefined( const IsoString& globalId )
   {
      return GlobalVariableType( globalId ) != GlobalVariableType::Undefined;
   }
 
   static bool GlobalFlag( const IsoString& globalId );
 
   static int GlobalInteger( const IsoString& globalId );
 
   static unsigned GlobalUnsigned( const IsoString& globalId );
 
   static double GlobalReal( const IsoString& globalId );
 
   static RGBA GlobalColor( const IsoString& globalId );
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
   static Font GlobalFont( const IsoString& globalId );
#endif
 
   static String GlobalString( const IsoString& globalId );
 
   static void BeginUpdate();
 
   static void EndUpdate();
 
   static void CancelUpdate();
 
   static void SetGlobalFlag( const IsoString& globalId, bool );
 
   static void SetGlobalInteger( const IsoString& globalId, int );
 
   static void SetGlobalUnsigned( const IsoString& globalId, unsigned );
 
   static void SetGlobalReal( const IsoString& globalId, double );
 
   static void SetGlobalColor( const IsoString& globalId, RGBA );
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
   static void SetGlobalFont( const IsoString& globalId, const Font& );
#endif
 
   static void SetGlobalString( const IsoString& globalId, const String& );
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_GlobalSettings_h
 
// ----------------------------------------------------------------------------
// EOF pcl/GlobalSettings.h - Released 2024-01-13T15:47:58Z