PCL
Public Types | Public Member Functions | Static Public Member Functions | List of all members
pcl::PixInsightSettings Class Reference

Retrieves global settings from the PixInsight core application. More...

#include <GlobalSettings.h>

Public Types

using variable_type = GlobalVariableType::value_type
 

Public Member Functions

 PixInsightSettings ()=delete
 
 PixInsightSettings (const PixInsightSettings &)=delete
 
virtual ~PixInsightSettings ()=delete
 
PixInsightSettings & operator= (const PixInsightSettings &)=delete
 

Static Public Member Functions

static void BeginUpdate ()
 
static void CancelUpdate ()
 
static void EndUpdate ()
 
static RGBA GlobalColor (const IsoString &globalId)
 
static bool GlobalFlag (const IsoString &globalId)
 
static Font GlobalFont (const IsoString &globalId)
 
static int GlobalInteger (const IsoString &globalId)
 
static double GlobalReal (const IsoString &globalId)
 
static String GlobalString (const IsoString &globalId)
 
static unsigned GlobalUnsigned (const IsoString &globalId)
 
static variable_type GlobalVariableType (const IsoString &globalId)
 
static bool IsGlobalVariableDefined (const IsoString &globalId)
 
static void SetGlobalColor (const IsoString &globalId, RGBA)
 
static void SetGlobalFlag (const IsoString &globalId, bool)
 
static void SetGlobalFont (const IsoString &globalId, const Font &)
 
static void SetGlobalInteger (const IsoString &globalId, int)
 
static void SetGlobalReal (const IsoString &globalId, double)
 
static void SetGlobalString (const IsoString &globalId, const String &)
 
static void SetGlobalUnsigned (const IsoString &globalId, unsigned)
 

Detailed Description

PixInsight global settings, also known as global variables, are identifier/value pairs available from the core application to all installed modules. Settings can be of six types: flags (or Boolean), integer (signed and unsigned), real (floating point), color, font, and string. See the pcl::GlobalVariableType namespace for more details.

Below is a complete list of all global settings available in current versions of the PixInsight platform (up-to-date as of core version 1.8.9-2).

PixInsight Public Global Variables

Global Flags

