Lugaru's Epsilon
Programmer's
Editor

Context:
Epsilon User's Manual and Reference
   Primitives and EEL Subroutines
      Operating System Primitives
         System Primitives
         Window System Primitives
            WinHelp Interface
            Menu Bar Primitives
            Tool Bar Primitives
            . . .
         Timing
         . . .

Previous   Up    Next
Window System Primitives  Primitives and EEL Subroutines   Menu Bar Primitives


Epsilon User's Manual and Reference > Primitives and EEL Subroutines > Operating System Primitives > Window System Primitives >

WinHelp Interface

These Windows-only functions support HtmlHelp files and (for older Windows versions that include it) WinHelp files.

int win_help_contents(char *file)

The win_help_contents( ) primitive displays the contents page of the specified Windows help file. If the file parameter is "", it uses Epsilon's help file, displaying help on Epsilon. The function returns a nonzero value if it was successful.

int win_help_string(char *file, char *key)

The win_help_string( ) primitive looks up the entry for key in the specified Windows help file. If the key parameter is "", it shows the list of possible keywords. If the file parameter is "", it uses Epsilon's help file, displaying help on Epsilon. The function returns a nonzero value if it was successful.

windows_help_from(char *file, int show_contents)

The windows_help_from( ) subroutine wraps the above two subroutines. If there's a suitable highlighted region, it calls win_help_string( ) to display help on the keyword text in the highlighted region. Otherwise, it either displays the help file's contents topic (if show_contents is nonzero), or the help file's keyword index. The windows_help_from( ) subroutine also handles tasks like displaying an error if the user isn't running Epsilon for Windows.



Previous   Up    Next
Window System Primitives  Primitives and EEL Subroutines   Menu Bar Primitives


Lugaru Copyright (C) 1984, 2012 Lugaru Software Ltd. All Rights Reserved.