FLImaging 7.1.2.3
GUIStringUtilities.h
1#pragma once
2#include "DefinitionsGUI.h"
3
11
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
246 static Base::CFLString<wchar_t> ConvertEnumWarpingTypeToString(Foundation::EWarpingType eWarpingType, bool bIncludeEnumName = false, ECodeType eCodeType = ECodeType_Cpp);
247
275 static Base::CFLString<wchar_t> ConvertEnumValueTypeToString(Base::EValueType eValueType, bool bIncludeEnumName = false, ECodeType eCodeType = ECodeType_Cpp);
276
305 static Base::CFLString<wchar_t> ConvertEnumViewGraphAxisToString(EViewGraphAxis eAxis, bool bIncludeEnumName = false, ECodeType eCodeType = ECodeType_Cpp);
306
336
353
377
394
418
435
457
474
496
513
536 static const Base::CFLString<wchar_t> ConvertEnumLengthUnitToString(Foundation::ELengthUnit eLengthUnit, bool bIncludeEnumName = false, ECodeType eCodeType = ECodeType_Cpp);
537
554
570 static void ConvertFloatToStringWithPrecision(float f32Val, uint8_t u8Precision, Base::CFLString<wchar_t>& strOut);
571
587 static void ConvertDoubleToStringWithPrecision(double f64Val, uint8_t u8Precision, Base::CFLString<wchar_t>& strOut);
588
608 static Base::CFLString<wchar_t> ConvertEnumPixelFormatToString(const Base::EPixelFormat& ePF, bool bIncludeEnumName = false, ECodeType eCodeType = ECodeType_Cpp);
609
629 static bool ConvertEnumColorSequenceToString(const Base::EColorSequence& eCS, const int32_t& i32Channels, Base::CFLString<wchar_t>& str);
630
649
665 static bool ConvertColorToStringHex(COLORREF clr, Base::CFLString<wchar_t>& str);
666
678 static bool ConvertStringToColor(const Base::CFLString<wchar_t>& str, const Base::CFLString<wchar_t>& strFormatString, COLORREF& clr);
679
695 static bool ConvertStringHexToColor(const Base::CFLString<wchar_t>& str, COLORREF& clr);
696
716 static bool ConvertStringHexToColor(const Base::CFLString<wchar_t>& str, uint8_t& u8R, uint8_t& u8G, uint8_t& u8B);
717
733 static bool ConvertColorToStringRGB(COLORREF clr, Base::CFLString<wchar_t>& str);
734
750 static bool ConvertStringRGBToColor(const Base::CFLString<wchar_t>& str, COLORREF& clr);
751
771 static bool ConvertStringRGBToColor(const Base::CFLString<wchar_t>& str, uint8_t& u8R, uint8_t& u8G, uint8_t& u8B);
772
788 static void TokenizeRange(const Base::CFLString<wchar_t>& strPageRange, Base::CFLArray<int32_t>& flaPages);
789
804
823
842
858 static int64_t ExtractClassNumberFromFigureName(const Base::CFLString<wchar_t>& strFigureName);
859
874
891
911 static Base::CFLString<wchar_t> ConvertEnumCenterTypeToString(Foundation::ECenterType eCenterType, bool bIncludeEnumName = false, ECodeType eCodeType = ECodeType_Cpp);
912
937 static int32_t GetViewSerialNumber(const Base::CFLString<wchar_t>& strViewTitle);
938
964
984 static bool IsSplitter(TCHAR ch);
985
1013 static Base::CFLString<wchar_t> GenerateViewTitle(EViewType eViewType, int32_t i32Index);
1014
1015 static const CResult GetFontFromIniString(const Base::CFLString<wchar_t>& str, LOGFONT& lf);
1016
1017 };
1018 }
1019}
Template type array class.
Definition FLArray.h:53
ESubband
Subband types in image transformation.
Definition FLImageExtraDataWT.h:39
Template type string class.
Definition FLString.h:34
FLImaging module execution result object.
Definition ResultsDef.h:1640
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 Base::CFLString< wchar_t > ConvertEnumViewGraphAxisToString(EViewGraphAxis eAxis, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts a EViewGraphAxis enum to a string.
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 Base::CFLString< wchar_t > ConvertEnumImageExtraDataWTSubbandToString(FLImaging::Base::CFLImageExtraDataWT::ESubband eImageExtraDataWTSubband, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts an EImageExtraDataWTSubband enum to a string.
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, ECodeType eCodeType=ECodeType_Cpp)
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, ECodeType eCodeType=ECodeType_Cpp)
Function that converts an EArcClosingMethod enum to a string.
static Base::CFLString< wchar_t > ConvertEnumEulerSequenceToString(Foundation::EEulerSequence eES, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts a EEulerSequence 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.
static Base::CFLString< wchar_t > GenerateViewTitle(EViewType eViewType, int32_t i32Index)
Generates a formatted view title string based on the specified view type and index.
CGUIStringUtilities()
Default constructor.
static Base::CFLString< wchar_t > ConvertEnumWarpingTypeToString(Foundation::EWarpingType eWarpingType, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts an EWarpingType enum to a string.
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 Base::CFLString< wchar_t > ConvertEnumValueTypeToString(Base::EValueType eValueType, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts a EValueType enum to a string.
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 Base::CFLString< wchar_t > GetViewTitleWithoutSerialNumber(const Base::CFLString< wchar_t > &strViewTitle)
Extracts the view title string excluding the serial number prefix.
static bool IsSplitter(TCHAR ch)
Checks whether a given character is considered a word splitter.
static Foundation::ECenterType ConvertStringToEnumCenterType(const Base::CFLString< wchar_t > &strCenterType)
Function that converts a string into an ECenterType enum and returns it.
static int32_t ExtractBracketedIndex(const Base::CFLString< wchar_t > &str)
Extracts the first integer value found inside square brackets (e.g., "[123]") from the given string.
static int32_t GetViewSerialNumber(const Base::CFLString< wchar_t > &strViewTitle)
Extracts the serial number from a given view title string.
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 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...
static Base::CFLString< wchar_t > ConvertEnumPixelFormatToString(const Base::EPixelFormat &ePF, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
This function retrieves a string representing the pixel format.
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 > ConvertEnumFigureDeclTypeToString(FLImaging::Foundation::EFigureDeclType eFigureDeclType, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts an EFigureDeclType enum to a string.
static const Base::CFLString< wchar_t > ConvertEnumLengthUnitToString(Foundation::ELengthUnit eLengthUnit, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts an Foundation::ELengthUnit enum to a string. For example, ELengthUnit_Left is ...
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 > ConvertEnumCenterTypeToString(Foundation::ECenterType eCenterType, bool bIncludeEnumName=false, ECodeType eCodeType=ECodeType_Cpp)
Function that converts an ECenterType enum to a string.
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 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
EValueType
Value type.
Definition DefinitionsBase.h:50
EXYZSequence
XYZ sequence.
Definition DefinitionsBase.h:2996
EColorSequence
Color sequence.
Definition DefinitionsBase.h:2908
EWarpingType
Definition DefinitionsFigure.h:2803
EFigureDeclType
Declare type of figure.
Definition DefinitionsFigure.h:33
EFigureTemplateType
Template type of figure.
Definition DefinitionsFigure.h:357
EEulerSequence
The order of rotations.
Definition DefinitionsMathematics.h:240
EArcClosingMethod
Arc closing method.
Definition DefinitionsFigure.h:2546
ELengthUnit
Indicates a unit of length.
Definition DefinitionsFoundation.h:77
ECenterType
Center type.
Definition DefinitionsFigure.h:2720
Definition D2DObject.h:12
ECodeType
Code type.
Definition DefinitionsGUI.h:9054
@ ECodeType_Cpp
C++.
Definition DefinitionsGUI.h:9069
EViewGraphAxis
Specifies the axis type used in the graph view.
Definition DefinitionsGUIViewGraph.h:73
EDockPosition
Dock position.
Definition DefinitionsGUI.h:9949
EViewType
View Type.
Definition DefinitionsGUI.h:45