Application/AutoUIScaling
Application/CompressSettingsBlocks
Application/HealRegistryInformationOnUpdates
Application/MinifySettingsXML
ColorManagement/DefaultEmbedProfilesInGrayscaleImages
ColorManagement/DefaultEmbedProfilesInRGBImages
ColorManagement/DefaultGamutCheckEnabled
ColorManagement/DefaultProofingEnabled
ColorManagement/IsEnabled
ColorManagement/IsValidRead-only.
ColorManagement/UseLowResolutionCLUTs
ColorManagement/UseProofingBPC
ImageWindow/BackupFiles
ImageWindow/CreatePreviewsFromCoreProperties
ImageWindow/Default24BitScreenLUT
ImageWindow/DefaultEmbedProperties
ImageWindow/DefaultEmbedThumbnails
ImageWindow/DefaultMasksShown
ImageWindow/DefaultMetricResolution
ImageWindow/FastScreenRenditions
ImageWindow/FileFormatWarnings
ImageWindow/FollowDownloadLocations
ImageWindow/HighDPIRenditions
ImageWindow/LoadAstrometricSolutions
ImageWindow/LoadInitialProcessingFromCoreProperties
ImageWindow/MeasureScreenRenderingPerformance
ImageWindow/NativeFileDialogs
ImageWindow/ProjectVerifyIncrementalChecksums
ImageWindow/RememberFileOpenType
ImageWindow/RememberFileSaveType
ImageWindow/ShowActiveSTFIndicators
ImageWindow/ShowCaptionCurrentChannels
ImageWindow/ShowCaptionFullPaths
ImageWindow/ShowCaptionIdentifiers
ImageWindow/ShowCaptionZoomRatios
ImageWindow/ShowViewSelectorImageThumbnails
ImageWindow/StrictFileSaveMode
ImageWindow/SwapCompression
ImageWindow/TouchEvents
ImageWindow/UseFileNamesAsImageIdentifiers
ImageWindow/VerboseNetworkOperationsIgnored on Windows.
ImageWindow/ZoomAtCursor
MainWindow/AcceptDroppedFiles
MainWindow/AnimateCombo
MainWindow/AnimateMenu
MainWindow/AnimateToolBox
MainWindow/AnimateToolTip
MainWindow/AnimateWindows
MainWindow/CapitalizedMenuBars
MainWindow/CheckForUpdatesAtStartup
MainWindow/ConfirmProgramTermination
MainWindow/DesktopSettingsAware
MainWindow/DoubleClickLaunchesOpenDialog
MainWindow/DropShadowChildWindows
MainWindow/DropShadowIcons
MainWindow/ExpandFavoritesAtStartup
MainWindow/ExpandMostUsedAtStartup
MainWindow/ExpandRecentlyUsedAtStartup
MainWindow/ExplodeIcons
MainWindow/FadeAutoHideWindows
MainWindow/FadeMenu
MainWindow/FadeToolTip
MainWindow/FadeWindows
MainWindow/FadeWorkspaces
MainWindow/FullScreenAtStartup
MainWindow/HighQualityWallpapers
MainWindow/HoverableAutoHideWindows
MainWindow/ImplodeIcons
MainWindow/MaximizeAtStartup
MainWindow/NativeMenuBar
MainWindow/OpenURLsWithInternalBrowser
MainWindow/OpenResourcesOnNewWebBrowserWindows
MainWindow/PrivateWebBrowsingMode
MainWindow/ShowFavorites
MainWindow/ShowMostUsed
MainWindow/ShowRecentlyUsed
MainWindow/ShowSplashAtStartup
MainWindow/ShowViewListImageThumbnails
MainWindow/ShowWorkspaceThumbnails
MainWindow/TranslucentAutoHideWindows
MainWindow/TranslucentChildWindows
MainWindow/TranslucentWindows
MainWindow/UseWallpapers
MainWindow/WindowButtonsOnTheLeft
Process/AlertOnProcessCompleted
Process/BackupFiles
Process/EnableCUDAAcceleration
Process/EnableExecutionStatistics
Process/EnableLaunchStatistics
Process/EnableParallelCoreColorManagement
Process/EnableParallelCoreRendering
Process/EnableParallelModuleProcessing
Process/EnableParallelProcessing
Process/EnableThreadCPUAffinity
Process/GenerateScriptComments
Process/InitCUDARuntimeAtStartup
Process/VerifyScriptChecksums
Security/AllowInsecureRepositories
Security/AllowUnsignedRepositories
Security/AllowUnsignedScriptExecution
Security/EnableLocalSigningIdentity
Security/ReportScriptSignatures
Security/WarnOnUnsignedCodeExecution

Global Integers

