表示界面中的元素更多...

#include <UIElement.h>

类 sw::UIElement 继承关系图:

类
struct	_CanAddChild< T, decltype(void(std::declval< UIElement >().AddChild(std::declval< T >())))>
	_CanAddChild模板偏特化，当AddChild有对应类型的重载时该偏特化生效更多...

Public 成员函数
	UIElement ()
	初始化UIElement

virtual	~UIElement ()=0
	析构函数，这里用纯虚函数使该类成为抽象类

void	RegisterRoutedEvent (RoutedEventType eventType, const RoutedEventHandler &handler)
	注册路由事件处理函数，当事件已注册时会覆盖已注册的函数

void	AddHandler (RoutedEventType eventType, const RoutedEventHandler &handler)
	添加路由事件处理函数

bool	RemoveHandler (RoutedEventType eventType, const RoutedEventHandler &handler)
	移除已添加的路由事件处理函数

void	UnregisterRoutedEvent (RoutedEventType eventType)
	取消对应类型路由事件的注册，该函数会移除对应事件所有的处理函数

bool	IsRoutedEventRegistered (RoutedEventType eventType)
	判断路由事件是否已存在事件处理函数

UIElement &	operator[] (int index) const
	通过索引获取子元素

UIElement &	GetChildAt (int index) const
	获取子元素

bool	AddChild (UIElement *element)
	添加子元素

bool	AddChild (UIElement &element)
	添加子元素

bool	AddChild (UIElement *element, uint64_t layoutTag)
	添加子元素并设置布局标记

bool	AddChild (UIElement &element, uint64_t layoutTag)
	添加子元素并设置布局标记

bool	RemoveChildAt (int index)
	移除指定索引处的子元素

bool	RemoveChild (UIElement *element)
	移除子元素

bool	RemoveChild (UIElement &element)
	移除子元素

void	ClearChildren ()
	移除所有子元素

int	IndexOf (UIElement *element)
	获取指定元素的索引

int	IndexOf (UIElement &element)
	获取指定元素的索引

bool	ShowContextMenu (const Point &point, sw::HorizontalAlignment horz=sw::HorizontalAlignment::Left, sw::VerticalAlignment vert=sw::VerticalAlignment::Top)
	弹出当前元素的上下文菜单

void	MoveToTop ()
	移动到界面顶部

void	MoveToBottom ()
	移动到界面底部

bool	IsRootElement () const
	判断当前元素是否为根节点

UIElement *	GetRootElement ()
	获取当前元素所在界面树的根节点

UIElement *	GetNextElement ()
	获取当前元素在界面树上的下一个节点，若已是最后一个节点则返回根节点

UIElement *	GetPreviousElement ()
	获取当前元素在界面树上的上一个节点，若元素为第一个节点则返回最后一个节点

UIElement *	GetNextTabStopElement ()
	获取下一个TabStop属性为true的元素

UIElement *	GetPreviousTabStopElement ()
	获取上一个TabStop属性为true的元素

Color	GetRealBackColor () const
	获取当前要显示的背景颜色

Color	GetRealTextColor () const
	获取当前要显示的文本颜色

void	SetCursor (HCURSOR hCursor)
	设置鼠标样式

void	SetCursor (StandardCursor cursor)
	设置鼠标样式

void	ResetCursor ()
	将鼠标样式设置为默认样式

void	SetAlignment (sw::HorizontalAlignment horz, sw::VerticalAlignment vert)
	设置对齐方式

void	Resize (const Size &size)
	调整当前元素的尺寸

bool	IsLayoutUpdateConditionSet (sw::LayoutUpdateCondition condition)
	判断指定的布局更新条件是否已设置

void	InvalidateMeasure ()
	使元素的布局状态失效，并立即触发布局更新

bool	BringIntoView ()
	尝试将当前元素移动到可视区域内

bool	AddBinding (BindingBase *binding)
	添加绑定对象

bool	AddBinding (Binding *binding)
	添加绑定对象

bool	AddBinding (DataBinding *binding)
	添加绑定到DataContext的绑定对象

bool	RemoveBinding (FieldId propertyId)
	移除指定属性的绑定对象

virtual uint64_t	GetTag () const override
	获取Tag

virtual void	SetTag (uint64_t tag) override
	设置Tag

virtual uint64_t	GetLayoutTag () const override
	获取布局标记

virtual int	GetChildLayoutCount () const override
	获取参与布局的子元素数量

virtual ILayout &	GetChildLayoutAt (int index) override
	获取对应索引处的子元素，只索引参与布局的子元素

virtual Size	GetDesireSize () const override
	获取当前元素所需尺寸

virtual void	Measure (const Size &availableSize) override
	测量元素所需尺寸

virtual void	Arrange (const sw::Rect &finalPosition) override
	安排元素位置

virtual UIElement *	ToUIElement () override
	尝试将对象转换成UIElement

template<typename First , typename... Rest>
auto	AddChildren (First &&first, Rest &&...rest) -> typename std::enable_if< _CanAddChildren< First, Rest... >::value, int >::type
	添加多个子元素

template<typename T >
auto	AddChildren (T &&child) -> typename std::enable_if< _CanAddChild< T >::value, int >::type
	添加多个子元素

template<typename T >
void	RegisterRoutedEvent (RoutedEventType eventType, T &obj, void(T::*handler)(UIElement &, RoutedEventArgs &))
	注册成员函数作为路由事件处理函数，当事件已注册时会覆盖已注册的函数

template<typename TEventArgs >
auto	RegisterRoutedEvent (const Action< UIElement &, TEventArgs & > &handler) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&sw::_IsTypedRoutedEventArgs< TEventArgs >::value >::type
	根据事件参数类型注册路由事件，当事件已注册时会覆盖已注册的函数

template<typename TEventArgs , typename THandleObj >
auto	RegisterRoutedEvent (THandleObj &obj, void(THandleObj::*handler)(UIElement &, TEventArgs &)) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&sw::_IsTypedRoutedEventArgs< TEventArgs >::value >::type
	根据事件参数类型注册成员函数作为路由事件，当事件已注册时会覆盖已注册的函数

template<typename T >
void	AddHandler (RoutedEventType eventType, T &obj, void(T::*handler)(UIElement &, RoutedEventArgs &))
	添加成员函数作为路由事件处理函数

template<typename TEventArgs >
auto	AddHandler (const Action< UIElement &, TEventArgs & > &handler) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&sw::_IsTypedRoutedEventArgs< TEventArgs >::value >::type
	根据事件参数类型添加路由事件处理函数

template<typename TEventArgs , typename THandleObj >
auto	AddHandler (THandleObj &obj, void(THandleObj::*handler)(UIElement &, TEventArgs &)) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&sw::_IsTypedRoutedEventArgs< TEventArgs >::value >::type
	根据事件参数类型添加成员函数作为路由事件处理函数

template<typename TEventArgs >
auto	AddHandler (RoutedEventType eventType, const Action< UIElement &, TEventArgs & > &handler) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&!std::is_same< TEventArgs, RoutedEventArgs >::value &&!sw::_IsTypedRoutedEventArgs< TEventArgs >::value >::type
	添加路由事件处理函数

template<typename TEventArgs , typename THandleObj >
auto	AddHandler (RoutedEventType eventType, THandleObj &obj, void(THandleObj::*handler)(UIElement &, TEventArgs &)) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&!std::is_same< TEventArgs, RoutedEventArgs >::value &&!sw::_IsTypedRoutedEventArgs< TEventArgs >::value >::type
	添加成员函数作为路由事件处理函数

template<typename T >
bool	RemoveHandler (RoutedEventType eventType, T &obj, void(T::*handler)(UIElement &, RoutedEventArgs &))
	移除已添加的类型为成员函数的路由事件处理函数

template<typename TEventArgs >
auto	RemoveHandler (const Action< UIElement &, TEventArgs & > &handler) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&sw::_IsTypedRoutedEventArgs< TEventArgs >::value, bool >::type
	移除已添加的路由事件处理函数

template<typename TEventArgs , typename THandleObj >
auto	RemoveHandler (THandleObj &obj, void(THandleObj::*handler)(UIElement &, TEventArgs &)) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&sw::_IsTypedRoutedEventArgs< TEventArgs >::value, bool >::type
	移除已添加的类型为成员函数的路由事件处理函数

