FLImaging 7.5.6.2
GUIFixedViewDeclaration.h
1#pragma once
2#include "DefinitionsGUI.h"
3#include "DefinitionsGUIFixedView.h"
4
12
14namespace FLImaging
15{
17 namespace GUI
18 {
19 class CGUIDocBase;
20 class CGUIChildFrameBase;
21 class CGUIViewBase;
22
30 class FL_EXPORT CGUIFixedViewDeclaration : public Base::CFLBase
31 {
32 public:
42
50
59 virtual void SetMultiDocTemplateName(std::string strMultiDocTemplateName);
60
69 virtual std::string GetMultiDocTemplateName() const;
70
82 virtual void SetViewName(const Base::CFLString<wchar_t>& strViewName);
83
95
103 virtual void ClearViewName();
104
118 virtual void SetConstantTitleOfView(const Base::CFLString<wchar_t>& strTitle, bool bSaveToConfig = true);
119
131
140
151 virtual CGUIDocBase* GetCreatedDocument() const;
152
163 virtual CGUIChildFrameBase* GetCreatedFrame() const;
164
175 virtual CGUIViewBase* GetCreatedView() const;
176
188 virtual const FLImaging::CResult Load();
189
205 virtual const FLImaging::CResult Save(const std::vector<EFixedViewPropertyFlag>& vctSaveProperty) const;
206
222 virtual const FLImaging::CResult Save(EFixedViewPropertyFlag eSaveItem) const;
223
237 virtual const FLImaging::CResult SaveAll() const;
238
250
284 virtual const CResult RegisterAndCreateFixedView(const std::string& strMultiDocTemplateName, const Base::CFLString<wchar_t>& flstrViewName, bool bShowView = true);
285
322 virtual const CResult RegisterAndCreateFixedView(EViewType eViewType, const Base::CFLString<wchar_t>& flstrViewName, bool bShowView = true);
323
324 EViewType GetViewType() const;
325
326 DeclareGetClassType();
327
328 protected:
329 virtual const FLImaging::CResult InternalLoadViewImage();
330 virtual const FLImaging::CResult InternalSaveViewImage(const std::vector<EFixedViewPropertyFlag>& vctSaveProperty) const;
331 virtual const FLImaging::CResult InternalLoadViewGraph();
332 virtual const FLImaging::CResult InternalSaveViewGraph(const std::vector<EFixedViewPropertyFlag>& vctSaveProperty) const;
333 virtual const FLImaging::CResult InternalLoadView3D();
334 virtual const FLImaging::CResult InternalSaveView3D(const std::vector<EFixedViewPropertyFlag>& vctSaveProperty) const;
335 virtual const FLImaging::CResult InternalLoadViewSNAP();
336 virtual const FLImaging::CResult InternalSaveViewSNAP(const std::vector<EFixedViewPropertyFlag>& vctSaveProperty) const;
337 virtual const FLImaging::CResult InternalLoadView3DPathEditor();
338 virtual const FLImaging::CResult InternalSaveView3DPathEditor(const std::vector<EFixedViewPropertyFlag>& vctSaveProperty) const;
339 virtual const FLImaging::CResult InternalLoadViewDrawing();
340 virtual const FLImaging::CResult InternalSaveViewDrawing(const std::vector<EFixedViewPropertyFlag>& vctSaveProperty) const;
341
342 const CResult Save(SFixedViewDeclarationProperty& sFvdProperty);
343 const CResult Load(const SFixedViewDeclarationProperty& sFvdProperty);
344
345 static const FLImaging::CResult InternalLoadViewImage(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
346 static const FLImaging::CResult InternalLoadViewGraph(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
347 static const FLImaging::CResult InternalLoadView3D(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
348 static const FLImaging::CResult InternalLoadViewSNAP(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
349 static const FLImaging::CResult InternalLoadView3DPathEditor(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
350 static const FLImaging::CResult InternalLoadViewDrawing(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
351
352 static const CResult Load(const Base::CFLString<wchar_t>& strViewName, EViewType eViewType, SFixedViewDeclarationProperty& sFvdProperty);
353
354 protected:
355 std::string m_strMultiDocTemplateName;
356 Base::CFLString<wchar_t> m_strViewName;
357 Base::CFLString<wchar_t> m_strConstantTitle;
358
359 CGUIDocBase* m_pCreatedDoc;
360 CGUIChildFrameBase* m_pCreatedFrame;
361 CGUIViewBase* m_pCreatedView;
362
363 friend class CGUIManagerView;
364 friend class CGUIFixedViewPlacementSet;
365 friend class CGUIFixedViewPlacement;
366 };
367 }
368}
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:1676
virtual CGUIViewBase * GetCreatedView() const
Get the pointer of created view.
virtual const CResult RegisterAndCreateFixedView(const std::string &strMultiDocTemplateName, const Base::CFLString< wchar_t > &flstrViewName, bool bShowView=true)
Registers a fixed view declaration and creates the corresponding view, document, and frame instances.
virtual const FLImaging::CResult Save(EFixedViewPropertyFlag eSaveItem) const
Saves attribute values for the fixed view (e.g., pixel precision for the image view) to the path obta...
virtual const FLImaging::CResult Load()
Loads attribute values for the fixed view (e.g., pixel precision for the image view) and sets them to...
virtual Base::CFLString< wchar_t > GetConstantTitleOfView() const
Function that returns a fixed title if the view is set to always display the same title.
virtual void SetMultiDocTemplateName(std::string strMultiDocTemplateName)
Set the MultiDocTemplateName of view.
virtual void ClearConstantTitleOfView()
A function that clears the constant title of the view set by SetConstantTitleOfView().
virtual const FLImaging::CResult Save(const std::vector< EFixedViewPropertyFlag > &vctSaveProperty) const
Saves attribute values for the fixed view (e.g., pixel precision for the image view) to the path obta...
virtual Base::CFLString< wchar_t > GetViewName() const
Get the name of view.
virtual CGUIDocBase * GetCreatedDocument() const
Get the pointer of document.
virtual void ClearViewName()
A function that clears the name of the view set by SetViewName().
virtual CGUIChildFrameBase * GetCreatedFrame() const
Get the pointer of child frame.
virtual void SetViewName(const Base::CFLString< wchar_t > &strViewName)
Set the name of view.
virtual const FLImaging::CResult SaveAll() const
Saves attribute values for the fixed view (e.g., pixel precision for the image view) to the path obta...
virtual ~CGUIFixedViewDeclaration()
Default destructor.
CGUIFixedViewDeclaration()
Default constructor.
virtual std::string GetMultiDocTemplateName() const
Get the MultiDocTemplateName of view.
virtual void SetConstantTitleOfView(const Base::CFLString< wchar_t > &strTitle, bool bSaveToConfig=true)
Function to set the view to always display the same title. If an empty string is provided,...
virtual const CResult RegisterAndCreateFixedView(EViewType eViewType, const Base::CFLString< wchar_t > &flstrViewName, bool bShowView=true)
Registers and creates a fixed view based on the specified view type.
virtual Base::CFLString< wchar_t > GetFileName() const
Returns the path to the settings file that stores the most recent settings in the pinned view....
Definition D2DObject.h:12
EViewType
View Type.
Definition DefinitionsGUI.h:45