FLImaging 7.10.21.1
GUIViewImageBaseWrap.h
1#pragma once
2
10
11#include "DefinitionsGUI.h"
12
13
15namespace FLImaging
16{
18 namespace GUI
19 {
21
29 class FL_EXPORT CGUIViewImageBaseWrap : public Base::CFLBase
30 {
31 SupportToDuplicateAbstractObject(CGUIViewImageBaseWrap)
32
33 typedef size_t __H_FLImaging_GUI_CGUIViewBase;
34 typedef size_t __H_FLImaging_GUI_CKeyEventProcedure;
35
36 public:
44
52
62
72
84
96
97
107 void Invalidate(bool bErase = true);
108
117
126
143 void MoveWindow(int32_t i32X, int32_t i32Y, int32_t i32Width, int32_t i32Height, bool bRepaint);
144
165 bool SetWindowPos(size_t stHandleInsertAfter, int32_t i32X, int32_t i32Y, int32_t i32CX, int32_t i32CY, uint32_t u32Flags);
166
177 bool ShowWindow(int32_t i32CmdShow);
178
188
196
204
217 virtual const CResult ShowToolBar(bool bShow);
218
228 virtual bool IsToolBarVisible();
229
239 virtual bool IsScrollBarVisible()const;
240
250 virtual bool IsScrollBarHorizontalVisible()const;
251
261 virtual bool IsScrollBarVerticalVisible()const;
262
272 virtual bool IsStatusBarVisible();
273
282 virtual void EnableContextMenu(bool bEnable);
283
292 virtual bool IsContextMenuEnabled();
293
300 virtual void LockUpdate();
301
308 virtual void UnlockUpdate();
309
319 virtual bool IsUpdateLocked() const;
320
330 virtual bool IsBeingDrawn() const;
331
343
353
365
379
393
405
415 virtual void EnableKeyEventParentNotification(bool bEnable);
416
427
443 virtual const CResult AddIgnoreShortcut(const Base::CFLArray<int32_t>& flaKeySequence);
444
458 virtual bool IsShortcutIgnored(const Base::CFLArray<int32_t>& flaKeySequence) const;
459
472
486 virtual const CResult AddKeyDownEventProcedure(__H_FLImaging_GUI_CKeyEventProcedure hProcedure);
487
501 virtual const CResult AddKeyUpEventProcedure(__H_FLImaging_GUI_CKeyEventProcedure hProcedure);
502
521 virtual void ShowUnavailableContextMenu(bool bShow);
522
533
545 virtual bool IsLButtonDown() const;
546
558 virtual bool IsMButtonDown() const;
559
571 virtual bool IsRButtonDown() const;
572
588 virtual const CResult EnableGesture(EGUIViewGesture eGesture, bool bEnable = true);
589
601 virtual bool IsGestureEnabled(EGUIViewGesture eGesture) const;
602
609 void Lock();
610
617 bool TryLock();
618
619
626 void Unlock();
627
636 virtual size_t GetMessageCallerPtr();
637
646 virtual size_t SetFocus();
647
659
668 virtual size_t GetViewPtr();
669
670
680 virtual void SetDrawingFigureLineColor(uint32_t u32LineColor);
681
691 virtual uint32_t GetDrawingFigureLineColor() const;
692
702 virtual void SetDrawingFigureFillColor(uint32_t u32FillColor);
703
713 virtual uint32_t GetDrawingFigureFillColor() const;
714
724 virtual void SetDrawingFigureEdgeColor(uint32_t u32EdgeColor);
725
735 virtual uint32_t GetDrawingFigureEdgeColor() const;
736
746 virtual void SetDrawingFigureLineWidth(float f32LineWidth);
747
757 virtual float GetDrawingFigureLineWidth() const;
758
771
784
794 virtual void SetDrawingFigureLineColorAlphaRatio(float f32LineColorAlphaRatio);
795
806
816 virtual void SetDrawingFigureFillColorAlphaRatio(float f32FillColorAlphaRatio);
817
828
838 virtual void EnableAttributeDrawingRealSizeLineWidth(bool bEnable);
839
850
860 virtual void SetDrawingFigureTextFontSize(float f32FontSize);
861
871 virtual float GetDrawingFigureTextFontSize() const;
872
882 virtual void EnableDrawingFigureTextRealSize(bool bRealSize);
883
894
904 virtual void SetDrawingFigureTextAngle(double f64Angle);
905
915 virtual double GetDrawingFigureTextAngle() const;
916
929
942
955
968
981
994
1007
1017 virtual void EnableDrawingFigureTextItalic(bool bItalic);
1018
1029
1041 virtual const CResult EnableViewListRegistration(bool bEnable = true);
1042
1052 virtual bool IsViewListRegistrationEnabled() const;
1053
1063 virtual CGUIViewImageBase* GetViewImageBasePtr() const;
1064
1065 private:
1066 void operator=(const CGUIViewImageBaseWrap& rh);
1068
1069 DeclareGetClassType();
1070
1071 public:
1072 virtual const CResult SetExternalParent(bool bSet);
1073
1074 protected:
1075 __H_FLImaging_GUI_CGUIViewBase m_hView;
1076 size_t m_stViewHandle;
1077 size_t m_stParentHandle;
1078 bool m_bAutoDestroy;
1079
1080 friend class CGUIViewImage;
1081 friend class CGUIViewImageBase;
1082 friend class CGUIManagerViewWrap;
1083 friend class CGUIManager;
1084 };
1085 }
1086}
Template type array class.
Definition FLArray.h:71
Top-level base class of FLImaging.
Definition FLImagingBase/FLBase.h:36
Template type string class.
Definition FLString.h:34
Simplified class representing a rectangle.
Definition FLImagingBase/TRect.h:37
FLImaging module execution result object.
Definition FLImagingBase/ResultsDef.h:1712
A class representing a rectangle.
Definition FLImagingFoundation/FLRect.h:24
A class of view base.
Definition FLImagingGUI/GUIViewImageBase.h:44
virtual EGUIViewImageFontWeight GetDrawingFigureTextFontWeight() const
A function that retrieves the default font weight applied when drawing text on a layer if no specific...
virtual EGUIViewImageTextAlignment GetDrawingFigureTextAlignment() const
A function that retrieves the default alignment of a string's position when drawing text on a layer i...
const CResult DesynchronizeWindow(const CGUIViewImageBaseWrap *pTargetView)
Disable synchronization for the window of the parameter.
virtual float GetDrawingFigureLineColorAlphaRatio() const
A function that retrieves the default alpha ratio of the line color for a drawing figure when drawing...
CGUIViewImageBaseWrap()
Default constructor.
virtual void SetDrawingFigureLineColorAlphaRatio(float f32LineColorAlphaRatio)
A function that sets the default alpha ratio of the line color for a drawing figure when drawing on a...
virtual const CResult EnableGesture(EGUIViewGesture eGesture, bool bEnable=true)
Enables or disables a specific GUI view gesture.
virtual bool IsViewListRegistrationEnabled() const
Checks whether this view can be registered in the view list of each class object that inherits CGUIPr...
void Unlock()
Unlocks the object.
bool SetWindowPos(size_t stHandleInsertAfter, int32_t i32X, int32_t i32Y, int32_t i32CX, int32_t i32CY, uint32_t u32Flags)
Sets the size, location, and Z order of the windows.
virtual void ShowUnavailableContextMenu(bool bShow)
Sets whether to hide or show the disabled context menu. The activation/deactivation of the context me...
virtual void SetDrawingFigurePenStyle(EGUIViewImagePenStyle ePenStyle)
A function that sets the default pen style for a drawing figure when drawing on a layer if no specifi...
virtual void SetDrawingFigureTextFontWeight(EGUIViewImageFontWeight eFontWeight)
A function that sets the default font weight to be applied when drawing text on a layer if no specifi...
virtual uint32_t GetDrawingFigureFillColor() const
A function that retrieves the current default fill color of a drawing figure.
virtual void EnableAttributeDrawingRealSizeLineWidth(bool bEnable)
Sets the default RealSizeLineWidth enable state when drawing shapes on the layer, in cases where the ...
bool IsAvailable()
Check window validity of view.
virtual const CResult AddKeyUpEventProcedure(__H_FLImaging_GUI_CKeyEventProcedure hProcedure)
Add handlers to receive key-up events when using key event parent notifications.
virtual size_t SetFocus()
Sets the keyboard focus to the specified window.
virtual float GetDrawingFigureLineWidth() const
A function that retrieves the current default line width of a drawing figure.
CGUIViewImageBaseWrap * GetRootSyncWindow() const
Gets the wrapping class of the root view that is currently synchronized with the image window.
virtual void EnableDrawingFigureTextItalic(bool bItalic)
A function that sets the default italic style for the font when drawing text on a layer if no specifi...
virtual bool IsBeingDrawn() const
Check whether the image is currently being drawn on the screen.
virtual void SetDrawingFigureTextFontSize(float f32FontSize)
A function that sets the default font size to be applied when drawing text on a layer if no specific ...
void BringToBottom()
Move the Z-Order of the window to the bottom.
virtual float GetDrawingFigureTextFontSize() const
A function that retrieves the default font size applied when drawing text on a layer if no specific f...
void Lock()
Sets a lock on the object.
virtual const CResult EnableViewListRegistration(bool bEnable=true)
Determines whether to register this view in the view list of each class object that inherits CGUIProp...
virtual bool IsToolBarVisible()
Determines whether the ToolBar is shown or hidden.
virtual bool IsUpdateLocked() const
Check whether the update of the image on the screen is locked.
virtual bool IsAttributeDrawingRealSizeLineWidthEnabled() const
Gets the default RealSizeLineWidth enable state when drawing shapes on the layer, in cases where the ...
virtual void SetDrawingFigureTextAngle(double f64Angle)
A function that sets the default angle of a string when drawing text on a layer if no specific angle ...
virtual bool IsUnavailableContextMenuVisible() const
Returns whether the disabled context menu is hidden or shown.
virtual void SetDrawingFigureTextAlignment(EGUIViewImageTextAlignment eAlign)
A function that sets the default alignment of a string's position when drawing text on a layer if no ...
virtual void SetDrawingFigureEdgeColor(uint32_t u32EdgeColor)
A function that sets the default edge color for a drawing figure when no specific color is specified.
void RedrawWindow()
Update the screen of the view.
void BringToTop()
Move the Z-Order of the window to the top.
virtual bool IsScrollBarHorizontalVisible() const
Returns whether the horizontal scroll bar is currently visible.
Foundation::CFLRect< int32_t > GetClientRect()
Gets the window client area of the view.
void MoveWindow(int32_t i32X, int32_t i32Y, int32_t i32Width, int32_t i32Height, bool bRepaint)
Move the window.
virtual bool IsScrollBarVisible() const
Returns whether any of the scroll bars (vertical or horizontal) are currently visible.
bool ShowWindow(int32_t i32CmdShow)
Set the display status of the window.
virtual ~CGUIViewImageBaseWrap()
Default destructor.
virtual void EnableKeyEventParentNotification(bool bEnable)
Sets whether key event parent notifications are enabled.
virtual void SetDrawingFigureTextFontName(const Base::CFLString< wchar_t > &strFontName)
A function that sets the default font name to be applied when drawing text on a layer if no specific ...
virtual const CResult ShowToolBar(bool bShow)
Sets whether the ToolBar is show/hide.
const CResult SynchronizeWindow(const CGUIViewImageBaseWrap *pTargetView)
Synchronizes the window of the parameter with the current window.
const CResult DesynchronizeWindowAll()
Disconnects the current window.
bool IsAvailableHandle()
Check window handle validity of view.
virtual EGUIViewImagePenStyle GetDrawingFigurePenStyle() const
A function that retrieves the default pen style applied to a drawing figure when drawing on a layer i...
virtual const CResult AddKeyDownEventProcedure(__H_FLImaging_GUI_CKeyEventProcedure hProcedure)
Add handlers to receive key-down events when using key event parent notifications.
virtual const CResult ClearIgnoreShortcut()
Clears the ignore shortcut.
const CResult ResignRootWindow()
If the root view of synchronized windows is the current image window, replace the root view with anot...
virtual void UnlockUpdate()
Unlock the update of the image on the screen.
virtual bool IsLButtonDown() const
Returns whether the left mouse button is currently pressed.
void UpdateWindow()
Immediately update the screen of the view (synchronous function).
virtual Base::CFLString< wchar_t > GetDrawingFigureTextFontName() const
A function that retrieves the default font name applied when drawing text on a layer if no specific f...
Foundation::CFLRect< int32_t > GetClientRectCanvasRegion()
Gets the window canvas area of the view.
virtual float GetDrawingFigureFillColorAlphaRatio() const
A function that retrieves the default alpha ratio of the fill color for a drawing figure when drawing...
virtual uint32_t GetDrawingFigureEdgeColor() const
A function that retrieves the current default edge color of a drawing figure.
virtual const CResult AddIgnoreShortcut(const Base::CFLArray< int32_t > &flaKeySequence)
Add shortcuts to ignore.
void Invalidate(bool bErase=true)
Invalidate the screen of the view (asynchronous function).
virtual bool IsDrawingFigureTextRealSizeEnabled() const
A function that retrieves the default setting for whether to draw text at actual size when no specifi...
virtual CGUIViewImageBase * GetViewImageBasePtr() const
Gets the pointer to the original view.
virtual size_t GetViewPtr()
Retrieves a pointer to the view.
virtual void SetDrawingFigureTextFontName(const Base::CFLString< wchar_t > *pStrFontName)
A function that sets the default font name to be applied when drawing text on a layer if no specific ...
virtual bool IsContextMenuEnabled()
Gets the context menu availability.
virtual bool IsScrollBarVerticalVisible() const
Returns whether the vertical scroll bar is currently visible.
virtual bool IsStatusBarVisible()
Determines whether the StatusBar is shown or hidden.
virtual bool IsRButtonDown() const
Returns whether the right mouse button is currently pressed.
virtual void SetDrawingFigureLineWidth(float f32LineWidth)
A function that sets the default line width for a drawing figure when no specific width is specified.
virtual double GetDrawingFigureTextAngle() const
A function that retrieves the default angle of a string when drawing text on a layer if no specific a...
virtual void LockUpdate()
Lock the update of the image on the screen.
virtual bool IsDrawingFigureTextItalicEnabled() const
A function that retrieves the default italic style applied to the font when drawing text on a layer i...
virtual size_t GetMessageCallerPtr()
Returns the pointer of the broadcast caller object.
virtual void SetDrawingFigureFillColorAlphaRatio(float f32FillColorAlphaRatio)
A function that sets the default alpha ratio of the fill color for a drawing figure when drawing on a...
virtual void SetDrawingFigureFillColor(uint32_t u32FillColor)
A function that sets the default fill color for a drawing figure when no specific color is specified.
virtual void SetDrawingFigureLineColor(uint32_t u32LineColor)
A function that sets the default line color used when drawing figures or text on a layer,...
bool IsSynchronizedWindow()
Returns whether the current image window is synchronized with another image window....
virtual bool IsMButtonDown() const
Returns whether the middle mouse button is currently pressed.
virtual bool IsShortcutIgnored(const Base::CFLArray< int32_t > &flaKeySequence) const
Returns whether the shortcut is ignored.
bool IsWindowVisible()
Gets the visibility status of the window.
virtual Base::TRect< int32_t > GetRestoreWindowRect()
Gets the restore window area of the view.
virtual bool IsGestureEnabled(EGUIViewGesture eGesture) const
Checks whether a specific GUI view gesture is enabled.
virtual uint32_t GetDrawingFigureLineColor() const
A function that retrieves the current default line color for a drawing figure.
virtual void EnableDrawingFigureTextRealSize(bool bRealSize)
A function that sets the default value for drawing text at actual size when no specific size setting ...
virtual bool IsKeyEventParentNotificationEnabled() const
Determines whether key event parent notifications are enabled.
virtual void EnableContextMenu(bool bEnable)
Sets the availability of the context menu.
Definition D2DObject.h:12
EGUIViewImageTextAlignment
Alignment text in an image view.
Definition FLImagingGUI/DefinitionsGUI.h:9387
EGUIViewImagePenStyle
Pen Style in Image View.
Definition FLImagingGUI/DefinitionsGUI.h:9101
EGUIViewImageFontWeight
Font thickness of image view.
Definition FLImagingGUI/DefinitionsGUI.h:9207
EGUIViewGesture
Defines the types of user interface gestures and input events in the GUI view.
Definition FLImagingGUI/DefinitionsGUI.h:127