template<typename TEventArgs >
auto	RemoveHandler (RoutedEventType eventType, const Action< UIElement &, TEventArgs & > &handler) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&!std::is_same< TEventArgs, RoutedEventArgs >::value &&!sw::_IsTypedRoutedEventArgs< TEventArgs >::value, bool >::type
	移除已添加的路由事件处理函数

template<typename TEventArgs , typename THandleObj >
auto	RemoveHandler (RoutedEventType eventType, THandleObj &obj, void(THandleObj::*handler)(UIElement &, TEventArgs &)) -> typename std::enable_if< std::is_base_of< RoutedEventArgs, TEventArgs >::value &&!std::is_same< TEventArgs, RoutedEventArgs >::value &&!sw::_IsTypedRoutedEventArgs< TEventArgs >::value, bool >::type
	移除已添加的类型为成员函数的路由事件处理函数

template<typename T , typename TProperty >
bool	RemoveBinding (TProperty T::*prop)
	移除指定属性的绑定对象

Public 成员函数继承自 sw::WndBase
virtual	~WndBase ()=0
	析构函数，这里用纯虚函数使该类成为抽象类

virtual Control *	ToControl ()
	尝试将对象转换成Control

virtual Window *	ToWindow ()
	尝试将对象转换成Window

bool	Equals (const WndBase &other) const
	判断当前对象与另一个WndBase是否相等

virtual std::wstring	ToString () const
	获取当前对象的描述字符串

void	UpdateInternalRect ()
	同步窗口位置和尺寸到内部记录的Rect

void	UpdateInternalText ()
	同步窗口文本到内部记录的字符串

void	Show (int nCmdShow)
	该函数调用ShowWindow

void	Close ()
	发送关闭消息

void	Update ()
	该函数调用UpdateWindow

void	UpdateFont ()
	更新字体

HFONT	GetFontHandle ()
	获取字体句柄

void	Redraw (bool erase=false, bool updateWindow=false)
	重画

bool	IsVisible () const
	判断当前对象在界面中是否可视，与Visible属性不同的是该函数返回值会受父窗口的影响

DWORD	GetStyle () const
	获取窗口样式

void	SetStyle (DWORD style)
	设置窗口样式

bool	GetStyle (DWORD mask) const
	判断窗口是否设有指定样式

void	SetStyle (DWORD mask, bool value)
	打开或关闭指定的样式

DWORD	GetExtendedStyle () const
	获取扩展窗口样式

void	SetExtendedStyle (DWORD style)
	设置扩展窗口样式

bool	GetExtendedStyle (DWORD mask)
	判断窗口是否设有指定扩展样式

void	SetExtendedStyle (DWORD mask, bool value)
	打开或关闭指定的扩展样式

Point	PointToScreen (const Point &point) const
	获取用户区点在屏幕上点的位置

Point	PointFromScreen (const Point &screenPoint) const
	获取屏幕上点在当前用户区点的位置

LRESULT	SendMessageA (UINT uMsg, WPARAM wParam, LPARAM lParam)
	发送消息（ASCII）

LRESULT	SendMessageW (UINT uMsg, WPARAM wParam, LPARAM lParam)
	发送消息（UNICODE）

BOOL	PostMessageA (UINT uMsg, WPARAM wParam, LPARAM lParam)
	发送消息（ASCII）并立即返回

BOOL	PostMessageW (UINT uMsg, WPARAM wParam, LPARAM lParam)
	发送消息（UNICODE）并立即返回

HitTestResult	NcHitTest (const Point &testPoint)
	测试指定点在窗口的哪一部分

void	Invoke (const SimpleAction &action)
	在窗口线程上执行指定委托

void	InvokeAsync (const SimpleAction &action)
	在窗口线程上执行指定委托，并立即返回

DWORD	GetThreadId () const
	获取当前窗口所属线程的线程id

bool	CheckAccess () const
	判断当前线程是否为窗口所属线程

bool	CheckAccess (const WndBase &other) const
	判断当前对象所属线程是否与另一个WndBase对象所属线程相同

template<typename TDerived , typename TProperty >
auto	GetProperty (TProperty TDerived::*prop) -> typename std::enable_if< std::is_base_of< WndBase, TDerived >::value &&_IsReadableProperty< TProperty >::value, typename TProperty::TValue >::type
	获取属性值

template<typename TDerived , typename TProperty >
auto	SetProperty (TProperty TDerived::*prop, typename TProperty::TSetterParam value) -> typename std::enable_if< std::is_base_of< WndBase, TDerived >::value &&_IsWritableProperty< TProperty >::value >::type
	设置属性值

Public 成员函数继承自 sw::DynamicObject
virtual	~DynamicObject ()=default
	析构函数

std::type_index	GetTypeIndex () const
	获取对象的类型索引

template<typename T >
bool	IsType (T **pout=nullptr)
	判断对象是否为指定类型

template<typename T >
bool	IsType (const T **pout=nullptr) const
	判断对象是否为指定类型

template<typename T >
T &	DynamicCast ()
	将对象动态转换为指定类型的引用

template<typename T >
const T &	DynamicCast () const
	将对象动态转换为指定类型的常量引用

template<typename T >
auto	UnsafeCast () -> typename std::enable_if< _IsStaticCastable< DynamicObject , T >::value, T & >::type
	将对象不安全地转换为指定类型的引用

template<typename T >
auto	UnsafeCast () -> typename std::enable_if<!_IsStaticCastable< DynamicObject , T >::value, T & >::type
	将对象不安全地转换为指定类型的引用

template<typename T >
auto	UnsafeCast () const -> typename std::enable_if< _IsStaticCastable< DynamicObject , T >::value, const T & >::type
	将对象不安全地转换为指定类型的引用

template<typename T >
auto	UnsafeCast () const -> typename std::enable_if<!_IsStaticCastable< DynamicObject , T >::value, const T & >::type
	将对象不安全地转换为指定类型的引用

Public 成员函数继承自 sw::INotifyObjectDead
virtual	~INotifyObjectDead ()
	析构时触发对象销毁事件

Public 成员函数继承自 sw::INotifyPropertyChanged
virtual	~INotifyPropertyChanged ()=default
	默认析构函数

Public 成员函数继承自 sw::IToString< WndBase >
std::wstring	ToString () const
	获取描述当前对象的字符串

Public 成员函数继承自 sw::IEqualityComparable< WndBase >
bool	Equals (const WndBase & other) const
	判断当前对象与另一个对象是否相等

bool	operator== (const WndBase & other) const
	判断当前对象是否与另一个对象相等

bool	operator!= (const WndBase & other) const
	判断当前对象是否与另一个对象不相等

Public 成员函数继承自 sw::ILayout
virtual	~ILayout ()=default
	默认虚析构函数

Public 成员函数继承自 sw::ITag
virtual	~ITag ()=default
	默认虚析构函数

Public 属性
DataContextChangedEventHandler	DataContextChanged
	数据上下问改变时触发该事件

const Property< Thickness >	Margin
	边距

const Property< HorizontalAlignment >	HorizontalAlignment
	水平对齐方式

const Property< VerticalAlignment >	VerticalAlignment
	垂直对齐方式

const ReadOnlyProperty< int >	ChildCount
	子元素数量

const Property< bool >	CollapseWhenHide
	是否在不可见时不参与布局

const ReadOnlyProperty< UIElement * >	Parent
	指向父元素的指针，当前元素为顶级窗口时该值为nullptr

const Property< uint64_t >	Tag
	储存用户自定义信息的标记

const Property< uint64_t >	LayoutTag
	布局标记，对于不同的布局有不同含义

const Property< sw::ContextMenu * >	ContextMenu
	右键按下时弹出的菜单

const Property< bool >	Float
	元素是否悬浮，若元素悬浮则该元素不会随滚动条滚动而改变位置

const Property< bool >	TabStop
	表示用户是否可以通过按下Tab键将焦点移动到当前元素

const Property< Color >	BackColor
	背景颜色，修改该属性会同时将Transparent属性设为false，对于部分控件该属性可能不生效

const Property< Color >	TextColor
	文本颜色，修改该属性会同时将InheritTextColor属性设为false，对于部分控件该属性可能不生效

const Property< bool >	Transparent
	是否使用透明背景

const Property< bool >	InheritTextColor
	是否继承父元素的文本颜色

const Property< sw::LayoutUpdateCondition >	LayoutUpdateCondition
	触发布局更新的条件

const ReadOnlyProperty< bool >	IsMeasureValid
	当前元素的布局状态是否有效

const Property< double >	MinWidth
	最小宽度，当值为负数或0时表示不限制

