UiWin类参考

MZFC的UI控件基类 更多...

#include <UiWin.h>

被CUiStatusBar、UiAlphabetBar、UiButton、UiCanvas、UiEditZoom、UiFillColor、UiGradient、UiList、UiList_2、UiMultiLineEditPro、UiReceiverItem、UiScrollWin、UiSingleLineEdit、UiStatic、UiToolbar_Icon、UiToolbar_Text及WinManager继承.

所有成员的列表。

公有成员
void	AddChild (UiWin *pChild)
	add child control(child node)
virtual int	CalcContentHeight ()
	calculate the content's height (the drawing of vertical scrollbar will called this member，can be derived)
virtual int	CalcContentTopPosH ()
	calculate the content's left position (the drawing of horizontal scrollbar will called this member，can be derived)
virtual int	CalcContentTopPosV ()
	calculate the content's top position (the drawing of vertical scrollbar will called this member，can be derived)
virtual int	CalcContentWidth ()
	calculate the content's width (the drawing of horizontal scrollbar will called this member，can be derived)
MZFC_INLINE void	EnableClipExtend (bool bEnable)
	turn on/off the clip-extend of the control
MZFC_INLINE void	EnableDragModeH (bool bEnable)
	Enable the horizontal drag mode. See MZ_WM_LIST_ITEM_DRAG_H message
virtual void	EnableDragScroll (bool bEnable)
	Enable the DragScroll property
MZFC_INLINE void	EnableDragScrollbarV (bool bEnable)
	enable vertical DragScrollBar
MZFC_INLINE void	EnableGrabFocusByMouse (bool bEnable)
	set whether the control gain focus when it is click by the mouse left button
MZFC_INLINE void	EnableNotifyMessage (bool bEnable)
	set whether the control should send MZ_WM_MOUSE_NOTIFY to its container window
MZFC_INLINE void	EnablePressedHoldSupport (bool bEnable)
	set whether the control has pressed-hold supoort
MZFC_INLINE void	EnableScrollableParent (bool bEnable)
	set whether tell its scrollable parent when dragged by mouse
MZFC_INLINE void	EnableScrollBarH (bool bEnable)
	Enable or Disable the horizontal Scrollbar
MZFC_INLINE void	EnableScrollBarV (bool bEnable)
	Enable or Disable the vertical Scrollbar
MZFC_INLINE void	EnableScrollOptimize (bool bEnable)
	enable scroll optimize
MZFC_INLINE void	EnableSound (bool bEnable)
	Enable sound property of the control
size_t	FindChild (UiWin *pChild)
	find the z-order of a child
UiWin *	GetCapture ()
	get the UiWin currently has mouse-capture
UiWin *	GetChild (int nIndex)
	get child of specify index
UiWin *	GetChildByID (int nID)
	get the child control of the specify ID
size_t	GetChildrenCount ()
	get count of children
RECT	GetClientRect ()
	get the rect of the control. (relative to itself, x,y are always zero)
MZFC_INLINE int	GetClipExtend ()
	set the clip-extend value of the control
int	GetDragMode ()
	get the drag mode
MZFC_INLINE DWORD	GetDrawTextFormat ()
	Set the DrawText format
MZFC_INLINE int	GetEllipsis_Bottom ()
MZFC_INLINE int	GetEllipsis_Left ()
MZFC_INLINE int	GetEllipsis_Right ()
MZFC_INLINE int	GetEllipsis_Top ()
MZFC_INLINE int	GetHeight ()
	get the height
MZFC_INLINE INT	GetHidingScrollbarResID ()
int	GetID ()
	get the control's ID
virtual WinManager *	GetManager ()
	get the manager of the control
MZFC_INLINE POINT	GetMouseDownPos ()
	get the MouseDown position
MZFC_INLINE UiWin *	GetParent ()
	get the parent (container) of the control
virtual HWND	GetParentWnd ()
	get the window where the control is in
MZFC_INLINE int	GetPosX ()
	get the X coordinate
MZFC_INLINE int	GetPosY ()
	get the Y coordinate
