Package RASCAL.Configure

DescriptionEvent definitions for the !Configure plugin protocol.
Authorbbracke
Date2005/11/21 20:14:33
Revision1.1
 

Clauses

Quick access : Clauses -  Generics -  Definitions -  Subprograms

 
Context clauses
RASCAL.OS
 
Use clauses
RASCAL.OS
 

Basic Objects

Quick access : Clauses -  Generics -  Definitions -  Subprograms

Basic Objects
Name Type Default
Top_Level_CPIInteger16#50DBF#constant
Boot_CPIInteger16#50DBE#constant
Font_CPIInteger16#50DBD#constant
Network_CPIInteger16#50DBC#constant
Sound_CPIInteger16#50DBB#constant
Disc_CPIInteger16#50DBA#constant
Screen_CPIInteger16#50DB9#constant
Apps_CPIInteger16#50DB8#constant
Extension_CPIInteger16#50DB7#constant
System_Tools_CPIInteger16#50DB6#constant
Window_CPIInteger16#50DB5#constant
User_CPIInteger16#50DB4#constant
 

Definitions

Quick access : Clauses -  Generics -  Definitions -  Subprograms

Types
Name Declaration
Message_PlugInQuit_Pointeraccess Message_PlugInQuit
Message_PlugInQuitContinue_Pointeraccess Message_PlugInQuitContinue
Message_PlugInQuitAbort_Pointeraccess Message_PlugInQuitAbort
Message_OpenConfigWindow_Pointeraccess Message_OpenConfigWindow
   
Message_PlugInQuit record
This message is sent to plug-ins to let them know that they are about to be quit, in order to allow them to take action if they have unsaved data.
If a top-level parent plug-in is sending this message to a second-level child plug-in as a result of the user clicking on Set , bit 1 will be set in the flag word.
The child plug-in should therefore save its data immediately and not issue a promp.
Component Type Default
FlagsInteger
DescriptorInteger
HeaderMessage_Event_Header
   
AMEL_Message_PlugInQuit abstract tagged record
inheritance from Message_EventListener (Message_Event_PlugInQuit)
Component Type Default
EventMessage_PlugInQuit_Pointer
   
Message_PlugInQuitContinue record
This message is sent by plug-ins to their parent application to tell the parent to resume the quitting process.
(i.e. Configure for top-level plug-ins, or the parent plug-in for second-level plug-ins)
In other words, the message is sent once the user has chosen to discard or save data, but not to abort the quit operation.
Component Type Default
DescriptorInteger
HeaderMessage_Event_Header
   
AMEL_Message_PlugInQuitContinue abstract tagged record
inheritance from Message_EventListener (Message_Event_PlugInQuitContinue)
Component Type Default
EventMessage_PlugInQuitContinue_Pointer
   
Message_PlugInQuitAbort record
This message is sent by a plug-in if the user chooses to cancel the quit procedure when offered the choice of Discard, Save or Cancel.
On receipt of this message from a plug-in of its own class, the plug-in should reset its internal 'complain' flag and once again be ready to complain at subsequent quits.
Component Type Default
DescriptorInteger
HeaderMessage_Event_Header
   
AMEL_Message_PlugInQuitAbort abstract tagged record
inheritance from Message_EventListener (Message_Event_PlugInQuitAbort)
Component Type Default
EventMessage_PlugInQuitAbort_Pointer
   
Message_OpenConfigWindow record
If a plug-in receives this message from Configure, it means that the user has 'lost' the window on the screen and has clicked the plug-in's icon in Configure again.
The action to take is very simple: we must bring our window to the front of the window stack, but we must not move it to a new position.
Nor must we alter its contents in any way
Component Type Default
HeaderMessage_Event_Header
   
AMEL_Message_OpenConfigWindow abstract tagged record
inheritance from Message_EventListener (Message_Event_OpenConfigWindow)
Component Type Default
EventMessage_OpenConfigWindow_Pointer
  
Pragmas
Convention(C, Message_PlugInQuit)
Convention(C, Message_PlugInQuitContinue)
Convention(C, Message_PlugInQuitAbort)
Convention(C, Message_OpenConfigWindow)