Application/AutoSaveSettingsPeriodIn seconds.
Application/FontResolutionIn dots per inch.
Application/InstanceThe running application's instance number (≥ 1).
Application/MessageBoxOkCancelButtonOrder0 = default, 1 = Ok/Cancel, 2 = Cancel/Ok
Application/MessageBoxYesNoButtonOrder0 = default, 1 = Yes/No, 2 = No/Yes
Application/SurfaceSwapIntervalThe minimum number of video frames displayed before buffer swaps (vertical synchronization). Read-only.
ColorManagement/DefaultRenderingIntentSee the pcl::ICCRenderingIntent namespace.
ColorManagement/OnMissingProfileCore application policies. See the documentation for ColorManagementSetup.
ColorManagement/OnProfileMismatchCore application policies. See the documentation for ColorManagementSetup.
ColorManagement/ProofingIntentSee the pcl::ICCRenderingIntent namespace.
ImageWindow/CursorToleranceIn device pixels.
ImageWindow/DefaultMaskModeSee the pcl::MaskMode namespace.
ImageWindow/DefaultTransparencyModeSee the pcl::TransparencyMode namespace.
ImageWindow/FastScreenRenditionThresholdIn MiB.
ImageWindow/ImageThumbnailSizeIn image pixels.
ImageWindow/ProjectThumbnailSizeIn image pixels.
ImageWindow/WheelStepAngleIn degrees, unsigned.
ImageWindow/WheelDirectionWhen ≥ 0, rotating forward zooms out. When < 0, rotating forward zooms in.
MainWindow/MaxRecentFilesMaximum length of recent file menu lists.
Process/AutoSavePSMPeriodIn seconds.
Process/ConsoleDelayIn milliseconds.
Process/MaxConsoleLinesMaximum number of stored text lines on Process Console.
Process/MaxModuleThreadPriorityFrom 0=idle to 7=real-time.
Process/MaxProcessorsMaximum number of processor cores allowed for installed modules.
Process/MaxFileReadThreadsMaximum number of concurrent file reading threads.
Process/MaxFileWriteThreadsMaximum number of concurrent file writing threads.
Process/MaxUsageListLengthMaximum length of the Recently Used and Most Used lists on Process Explorer.
Process/PerformMallocTrimCallsWhen > 0, call malloc_trim() to release free memory. Only available on Linux; ignored on macOS and Windows.
System/NumberOfProcessorsTotal number of processor cores available. Read-only.
TransparencyBrush/BrushSee the pcl::BackgroundBrush namespace.
Workspace/PrimaryScreenCenterXRead-only. In physical device pixels.
Workspace/PrimaryScreenCenterYRead-only. In physical device pixels.
Workspace/IconGridSpacingGrid distance for aligned icon positions on all workspaces. In logical device pixels.

Global Reals

Application/StartJDStarting time of the core application instance as a Julian date. Read-only.
Application/UIScalingFactorGlobal interface scaling factor of the core application. In the range [1.0,4.0].
ImageWindow/DefaultHorizontalResolutionIn device pixels per resolution unit. See the ImageWindow/DefaultMetricResolution global variable.
ImageWindow/DefaultVerticalResolutionIn device pixels per resolution unit. See the ImageWindow/DefaultMetricResolution global variable.
ImageWindow/PinchSensitivityFor touch events. In device pixels.
MainWindow/ActiveWindowOpacityWindow opacity in the [0,1] range.
MainWindow/AutoHideWindowOpacityWindow opacity in the [0,1] range.
MainWindow/DropShadowBlurRadiusRadius in pixels of the Gaussian filter applied to drop shadow decorations.
MainWindow/InactiveChildWindowOpacityWindow opacity in the [0,1] range.
MainWindow/InactiveWindowOpacityWindow opacity in the [0,1] range.
MainWindow/MovingChildWindowOpacityWindow opacity in the [0,1] range.
MainWindow/MovingWindowOpacityWindow opacity in the [0,1] range.

Global Colors

Since PixInsight core version 1.8.0, most UI colors and fonts are defined in cascading style sheet files loaded automatically on startup. Only the following four color variables remain because they are purely functional (i.e., not related to the appearance of GUI controls).

ColorManagement/GamutWarningColorColor used for signaling out-of-gamut pixels in color proofing image renditions.
MainWindow/DropShadowColorThe color of drop shadow decorations.
TransparencyBrush/BackgroundColorBackground brush color for renditions of translucent image pixels.
TransparencyBrush/DefaultColorOpaque color for renditions of translucent image pixels.
TransparencyBrush/ForegroundColorForeground brush color for renditions of translucent image pixels.

Global Fonts

Currently there are no global font variables. Since PixInsight core version 1.8.0, all UI fonts are defined through cascading style sheet files loaded automatically on startup.

Global Strings

