FLImaging 6.11.25.2
GUIFixedViewPlacementSet.h
1#pragma once
2
10
11#include "GUIFixedViewPlacement.h"
12
14namespace FLImaging
15{
17 namespace GUI
18 {
19 class CGUIMenuItemFixedViewPlacementSet;
20 class CGUIDialogFixedViewPlacementSet;
21
30 {
31 public:
39
49 CGUIFixedViewPlacementSet(bool bDefaultSet);
50
61
71
79
93 virtual const CResult Assign(const CGUIFixedViewPlacementSet& rhs);
94
108 virtual const CResult Assign(const CGUIFixedViewPlacementSet* pRhs);
109
122
135 virtual void SetName(const Base::CFLString<wchar_t>& strName, bool bUpdateMenuItem = false);
136
148
159 virtual int64_t GetIndex() const;
160
167 virtual void Clear();
168
180
191 virtual int64_t GetFixedViewPlacementCount() const;
192
205 virtual CGUIFixedViewPlacement* GetFixedViewPlacement(int32_t i32Index) const;
206
217 virtual void SetMenuItem(CGUIMenuItemFixedViewPlacementSet* pMenuItem);
218
229 virtual CGUIMenuItemFixedViewPlacementSet* GetMenuItem() const;
230
240 virtual void SetDefault(bool bSet);
241
251 virtual bool IsDefault() const;
252
266 const CResult ApplyViewLayout(int32_t i32FvpCount);
267
281 virtual const CResult Import(const wchar_t* pWcsFileNameWithPath);
282
296 virtual const CResult Export(const wchar_t* pWcsFileNameWithPath = nullptr) const;
297
324
335
349
350 DeclareGetClassType();
351
352 protected:
353 virtual const CResult Import(const wchar_t* pWcsFileNameWithPath, bool bCreateFvd, bool bRemoveFvd);
354 virtual const CResult InternalImport(const wchar_t* pWcsFileNameWithPath, bool bCreateFvd, bool bRemoveFvd);
355 const CResult ApplyViewLayout(int32_t i32FvpCount, bool bCreateFvd, bool bRemoveFvd);
356 const CResult InternalApplyViewLayoutRecreateMismatched(int32_t i32FvpCount, bool bCreateFvd, bool bRemoveFvd);
357 const CResult InternalApplyViewLayoutReindexBestEffort(int32_t i32FvpCount, bool bCreateFvd, bool bRemoveFvd);
358 const CResult InternalApplyViewLayoutRecreateAll(int32_t i32FvpCount, bool bCreateFvd, bool bRemoveFvd);
359 const CResult InternalApplyViewLayoutNoOp(int32_t i32FvpCount, bool bCreateFvd, bool bRemoveFvd);
360
361 protected:
362 std::vector<CGUIFixedViewPlacement>& m_vctViewPlacements;
363 Base::CFLString<wchar_t> m_strName;
364 CGUIMenuItemFixedViewPlacementSet* m_pMenuItemViewSetBase;
365 bool m_bDefaultSet;
366 EFixedViewPlacementSetSyncNumberPolicy m_eSyncNumberPolicy;
367
368 friend class CGUIDialogFixedViewPlacementSet;
369 friend class CGUIManager;
370 };
371 }
372}
373
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:1631
A class that contains the position, ratio, and view type of fixed views that make up the FLImaging::G...
Definition GUIFixedViewPlacement.h:33
virtual int64_t GetIndex() const
A function that retrieves the index of this object. Returns a valid value only if it is registered in...
virtual const CResult Import(const wchar_t *pWcsFileNameWithPath)
Reads the INI file and sets the attribute values of this.
virtual const CResult Assign(const CGUIFixedViewPlacementSet &rhs)
Copy another object into the current one.
virtual void Clear()
Clear this object's variables.
virtual void AddFixedViewPlacement(CGUIFixedViewPlacement fvp)
Add a FixedViewPlacement to this.
const CResult ApplyViewLayout(int32_t i32FvpCount)
Updates the fixed views added to this object. If there is no fixed view or fixed view declaration obj...
virtual int64_t GetFixedViewPlacementCount() const
Gets the number of FixedViewPlacement added to this.
const CGUIFixedViewPlacementSet & operator=(const CGUIFixedViewPlacementSet &rh)
assignment operator
virtual void SetName(const Base::CFLString< wchar_t > &strName, bool bUpdateMenuItem=false)
Set the name.
virtual Base::CFLString< wchar_t > GetName() const
Get the name of this.
CGUIFixedViewPlacementSet()
Default constructor.
const CResult SetSyncNumberPolicy(EFixedViewPlacementSetSyncNumberPolicy ePolicy=EFixedViewPlacementSetSyncNumberPolicy_NoOp)
Synchronizes each view's serial number with its preset index in the fixed view placement set.
EFixedViewPlacementSetSyncNumberPolicy GetSyncNumberPolicy() const
Returns the current synchronization policy applied when matching view serial numbers with preset indi...
virtual const CResult Assign(const CGUIFixedViewPlacementSet *pRhs)
Copy another object into the current one.
virtual bool IsDefault() const
Retrieves whether this object is the default fixed view set. If it is the default fixed view set,...
virtual CGUIMenuItemFixedViewPlacementSet * GetMenuItem() const
Gets the menu item of this object.
bool IsSyncNumberEnabled() const
Returns whether view serial number synchronization with preset index is enabled.
virtual void SetDefault(bool bSet)
Sets or unsets this object as the default fixed view set. When set as the default fixed view set,...
CGUIFixedViewPlacementSet(const CGUIFixedViewPlacementSet *pRh)
Copy constructor.
virtual CGUIFixedViewPlacement * GetFixedViewPlacement(int32_t i32Index) const
Gets the pointer of FixedViewPlacement added to this by the index.
virtual ~CGUIFixedViewPlacementSet()
Default destructor.
CGUIFixedViewPlacementSet(bool bDefaultSet)
Constructor.
virtual const CResult Export(const wchar_t *pWcsFileNameWithPath=nullptr) const
Saves the attributes of this to an INI file.
virtual void SetMenuItem(CGUIMenuItemFixedViewPlacementSet *pMenuItem)
Sets the menu item of this object.
CGUIFixedViewPlacementSet(const CGUIFixedViewPlacementSet &rh)
Copy constructor by reference.
Definition D2DObject.h:12
EFixedViewPlacementSetSyncNumberPolicy
Defines synchronization behaviors for matching view serial numbers with preset indices in a fixed vie...
Definition DefinitionsGUIFixedView.h:30
@ EFixedViewPlacementSetSyncNumberPolicy_NoOp
Do nothing even if differences exist between view serials and preset indices.
Definition DefinitionsGUIFixedView.h:37