MZFC_INLINE int	GetPressedHoldTime ()
RECT	GetRect ()
	get the rect of the control. (relative to it's container or parent)
virtual UiWin *	GetScrollableParent ()
	get the scrollable parent of the control (include itself)
MZFC_INLINE int	GetScrollbarMarginH ()
MZFC_INLINE int	GetScrollbarMarginV ()
virtual CMzString &	GetText ()
	get the text property
MZFC_INLINE COLORREF	GetTextColor ()
	get the text color property
MZFC_INLINE int	GetTextSize ()
	get the text size property
MZFC_INLINE int	GetTextWeight ()
	get the text font-weight property: FW_NORMAL, FW_XXXX, etc. See Win32 API: CreateFont for details
int	GetTopPos ()
	get the top position of the content
MZFC_INLINE void *	GetUserData ()
	get the user data of the control
MZFC_INLINE int	GetWidth ()
	get the width
bool	HasChild (UiWin *pWin)
	whether has a specify child control
bool	HasChildNode (UiWin *pWin)
	check whether the control has specify child node.
void	InsertChild (UiWin *pChild, size_t nZOrder)
	insert a child to a position of z-order (zero-base)
virtual void	Invalidate (RECT *prcUpdate=NULL)
	Invalidate the control's rect of the HWND
MZFC_INLINE bool	IsCancelAction ()
	get the CancelAction property (if you pressed and drag, this property will be true; if you pressed and drag and release, false)
MZFC_INLINE bool	IsDragingScrollbarV ()
	the dragging vertical DragScrollBar status
MZFC_INLINE bool	IsEnable ()
	whether the control receive mouse message.
MZFC_INLINE bool	IsEnableClipExtend ()
	whether the clip-extend of the control is turn on
MZFC_INLINE bool	IsEnableDragModeH ()
	whether the horizontal drag mode is enable
bool	IsEnableDragScroll ()
	the DragScroll property
MZFC_INLINE bool	IsEnableDragScrollbarV ()
	whether enable vertical DragScrollBar
MZFC_INLINE bool	IsEnableGrabFocusByMouse ()
	whether the control gain focus when it is click by the mouse left button
MZFC_INLINE bool	IsEnableNotifyMessage ()
	whether the control should send MZ_WM_MOUSE_NOTIFY to its container window
MZFC_INLINE bool	IsEnablePressedHoldSupport ()
	whether the control has pressed-hold supoort
MZFC_INLINE bool	IsEnableScrollableParent ()
	get whether tell its scrollable parent when dragged by mouse
MZFC_INLINE bool	IsEnableScrollBarH ()
	whether the horizontal Scrollbar is enabled
MZFC_INLINE bool	IsEnableScrollBarV ()
	whether the horizontal vertical is enabled
MZFC_INLINE bool	IsEnableScrollOptimize ()
bool	IsFocused ()
	whether the control has the keyboard input focus
bool	IsHidingScrollbar ()
MZFC_INLINE bool	IsInDragH ()
MZFC_INLINE bool	IsLButtonDblClk ()
	get the LButtonDbClk property
MZFC_INLINE bool	IsLButtonDown ()
	get the LButtonDown property
MZFC_INLINE bool	IsMouseDownAtScrolling ()
	is mouse down when the control is in scrolling status
MZFC_INLINE bool	IsMouseMoved ()
	get the MouseMoved property
MZFC_INLINE bool	IsPressedHoldTimeup ()
	whether pressed-hold time is up(false when mouse left button is pressed down, true when hold to time up)
virtual bool	IsScrollable ()
	is the content scrollable
MZFC_INLINE bool	IsScrolling ()
	is the control in scrolling status
MZFC_INLINE bool	IsSoundEnabled ()
MZFC_INLINE bool	IsStateLocked ()
	whether the control is locked
MZFC_INLINE bool	IsVertDragDisabled ()
MZFC_INLINE bool	IsVisible ()
	whether the control is visible
virtual void	LockState (bool bLock)
	locked property of the control
void	Move (int xOffset, int yOffset)
	move the control
void	MoveChildren (int xOffset, int yOffset)
	move the positions of children
virtual void	MoveTopPos (int nOffset)
	move the top position of the content
virtual int	OnChar (TCHAR chCharCode, LPARAM lKeyData)
	call when a keyboard character key is pressed.(only when the control has focus)
virtual void	OnCopy ()
	called if the control has keyboard focus when the container window receive WM_COPY message
virtual void	OnCut ()
	called if the control has keyboard focus when the container window receive WM_CUT message
virtual void	OnFocusd (UiWin *pWinPrev)
	called when the control gain keyboard focus
virtual int	OnImeComposition (BOOL fFlags)
	call when receive a IME message.(only when the control has focus)
virtual int	OnImeEndComposition ()
	call when receive a IME message.(only when the control has focus)
virtual int	OnImeStartComposition ()
	call when receive a IME message.(only when the control has focus)
virtual void	OnInsertPic (TCHAR *szString)
virtual int	OnKeyDown (int nVirtKey, DWORD lKeyData)
	call when the keyboard is pressed down.(only when the control has focus)
virtual int	OnKeyUp (int nVirtKey, DWORD lKeyData)
	call when the a keyboard key is released.(only when the control has focus)
virtual int	OnLButtonDblClk (UINT fwKeys, int xPos, int yPos)
	called when the control is double click by mouse left button.
virtual int	OnLButtonDown (UINT fwKeys, int xPos, int yPos)
	called when the control is pressed down by mouse left button.
virtual int	OnLButtonUp (UINT fwKeys, int xPos, int yPos)
	called when the mouse left button is is released on the control
virtual void	OnLostFocus (UiWin *pWinNext)
	called when the control lost keyboard focus
virtual int	OnMouseMove (UINT fwKeys, int xPos, int yPos)
	called when the control has mouse move message.
virtual void	OnPaint (HDC hdcDst, RECT *prcWin, RECT *prcUpdate)
	Called when drawing
virtual void	OnPaste ()
	called if the control has keyboard focus when the container window receive WM_PASTE message
virtual void	OnPaste (TCHAR *szString)
virtual void	OnPressedHoldStart ()
	called when pressed-hold is started
virtual void	OnPressedHoldTimeup ()
	called when pressed-hold is ended
virtual int	OnTimer (UINT_PTR nIDEvent)
	called then Timer arrived.
virtual void	OnWmA4M8 (WPARAM wParam, WPARAM lParam)
	called if the control has keyboard focus when the container window receive WM_A4M8 message
virtual void	PaintScrollBarH (HDC hdc, RECT *prcWin, RECT *prcUpdate)
	paint the horizontal scrollbar (override to define your own drawing)
virtual void	PaintScrollBarHiding ()
virtual void	PaintScrollBarV (HDC hdc, RECT *prcWin, RECT *prcUpdate)
	paint the vertical scrollbar (override to define your own drawing)
virtual void	PaintScrollBarV_Ex (HDC hdc, RECT *prcWin, INT nResID)
virtual void	PaintWin (HDC hdcDst, RECT *prcWin, RECT *prcUpdate)
	Draw the control on the destinate DC.
void	PostCommandMessage (int nID, int nNotifyCode, LPARAM lParam)
	Post MZ_WM_COMMAND message to the window where the control is in. See MZ_WM_COMMAND.
void	PostCommandMessage (LPARAM lParam)
	Post MZ_WM_COMMAND message to the window where the control is in. See MZ_WM_COMMAND.
void	PostCommandMessage ()
	Post MZ_WM_COMMAND message to the window where the control is in. See MZ_WM_COMMAND.
void	PostMessage (UINT message, WPARAM wParam, LPARAM lParam)
	Post message to the window where the control is in
virtual void	PostUiMessage (UiWin *pwinDst, LPARAM lParam)
	Post Message to the destinate UiWin in the same WinManager. (See MZ_MZ_UI_POSTMESSAGE)
void	ReleaseCapture ()
	release the mouse-capture
void	RemoveAllChildren ()
	remove all children controls
void	RemoveChild (UiWin *pChild)
	delete child control
virtual void	ScrollStart (double fScrollSpeed)
	start scroll
virtual void	ScrollStop ()
	stop scroll
virtual void	ScrollTo (int nScrollToType=UI_SCROLLTO_TOP, int nDstTopPos=0, bool bAnimate=true)
	Scroll the content of a control to a position
void	SendCommandMessage (LPARAM lParam)
	Send MZ_WM_COMMAND message to the window where the control is in. See MZ_WM_COMMAND.
void	SendCommandMessage ()
	Send MZ_WM_COMMAND message to the window where the control is in. See MZ_WM_COMMAND.
void	SendMessage (UINT message, WPARAM wParam, LPARAM lParam)
	Send message to the window where the control is in
MZFC_INLINE void	SetCancelAction (bool bCancel)
	set the CancelAction property
void	SetCapture ()
	let the control has mouse-capture
MZFC_INLINE void	SetClipExtend (int nExtend)
	set the clip-extend value of the control（extend the control's rectange, in physical pixels）
virtual void	SetDragMode (int nDragMode)
	set the drag mode
MZFC_INLINE void	SetDrawTextFormat (DWORD dwFormat)
	Set the DrawText format
MZFC_INLINE void	SetEllipsis (int nEllipsis_Left, int nEllipsis_Right, int nEllipsis_Top, int nEllipsis_Bottom)
virtual void	SetEnable (bool bEnable=true)
	set whether the control receive mouse message. (including its child node would be affected)
virtual void	SetFocus (bool bFocus)
	let the control has the keyboard input focus
void	SetHidingScrollbar (bool bHiding)
MZFC_INLINE void	SetHidingScrollbarResID (INT nResID)
void	SetID (int nID)
	Set the control's ID
MZFC_INLINE void	SetIsDragingScrollbarV (bool bIs)
	set the dragging vertical DragScrollBar status
MZFC_INLINE void	SetIsInDragH (bool bIsInDragH)
MZFC_INLINE void	SetLButtonDblClk (bool bDblClk)
	set the LButtonDbClk property
MZFC_INLINE void	SetLButtonDown (bool bDown)
	set the LButtonDown property
MZFC_INLINE void	SetMouseDownAtScrolling (bool bDownAtScrolling)
	set the mouse is down when the control is in scrolling status
MZFC_INLINE void	SetMouseDownPos (int x, int y)
	set the MouseDown position
MZFC_INLINE void	SetMouseMoved (bool bMoved)
	set the MouseMoved property
virtual void	SetParent (UiWin *pParent)
virtual void	SetPos (int x, int y, int w, int h, UINT flags=0)
	set the position and size of the control
MZFC_INLINE void	SetPressedHoldTime (int nElapse)
MZFC_INLINE void	SetPressedHoldTimeup (bool bTimeup)
MZFC_INLINE void	SetScrollbarMarginH (int nMargin)
MZFC_INLINE void	SetScrollbarMarginV (int nMargin)
virtual void	SetText (LPCTSTR text)
	set the text property
MZFC_INLINE void	SetTextColor (COLORREF cr)
	set the text color property
MZFC_INLINE void	SetTextSize (int nSize)
	set the text size property
MZFC_INLINE void	SetTextWeight (int nWeight)
	set the text font-weight property: FW_NORMAL, FW_XXXX, etc. See Win32 API: CreateFont for details
virtual void	SetTopPos (int nTopPos)
	set the top position of the content
MZFC_INLINE void	SetUserData (void *data)
	set the user data of the control
MZFC_INLINE void	SetVertDragDisabled (bool bDisable)
virtual void	SetVisible (bool bVisible=true)
	set whether the control is visible
void	SetZOrderOfChild (UiWin *pChild, size_t nZOrder)
	Bring the UiWin to specified z-order of those have same parent
	UiWin ()
virtual void	UiWinProc (LPARAM lParam)
	MZ_MZ_UI_POSTMESSAGE 's process function, override to define your own processing.
virtual void	Update ()
	update the control
virtual void	zReserved1 (void *pv)
virtual void	zReserved10 (void *pv)
virtual void	zReserved2 (void *pv)
virtual void	zReserved3 (void *pv)
virtual void	zReserved4 (void *pv)
virtual void	zReserved5 (void *pv)
virtual void	zReserved6 (void *pv)
virtual void	zReserved7 (void *pv)
virtual void	zReserved8 (void *pv)
virtual void	zReserved9 (void *pv)
virtual	~UiWin ()
公有属性
byte	m_zReserved [20]
保护成员
MZFC_INLINE void	SetIsScrolling (bool bScrolling)
保护属性
bool	m_bEnableNotifyMessage
bool	m_bEnablePressedHoldSupport
bool	m_bEnableScrollOptimize
bool	m_bIsDragingScrollbarV
bool	m_bIsEnableDragScrollbarV
bool	m_bIsEnableGrabFocusByMouse
bool	m_bPressedHoldTimeup
int	m_nEllipsis_Bottom
int	m_nEllipsis_Left
int	m_nEllipsis_Right
int	m_nEllipsis_Top
int	m_nLeftPos
int	m_nPressedHoldTime
int	m_nTopPos

---

详细描述

MZFC的UI控件基类

---

构造及析构函数文档

---

成员函数文档

---

成员数据文档

---

该类的文档由以下文件生成：

• UiWin.h