Application/AppDirectoryFull path to the distribution's core application bundle. Read-only. macOS only,
Application/AsteroidEphemeridesFileFile name or path of the distribution's asteroid ephemerides file (XEPH format).
Application/AsteroidEphemeridesFilePathFull path to the current distribution's asteroid ephemerides file (XEPH format). Read-only.
Application/BaseDirectoryBase directory of the core distribution. Read-only.
Application/BinDirectoryFull path to the distribution's bin directory. Read-only.
Application/CIP_ITRSDataFileFile name or path of the distribution's data file of CIP coordinates in the ITRS (plain text).
Application/CIP_ITRSDataFilePathFull path to the current distribution's data file of CIP coordinates in the ITRS (plain text). Read-only
Application/ColorDirectoryFull path to the distribution's color directory. Read-only.
Application/ConfigDirectoryFull path to the application's configuration directory. Platform-dependent. Read-only.
Application/CoreDirectoryFull directory of the core executable file. Read-only.
Application/CoreFilePathFull file path of the core executable. Read-only.
Application/DeltaATDataFileFile name or path of the distribution's Delta AT (TAI-UTC) data file (plain text).
Application/DeltaATDataFilePathFull path to the current distribution's Delta AT (TAI-UTC) data file (plain text). Read-only
Application/DeltaTDataFileFile name or path of the distribution's Delta T (TT-UT1) data file (plain text).
Application/DeltaTDataFilePathFull path to the current distribution's Delta T (TT-UT1) data file (plain text). Read-only
Application/DocDirectoryFull path to the distribution's doc directory. Read-only.
Application/EtcDirectoryFull path to the distribution's etc directory. Read-only.
Application/FundamentalEphemeridesFileFile name or path of the distribution's fundamental ephemerides file (XEPH format).
Application/FundamentalEphemeridesFilePathFull path to the current distribution's fundamental ephemerides file (XEPH format). Read-only.
Application/HighResFontFont family for automatic style sheet replacement on high-dpi displays.
Application/HighResMonoFontMonospaced font family for automatic style sheet replacement on high-dpi displays.
Application/IncludeDirectoryFull path to the distribution's include directory. Read-only.
Application/LibDirectoryFull path to the distribution's lib directory. Read-only.
Application/LibraryDirectoryFull path to the distribution's library directory. Read-only.
Application/LowResFontFont family for automatic style sheet replacement on low-dpi displays.
Application/LowResMonoFontMonospaced font family for automatic style sheet replacement on low-dpi displays.
Application/NutationModelFileFile name or path of the distribution's nutation model file (XEPH format).
Application/NutationModelFilePathFull path to the current distribution's nutation model file (XEPH format). Read-only.
Application/ResourceFile01Core resource file #1.
Application/ResourceFile02Core resource file #2.
Application/ResourceFile03Core resource file #3.
Application/ResourceFile04Core resource file #4.
Application/ResourceFile05Core resource file #5.
Application/ResourceFile06Core resource file #6.
Application/ResourceFile07Core resource file #7.
Application/ResourceFile08Core resource file #8.
Application/ResourceFile09Core resource file #9.
Application/ResourceFile10Core resource file #10.
Application/RscDirectoryFull path to the distribution's rsc directory. Read-only.
Application/ShortTermAsteroidEphemeridesFileFile name or path of the distribution's asteroid ephemerides file (XEPH format) - short-term version (reduced time span).
Application/ShortTermAsteroidEphemeridesFilePathFull path to the current distribution's asteroid ephemerides file (XEPH format) - short-term version (reduced time span). Read-only.
Application/ShortTermFundamentalEphemeridesFileFile name or path of the distribution's fundamental ephemerides file (XEPH format) - short-term version (reduced time span).
Application/ShortTermFundamentalEphemeridesFilePathFull path to the current distribution's fundamental ephemerides file (XEPH format) - short-term version (reduced time span). Read-only.
Application/ShortTermNutationModelFileFile name or path of the distribution's nutation model file (XEPH format) - short-term version (reduced time span).
Application/ShortTermNutationModelFilePathFull path to the current distribution's nutation model file (XEPH format) - short-term version (reduced time span). Read-only.
Application/SrcDirectoryFull path to the distribution's src directory. Read-only.
Application/StartTimeStarting time of the core application in ISO 8601 extended format. Read-only.
Application/StyleSheetFileMain core stile sheet file.
ColorManagement/DefaultGrayscaleProfilePathFull path to the default ICC color profile for grayscale monochrome images.
ColorManagement/DefaultRGBProfilePathFull path to the default ICC color profile for RGB color images.
ColorManagement/MonitorProfilePathFull path to the ICC color profile associated with the primary monitor. Read-only.
ColorManagement/ProofingProfilePathFull path to the ICC color profile for the color proofing target device.
ColorManagement/UpdateMonitorProfileFull path to the scheduled new ICC color profile for the primary monitor. Write-only. See the documentation for ColorManagementSetup.
FileFormat/ReadFiltersA list of file filters for file formats capable of image read operations, suitable for file dialogs. Read-only. Updated dynamically on-demand.
FileFormat/WriteFiltersA list of file filters for file formats capable of image write operations, suitable for file dialogs. Read-only. Updated dynamically on-demand.
ImageContainerIcon/PrefixPrefix for automatically generated image container identifiers.
ImageWindow/ClonePostfixPostfix appended to image duplicates
ImageWindow/DefaultFileExtensionThe default file suffix used to save newly created images.
ImageWindow/DownloadsDirectoryFull path to the core downloads directory.
ImageWindow/NewImageCaptionWindow title token for signaling newly created images.
ImageWindow/PrefixPrefix used for automatically generated image identifiers.
ImageWindow/ProxyURLThe proxy that will be used for core network operations.
MainWindow/WallpaperFile01Core workspace wallpaper file #1.
MainWindow/WallpaperFile02Core workspace wallpaper file #2.
MainWindow/WallpaperFile03Core workspace wallpaper file #3.
MainWindow/WallpaperFile04Core workspace wallpaper file #4.
MainWindow/WallpaperFile05Core workspace wallpaper file #5.
MainWindow/WallpaperFile06Core workspace wallpaper file #6.
MainWindow/WallpaperFile07Core workspace wallpaper file #7.
MainWindow/WallpaperFile08Core workspace wallpaper file #8.
MainWindow/WallpaperFile09Core workspace wallpaper file #9.
MainWindow/WallpaperFile10Core workspace wallpaper file #10.
Preview/PrefixPrefix used for automatically generated preview identifiers.
ProcessIcon/PrefixPrefix used for automatically generated process icon identifiers.
View/BrokenLinkTextText fragment used to signal broken image and/or process relations, such as missing masks.
ViewList/NoPreviewSelectedTextText fragment used when there are no previews selected.
ViewList/NoPreviewsAvailableTextText fragment used when there are no previews available.
ViewList/NoViewSelectedTextText fragment used when there are no views selected.
ViewList/NoViewsAvailableTextText fragment used when there are no views available.
Workspace/PrefixPrefix used for automatically generated workspace identifiers.