const Property< double >	MinHeight
	最小高度，当值为负数或0时表示不限制

const Property< double >	MaxWidth
	最大宽度，当值为负数或0时表示不限制

const Property< double >	MaxHeight
	最大高度，当值为负数或0时表示不限制

const ReadOnlyProperty< sw::Rect >	LogicalRect
	元素的逻辑位置和尺寸，即去除布局偏移以及拉伸影响的位置和尺寸

const Property< bool >	IsHitTestVisible
	当前元素是否响应鼠标事件

const ReadOnlyProperty< bool >	IsFocusedViaTab
	当前元素是否是通过按下Tab键获得的焦点

const Property< DynamicObject * >	DataContext
	数据上下文

const ReadOnlyProperty< DynamicObject * >	CurrentDataContext
	当前元素的有效数据上下文

Public 属性继承自 sw::WndBase
const ReadOnlyProperty< HWND >	Handle
	窗口句柄

const Property< sw::Font >	Font
	字体

const Property< std::wstring >	FontName
	字体名称

const Property< double >	FontSize
	字体大小

const Property< sw::FontWeight >	FontWeight
	字体粗细

const Property< sw::Rect >	Rect
	位置和尺寸

const Property< double >	Left
	左边

const Property< double >	Top
	顶边

const Property< double >	Width
	宽度

const Property< double >	Height
	高度

const ReadOnlyProperty< sw::Rect >	ClientRect
	用户区尺寸

const ReadOnlyProperty< double >	ClientWidth
	用户区宽度

const ReadOnlyProperty< double >	ClientHeight
	用户区高度

const Property< bool >	Enabled
	窗口或控件是否可用

const Property< bool >	Visible
	窗口或控件是否可见

const Property< std::wstring >	Text
	窗口标题或控件文本

const Property< bool >	Focused
	窗口是否拥有焦点

const ReadOnlyProperty< WndBase * >	Parent
	父窗口

const ReadOnlyProperty< bool >	IsDestroyed
	是否已销毁，当该值为true时不应该继续使用当前对象

const Property< bool >	AcceptFiles
	是否接受拖放文件

const ReadOnlyProperty< bool >	IsControl
	当前对象是否是控件

const ReadOnlyProperty< std::wstring >	ClassName
	窗口类名

const Property< bool >	IsGroupStart
	窗口是否为一组控件中的第一个控件

const ReadOnlyProperty< bool >	IsMouseCaptured
	鼠标是否被当前窗口捕获

Public 属性继承自 sw::INotifyObjectDead
ObjectDeadEventHandler	ObjectDead
	对象销毁时触发该事件

Public 属性继承自 sw::INotifyPropertyChanged
PropertyChangedEventHandler	PropertyChanged
	当属性值更改时触发的事件

Protected 成员函数
void	RaiseRoutedEvent (RoutedEventType eventType)
	触发路由事件

void	RaiseRoutedEvent (RoutedEventArgs &eventArgs)
	触发路由事件

double &	GetInternalArrangeOffsetX ()
	获取布局时子元素的水平偏移量

double &	GetInternalArrangeOffsetY ()
	获取布局时子元素的垂直偏移量

double	GetChildRightmost (bool update)
	获取所有子元素在当前元素中最右边的位置（只考虑参与布局的子窗口且忽略悬浮的元素）

double	GetChildBottommost (bool update)
	获取所有子元素在当前元素中最底边的位置（只考虑参与布局的子窗口且忽略悬浮的元素）

void	UpdateChildrenZOrder (bool invalidateMeasure=true)
	更新子元素的Z轴位置

void	UpdateSiblingsZOrder (bool invalidateMeasure=true)
	更新兄弟元素的Z轴位置

void	ClampDesireSize (sw::Size &size) const
	限定指定尺寸在最小和最大尺寸之间

void	ClampDesireSize (sw::Rect &rect) const
	限定指定矩形的尺寸在最小和最大尺寸之间

bool	QueryAllChildren (const Func< UIElement *, bool > &queryFunc)
	查询所有子元素，直到queryFunc返回false或所有子元素均被查询

virtual Size	MeasureOverride (const Size &availableSize)
	测量元素所需尺寸，无需考虑边框和边距

virtual void	ArrangeOverride (const Size &finalSize)
	安排子元素的位置，可重写该函数以实现自定义布局

virtual void	SetBackColor (Color color, bool redraw)
	设置背景颜色

virtual void	SetTextColor (Color color, bool redraw)
	设置文本颜色

virtual bool	RequestBringIntoView (const sw::Rect &screenRect)
	尝试将指定的矩形区域移动到可视区域内

virtual void	OnAddedChild (UIElement &element)
	添加子元素后调用该函数

virtual void	OnRemovedChild (UIElement &element)
	移除子元素后调用该函数

virtual void	OnTabMove (bool forward)
	通过tab键将焦点从当前元素移出时调用该函数

virtual void	OnTabStop ()
	通过tab键将焦点移动到当前元素时调用该函数

virtual void	OnMinMaxSizeChanged ()
	当MinWidth、MinHeight、MaxWidth或MaxHeight属性更改时调用此函数

virtual void	OnRoutedEvent (RoutedEventArgs &eventArgs, const RoutedEventHandler &handler)
	路由事件经过当前元素时调用该函数

virtual bool	SetParent (WndBase *parent) override
	设置父窗口

virtual void	ParentChanged (WndBase *newParent) override
	父窗口改变时调用此函数

virtual bool	OnClose () override
	接收到WM_CLOSE时调用该函数

virtual bool	OnMove (const Point &newClientPosition) override
	接收到WM_MOVE时调用该函数

virtual bool	OnSize (const Size &newClientSize) override
	接收到WM_SIZE时调用该函数

virtual void	OnTextChanged () override
	Text属性更改时调用此函数

virtual void	FontChanged (HFONT hfont) override
	字体改变时调用该函数

virtual void	VisibleChanged (bool newVisible) override
	Visible属性改变时调用此函数

virtual bool	OnSetFocus (HWND hPrevFocus) override
	接收到WM_SETFOCUS时调用该函数

virtual bool	OnKillFocus (HWND hNextFocus) override
	接收到WM_KILLFOCUS时调用该函数

virtual bool	OnChar (wchar_t ch, const KeyFlags &flags) override
	接收到WM_CHAR时调用该函数

virtual bool	OnKeyDown (VirtualKey key, const KeyFlags &flags) override
	接收到WM_KEYDOWN时调用该函数

virtual bool	OnKeyUp (VirtualKey key, const KeyFlags &flags) override
	接收到WM_KEYUP时调用该函数

virtual bool	OnMouseMove (const Point &mousePosition, MouseKey keyState) override
	接收到WM_MOUSEMOVE时调用该函数

virtual bool	OnMouseLeave () override
	接收到WM_MOUSELEAVE时调用该函数

virtual bool	OnMouseWheel (int wheelDelta, const Point &mousePosition, MouseKey keyState) override
	接收到WM_MOUSEWHEEL时调用该函数

virtual bool	OnMouseLeftButtonDown (const Point &mousePosition, MouseKey keyState) override
	接收到WM_LBUTTONDOWN时调用该函数

virtual bool	OnMouseLeftButtonUp (const Point &mousePosition, MouseKey keyState) override
	接收到WM_LBUTTONUP时调用该函数

virtual bool	OnMouseRightButtonDown (const Point &mousePosition, MouseKey keyState) override
	接收到WM_RBUTTONDOWN时调用该函数

virtual bool	OnMouseRightButtonUp (const Point &mousePosition, MouseKey keyState) override
	接收到WM_RBUTTONUP时调用该函数

virtual bool	OnMouseMiddleButtonDown (const Point &mousePosition, MouseKey keyState) override
	接收到WM_MBUTTONDOWN时调用该函数

virtual bool	OnMouseMiddleButtonUp (const Point &mousePosition, MouseKey keyState) override
	接收到WM_MBUTTONUP时调用该函数

virtual bool	OnContextMenu (bool isKeyboardMsg, const Point &mousePosition) override
	接收到WM_CONTEXTMENU后调用目标控件的该函数

virtual void	OnMenuCommand (int id) override
	当WM_COMMAND接收到菜单命令时调用该函数

virtual bool	OnColor (HDC hdc, HBRUSH &hRetBrush) override
	父窗口接收到WM_CTLCOLORxxx时调用对应控件的该函数

