檢視原始碼 wxHelpEvent (wx v2.4.3)

當使用者請求內容相關的說明時,會發送說明事件。

這可能是由於應用程式透過 wxContextHelp (在 wx 中未實作)請求內容相關的說明模式所導致,或(在 MS Windows 上)當使用者按下 F1 或點擊對話框標題中的查詢按鈕時,由系統產生 WM_HELP 訊息所導致。

說明事件會發送到使用者點擊的視窗,並在視窗階層中向上傳播,直到事件被處理或沒有其他事件處理常式為止。

應用程式應呼叫 wxEvent:getId/1 來檢查點擊的視窗的識別碼,然後顯示一些適當的說明,或者如果識別碼無法識別,則呼叫 wxEvent:skip/2

呼叫 Skip 很重要,因為它允許 wxWidgets 為點擊視窗的祖先產生進一步的事件。否則,將無法為容器視窗顯示說明,因為處理會在找到第一個視窗後停止。

請參閱

此類別繼承自以下類別,並可以使用其函式:

wxWidgets 文件: wxHelpEvent

事件

使用 wxEvtHandler:connect/3wxHelpEventType 來訂閱此類型的事件。

摘要

函式

傳回說明事件的來源,它是 wxHelpEvent::Origin (在 wx 中未實作)值之一。

傳回滑鼠左鍵點擊位置的螢幕座標。

設定說明事件的來源,通常僅由 wxWidgets 內部使用。

設定滑鼠左鍵點擊位置的螢幕座標。

類型

-type wxHelp() :: #wxHelp{type :: wxHelpEvent:wxHelpEventType()}.
-type wxHelpEvent() :: wx:wx_object().
-type wxHelpEventType() :: help | detailed_help.

函式

-spec getOrigin(This) -> wx:wx_enum() when This :: wxHelpEvent().

傳回說明事件的來源,它是 wxHelpEvent::Origin (在 wx 中未實作)值之一。

應用程式可能會以不同的方式處理使用鍵盤或滑鼠產生的事件,例如,使用 wx_misc:getMousePosition/0 處理滑鼠事件。

請參閱: setOrigin/2

-spec getPosition(This) -> {X :: integer(), Y :: integer()} when This :: wxHelpEvent().

傳回滑鼠左鍵點擊位置的螢幕座標。

這允許應用程式適當地定位說明。

連結到此函式

setOrigin(This, Origin)

檢視原始碼
-spec setOrigin(This, Origin) -> ok when This :: wxHelpEvent(), Origin :: wx:wx_enum().

設定說明事件的來源,通常僅由 wxWidgets 內部使用。

請參閱: getOrigin/1

-spec setPosition(This, Pt) -> ok when This :: wxHelpEvent(), Pt :: {X :: integer(), Y :: integer()}.

設定滑鼠左鍵點擊位置的螢幕座標。