檢視原始碼 wxCaret (wx v2.4.3)
插入符號是一個閃爍的游標,顯示輸入文字將出現的位置。
文字控制項通常有自己的插入符號,但是 wxCaret
提供了一種在其他視窗中使用插入符號的方式。
目前,插入符號顯示為具有給定大小的矩形。未來,將可以指定用於插入符號形狀的點陣圖。
插入符號始終與視窗相關聯,可以使用 wxWindow:getCaret/1
檢索目前的插入符號。同一個插入符號不能在兩個不同的視窗中重複使用。
wxWidgets 文件:wxCaret
摘要
函式
使用給定的大小(以像素為單位)建立插入符號,並將其與 window
關聯(與等效的建構函式相同)。
銷毀物件
返回閃爍時間,以毫秒為單位測量,是插入符號兩次反轉之間經過的時間(所有插入符號的閃爍時間都相同,因此此函式是靜態的)。
取得插入符號所關聯的視窗。
隱藏插入符號,與 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().
返回閃爍時間,以毫秒為單位測量,是插入符號兩次反轉之間經過的時間(所有插入符號的閃爍時間都相同,因此此函式是靜態的)。
-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 下,此函式將永久變更所有插入符號的閃爍時間(直到下次呼叫),即使是其他應用程式中的插入符號也是如此。
-spec setSize(This, Width, Height) -> ok when This :: wxCaret(), Width :: integer(), Height :: integer().
變更插入符號的大小。
-spec show(This) -> ok when This :: wxCaret().
與 show(This, [])
等效。
顯示或隱藏插入符號。
請注意,如果插入符號被隱藏 N 次,則也必須顯示 N 次才能在螢幕上重新出現。