Package RASCAL.InteractiveHelp

DescriptionEvent definitions handling messages from !Help and a subprogram to run !Help.
Authorbbracke
Date2005/11/21 20:14:33
Revision1.1
 

Clauses

Quick access : Clauses -  Generics -  Definitions -  Subprograms

 
Context clauses
RASCAL.OS
Interfaces.C
 
Use clauses
RASCAL.OS
Interfaces.C
 

Definitions

Quick access : Clauses -  Generics -  Definitions -  Subprograms

Types
Name Declaration
Help_Enable_Flag_Type(Enable, Disable, Reread_Config)
Message_HelpRequest_Pointeraccess Message_HelpRequest
Message_HelpReply_Pointeraccess Message_HelpReply
Message_HelpEnable_Pointeraccess Message_HelpEnable
   
Message_HelpRequest record
The !Help application sends out this message.

If you want to give help on the given window and icon, then reply with a HelpReply message.
Component Type Default
IconIcon_handle_Type
WindowWimp_Handle_Type
Button_StateInteger
Mouse_YInteger
Mouse_XInteger
HeaderMessage_Event_Header
   
AMEL_Message_HelpRequest abstract tagged record
inheritance from Message_EventListener (Message_Event_HelpRequest)
Component Type Default
EventMessage_HelpRequest_Pointer
   
Message_HelpReply record
This message is sent by an application in reply to a HelpRequest message.
Escape codes may be used under RISC OS 3 !Help or equivalent.
The current !Help implementation passes the message block direct to OS_GSTrans before checking for "\\" escape codes.
Passing CR or LF terminated strings and using "|" codes other than {fCode}|M{f} is undocumented.
Component Type Default
HelpChar_Array (1..235)
HeaderMessage_Event_Header
   
AMEL_Message_HelpReply abstract tagged record
inheritance from Message_EventListener (Message_Event_HelpReply)
Component Type Default
EventMessage_HelpReply_Pointer
   
Message_HelpEnable record
Used for the RISC OS 4 !Help application and allows configuration to be handled by another program.
Component Type Default
FlagHelp_Enable_Flag_Type
HeaderMessage_Event_Header
   
AMEL_Message_HelpEnable abstract tagged record
inheritance from Message_EventListener (Message_Event_HelpEnable)
Component Type Default
EventMessage_HelpEnable_Pointer
  
Exceptions
Help_Not_Found
  
Pragmas
Convention(C, Message_HelpRequest)
Convention(C, Message_HelpReply)
Convention(C, Message_HelpEnable)
 

Subprograms

Quick access : Clauses -  Generics -  Definitions -  Subprograms

  
Run procedure
Run the Interactive Help application.