Definition at line 388 of file GlobalSettings.h.

Member Typedef Documentation

◆ variable_type

using pcl::PixInsightSettings::variable_type = GlobalVariableType::value_type

Represents the data type of a global variable.

Definition at line 395 of file GlobalSettings.h.

Constructor & Destructor Documentation

◆ PixInsightSettings() [1/2]

pcl::PixInsightSettings::PixInsightSettings ( )
delete

Default constructor. This constructor is disabled because PixInsightSettings is not an instantiable class.

◆ PixInsightSettings() [2/2]

pcl::PixInsightSettings::PixInsightSettings ( const PixInsightSettings &  )
delete

Copy constructor. This constructor is disabled because PixInsightSettings is not an instantiable class.

◆ ~PixInsightSettings()

virtual pcl::PixInsightSettings::~PixInsightSettings ( )
virtualdelete

Virtual destructor. This destructor is disabled because PixInsightSettings is not an instantiable class.

Member Function Documentation

◆ BeginUpdate()

static void pcl::PixInsightSettings::BeginUpdate ( )
static

Begins a global variable update operation.

See also
EndUpdate(), CalcelUpdate()

◆ CancelUpdate()

static void pcl::PixInsightSettings::CancelUpdate ( )
static

Aborts an ongoing global variable update operation.