virtual bool	OnSetCursor (HWND hwnd, HitTestResult hitTest, int message, bool &result) override
	接收到WM_SETCURSOR消息时调用该函数

virtual bool	OnDropFiles (HDROP hDrop) override
	接收到WM_DROPFILES时调用该函数

virtual void	OnNcHitTest (const Point &testPoint, HitTestResult &result) override
	接收到WM_NCHITTEST后调用该函数

Protected 成员函数继承自 sw::WndBase
	WndBase ()
	初始化WndBase

	WndBase (const WndBase &)=delete

	WndBase (WndBase &&)=delete

WndBase &	operator= (const WndBase &)=delete

WndBase &	operator= (WndBase &&)=delete

void	InitWindow (LPCWSTR lpWindowName, DWORD dwStyle, DWORD dwExStyle)
	初始化为窗口，该函数会调用CreateWindowExW

void	InitControl (LPCWSTR lpClassName, LPCWSTR lpWindowName, DWORD dwStyle, DWORD dwExStyle, LPVOID lpParam=NULL)
	初始化为控件，该函数会调用CreateWindowExW

LRESULT	DefaultWndProc (const ProcMsg &msg)
	调用默认的WndProc，对于窗口则调用DefWindowProcW，控件则调用_controlOldWndProc

virtual LRESULT	WndProc (ProcMsg &refMsg)
	对WndProc的封装

virtual std::wstring &	GetInternalText ()
	获取内部记录窗口文本的字符串引用

virtual void	SetInternalText (const std::wstring &value)
	修改窗口文本，该函数默认实现为调用SetWindowTextW

virtual bool	OnCreate ()
	接收到WM_CREATE时调用该函数

virtual bool	OnDestroy ()
	接收到WM_DESTROY时调用该函数

virtual bool	OnPaint ()
	接收到WM_PAINT时调用该函数

virtual void	OnEndPaint ()
	在OnPaint函数完成之后调用该函数

virtual bool	OnNcPaint (HRGN hRgn)
	接收到WM_NCPAINT时调用该函数

virtual void	OnEndNcPaint ()
	在OnNcPaint函数完成之后调用该函数

virtual bool	OnMouseLeftButtonDoubleClick (const Point &mousePosition, MouseKey keyState)
	接收到WM_LBUTTONDBLCLK时调用该函数

virtual bool	OnMouseRightButtonDoubleClick (const Point &mousePosition, MouseKey keyState)
	接收到WM_RBUTTONDBLCLK时调用该函数

virtual bool	OnMouseMiddleButtonDoubleClick (const Point &mousePosition, MouseKey keyState)
	接收到WM_MBUTTONDBLCLK时调用该函数

virtual bool	OnDeadChar (wchar_t ch, const KeyFlags &flags)
	接收到WM_DEADCHAR时调用该函数

virtual bool	OnSysChar (wchar_t ch, const KeyFlags &flags)
	接收到WM_SYSCHAR时调用该函数

virtual bool	OnSysDeadChar (wchar_t ch, const KeyFlags &flags)
	接收到WM_SYSDEADCHAR时调用该函数

virtual bool	OnSysKeyDown (VirtualKey key, const KeyFlags &flags)
	接收到WM_SYSKEYDOWN时调用该函数

virtual bool	OnSysKeyUp (VirtualKey key, const KeyFlags &flags)
	接收到WM_SYSKEYUP时调用该函数

virtual void	OnCommand (int code)
	当父窗口接收到控件的WM_COMMAND时调用该函数

virtual void	OnControlCommand (WndBase *pControl, int code, int id)
	当WM_COMMAND接收到控件命令时调用该函数

virtual void	OnAcceleratorCommand (int id)
	当WM_COMMAND接收到快捷键命令时调用该函数

virtual void	HandleInitialized (HWND hwnd)
	窗口句柄初始化完成

virtual bool	OnMenuSelect (HMENU hMenu, int id, int flags)
	接收到WM_MENUSELECT后调用该函数

virtual bool	OnNotify (NMHDR *pNMHDR, LRESULT &result)
	接收到WM_NOTIFY后调用该函数

virtual bool	OnNotified (NMHDR *pNMHDR, LRESULT &result)
	父窗口接收到WM_NOTIFY后且父窗口OnNotify函数返回false时调用发出通知控件的该函数

virtual bool	OnVerticalScroll (int event, int pos)
	接收到WM_VSCROLL时调用目标控件的该函数

virtual bool	OnHorizontalScroll (int event, int pos)
	接收到WM_HSCROLL时调用目标控件的该函数

virtual bool	OnEnabledChanged (bool newValue)
	接收到WM_ENABLE时调用该函数

virtual bool	OnCtlColor (WndBase *pControl, HDC hdc, HBRUSH &hRetBrush)
	接收到WM_CTLCOLORxxx时调用该函数

virtual bool	OnEraseBackground (HDC hdc, LRESULT &result)
	接收到WM_ERASEBKGND时调用该函数

virtual bool	OnDrawItem (int id, DRAWITEMSTRUCT *pDrawItem)
	接收到WM_DRAWITEM时调用该函数

virtual bool	OnDrawItemSelf (DRAWITEMSTRUCT *pDrawItem)
	父窗口接收到WM_DRAWITEM后且父窗口OnDrawItem函数返回false时调用发出通知控件的该函数

virtual bool	OnMeasureItem (int id, MEASUREITEMSTRUCT *pMeasure)
	接收到WM_MEASUREITEM时调用该函数

virtual bool	OnMeasureItemSelf (MEASUREITEMSTRUCT *pMeasure)
	父窗口接收到WM_MEASUREITEM后且父窗口OnMeasureItem函数返回false时调用发出通知控件的该函数

Protected 成员函数继承自 sw::ObservableObject
void	RaisePropertyChanged (FieldId propertyId)
	触发属性更改通知事件

template<typename T , typename TProperty >
void	RaisePropertyChanged (TProperty T::*property)
	触发属性更改通知事件

额外继承的成员函数
静态 Public 成员函数继承自 sw::WndBase
static WndBase *	GetWndBase (HWND hwnd) noexcept
	通过窗口句柄获取WndBase

static bool	IsPtrValid (const WndBase *ptr) noexcept
	检查指针是否指向有效的WndBase对象

详细描述

表示界面中的元素

成员函数说明

◆ AddBinding() [1/3]

bool sw::UIElement::AddBinding ( Binding * binding )

添加绑定对象

返回: 若函数成功则返回true，否则返回false

注解: 绑定对象的生命周期将由当前元素管理，请勿与其他对象共享; 该函数会将绑定的目标对象设置为当前元素，若未指定源对象则会将DataContext作为源对象; 同一个属性只能设置一个绑定，若该属性已存在绑定则会被新的绑定覆盖

◆ AddBinding() [2/3]

bool sw::UIElement::AddBinding ( BindingBase * binding )

添加绑定对象

返回: 若函数成功则返回true，否则返回false

注解: 绑定对象的生命周期将由当前元素管理，请勿与其他对象共享; 请确保绑定对象的目标属性为当前元素的属性，该函数内部不会对此进行检查; 同一个属性只能设置一个绑定，若该属性已存在绑定则会被新的绑定覆盖

◆ AddBinding() [3/3]

bool sw::UIElement::AddBinding ( DataBinding * binding )

添加绑定到DataContext的绑定对象

返回: 若函数成功则返回true，否则返回false

注解: 绑定对象的生命周期将由当前元素管理，请勿与其他对象共享; 同一个属性只能设置一个绑定，若该属性已存在绑定则会被新的绑定覆盖

◆ AddChild() [1/4]

bool sw::UIElement::AddChild ( UIElement & element )

添加子元素

返回: 若函数成功则返回true，否则返回false

注解: 添加的子元素必须与当前元素在同一线程创建

◆ AddChild() [2/4]

bool sw::UIElement::AddChild	(	UIElement &	element,
		uint64_t	layoutTag
	)

添加子元素并设置布局标记

返回: 若函数成功则返回true，否则返回false

注解: 添加的子元素必须与当前元素在同一线程创建

◆ AddChild() [3/4]

bool sw::UIElement::AddChild ( UIElement * element )

添加子元素

返回: 若函数成功则返回true，否则返回false

注解: 添加的子元素必须与当前元素在同一线程创建

◆ AddChild() [4/4]

bool sw::UIElement::AddChild	(	UIElement *	element,
		uint64_t	layoutTag
	)

添加子元素并设置布局标记

返回: 若函数成功则返回true，否则返回false

注解: 添加的子元素必须与当前元素在同一线程创建

◆ AddChildren() [1/2]

template<typename First , typename... Rest>

auto sw::UIElement::AddChildren	(	First &&	first,
		Rest &&...	rest
	)		-> typename std::enable_if<_CanAddChildren<First, Rest...>::value, int>::type

inline

添加多个子元素

返回: 返回成功添加的子元素数量

注解: 当有一个子元素添加失败时后续的子元素将不会继续添加; 添加的子元素必须与当前元素在同一线程创建

◆ AddChildren() [2/2]

template<typename T >

auto sw::UIElement::AddChildren ( T && child ) -> typename std::enable_if<_CanAddChild<T>::value, int>::type

inline

添加多个子元素

返回: 返回成功添加的子元素数量

注解: 当有一个子元素添加失败时后续的子元素将不会继续添加; 添加的子元素必须与当前元素在同一线程创建

◆ AddHandler() [1/6]

template<typename TEventArgs >

auto sw::UIElement::AddHandler ( const Action< UIElement &, TEventArgs & > & handler ) -> typename std::enable_if<std::is_base_of<RoutedEventArgs, TEventArgs>::value && sw::_IsTypedRoutedEventArgs<TEventArgs>::value>::type

inline

根据事件参数类型添加路由事件处理函数

模板参数

TEventArgs 路由事件的参数类型，必须继承自TypedRoutedEventArgs<...>

参数

handler 事件的处理函数

◆ AddHandler() [2/6]

template<typename TEventArgs >

auto sw::UIElement::AddHandler	(	RoutedEventType	eventType,
		const Action< UIElement &, TEventArgs & > &	handler
	)		-> typename std::enable_if< std::is_base_of<RoutedEventArgs, TEventArgs>::value && !std::is_same<TEventArgs, RoutedEventArgs>::value && !sw::_IsTypedRoutedEventArgs<TEventArgs>::value>::type

inline

添加路由事件处理函数

模板参数

TEventArgs 路由事件的参数类型，必须继承自RoutedEventArgs

参数

eventType	路由事件类型
handler	处理函数

◆ AddHandler() [3/6]

void sw::UIElement::AddHandler	(	RoutedEventType	eventType,
		const RoutedEventHandler &	handler
	)

添加路由事件处理函数

参数

eventType	路由事件类型
handler	处理函数

◆ AddHandler() [4/6]

template<typename T >

void sw::UIElement::AddHandler	(	RoutedEventType	eventType,
		T &	obj,
		void(T::*)(UIElement &, RoutedEventArgs &)	handler
	)

inline

添加成员函数作为路由事件处理函数

模板参数

T 成员函数所在的类

参数

eventType	路由事件类型
obj	注册的成员函数所在的对象
handler	处理函数

◆ AddHandler() [5/6]

template<typename TEventArgs , typename THandleObj >

auto sw::UIElement::AddHandler	(	RoutedEventType	eventType,
		THandleObj &	obj,
		void(THandleObj::*)(UIElement &, TEventArgs &)	handler
	)		-> typename std::enable_if< std::is_base_of<RoutedEventArgs, TEventArgs>::value && !std::is_same<TEventArgs, RoutedEventArgs>::value && !sw::_IsTypedRoutedEventArgs<TEventArgs>::value>::type

inline

添加成员函数作为路由事件处理函数

模板参数

TEventArgs	路由事件的参数类型，必须继承自RoutedEventArgs
THandleObj	成员函数所在的类

参数

eventType	路由事件类型
obj	注册的成员函数所在的对象
handler	处理函数

◆ AddHandler() [6/6]

template<typename TEventArgs , typename THandleObj >

auto sw::UIElement::AddHandler	(	THandleObj &	obj,
		void(THandleObj::*)(UIElement &, TEventArgs &)	handler
	)		-> typename std::enable_if<std::is_base_of<RoutedEventArgs, TEventArgs>::value && sw::_IsTypedRoutedEventArgs<TEventArgs>::value>::type

inline

根据事件参数类型添加成员函数作为路由事件处理函数

模板参数

TEventArgs	路由事件的参数类型，必须继承自TypedRoutedEventArgs<...>
THandleObj	成员函数所在的类

参数

obj	注册的成员函数所在的对象
handler	事件的处理函数

◆ Arrange()

virtual void sw::UIElement::Arrange ( const sw::Rect & finalPosition )

overridevirtual

安排元素位置

参数

finalSize 最终元素所安排的位置

实现了 sw::ILayout.

被 sw::Layer , 以及 sw::PanelBase 重载.

◆ ArrangeOverride()

virtual void sw::UIElement::ArrangeOverride ( const Size & finalSize )

protectedvirtual

安排子元素的位置，可重写该函数以实现自定义布局

参数

finalSize 可用于排列子元素的最终尺寸

被 sw::Layer, sw::PanelBase , 以及 sw::TabControl 重载.

◆ BringIntoView()

bool sw::UIElement::BringIntoView ( )

尝试将当前元素移动到可视区域内

返回: 若函数成功则返回true，否则返回false

注解: 对于悬浮元素（Float属性为true）始终返回false

◆ ClampDesireSize() [1/2]

void sw::UIElement::ClampDesireSize ( sw::Rect & rect ) const

protected

限定指定矩形的尺寸在最小和最大尺寸之间

参数

rect	要限定的矩形，不包含边距

◆ ClampDesireSize() [2/2]

void sw::UIElement::ClampDesireSize ( sw::Size & size ) const

protected

限定指定尺寸在最小和最大尺寸之间

参数

size	要限定的尺寸，不包含边距

◆ FontChanged()

virtual void sw::UIElement::FontChanged ( HFONT hfont )

overrideprotectedvirtual

字体改变时调用该函数

参数

hfont 字体句柄

重载 sw::WndBase .

被 sw::GroupBox, sw::HwndHost, sw::Label , 以及 sw::SysLink 重载.

◆ GetChildBottommost()

double sw::UIElement::GetChildBottommost ( bool update )

protected

获取所有子元素在当前元素中最底边的位置（只考虑参与布局的子窗口且忽略悬浮的元素）

参数

update 是否更字段

返回: _childBottommost字段

◆ GetChildLayoutAt()

virtual ILayout & sw::UIElement::GetChildLayoutAt ( int index )

overridevirtual

获取对应索引处的子元素，只索引参与布局的子元素

注解: 参与布局的子元素：即非collapsed状态的元素

实现了 sw::ILayout.

◆ GetChildLayoutCount()

virtual int sw::UIElement::GetChildLayoutCount ( ) const

overridevirtual

获取参与布局的子元素数量

注解: 参与布局的子元素：即非collapsed状态的元素

实现了 sw::ILayout.

◆ GetChildRightmost()

double sw::UIElement::GetChildRightmost ( bool update )

protected

获取所有子元素在当前元素中最右边的位置（只考虑参与布局的子窗口且忽略悬浮的元素）

参数

update 是否更字段

返回: _childRightmost字段

◆ GetDesireSize()

virtual Size sw::UIElement::GetDesireSize ( ) const

overridevirtual

获取当前元素所需尺寸

实现了 sw::ILayout.

◆ GetInternalArrangeOffsetX()

double & sw::UIElement::GetInternalArrangeOffsetX ( )

protected

获取布局时子元素的水平偏移量

注解: 内部使用，Layer类中通过修改该值来实现子元素的布局偏移

◆ GetInternalArrangeOffsetY()

double & sw::UIElement::GetInternalArrangeOffsetY ( )

protected

获取布局时子元素的垂直偏移量

注解: 内部使用，Layer类中通过修改该值来实现子元素的布局偏移

◆ GetLayoutTag()

virtual uint64_t sw::UIElement::GetLayoutTag ( ) const

overridevirtual

获取布局标记

实现了 sw::ILayout.

◆ GetRealBackColor()

Color sw::UIElement::GetRealBackColor ( ) const

获取当前要显示的背景颜色

返回: 当Transparent为true时获取到祖先节点中首个Transparent为false的背景颜色，否则返回当前元素的背景颜色

◆ GetRealTextColor()

Color sw::UIElement::GetRealTextColor ( ) const

获取当前要显示的文本颜色

返回: 当InheritTextColor为true时获取到祖先节点中首个InheritTextColor为false的文本颜色，否则返回当前元素的文本颜色

◆ GetTag()

virtual uint64_t sw::UIElement::GetTag ( ) const

overridevirtual

获取Tag

实现了 sw::ITag.

◆ IndexOf() [1/2]

int sw::UIElement::IndexOf ( UIElement & element )

获取指定元素的索引

参数

element 要查找的元素

返回: 若找到指定元素则返回对应的索引，否则返回-1

◆ IndexOf() [2/2]

int sw::UIElement::IndexOf ( UIElement * element )

获取指定元素的索引

参数

element 要查找的元素

返回: 若找到指定元素则返回对应的索引，否则返回-1

◆ IsRoutedEventRegistered()

bool sw::UIElement::IsRoutedEventRegistered ( RoutedEventType eventType )

判断路由事件是否已存在事件处理函数

参数

eventType 路由事件类型

◆ Measure()

virtual void sw::UIElement::Measure ( const Size & availableSize )

overridevirtual

测量元素所需尺寸

参数

availableSize 可用的尺寸

实现了 sw::ILayout.

◆ MeasureOverride()

virtual Size sw::UIElement::MeasureOverride ( const Size & availableSize )

protectedvirtual

测量元素所需尺寸，无需考虑边框和边距

参数

availableSize 可用的尺寸

返回: 返回元素需要占用的尺寸，若返回Size{NAN,NAN}则使用默认实现

注解: 返回值除了Size{NAN,NAN}表示默认尺寸外不应包含NAN、INF、负数等非法值

被 sw::BmpBox, sw::ButtonBase, sw::Label, sw::Layer, sw::PanelBase, sw::SysLink , 以及 sw::TabControl 重载.

◆ OnAddedChild()

virtual void sw::UIElement::OnAddedChild ( UIElement & element )

protectedvirtual

添加子元素后调用该函数

参数

element 添加的子元素

被 sw::TabControl 重载.

◆ OnChar()

virtual bool sw::UIElement::OnChar	(	wchar_t	ch,
		const KeyFlags &	flags
	)

overrideprotectedvirtual

接收到WM_CHAR时调用该函数

参数

ch	按键的字符代码
flags	附加信息

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::TextBoxBase 重载.

◆ OnClose()

virtual bool sw::UIElement::OnClose ( )

overrideprotectedvirtual

接收到WM_CLOSE时调用该函数

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::Window 重载.

◆ OnColor()

virtual bool sw::UIElement::OnColor	(	HDC	hdc,
		HBRUSH &	hRetBrush
	)

overrideprotectedvirtual

父窗口接收到WM_CTLCOLORxxx时调用对应控件的该函数

参数

hdc	控件的显示上下文句柄
hRetBrush	要返回的画笔

返回: 若返回true则将hRetBrush作为消息的返回值，否则使用DefaultWndProc的返回值

重载 sw::WndBase .

◆ OnContextMenu()

virtual bool sw::UIElement::OnContextMenu	(	bool	isKeyboardMsg,
		const Point &	mousePosition
	)

overrideprotectedvirtual

接收到WM_CONTEXTMENU后调用目标控件的该函数

参数

isKeyboardMsg	消息是否由按下快捷键（Shift+F10、VK_APPS）产生
mousePosition	鼠标在屏幕中的位置

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::ListBox , 以及 sw::SplitButton 重载.

◆ OnDropFiles()

virtual bool sw::UIElement::OnDropFiles ( HDROP hDrop )

overrideprotectedvirtual

接收到WM_DROPFILES时调用该函数

参数

hDrop 描述拖入文件的句柄

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnKeyDown()

virtual bool sw::UIElement::OnKeyDown	(	VirtualKey	key,
		const KeyFlags &	flags
	)

overrideprotectedvirtual

接收到WM_KEYDOWN时调用该函数

参数

key	虚拟按键
flags	附加信息

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::Button, sw::CommandLink, sw::DockSplitter , 以及 sw::TextBoxBase 重载.

◆ OnKeyUp()

virtual bool sw::UIElement::OnKeyUp	(	VirtualKey	key,
		const KeyFlags &	flags
	)

overrideprotectedvirtual

接收到WM_KEYUP时调用该函数

参数

key	虚拟按键
flags	附加信息

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnKillFocus()

virtual bool sw::UIElement::OnKillFocus ( HWND hNextFocus )

overrideprotectedvirtual

接收到WM_KILLFOCUS时调用该函数

参数

hNextFocus 接收到焦点的hwnd，可能为NULL

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::Button, sw::CommandLink, sw::DockSplitter , 以及 sw::SpinBox 重载.

◆ OnMenuCommand()

virtual void sw::UIElement::OnMenuCommand ( int id )

overrideprotectedvirtual

当WM_COMMAND接收到菜单命令时调用该函数

参数

id 菜单id

重载 sw::WndBase .

被 sw::Window 重载.

◆ OnMinMaxSizeChanged()

virtual void sw::UIElement::OnMinMaxSizeChanged ( )

protectedvirtual

当MinWidth、MinHeight、MaxWidth或MaxHeight属性更改时调用此函数

被 sw::Window 重载.

◆ OnMouseLeave()

virtual bool sw::UIElement::OnMouseLeave ( )

overrideprotectedvirtual

接收到WM_MOUSELEAVE时调用该函数

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnMouseLeftButtonDown()

