GFt::Widget::VScrollBar类 参考

垂直滚动条 更多...

#include <ScrollBar.h>

类 GFt::Widget::VScrollBar 继承关系图:

Public 成员函数
	VScrollBar (const iRect &rect, Block *parent=nullptr, int zIndex=0)
	构造函数
	~VScrollBar () override=default
Color &	backgroundColor ()
const Color &	backgroundColor () const
Color &	barBorderColor ()
const Color &	barBorderColor () const
Color &	barColor ()
const Color &	barColor () const
float	getCompleteSize () const
	获取完整大小
float	getPosition () const
	获取当前位置
float	getStep () const
	获取步长
float	getVisibleSize () const
	获取可见大小
void	setCompleteSize (float size)
	设置完整大小
void	setPosition (float pos)
	设置当前位置
void	setStep (float step)
	设置步长
void	setVisibleSize (float size)
	设置可见大小
Public 成员函数 继承自 GFt::Block
	Block (const iRect &rect, Block *parent=nullptr, int zIndex=0)
	构造函数
virtual	~Block ()
iPoint	absolutePosition () const
	计算相对于屏幕的绝对坐标
void	addChild (Block *child)
	添加子对象
Block *	getParent () const
	获取父对象
int	getZIndex () const
	获取层级
void	hide ()
	隐藏块对象
bool	isHide () const
	获取块当前是否被隐藏
iPoint	relativePosFrom (Block *block) const
	计算相对于指定对象的相对坐标
void	removeChild (Block *child)
	移除子对象
void	setParent (Block *parent)
	设置父对象
void	setZIndex (int zIndex)
	设置层级
void	show ()
	显示块对象
Public 成员函数 继承自 GFt::GraphInterface
	GraphInterface (iRect rect)
	构造函数
virtual	~GraphInterface ()
const iRect &	rect () const
void	setHeight (int height)
void	setPosition (const iPoint &pos)
void	setRect (const iRect &rect)
void	setSize (const iSize &size)
void	setWidth (int width)
void	setX (int x)
void	setY (int y)

Public 属性
Signal< float >	onCurrentPosChanged
	滚动条位置发生改变时发出此信号
Public 属性 继承自 GFt::Block
Signal< Block * >	FocusOff
	当该对象失去焦点时触发该信号
Signal< Block * >	FocusOn
	当该对象获得焦点时触发该信号
Signal< Block * >	HoverOff
	当鼠标移开该对象时之上时触发该信号
Signal< Block * >	HoverOn
	当鼠标悬停该对象时之上时触发该信号
Signal< bool >	ViewChanged
	当该对象显示状态变化时触发该信号
Public 属性 继承自 GFt::GraphInterface
Signal< const iPoint & >	onPositionChanged
Signal< const iSize & >	onSizeChanged

Protected 成员函数
void	onDraw (Graphics &g) override
	此函数用于绘制内容
void	onMouseButtonPress (MouseButtonPressEvent *e) override
	此函数用于处理鼠标按钮按下事件
void	onMouseWheel (MouseWheelEvent *e) override
	此函数用于处理鼠标滚轮事件
Protected 成员函数 继承自 GFt::Block
void	onKeyPress (KeyPressEvent *event) override
	此函数用于处理键盘按键按下事件
void	onKeyRelease (KeyReleaseEvent *event) override
	此函数用于处理键盘按键释放事件
void	onMouseButtonRelease (MouseButtonReleaseEvent *event) override
	此函数用于处理鼠标按钮释放事件
void	onMouseMove (MouseMoveEvent *event) override
	此函数用于处理鼠标移动事件
void	onTextInput (TextInputEvent *event) override
	此函数用于处理文本输入事件
Protected 成员函数 继承自 GFt::GraphInterface
Protected 成员函数 继承自 GFt::MouseButtonPressEventMonitor
Protected 成员函数 继承自 GFt::MouseButtonReleaseEventMonitor
Protected 成员函数 继承自 GFt::MouseMoveEventMonitor
Protected 成员函数 继承自 GFt::MouseWheelEventMonitor
Protected 成员函数 继承自 GFt::KeyPressEventMonitor
Protected 成员函数 继承自 GFt::KeyReleaseEventMonitor
Protected 成员函数 继承自 GFt::TextInputEventMonitor

详细描述

垂直滚动条

构造及析构函数说明

VScrollBar()

GFt::Widget::VScrollBar::VScrollBar	(	const iRect &	rect,
		Block *	parent = nullptr,
		int	zIndex = 0 )

构造函数

参数

rect	矩形区域
parent	父级块
zIndex	层级

~VScrollBar()

GFt::Widget::VScrollBar::~VScrollBar ( )

overridedefault

成员函数说明

backgroundColor() [1/2]

Color & GFt::Widget::VScrollBar::backgroundColor

(

)

backgroundColor() [2/2]

const Color & GFt::Widget::VScrollBar::backgroundColor

(

)

const

barBorderColor() [1/2]

Color & GFt::Widget::VScrollBar::barBorderColor

(

)

barBorderColor() [2/2]

const Color & GFt::Widget::VScrollBar::barBorderColor

(

)

const

barColor() [1/2]

Color & GFt::Widget::VScrollBar::barColor

(

)

barColor() [2/2]

const Color & GFt::Widget::VScrollBar::barColor

(

)

const

getCompleteSize()

float GFt::Widget::VScrollBar::getCompleteSize

(

)

const

获取完整大小

返回

完整大小

getPosition()

float GFt::Widget::VScrollBar::getPosition

(

)

const

获取当前位置

返回

当前位置

getStep()

float GFt::Widget::VScrollBar::getStep

(

)

const

获取步长

返回

步长

getVisibleSize()

float GFt::Widget::VScrollBar::getVisibleSize

(

)

const

获取可见大小

返回

可见大小

onDraw()

void GFt::Widget::VScrollBar::onDraw ( Graphics & g )

overrideprotectedvirtual

此函数用于绘制内容

参数

g

绘图设备对象

此函数会在每一帧绘制时被调用, 用于绘制内容

注解

若启用了裁剪优化，且此对象所在位置不与父对象的区域存在交集, 则此函数不会被调用

由于此函数会在每帧渲染时调用，因而应尽量避免过多的计算、创建和销毁临时对象，以提高效率。

渲染帧时长(可通过 Application::getRenderTime() 获取)最好控制在16ms以内，否则会引发较为明显的卡顿

重载 GFt::Block .

onMouseButtonPress()

void GFt::Widget::VScrollBar::onMouseButtonPress ( MouseButtonPressEvent * event )

overrideprotectedvirtual

此函数用于处理鼠标按钮按下事件

此函数存在默认行为：当此对象被点击时捕获焦点

参数

event

鼠标按钮按下事件

注解

鼠标处理函数会依据鼠标位置进行事件的捕获决断, 并将事件传递给相应的对象进行处理

具体的决断逻辑为：从根节点开始，查找首个满足鼠标位置在其区域内的对象，以该对象 为根节点再次重复此操作，直到某个对象不存在满足条件的子对象，则将事件传递给该对 象进行处理。该对象处理后若冒泡行为未被阻止，则再向上冒泡(即向父对象传递事件)， 直到根节点。

鼠标事件处理示意图

重载 GFt::Block .

onMouseWheel()

void GFt::Widget::VScrollBar::onMouseWheel ( MouseWheelEvent * event )

overrideprotectedvirtual

此函数用于处理鼠标滚轮事件

参数

event

鼠标滚轮事件

参见

onMouseButtonPress

重载 GFt::Block .

setCompleteSize()

void GFt::Widget::VScrollBar::setCompleteSize

(

float

size

)

设置完整大小

参数

size

大小

setPosition()

void GFt::Widget::VScrollBar::setPosition

(

float

pos

)

设置当前位置

参数

pos

位置

setStep()

void GFt::Widget::VScrollBar::setStep

(

float

step

)

设置步长

参数

step

步长

setVisibleSize()

void GFt::Widget::VScrollBar::setVisibleSize

(

float

size

)

设置可见大小

参数

size

大小

类成员变量说明

onCurrentPosChanged

Signal<float> GFt::Widget::VScrollBar::onCurrentPosChanged

滚动条位置发生改变时发出此信号