User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.99

Expand All
Contract All

Table of Contents

# wxHelpEvent

### MODULE

wxHelpEvent

### MODULE SUMMARY

See external documentation: wxHelpEvent.

### DESCRIPTION

See external documentation: wxHelpEvent.

Use wxEvtHandler:connect/3 with EventType:

  help, detailed_help

See also the message variant #wxHelp{} event record type.

This class is derived (and can use functions) from:
wxEvent

### DATA TYPES

wxHelpEvent()

  An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

### EXPORTS

getOrigin(This::wxHelpEvent()) -> Origin

Types:

Origin = integer()

See external documentation.
Origin is one of ?wxHelpEvent_Origin_Unknown | ?wxHelpEvent_Origin_Keyboard | ?wxHelpEvent_Origin_HelpButton

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

See external documentation.

setOrigin(This::wxHelpEvent(), Origin) -> ok

Types:

Origin = integer()

See external documentation.
Origin is one of ?wxHelpEvent_Origin_Unknown | ?wxHelpEvent_Origin_Keyboard | ?wxHelpEvent_Origin_HelpButton

setPosition(This::wxHelpEvent(), Pos::{X::integer(), Y::integer()}) -> ok

See external documentation.