Use this function if you catch an exception during the sequence of SetGlobalXXX() calls. After cancelling an update operation, you shouldn't call EndUpdate().

See also
BeginUpdate(), EndUpdate()

◆ EndUpdate()

static void pcl::PixInsightSettings::EndUpdate ( )
static

Terminates a global variable update operation.

See also
BeginUpdate(), CancelUpdate()

◆ GlobalColor()

static RGBA pcl::PixInsightSettings::GlobalColor ( const IsoString &  globalId)
static

Returns the value of a global RGBA color variable.

◆ GlobalFlag()

static bool pcl::PixInsightSettings::GlobalFlag ( const IsoString &  globalId)
static

Returns the value of a global boolean variable.

◆ GlobalFont()

static Font pcl::PixInsightSettings::GlobalFont ( const IsoString &  globalId)
static

Returns the value of a global font face variable.

◆ GlobalInteger()

static int pcl::PixInsightSettings::GlobalInteger ( const IsoString &  globalId)
static

Returns the value of a global signed integer variable.

◆ GlobalReal()

static double pcl::PixInsightSettings::GlobalReal ( const IsoString &  globalId)
static

Returns the value of a global floating point real variable.

◆ GlobalString()

static String pcl::PixInsightSettings::GlobalString ( const IsoString &  globalId)
static

Returns the value of a global string variable.

◆ GlobalUnsigned()

static unsigned pcl::PixInsightSettings::GlobalUnsigned ( const IsoString &  globalId)
static

Returns the value of a global unsigned integer variable.

◆ GlobalVariableType()

static variable_type pcl::PixInsightSettings::GlobalVariableType ( const IsoString &  globalId)
static

Retrieves the type of a global variable globalId.

◆ IsGlobalVariableDefined()

static bool pcl::PixInsightSettings::IsGlobalVariableDefined ( const IsoString &  globalId)
inlinestatic

Returns true iff the specified global variable globalId is defined in the current PixInsight platform.

Definition at line 430 of file GlobalSettings.h.

◆ operator=()

PixInsightSettings& pcl::PixInsightSettings::operator= ( const PixInsightSettings &  )
delete

Copy assignment. This operator is disabled because PixInsightSettings is not an instantiable class.

◆ SetGlobalColor()

static void pcl::PixInsightSettings::SetGlobalColor ( const IsoString &  globalId,
RGBA   
)
static

Sets the value of a global RGBA color variable.

◆ SetGlobalFlag()

static void pcl::PixInsightSettings::SetGlobalFlag ( const IsoString &  globalId,
bool   
)
static

Sets the value of a global boolean variable.

◆ SetGlobalFont()

static void pcl::PixInsightSettings::SetGlobalFont ( const IsoString &  globalId,
const Font &   
)
static

Sets the value of a global font face variable.

◆ SetGlobalInteger()

static void pcl::PixInsightSettings::SetGlobalInteger ( const IsoString &  globalId,
int   
)
static

Sets the value of a global signed integer variable.

◆ SetGlobalReal()

static void pcl::PixInsightSettings::SetGlobalReal ( const IsoString &  globalId,
double   
)
static

Sets the value of a global floating point real variable.

◆ SetGlobalString()

static void pcl::PixInsightSettings::SetGlobalString ( const IsoString &  globalId,
const String &   
)
static

Sets the value of a global string variable.

◆ SetGlobalUnsigned()

static void pcl::PixInsightSettings::SetGlobalUnsigned ( const IsoString &  globalId,
unsigned   
)
static

Sets the value of a global unsigned integer variable.

The documentation for this class was generated from the following file: