查看源代码 wxCaret (wx v2.4.3)
插入符是一个闪烁的光标,指示键入文本将出现的位置。
文本控件通常有自己的插入符,但 wxCaret
提供了一种在其他窗口中使用插入符的方法。
目前,插入符以给定大小的矩形显示。将来,可以指定用于插入符形状的位图。
插入符始终与窗口关联,可以使用 wxWindow:getCaret/1
检索当前插入符。同一个插入符不能在两个不同的窗口中重复使用。
wxWidgets 文档: wxCaret
概要
函数
创建具有给定大小(以像素为单位)的插入符,并将其与 window
关联(与等效的构造函数相同)。
销毁对象
返回闪烁时间,以毫秒为单位测量,是插入符的 2 次反转之间经过的时间(所有插入符的闪烁时间相同,因此此函数是静态的)。
获取与插入符关联的窗口。
隐藏插入符,与 Show(false) 相同。
如果插入符创建成功,则返回 true。
如果插入符可见则返回 true,如果永久隐藏则返回 false(如果插入符正在闪烁且当前未显示,但会在下一次闪烁后显示,此方法仍返回 true)。
将插入符移动到给定位置(以逻辑坐标为单位)。
创建具有给定大小(以像素为单位)的插入符,并将其与 window
关联。
设置所有插入符的闪烁时间。
更改插入符的大小。
等效于 show(This, [])
。
显示或隐藏插入符。
类型
-type wxCaret() :: wx:wx_object().
函数
-spec create(This, Window, Size) -> boolean() when This :: wxCaret(), Window :: wxWindow:wxWindow(), Size :: {W :: integer(), H :: integer()}.
-spec create(This, Window, Width, Height) -> boolean() when This :: wxCaret(), Window :: wxWindow:wxWindow(), Width :: integer(), Height :: integer().
创建具有给定大小(以像素为单位)的插入符,并将其与 window
关联(与等效的构造函数相同)。
-spec destroy(This :: wxCaret()) -> ok.
销毁对象
-spec getBlinkTime() -> integer().
返回闪烁时间,以毫秒为单位测量,是插入符的 2 次反转之间经过的时间(所有插入符的闪烁时间相同,因此此函数是静态的)。
-spec getWindow(This) -> wxWindow:wxWindow() when This :: wxCaret().
获取与插入符关联的窗口。
-spec hide(This) -> ok when This :: wxCaret().
隐藏插入符,与 Show(false) 相同。
如果插入符创建成功,则返回 true。
如果插入符可见则返回 true,如果永久隐藏则返回 false(如果插入符正在闪烁且当前未显示,但会在下一次闪烁后显示,此方法仍返回 true)。
将插入符移动到给定位置(以逻辑坐标为单位)。
-spec new(Window, Size) -> wxCaret() when Window :: wxWindow:wxWindow(), Size :: {W :: integer(), H :: integer()}.
-spec new(Window, Width, Height) -> wxCaret() when Window :: wxWindow:wxWindow(), Width :: integer(), Height :: integer().
创建具有给定大小(以像素为单位)的插入符,并将其与 window
关联。
-spec setBlinkTime(Milliseconds) -> ok when Milliseconds :: integer().
设置所有插入符的闪烁时间。
警告
在 Windows 下,此函数将永久更改所有插入符的闪烁时间(直到下次调用它),即使是其他应用程序中的插入符也是如此。
参见: getBlinkTime/0
-spec setSize(This, Width, Height) -> ok when This :: wxCaret(), Width :: integer(), Height :: integer().
更改插入符的大小。
-spec show(This) -> ok when This :: wxCaret().
等效于 show(This, [])
。
显示或隐藏插入符。
请注意,如果插入符被隐藏了 N 次,则必须也显示 N 次才能重新出现在屏幕上。