virtual bool sw::UIElement::OnMouseLeftButtonDown	(	const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_LBUTTONDOWN时调用该函数

参数

mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::DockSplitter 重载.

◆ OnMouseLeftButtonUp()

virtual bool sw::UIElement::OnMouseLeftButtonUp	(	const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_LBUTTONUP时调用该函数

参数

mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::DockSplitter 重载.

◆ OnMouseMiddleButtonDown()

virtual bool sw::UIElement::OnMouseMiddleButtonDown	(	const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_MBUTTONDOWN时调用该函数

参数

mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnMouseMiddleButtonUp()

virtual bool sw::UIElement::OnMouseMiddleButtonUp	(	const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_MBUTTONUP时调用该函数

参数

mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnMouseMove()

virtual bool sw::UIElement::OnMouseMove	(	const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_MOUSEMOVE时调用该函数

参数

mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::DockSplitter 重载.

◆ OnMouseRightButtonDown()

virtual bool sw::UIElement::OnMouseRightButtonDown	(	const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_RBUTTONDOWN时调用该函数

参数

mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnMouseRightButtonUp()

virtual bool sw::UIElement::OnMouseRightButtonUp	(	const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_RBUTTONUP时调用该函数

参数

mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnMouseWheel()

virtual bool sw::UIElement::OnMouseWheel	(	int	wheelDelta,
		const Point &	mousePosition,
		MouseKey	keyState
	)

overrideprotectedvirtual

接收到WM_MOUSEWHEEL时调用该函数

参数

wheelDelta	滚轮滚动的距离，为120的倍数
mousePosition	鼠标在用户区中的位置
keyState	指示某些按键是否按下

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

◆ OnMove()

virtual bool sw::UIElement::OnMove ( const Point & newClientPosition )

overrideprotectedvirtual

接收到WM_MOVE时调用该函数

参数

newClientPosition 移动后用户区左上角的位置

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::SpinBox 重载.

◆ OnNcHitTest()

virtual void sw::UIElement::OnNcHitTest	(	const Point &	testPoint,
		HitTestResult &	result
	)

overrideprotectedvirtual

接收到WM_NCHITTEST后调用该函数

参数

testPoint	要测试的点在屏幕中的位置
result	测试的结果，默认为调用DefaultWndProc的结果

重载 sw::WndBase .

◆ OnRemovedChild()

virtual void sw::UIElement::OnRemovedChild ( UIElement & element )

protectedvirtual

移除子元素后调用该函数

参数

element 移除的子元素

被 sw::TabControl 重载.

◆ OnRoutedEvent()

virtual void sw::UIElement::OnRoutedEvent	(	RoutedEventArgs &	eventArgs,
		const RoutedEventHandler &	handler
	)

protectedvirtual

路由事件经过当前元素时调用该函数

参数

eventArgs	事件参数
handler	事件处理函数，值为空时表示当前元素没有注册该事件处理函数

被 sw::Layer , 以及 sw::PanelBase 重载.

◆ OnSetCursor()

virtual bool sw::UIElement::OnSetCursor	(	HWND	hwnd,
		HitTestResult	hitTest,
		int	message,
		bool &	result
	)

overrideprotectedvirtual

接收到WM_SETCURSOR消息时调用该函数

参数

hwnd	鼠标所在窗口的句柄
hitTest	hit-test的结果，详见WM_NCHITTEST消息的返回值
message	触发该事件的鼠标消息，如WM_MOUSEMOVE
result	消息的返回值，默认为false

返回: 若返回true则将result作为消息的返回值，否则使用DefaultWndProc的返回值

重载 sw::WndBase .

被 sw::DockSplitter 重载.

◆ OnSetFocus()

virtual bool sw::UIElement::OnSetFocus ( HWND hPrevFocus )

overrideprotectedvirtual

接收到WM_SETFOCUS时调用该函数

参数

hPrevFocus 丢失焦点的hwnd，可能为NULL

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::Button, sw::CommandLink , 以及 sw::IPAddressControl 重载.

◆ OnSize()

virtual bool sw::UIElement::OnSize ( const Size & newClientSize )

overrideprotectedvirtual

接收到WM_SIZE时调用该函数

参数

newClientSize 改变后的用户区尺寸

返回: 若已处理该消息则返回true，否则返回false以调用DefaultWndProc

重载 sw::WndBase .

被 sw::BmpBox, sw::HwndHost, sw::IPAddressControl, sw::Label, sw::SpinBox , 以及 sw::Splitter 重载.

◆ OnTabMove()

virtual void sw::UIElement::OnTabMove ( bool forward )

protectedvirtual

通过tab键将焦点从当前元素移出时调用该函数

参数

forward 指示焦点移动的方向，true表示向后移动，false表示向前移动

◆ OnTextChanged()

virtual void sw::UIElement::OnTextChanged ( )

overrideprotectedvirtual

Text属性更改时调用此函数

重载 sw::WndBase .

被 sw::GroupBox, sw::Label, sw::SpinBox , 以及 sw::SysLink 重载.

◆ ParentChanged()

virtual void sw::UIElement::ParentChanged ( WndBase * newParent )

overrideprotectedvirtual

父窗口改变时调用此函数

参数

newParent 新的父窗口

重载 sw::WndBase .

◆ QueryAllChildren()

bool sw::UIElement::QueryAllChildren ( const Func< UIElement *, bool > & queryFunc )

protected

查询所有子元素，直到queryFunc返回false或所有子元素均被查询

参数

queryFunc 查询函数，参数为子元素指针，返回值为bool，返回false时停止查询

返回: 若queryFunc在某次调用中返回false则返回false，否则返回true

◆ RaiseRoutedEvent() [1/2]

void sw::UIElement::RaiseRoutedEvent ( RoutedEventArgs & eventArgs )

protected

触发路由事件

参数

eventArgs 要触发事件的事件参数

◆ RaiseRoutedEvent() [2/2]

void sw::UIElement::RaiseRoutedEvent ( RoutedEventType eventType )

protected

触发路由事件

参数

eventType 事件类型

◆ RegisterRoutedEvent() [1/4]

template<typename TEventArgs >

auto sw::UIElement::RegisterRoutedEvent ( const Action< UIElement &, TEventArgs & > & handler ) -> typename std::enable_if<std::is_base_of<RoutedEventArgs, TEventArgs>::value && sw::_IsTypedRoutedEventArgs<TEventArgs>::value>::type

inline

根据事件参数类型注册路由事件，当事件已注册时会覆盖已注册的函数

模板参数

TEventArgs 路由事件的参数类型，必须继承自TypedRoutedEventArgs<...>

参数

handler 事件的处理函数，当值为nullptr时可取消注册

弃用:: 使用AddHandler函数代替以避免覆盖已注册的事件处理函数

◆ RegisterRoutedEvent() [2/4]

void sw::UIElement::RegisterRoutedEvent	(	RoutedEventType	eventType,
		const RoutedEventHandler &	handler
	)

注册路由事件处理函数，当事件已注册时会覆盖已注册的函数

参数

eventType	路由事件类型
handler	处理函数，当值为nullptr时可取消注册

弃用:: 使用AddHandler函数代替以避免覆盖已注册的事件处理函数

◆ RegisterRoutedEvent() [3/4]

template<typename T >

void sw::UIElement::RegisterRoutedEvent	(	RoutedEventType	eventType,
		T &	obj,
		void(T::*)(UIElement &, RoutedEventArgs &)	handler
	)

inline

注册成员函数作为路由事件处理函数，当事件已注册时会覆盖已注册的函数

模板参数

T 成员函数所在的类

参数

eventType	路由事件类型
obj	注册的成员函数所在的对象
handler	处理函数，当值为nullptr时可取消注册

弃用:: 使用AddHandler函数代替以避免覆盖已注册的事件处理函数

◆ RegisterRoutedEvent() [4/4]

template<typename TEventArgs , typename THandleObj >

auto sw::UIElement::RegisterRoutedEvent	(	THandleObj &	obj,
		void(THandleObj::*)(UIElement &, TEventArgs &)	handler
	)		-> typename std::enable_if<std::is_base_of<RoutedEventArgs, TEventArgs>::value && sw::_IsTypedRoutedEventArgs<TEventArgs>::value>::type

inline

根据事件参数类型注册成员函数作为路由事件，当事件已注册时会覆盖已注册的函数

模板参数

TEventArgs	路由事件的参数类型，必须继承自TypedRoutedEventArgs<...>
THandleObj	成员函数所在的类

参数

obj	注册的成员函数所在的对象
handler	事件的处理函数，当值为nullptr时可取消注册

弃用:: 使用AddHandler函数代替以避免覆盖已注册的事件处理函数

◆ RemoveBinding() [1/2]

bool sw::UIElement::RemoveBinding ( FieldId propertyId )

移除指定属性的绑定对象

返回: 若函数成功则返回true，否则返回false

◆ RemoveBinding() [2/2]

template<typename T , typename TProperty >

bool sw::UIElement::RemoveBinding ( TProperty T::* prop )

inline

移除指定属性的绑定对象

返回: 若函数成功则返回true，否则返回false

◆ RemoveChild() [1/2]

bool sw::UIElement::RemoveChild ( UIElement & element )

移除子元素

返回: 移除是否成功

◆ RemoveChild() [2/2]

bool sw::UIElement::RemoveChild ( UIElement * element )

移除子元素

返回: 移除是否成功

◆ RemoveChildAt()

bool sw::UIElement::RemoveChildAt ( int index )

移除指定索引处的子元素

参数

index 要移除的索引

返回: 移除是否成功

◆ RemoveHandler() [1/6]

template<typename TEventArgs >

auto sw::UIElement::RemoveHandler ( const Action< UIElement &, TEventArgs & > & handler ) -> typename std::enable_if<std::is_base_of<RoutedEventArgs, TEventArgs>::value && sw::_IsTypedRoutedEventArgs<TEventArgs>::value, bool>::type

inline

移除已添加的路由事件处理函数

模板参数

TEventArgs 路由事件的参数类型，必须继承自TypedRoutedEventArgs<...>

参数

handler 事件的处理函数

返回: 是否成功移除

◆ RemoveHandler() [2/6]

template<typename TEventArgs >

auto sw::UIElement::RemoveHandler	(	RoutedEventType	eventType,
		const Action< UIElement &, TEventArgs & > &	handler
	)		-> typename std::enable_if< std::is_base_of<RoutedEventArgs, TEventArgs>::value && !std::is_same<TEventArgs, RoutedEventArgs>::value && !sw::_IsTypedRoutedEventArgs<TEventArgs>::value, bool>::type

inline

移除已添加的路由事件处理函数

模板参数

TEventArgs 路由事件的参数类型，必须继承自RoutedEventArgs

参数

eventType	路由事件类型
handler	处理函数

返回: 是否成功移除

◆ RemoveHandler() [3/6]

bool sw::UIElement::RemoveHandler	(	RoutedEventType	eventType,
		const RoutedEventHandler &	handler
	)

移除已添加的路由事件处理函数

参数

eventType	路由事件类型
handler	处理函数

返回: 是否成功移除

◆ RemoveHandler() [4/6]

template<typename T >

bool sw::UIElement::RemoveHandler	(	RoutedEventType	eventType,
		T &	obj,
		void(T::*)(UIElement &, RoutedEventArgs &)	handler
	)

inline

移除已添加的类型为成员函数的路由事件处理函数

模板参数

T 成员函数所在的类

参数

eventType	路由事件类型
obj	注册的成员函数所在的对象
handler	处理函数

返回: 是否成功移除

◆ RemoveHandler() [5/6]

template<typename TEventArgs , typename THandleObj >

auto sw::UIElement::RemoveHandler	(	RoutedEventType	eventType,
		THandleObj &	obj,
		void(THandleObj::*)(UIElement &, TEventArgs &)	handler
	)		-> typename std::enable_if< std::is_base_of<RoutedEventArgs, TEventArgs>::value && !std::is_same<TEventArgs, RoutedEventArgs>::value && !sw::_IsTypedRoutedEventArgs<TEventArgs>::value, bool>::type

inline

移除已添加的类型为成员函数的路由事件处理函数

模板参数

TEventArgs	路由事件的参数类型，必须继承自RoutedEventArgs
THandleObj	成员函数所在的类

参数

eventType	路由事件类型
obj	注册的成员函数所在的对象
handler	处理函数

返回: 是否成功移除

◆ RemoveHandler() [6/6]

template<typename TEventArgs , typename THandleObj >

auto sw::UIElement::RemoveHandler	(	THandleObj &	obj,
		void(THandleObj::*)(UIElement &, TEventArgs &)	handler
	)		-> typename std::enable_if<std::is_base_of<RoutedEventArgs, TEventArgs>::value && sw::_IsTypedRoutedEventArgs<TEventArgs>::value, bool>::type

inline

移除已添加的类型为成员函数的路由事件处理函数

模板参数

TEventArgs	路由事件的参数类型，必须继承自TypedRoutedEventArgs<...>
THandleObj	成员函数所在的类

参数

obj	注册的成员函数所在的对象
handler	事件的处理函数

返回: 是否成功移除

◆ RequestBringIntoView()

virtual bool sw::UIElement::RequestBringIntoView ( const sw::Rect & screenRect )

protectedvirtual

尝试将指定的矩形区域移动到可视区域内

参数

screenRect 要移动到可视区域的矩形在屏幕中的位置

返回: 若已处理该请求则返回true，否则返回false以继续向上冒泡

被 sw::Layer , 以及 sw::PanelBase 重载.

◆ Resize()

void sw::UIElement::Resize ( const Size & size )

调整当前元素的尺寸

注解: 通过该函数可以调整横向或纵向对齐方式为拉伸时的DesireSize

◆ SetAlignment()

void sw::UIElement::SetAlignment	(	sw::HorizontalAlignment	horz,
		sw::VerticalAlignment	vert
	)

设置对齐方式

参数

horz	水平对齐方式
vert	垂直对齐方式

◆ SetBackColor()

virtual void sw::UIElement::SetBackColor	(	Color	color,
		bool	redraw
	)

protectedvirtual

设置背景颜色

参数

color	要设置的颜色
redraw	是否重绘

被 sw::GroupBox, sw::ListView, sw::MonthCalendar, sw::StatusBar , 以及 sw::TreeView 重载.

◆ SetCursor() [1/2]

void sw::UIElement::SetCursor ( HCURSOR hCursor )

设置鼠标样式

参数

hCursor 鼠标句柄

◆ SetCursor() [2/2]

void sw::UIElement::SetCursor ( StandardCursor cursor )

设置鼠标样式

参数

cursor 鼠标样式

◆ SetParent()

virtual bool sw::UIElement::SetParent ( WndBase * parent )

overrideprotectedvirtual

设置父窗口

返回: 设置是否成功

重载 sw::WndBase .

◆ SetTag()

virtual void sw::UIElement::SetTag ( uint64_t tag )

overridevirtual

设置Tag

实现了 sw::ITag.

◆ SetTextColor()

virtual void sw::UIElement::SetTextColor	(	Color	color,
		bool	redraw
	)

protectedvirtual

设置文本颜色

参数

color	要设置的颜色
redraw	是否重绘

被 sw::GroupBox, sw::ListView, sw::MonthCalendar , 以及 sw::TreeView 重载.

◆ ShowContextMenu()

bool sw::UIElement::ShowContextMenu	(	const Point &	point,
		sw::HorizontalAlignment	horz = `sw::HorizontalAlignment::Left`,
		sw::VerticalAlignment	vert = `sw::VerticalAlignment::Top`
	)

弹出当前元素的上下文菜单

参数

point	弹出菜单在屏幕中的位置
horz	菜单的水平方向对齐方式
vert	菜单的垂直方向对齐方式

返回: 若函数成功则返回true，否则返回false

◆ ToUIElement()

virtual UIElement * sw::UIElement::ToUIElement ( )

overridevirtual

尝试将对象转换成UIElement

返回: 若函数成功则返回UIElement指针，否则返回nullptr

重载 sw::WndBase .

◆ UnregisterRoutedEvent()

void sw::UIElement::UnregisterRoutedEvent ( RoutedEventType eventType )

取消对应类型路由事件的注册，该函数会移除对应事件所有的处理函数

参数

eventType 路由事件类型

◆ VisibleChanged()

virtual void sw::UIElement::VisibleChanged ( bool newVisible )

overrideprotectedvirtual

Visible属性改变时调用此函数

重载 sw::WndBase .

类成员变量说明

◆ CurrentDataContext

const ReadOnlyProperty<DynamicObject *> sw::UIElement::CurrentDataContext

当前元素的有效数据上下文

注解: 若当前元素的DataContext不为nullptr则返回该值，否则递归获取父元素的DataContext

◆ LayoutUpdateCondition

const Property<sw::LayoutUpdateCondition> sw::UIElement::LayoutUpdateCondition

触发布局更新的条件

注解: 修改该属性不会立即触发布局更新

◆ LogicalRect

const ReadOnlyProperty<sw::Rect> sw::UIElement::LogicalRect

元素的逻辑位置和尺寸，即去除布局偏移以及拉伸影响的位置和尺寸

注解: 当布局未完成时该属性的值可能不准确

◆ Transparent

const Property<bool> sw::UIElement::Transparent

是否使用透明背景

注解: 此属性并非真正意义上的透明，将该属性设为true可继承父元素的背景颜色

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

UIElement.h

类

Public 成员函数

Public 属性

Protected 成员函数

额外继承的成员函数

详细描述

成员函数说明

◆ AddBinding() [1/3]

◆ AddBinding() [2/3]

◆ AddBinding() [3/3]

◆ AddChild() [1/4]

◆ AddChild() [2/4]

◆ AddChild() [3/4]

◆ AddChild() [4/4]

◆ AddChildren() [1/2]

◆ AddChildren() [2/2]

◆ AddHandler() [1/6]

◆ AddHandler() [2/6]

◆ AddHandler() [3/6]

◆ AddHandler() [4/6]

◆ AddHandler() [5/6]

◆ AddHandler() [6/6]

◆ Arrange()

◆ ArrangeOverride()

◆ BringIntoView()

◆ ClampDesireSize() [1/2]

◆ ClampDesireSize() [2/2]

◆ FontChanged()

◆ GetChildBottommost()

◆ GetChildLayoutAt()

◆ GetChildLayoutCount()

◆ GetChildRightmost()

◆ GetDesireSize()

◆ GetInternalArrangeOffsetX()

◆ GetInternalArrangeOffsetY()

◆ GetLayoutTag()

◆ GetRealBackColor()

◆ GetRealTextColor()

◆ GetTag()

◆ IndexOf() [1/2]

◆ IndexOf() [2/2]

◆ IsRoutedEventRegistered()

◆ Measure()

◆ MeasureOverride()

◆ OnAddedChild()

◆ OnChar()

◆ OnClose()

◆ OnColor()

◆ OnContextMenu()

◆ OnDropFiles()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnKillFocus()

◆ OnMenuCommand()

◆ OnMinMaxSizeChanged()

◆ OnMouseLeave()

◆ OnMouseLeftButtonDown()

◆ OnMouseLeftButtonUp()

◆ OnMouseMiddleButtonDown()

◆ OnMouseMiddleButtonUp()

◆ OnMouseMove()

◆ OnMouseRightButtonDown()

◆ OnMouseRightButtonUp()

◆ OnMouseWheel()

◆ OnMove()

◆ OnNcHitTest()

◆ OnRemovedChild()

◆ OnRoutedEvent()

◆ OnSetCursor()

◆ OnSetFocus()

◆ OnSize()

◆ OnTabMove()

◆ OnTextChanged()

◆ ParentChanged()

◆ QueryAllChildren()

◆ RaiseRoutedEvent() [1/2]

◆ RaiseRoutedEvent() [2/2]

◆ RegisterRoutedEvent() [1/4]

◆ RegisterRoutedEvent() [2/4]

◆ RegisterRoutedEvent() [3/4]