Guide API
Skip to main content

Module help

Module help 

Source
Expand description

Help contexts.

A HelpCtx identifies which help topic applies to the focused view — the status line and a help viewer use it to show context-sensitive help. Like Command, a help context’s identity is a namespaced static string, so app- and view-defined contexts mint their own collision-safely via HelpCtx::custom under their own dotted prefix.

Guide: Menus, status line & help.

§Turbo Vision heritage

Ports the hc* help-context family (views.h). Contexts were originally plain ints used to index a help file’s topic table; here the identity is a namespaced &'static str instead (deviation D1).

Structs§

HelpCtx
Identifies which help topic applies to the focused view.