FLImaging 6.8.12.1
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 SetViewCount(int32_t i32ViewCount);
267
281 virtual const CResult Import(const wchar_t* pWcsFileNameWithPath);
282
296 virtual const CResult Export(const wchar_t* pWcsFileNameWithPath = nullptr) const;
297
298 DeclareGetClassType();
299
300 protected:
301 virtual const CResult InternalImport(const wchar_t* pWcsFileNameWithPath);
302
303 protected:
304 std::vector<CGUIFixedViewPlacement>& m_vctViewPlacements;
305 Base::CFLString<wchar_t> m_strName;
306 CGUIMenuItemFixedViewPlacementSet* m_pMenuItemViewSetBase;
307 bool m_bDefaultSet;
308
309 friend class CGUIDialogFixedViewPlacementSet;
310 };
311 }
312}
313
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:1596
A class that contains the position, ratio, and view type of fixed views that make up the FLImaging::G...
Definition GUIFixedViewPlacement.h:32
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.
virtual int64_t GetFixedViewPlacementCount() const
Gets the number of FixedViewPlacement added to this.
const CResult SetViewCount(int32_t i32ViewCount)
Updates the fixed views added to this object. If there is no fixed view or fixed view declaration obj...
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.
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.
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