FLImaging 6.9.12.2
GUIPropertyItemBase.h
1
8#pragma once
9
10#include "DefinitionsGUI.h"
11#include <functional>
12
14namespace FLImaging
15{
17 namespace GUI
18 {
19 class CInternalPermissionManager;
23
24 typedef std::function<void(CGUIPropertyItemBase*, Base::CFLString<wchar_t>&, const Base::CFLString<wchar_t>&)> CPropertyCallback;
25#define MakePropertyCallback [=](CGUIPropertyItemBase* pItem, Base::CFLString<wchar_t>& strValue, const Base::CFLString<wchar_t>& strOrig) -> void
26
27 typedef std::function<void(CGUIPropertyItemBase*, bool&, const bool&)> CPropertyAdditionalCheckBoxCallback;
28 #define MakePropertyAdditionalCheckBoxCallback [=](CGUIPropertyItemBase* pItem, bool& bCheckValue, const bool& bCheckValueOrig) -> void
29
37 class FL_EXPORT CGUIPropertyItemBase : public Base::CFLBase
38 {
39 public:
48
57
71 virtual bool SetPath(const Base::CFLString<wchar_t>& strPath);
72
85
99 virtual bool SetName(const Base::CFLString<wchar_t>& strName);
100
113
126
140 virtual bool Load(const Base::CFLString<wchar_t>& strFilePath = L"");
141
155 virtual bool Load(const Base::CFLArray<Base::CFLString<wchar_t>>& flaData);
156
170 virtual bool Save(const Base::CFLString<wchar_t>& strFilePath = L"") const;
171
187 virtual bool Save(Base::CFLArray<Base::CFLString<wchar_t>>& flaData) const;
188
198 virtual void SetReadOnly(bool bReadOnly);
199
209 virtual bool IsReadOnly() const;
210
218 virtual void Invalidate();
219
233 virtual bool SetValue(Base::CFLString<wchar_t> strValue, bool bInvokeCallback = true);
234
247
280
291
302
314 virtual bool SetOrigValue(const Base::CFLString<wchar_t>& strValue);
315
325 virtual void SetDefaultValue(const Base::CFLString<wchar_t>& strDefaultValue);
326
337
348 virtual void EnableAutoLoad(bool bAutoLoad = true);
349
359 virtual bool IsAutoLoadEnabled() const;
360
371 virtual void EnableAutoSave(bool bAutoSave = true);
372
382 virtual bool IsAutoSaveEnabled() const;
383
393 virtual void SetDescription(const Base::CFLString<wchar_t>& strDescription);
394
405
415 virtual CMFCPropertyGridProperty* GetGridProperty() const;
416
426 virtual CMFCPropertyGridProperty* CreateGridProperty() = 0;
427
437 virtual uint32_t GetHash() const;
438
448 virtual uint32_t GetParentHash() const;
449
465 virtual bool SetPropertyCallback(CPropertyCallback* pFunc, bool bAutoDestroy = true);
466
478 virtual CPropertyCallback* GetPropertyCallback() const;
479
491 virtual void SetGUIMenuItemProperty(CGUIMenuItemProperty* pMIP);
492
502 virtual CGUIMenuItemProperty* GetGUIMenuItemProperty() const;
503
515 virtual void SetVisible(BOOL bShow, BOOL bAdjustLayout = FALSE);
516
526 virtual bool IsVisible() const;
527
537 virtual bool GetVisibleValue() const;
538
551
561 virtual bool IsInitialized() const;
562
572 virtual void SetInitialized(bool bInit);
573
583 virtual int32_t GetSubItemsCount() const;
584
596 virtual CGUIPropertyItemBase* GetSubItem(int32_t i32Index) const;
597
607 virtual void Enable(bool bEnable);
608
618 virtual bool IsEnabled() const;
619
629 virtual bool IsEffectivelyEnabled() const;
630
640 virtual void EnableInheritanceOfEnablement(bool bEnable = true);
641
652
662 virtual void EnableInheritanceOfVisibility(bool bEnable = true);
663
674
684 virtual void EnableGrayWhileDisabled(bool bGray = true);
685
695 virtual bool IsGrayWhileDisabled() const;
696
712 virtual void SetMinimalAuthorityLevel(Base::EAuthorityLevel eAuthorityLevel, GUI::EPermission ePermission);
729
742
750 virtual void SetModifiedFlag();
751
771 virtual void AddCheckBox(ECheckBoxLocation eLocation = ECheckBoxLocation_LeftOfName, bool bAdditionalCheckBoxValue = false);
772
782 virtual bool IsCheckBoxAdded() const;
783
792
805
818
838 virtual bool SetPropertyAdditionalCheckBoxCallback(CPropertyAdditionalCheckBoxCallback* pFunc, bool bAutoDestroy = true);
839
849 virtual CPropertyAdditionalCheckBoxCallback* GetPropertyAdditionalCheckBoxCallback() const;
850
860 virtual void SetAdditionalCheckBoxValue(bool bCheck);
861
871 virtual bool GetAdditionalCheckBoxValue() const;
872
882 virtual bool Update();
883
893 virtual bool IsInsideCallback() const;
894
895 virtual void SetParentWndList(CMFCPropertyGridCtrl* pPGC);
896 DeclareGetClassType();
897
898 protected:
899 virtual void InvokeCallback(Base::CFLString<wchar_t>& strValue);
900 virtual void InternalSetValue(const COleVariant& varValue, bool bRedrawImmediate);
901 virtual void InternalSetOrigValue(const COleVariant& varValue);
902
903 virtual bool IsSNAPPropertyItem() const;
904 virtual Base::CFLString<wchar_t> GetSNAPFilePath() const;
905
906 virtual const CResult ConvertAbsolutePathToRelativePath(const Base::CFLString<wchar_t>& flsAbsolutePath, Base::CFLString<wchar_t>& flsResultRelativePath) const;
907 virtual const CResult ConvertRelativePathToAbsolutePath(const Base::CFLString<wchar_t>& flsRelativePath, Base::CFLString<wchar_t>& flsResultAbsolutePath) const;
908
909 protected:
910 Base::CFLString<wchar_t> m_strPath;
911 Base::CFLString<wchar_t> m_strName;
912
913 Base::CFLString<wchar_t> m_strDefaultValue;
914 Base::CFLString<wchar_t> m_strDescription;
915
916 Base::CFLString<wchar_t> m_strInitialValue;
917
918 Base::CFLString<wchar_t> m_strBufferValue;
919 Base::CFLString<wchar_t> m_strPrevBufferValue;
920
921 CMFCPropertyGridProperty* m_pGridProperty;
922 mutable CGUIPropertyGridCtrl* m_pParentPropertyGridCtrl;
923
924 CPropertyCallback* m_pPropertyCallback;
925 CPropertyAdditionalCheckBoxCallback* m_pPropertyAdditionalCheckBoxCallback;
926 bool m_bPropertyCallbackAutoDestroy;
927 bool m_bPropertyAdditionalCheckBoxCallbackAutoDestroy;
928
929 CGUIMenuItemProperty* m_pGUIMenuItemProperty;
930
931 CInternalPermissionManager* m_pInternalPM;
932
933 bool m_bInit;
934 BOOL m_bShow;
935 bool m_bEnable;
936 bool m_bAutoLoad;
937 bool m_bAutoSave;
938 bool m_bReadOnly;
939 bool m_bInCallback;
940
941 bool m_bInheritanceOfEnablement;
942 bool m_bInheritanceOfVisibility;
943 bool m_bEnableGrayWhileDisabled;
944
945 bool m_bCheckBoxAdded;
946 bool m_bAdditionalCheckBoxValue;
947 ECheckBoxLocation m_eAdditionalCheckBoxLocation;
948
949 EPropertyItemType m_ePropertyItemType;
950
951 friend class CGUIPaneProperties;
952 friend class CGUIMenuItemProperty;
953 friend class CInternalPermissionManager;
954 friend class CGUIPropertyGridPropertyInterface;
955 friend class CGUIPropertyGridPropertyBase;
956 friend class CGUIPropertyGridPropertyColor;
957 friend class CGUIPropertyGridPropertyDraggableSpin;
958 friend class CGUIDialogPropertyImageFigureDrawingAttribute;
959 friend class CGUIDialogProperty;
960 friend class CGUIDialogPropertyObjectFigure;
961 friend class CGUIDialogPropertyObjectFigureTransform;
962 friend class CGUIDialogPropertyView3DToolROI;
963 };
964 }
965}
Template type array class.
Definition FLArray.h:53
Top-level base class of FLImaging.
Definition FLBase.h:36
Template type string class.
Definition FLString.h:34
FLImaging module execution result object.
Definition ResultsDef.h:1605
The menu item class associated with the property pane.
Definition GUIMenuItemProperty.h:48
A class of property grid control.
Definition GUIPropertyGridCtrl.h:51
Property item base class.
Definition GUIPropertyItemBase.h:38
virtual FLImaging::GUI::CGUIPropertyGridCtrl * GetParentWndList() const
Returns a pointer to the grid control to which this item belongs.
virtual void Invalidate()
Invalidates the area corresponding to this on the screen, forcing a redraw.
virtual bool SetName(const Base::CFLString< wchar_t > &strName)
Sets the name of this.
virtual Base::EAuthorityLevel GetMinimalAuthorityLevel(GUI::EPermission ePermission) const
Returns the minimal permission level required to view, execute, or modify this property item.
virtual bool SetPath(const Base::CFLString< wchar_t > &strPath)
Sets the parent path of this. It should be set in the format like "Grandparent@Parent".
virtual uint32_t GetHash() const
Returns the hash value of this.
virtual ECheckBoxLocation GetAdditionalCheckBoxLocation() const
Gets the current location of the additional checkbox.
virtual bool IsEffectivelyEnabled() const
Checks whether the object is effectively enabled, taking into account the activation state of its par...
virtual void SetDescription(const Base::CFLString< wchar_t > &strDescription)
Sets the description of this.
virtual bool SetPropertyCallback(CPropertyCallback *pFunc, bool bAutoDestroy=true)
Sets a callback function for the property.
virtual void EnableInheritanceOfEnablement(bool bEnable=true)
Enables or disables inheritance of the enablement state for the object.
virtual Base::CFLString< wchar_t > GetValue() const
Returns the current value of this property item.
virtual void SetAdditionalCheckBoxValue(bool bCheck)
Sets the checked state of the additional checkbox.
virtual bool Save(const Base::CFLString< wchar_t > &strFilePath=L"") const
Saves the value of this to an ini file.
virtual void EnableAutoSave(bool bAutoSave=true)
Enables or disables the auto-save feature for this. Auto-save is a feature that automatically saves t...
virtual CPropertyAdditionalCheckBoxCallback * GetPropertyAdditionalCheckBoxCallback() const
Gets the currently assigned callback for the additional checkbox.
virtual Base::CFLString< wchar_t > GetName() const
Returns the name of this.
virtual bool GetAdditionalCheckBoxValue() const
Gets the checked state of the additional checkbox.
virtual CMFCPropertyGridProperty * CreateGridProperty()=0
Creates and returns a new grid property associated with this.
virtual bool IsAutoLoadEnabled() const
Checks if auto-Load is enabled for this.
CGUIPropertyItemBase()
Default constructor.
virtual void SetMinimalAuthorityLevel(Base::EAuthorityLevel eAuthorityLevel, GUI::EPermission ePermission)
Sets the minimal permission level required to view, execute, or modify this.
virtual CPropertyCallback * GetPropertyCallback() const
Retrieves the callback function associated with the property.
virtual bool GetVisibleValue() const
Returns the value (m_bShow) set by SetVisible(). Even if SetVisible(true) is set, the item may be hid...
virtual bool Load(const Base::CFLString< wchar_t > &strFilePath=L"")
Loads the value of this from an ini file.
virtual void SetDefaultValue(const Base::CFLString< wchar_t > &strDefaultValue)
Sets the default value of this.
virtual Base::CFLString< wchar_t > GetBufferValue() const
Returns the current buffer value of this.
virtual bool IsGrayWhileDisabled() const
Returns whether a disabled property item is displayed in grayscale. If true, the disabled property it...
virtual bool SetValue(Base::CFLString< wchar_t > strValue, bool bInvokeCallback=true)
Sets the value for this.
virtual int32_t GetSubItemsCount() const
Gets the count of sub-items contained within the object.
virtual Base::CFLString< wchar_t > GetDefaultValue() const
Returns the default value of this.
virtual bool SetBufferValue(Base::CFLString< wchar_t > strValue)
Sets the buffer value of this.
virtual void AddCheckBox(ECheckBoxLocation eLocation=ECheckBoxLocation_LeftOfName, bool bAdditionalCheckBoxValue=false)
Adds an additional checkbox to the property item. This checkbox is an auxiliary control displayed alo...
virtual bool IsInheritanceOfEnablementEnabled() const
Checks if inheritance of the enablement state is enabled.
virtual CMFCPropertyGridProperty * GetGridProperty() const
Returns a pointer to the grid property associated with this.
virtual bool IsInheritanceOfVisibilityEnabled() const
Checks if inheritance of the visibility state is enabled.
virtual Base::CFLString< wchar_t > GetPrevBufferValue() const
Returns the previous buffer value of this.
virtual bool IsCheckBoxAdded() const
Checks whether an additional checkbox has been added to this property item.
virtual void RemoveAdditionalCheckBoxAdded()
Removes the additional checkbox from the property item if it exists.
virtual bool SetPropertyAdditionalCheckBoxCallback(CPropertyAdditionalCheckBoxCallback *pFunc, bool bAutoDestroy=true)
Sets a callback function for the additional checkbox interaction.
virtual ~CGUIPropertyItemBase()
Destructor for CGUIPropertyItemBase class.
virtual void EnableInheritanceOfVisibility(bool bEnable=true)
Enables or disables inheritance of the visibility state for the object.
virtual void SetVisible(BOOL bShow, BOOL bAdjustLayout=FALSE)
Displays or hides this in the PropertyGridCtrl. If bAdjustLayout is FALSE, you must explicitly call G...
virtual void EnableAutoLoad(bool bAutoLoad=true)
Enables or disables the auto-load feature for this. Auto-load is a feature that loads and sets values...
virtual bool Load(const Base::CFLArray< Base::CFLString< wchar_t > > &flaData)
Loads the value of this from a string array.
virtual bool SetOrigValue(const Base::CFLString< wchar_t > &strValue)
Sets the original value of this.
virtual bool IsInitialized() const
Checks if the object is initialized.
virtual void SetGUIMenuItemProperty(CGUIMenuItemProperty *pMIP)
Sets the GUI menu item property associated with the object.
virtual CGUIPropertyItemBase * GetSubItem(int32_t i32Index) const
Retrieves a specific sub-item by its index.
virtual bool Update()
Updates internal state or UI and returns the success status.
virtual Base::CFLString< wchar_t > GetFullPath() const
Returns the full path of this as a string, formatted like "Grandparent@Parent@MyName".
virtual void SetInitialized(bool bInit)
Sets the initialization state of the object.
virtual bool IsReadOnly() const
Returns whether this is set as read-only. If true, this is read-only; if false, it is editable.
virtual bool IsVisible() const
Returns the visibility state of this. Even if SetVisible(true) is called, the item may be hidden base...
virtual bool IsInsideCallback() const
Returns whether the current context is inside a property callback procedure.
virtual bool IsEnabled() const
Checks if the object is enabled.
virtual uint32_t GetParentHash() const
Returns the hash value of the parent of this.
virtual void EnableGrayWhileDisabled(bool bGray=true)
Sets whether a disabled property item is displayed in grayscale. If true, the disabled property item ...
virtual void SetModifiedFlag()
Marks the property item as modified.
virtual bool Save(Base::CFLArray< Base::CFLString< wchar_t > > &flaData) const
Function to record the value of this in INI data array.
virtual void SetReadOnly(bool bReadOnly)
Sets whether this is read-only. If set to true, the item becomes non-editable; if false,...
virtual void Enable(bool bEnable)
Enables or disables the object.
virtual CGUIMenuItemProperty * GetGUIMenuItemProperty() const
Retrieves the GUI menu item property associated with the object.
virtual EPropertyItemType GetItemType() const
Returns the type of the property item.
virtual void SetAdditionalCheckBoxLocation(ECheckBoxLocation eLocation=ECheckBoxLocation_LeftOfName)
Sets the location of the additional checkbox.
virtual Base::CFLString< wchar_t > GetDescription() const
Returns the description of this.
virtual bool IsAutoSaveEnabled() const
Checks if auto-save is enabled for this.
virtual Base::CFLString< wchar_t > GetPath() const
Returns the parent path of this.
EAuthorityLevel
Authority level.
Definition AuthorityManager.h:29
Definition D2DObject.h:12
ECheckBoxLocation
CheckBox Location.
Definition DefinitionsGUI.h:10337
@ ECheckBoxLocation_LeftOfName
Left of name.
Definition DefinitionsGUI.h:10344
EPermission
Permission.
Definition DefinitionsGUI.h:9831
EPropertyItemType
Definition DefinitionsGUI.h:10853