查看源代码 wxHelpEvent (wx v2.4.3)
当用户请求上下文相关的帮助时,会发送帮助事件。
这可能是由于应用程序通过 wxContextHelp
(在 wx 中未实现)请求上下文相关的帮助模式,或者(在 MS Windows 上)由于用户按下 F1 或单击对话框标题栏中的查询按钮时,系统生成 WM_HELP 消息所致。
帮助事件会被发送到用户单击的窗口,并向上级窗口层级传播,直到事件被处理或没有更多的事件处理程序。
应用程序应调用 wxEvent:getId/1
来检查被单击窗口的标识符,然后显示一些合适的帮助或调用 wxEvent:skip/2
如果标识符无法识别。
调用 Skip 非常重要,因为它允许 wxWidgets 为被点击窗口的祖先生成进一步的事件。否则,将不可能为容器窗口显示帮助,因为在找到第一个窗口后处理就会停止。
参见
此类派生自,并且可以使用以下函数:
wxWidgets 文档: wxHelpEvent
事件
使用 wxEvtHandler:connect/3
和 wxHelpEventType
订阅此类型的事件。
概要
函数
返回帮助事件的来源,它是 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().
返回鼠标左键单击的位置,以屏幕坐标表示。
这允许应用程序适当地定位帮助。
-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()}.
设置鼠标左键单击的位置,以屏幕坐标表示。