FLImaging 6.11.25.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(EFixedViewPropertyFlag eSaveItem = EFixedViewPropertyFlag_All) const;
206
218
252 virtual const CResult RegisterAndCreateFixedView(const std::string& strMultiDocTemplateName, const Base::CFLString<wchar_t>& flstrViewName, bool bShowView = true);
253
290 virtual const CResult RegisterAndCreateFixedView(EViewType eViewType, const Base::CFLString<wchar_t>& flstrViewName, bool bShowView = true);
291
292 EViewType GetViewType() const;
293
294 DeclareGetClassType();
295
296 protected:
297 virtual const FLImaging::CResult InternalLoadViewImage();
298 virtual const FLImaging::CResult InternalSaveViewImage(EFixedViewPropertyFlag eSaveItem = EFixedViewPropertyFlag_All) const;
299 virtual const FLImaging::CResult InternalLoadViewGraph();
300 virtual const FLImaging::CResult InternalSaveViewGraph(EFixedViewPropertyFlag eSaveItem = EFixedViewPropertyFlag_All) const;
301 virtual const FLImaging::CResult InternalLoadView3D();
302 virtual const FLImaging::CResult InternalSaveView3D(EFixedViewPropertyFlag eSaveItem = EFixedViewPropertyFlag_All) const;
303 virtual const FLImaging::CResult InternalLoadViewSNAP();
304 virtual const FLImaging::CResult InternalSaveViewSNAP(EFixedViewPropertyFlag eSaveItem = EFixedViewPropertyFlag_All) const;
305 virtual const FLImaging::CResult InternalLoadView3DPathEditor();
306 virtual const FLImaging::CResult InternalSaveView3DPathEditor(EFixedViewPropertyFlag eSaveItem = EFixedViewPropertyFlag_All) const;
307 virtual const FLImaging::CResult InternalLoadViewDrawing();
308 virtual const FLImaging::CResult InternalSaveViewDrawing(EFixedViewPropertyFlag eSaveItem = EFixedViewPropertyFlag_All) const;
309
310 const CResult Save(SFixedViewDeclarationProperty& sFvdProperty);
311 const CResult Load(const SFixedViewDeclarationProperty& sFvdProperty);
312
313 static const FLImaging::CResult InternalLoadViewImage(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
314 static const FLImaging::CResult InternalLoadViewGraph(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
315 static const FLImaging::CResult InternalLoadView3D(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
316 static const FLImaging::CResult InternalLoadViewSNAP(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
317 static const FLImaging::CResult InternalLoadView3DPathEditor(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
318 static const FLImaging::CResult InternalLoadViewDrawing(const Base::CFLString<wchar_t>& strViewName, SFixedViewDeclarationProperty& sFvdProperty);
319
320 static const CResult Load(const Base::CFLString<wchar_t>& strViewName, EViewType eViewType, SFixedViewDeclarationProperty& sFvdProperty);
321
322 protected:
323 std::string m_strMultiDocTemplateName;
324 Base::CFLString<wchar_t> m_strViewName;
325 Base::CFLString<wchar_t> m_strConstantTitle;
326
327 CGUIDocBase* m_pCreatedDoc;
328 CGUIChildFrameBase* m_pCreatedFrame;
329 CGUIViewBase* m_pCreatedView;
330
331 friend class CGUIManagerView;
332 friend class CGUIFixedViewPlacementSet;
333 friend class CGUIFixedViewPlacement;
334 };
335 }
336}
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
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 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 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 Save(EFixedViewPropertyFlag eSaveItem=EFixedViewPropertyFlag_All) 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