FLImaging 6.5.8.1
GUIStringUtilities.h
1#pragma once
2#include "GUIDefinitions.h"
3
13namespace FLImaging
14{
16 namespace GUI
17 {
25 class FL_EXPORT CGUIStringUtilities
26 {
27 public:
35
43
44 static CGUIStringUtilities* GetObject();
45
61
78
94 static EFileExtension ConvertStringToEnumFileExtension(const Base::CFLString<wchar_t>& strExtension);
95
111 static const Base::CFLString<wchar_t> ConvertEnumFileExtensionToStringDefExt(EFileExtension eFileExtension);
112
128 static const Base::CFLString<wchar_t> ConvertEnumFileExtensionToStringFilter(EFileExtension eFileExtension);
129
154 static const CResult ConvertEnumFileExtensionToStringDefExtAndFilter(EFileExtension eFileExtension, bool bIncludeAllSupportingFilesFilter, bool bIncludeAllFilesFilter, Base::CFLString<wchar_t>& strFilter, Base::CFLString<wchar_t>& strDefExt);
155
172
189
206
223
244 static Base::CFLString<wchar_t> ConvertEnumWarpingTypeToString(Foundation::EWarpingType eWarpingType, bool bIncludeEnumName = false, bool bCSharpType = false);
245
262
283 static Base::CFLString<wchar_t> ConvertEnumFigureDeclTypeToString(FLImaging::Foundation::EFigureDeclType eFigureDeclType, bool bIncludeEnumName = false, bool bCSharpType = false);
284
301
322 static Base::CFLString<wchar_t> ConvertEnumFigureTemplateTypeToString(FLImaging::Foundation::EFigureTemplateType eTemplate, bool bIncludeEnumName = false, bool bCSharpType = false);
323
340
361 static Base::CFLString<wchar_t> ConvertEnumArcClosingMethodToString(FLImaging::Foundation::EArcClosingMethod eArcClosingMethod, bool bIncludeEnumName = false, bool bCSharpType = false);
362
379
400 static Base::CFLString<wchar_t> ConvertEnumImageExtraDataWTSubbandToString(FLImaging::Base::CFLImageExtraDataWT::ESubband eImageExtraDataWTSubband, bool bIncludeEnumName = false, bool bCSharpType = false);
401
418
441 static const Base::CFLString<wchar_t> ConvertEnumLengthUnitToString(Foundation::ELengthUnit eLengthUnit, bool bIncludeEnumName = false, bool bCSharpType = false);
442
459
475 static void ConvertFloatToStringWithPrecision(float f32Val, uint8_t u8Precision, Base::CFLString<wchar_t>& strOut);
476
492 static void ConvertDoubleToStringWithPrecision(double f64Val, uint8_t u8Precision, Base::CFLString<wchar_t>& strOut);
493
512
532 static bool ConvertEnumColorSequenceToString(const Base::EColorSequence& eCS, const int32_t& i32Channels, Base::CFLString<wchar_t>& str);
533
552
568 static bool ConvertColorToStringHex(COLORREF clr, Base::CFLString<wchar_t>& str);
569
581 static bool ConvertStringToColor(const Base::CFLString<wchar_t>& str, const Base::CFLString<wchar_t>& strFormatString, COLORREF& clr);
582
598 static bool ConvertStringHexToColor(const Base::CFLString<wchar_t>& str, COLORREF& clr);
599
619 static bool ConvertStringHexToColor(const Base::CFLString<wchar_t>& str, uint8_t& u8R, uint8_t& u8G, uint8_t& u8B);
620
636 static bool ConvertColorToStringRGB(COLORREF clr, Base::CFLString<wchar_t>& str);
637
653 static bool ConvertStringRGBToColor(const Base::CFLString<wchar_t>& str, COLORREF& clr);
654
674 static bool ConvertStringRGBToColor(const Base::CFLString<wchar_t>& str, uint8_t& u8R, uint8_t& u8G, uint8_t& u8B);
675
691 static void TokenizeRange(const Base::CFLString<wchar_t>& strPageRange, Base::CFLArray<int32_t>& flaPages);
692
707
726
745
761 static int64_t ExtractClassNumberFromFigureName(const Base::CFLString<wchar_t>& strFigureName);
762 };
763 }
764}
Template type array class.
Definition RangeTree.h:19
ESubband
Subband types in image transformation.
Definition FLImageExtraDataWT.h:39
Template type string class.
Definition INIUtilities.h:20
FLImaging module execution result object.
Definition ResultsDef.h:1514
String utility class for various string operations.
Definition GUIStringUtilities.h:26
static const Base::CFLString< wchar_t > ConvertEnumDockPositionToString(EDockPosition eDockPosition)
Function that converts an EDockPosition enum to a string. For example, EDockPosition_Left is converte...
static Base::CFLString< wchar_t > RemoveMenuItemRootPath(const Base::CFLString< wchar_t > &strFullPath, const Base::CFLString< wchar_t > &strRoot)
Removes the root path from the beginning of the given path if it exists. Returns the given path as is...
static const Base::CFLString< wchar_t > ConvertEnumLengthUnitToString(Foundation::ELengthUnit eLengthUnit, bool bIncludeEnumName=false, bool bCSharpType=false)
Function that converts an Foundation::ELengthUnit enum to a string. For example, ELengthUnit_Left is ...
static Foundation::EFigureTemplateType ConvertStringToEnumFigureTemplateType(const Base::CFLString< wchar_t > &strFigureTemplateType)
Function that converts a string to an enum EFigureTemplateType . For example, "Perspective" is conver...
static Foundation::EArcClosingMethod ConvertStringToEnumArcClosingMethod(const Base::CFLString< wchar_t > &strArcClosingMethod)
Function that converts a string to an enum EArcClosingMethod . For example, "EachOther" is converted ...
static Base::CFLString< wchar_t > ConvertEnumFigureTemplateTypeToString(FLImaging::Foundation::EFigureTemplateType eTemplate, bool bIncludeEnumName=false, bool bCSharpType=false)
Function that converts an EFigureTemplateType enum to a string.
static void TokenizeRange(const Base::CFLString< wchar_t > &strPageRange, Base::CFLArray< int32_t > &flaPages)
Extracts and returns the range from an input string formatted like "2-32" or "1,3,...
static Base::CFLString< wchar_t > ConvertEnumArcClosingMethodToString(FLImaging::Foundation::EArcClosingMethod eArcClosingMethod, bool bIncludeEnumName=false, bool bCSharpType=false)
Function that converts an EArcClosingMethod enum to a string.
static Base::CFLString< wchar_t > ConvertEnumFigureDeclTypeToString(FLImaging::Foundation::EFigureDeclType eFigureDeclType, bool bIncludeEnumName=false, bool bCSharpType=false)
Function that converts an EFigureDeclType enum to a string.
static Base::CFLString< wchar_t > GetFileName(const Base::CFLString< wchar_t > &strFilePath)
This function extracts the filename from a file path. For example, given the path "C:/Users/fl....
static bool ConvertColorToStringHex(COLORREF clr, Base::CFLString< wchar_t > &str)
Converts a color to a hexadecimal string in the format "rrggbb". For example, the color CYAN will ret...
static const Base::CFLString< wchar_t > ConvertEnumViewTypeToString(EViewType eViewType)
Function that converts an EViewType enum to a string. For example, EViewType_Image is converted to "I...
static bool ConvertEnumColorSequenceToString(const Base::EColorSequence &eCS, const int32_t &i32Channels, Base::CFLString< wchar_t > &str)
This function retrieves a string representing the color sequence and the number of channels.
CGUIStringUtilities()
Default constructor.
static Foundation::EFigureDeclType ConvertStringToEnumFigureDeclType(const Base::CFLString< wchar_t > &strFigureDeclType)
Function that converts a string to an enum EFigureDeclType . For example, "Perspective" is converted ...
static void ConvertFloatToStringWithPrecision(float f32Val, uint8_t u8Precision, Base::CFLString< wchar_t > &strOut)
This function converts a floating-point value to a string with specified precision.
static Foundation::ELengthUnit ConvertStringToEnumLengthUnit(const Base::CFLString< wchar_t > &strLengthUnit)
Function that converts a string to an enum Foundation::ELengthUnit . For example, "Left" is converted...
static const CResult ConvertEnumFileExtensionToStringDefExtAndFilter(EFileExtension eFileExtension, bool bIncludeAllSupportingFilesFilter, bool bIncludeAllFilesFilter, Base::CFLString< wchar_t > &strFilter, Base::CFLString< wchar_t > &strDefExt)
Function that converts an EFileExtension enum to both the default file name extension and the extensi...
static EViewType ConvertStringToEnumViewType(const Base::CFLString< wchar_t > &strViewType)
Function that converts a string to an enum EViewType . For example, "Image View" is converted to EVie...
static Base::CFLString< wchar_t > ConvertEnumWarpingTypeToString(Foundation::EWarpingType eWarpingType, bool bIncludeEnumName=false, bool bCSharpType=false)
Function that converts an EWarpingType enum to a string.
static int64_t ExtractClassNumberFromFigureName(const Base::CFLString< wchar_t > &strFigureName)
Extracts the leading number from the given string (Figure Name), up to the first non-digit character....
static bool ConvertStringHexToColor(const Base::CFLString< wchar_t > &str, COLORREF &clr)
Converts a hexadecimal string in the format "rrggbb" to a COLORREF value.
static bool ConvertColorToStringRGB(COLORREF clr, Base::CFLString< wchar_t > &str)
Converts a color to a string in the format "r,g,b". For example, the color CYAN will return "0,...
static Base::CFLString< wchar_t > EnsureMenuItemRootPath(const Base::CFLString< wchar_t > &strFullPath, const Base::CFLString< wchar_t > &strRoot)
Returns a string with the root path prefixed to the given path. If the input is an empty string or al...
virtual ~CGUIStringUtilities()
Default destructor.
static Base::CFLImageExtraDataWT::ESubband ConvertStringToEnumImageExtraDataWTSubband(const Base::CFLString< wchar_t > &strImageExtraDataWTSubband)
Function that converts a string to an enum EImageExtraDataWTSubband . For example,...
static EFileExtension ConvertStringToEnumFileExtension(const Base::CFLString< wchar_t > &strExtension)
Function that converts a file extension string into an EFileExtension enum and returns it.
static Base::CFLString< wchar_t > ConvertEnumImageExtraDataWTSubbandToString(FLImaging::Base::CFLImageExtraDataWT::ESubband eImageExtraDataWTSubband, bool bIncludeEnumName=false, bool bCSharpType=false)
Function that converts an EImageExtraDataWTSubband enum to a string.
static EDockPosition ConvertStringToEnumDockPosition(const Base::CFLString< wchar_t > &strDockPosition)
Function that converts a string to an enum EDockPosition . For example, "Left" is converted to EDockP...
static Base::CFLString< wchar_t > TrimRightPeriod(const Base::CFLString< wchar_t > &str)
Removes the trailing period (".") from a string if it ends with a period, such as in "ABC....
static Foundation::EWarpingType ConvertStringToEnumWarpingType(const Base::CFLString< wchar_t > &strWarpingType)
Function that converts a string to an enum EWarpingType . For example, "Perspective" is converted to ...
static Base::CFLString< wchar_t > GetFileExtension(const Base::CFLString< wchar_t > &strFilePath)
This function extracts the file extension from a file path. For example, given the path "C:/Users/fl....
static bool ConvertStringRGBToColor(const Base::CFLString< wchar_t > &str, uint8_t &u8R, uint8_t &u8G, uint8_t &u8B)
Converts a string in the format "r,g,b" to individual r, g, b values as uint8_t.
static const Base::CFLString< wchar_t > ConvertEnumFileExtensionToStringDefExt(EFileExtension eFileExtension)
Function that converts an EFileExtension enum to the default file name extension format for a file di...
static bool ConvertStringHexToColor(const Base::CFLString< wchar_t > &str, uint8_t &u8R, uint8_t &u8G, uint8_t &u8B)
Converts a hexadecimal string in the format "rrggbb" to individual r, g, b values as uint8_t.
static bool ConvertStringRGBToColor(const Base::CFLString< wchar_t > &str, COLORREF &clr)
Converts a string in the format "r,g,b" to a COLORREF value.
static void ConvertDoubleToStringWithPrecision(double f64Val, uint8_t u8Precision, Base::CFLString< wchar_t > &strOut)
This function converts a floating-point value to a string with specified precision.
static bool ConvertEnumXYZSequenceToString(const Base::EXYZSequence &eSequence, Base::CFLString< wchar_t > &str)
This function retrieves a string representing the XYZ sequence.
static bool ConvertEnumPixelFormatToString(const Base::EPixelFormat &ePF, Base::CFLString< wchar_t > &str)
This function retrieves a string representing the pixel format.
static const Base::CFLString< wchar_t > ConvertEnumFileExtensionToStringFilter(EFileExtension eFileExtension)
Function that converts an EFileExtension enum to the extension filter format for a file dialog....
EPixelFormat
Pixel format.
Definition DefinitionsBase.h:88
EXYZSequence
XYZ sequence.
Definition DefinitionsBase.h:2846
EColorSequence
Color sequence.
Definition DefinitionsBase.h:2788
EWarpingType
Definition DefinitionsFigure.h:2748
EFigureDeclType
Declare type of figure.
Definition DefinitionsFigure.h:33
EFigureTemplateType
Template type of figure.
Definition DefinitionsFigure.h:302
EArcClosingMethod
Arc closing method.
Definition DefinitionsFigure.h:2491
ELengthUnit
Indicates a unit of length.
Definition DefinitionsFoundation.h:77
EDockPosition
Dock position.
Definition GUIDefinitions.h:9487
EViewType
View Type.
Definition GUIDefinitions.h:45