Package RASCAL.OLE

DescriptionOLE related types and methods.
Authorbbracke
Date2005/11/21 20:14:33
Revision1.1
 

Clauses

Quick access : Clauses -  Generics -  Definitions -  Subprograms

 
Context clauses
System.Unsigned_Types
RASCAL.OS
 
Use clauses
RASCAL.OS
 

Definitions

Quick access : Clauses -  Generics -  Definitions -  Subprograms

Types
Name Declaration
OLE_Message_Type(Try_Edit, Run_And_Edit, ReEdit)
Message_OLEFileChanged_Pointeraccess Message_OLEFileChanged
Message_OLEOpenSession_Pointeraccess Message_OLEOpenSession
Message_OLEOpenSessionAck_Pointeraccess Message_OLEOpenSessionAck
Message_OLECloseSession_Pointeraccess Message_OLECloseSession
   
Message_OLEFileChanged record
Pathname is only valid if Message_Kind is Try_Edit
Component Type Default
PathnameChar_Array (1..228)
Session_NumberInteger
Message_KindOLE_Message_Type
HeaderMessage_Event_Header
   
AMEL_Message_OLEFileChanged abstract tagged record
inheritance from Message_EventListener (Message_Event_OLE_FileChanged)
Component Type Default
EventMessage_OLEFileChanged_Pointer
   
Message_OLEOpenSession record
This message requests a server to edit some data.
The normal procedure is to use message_Type Try_Edit initially, then if that bounces Run_And_Edit.
If the server already exists, ReEdit is used.
Filetype and pathname are only valid if message_kind is not reedit.
Component Type Default
PathnameChar_Array (1..196)
File_TypeInteger
Session_NumberInteger
Message_KindOLE_Message_Type
Y_CoordinateInteger
X_CoordinateInteger
Window_HandleWimp_Handle_Type
Unique_NameChar_Array (1..16)
HeaderMessage_Event_Header
   
AMEL_Message_OLEOpenSession abstract tagged record
inheritance from Message_EventListener (Message_Event_OLEOpenSession)
Component Type Default
EventMessage_OLEOpenSession_Pointer
   
Message_OLEOpenSessionAck record
The OLE server replies to OLE_OpenSession by changing message_id to OLE_OpenSessionAck, setting your_ref = my_ref, and sending it back.
Client then knows which task is editing its file.
It is returned in reply to an OLEOpenSession message. Server has loaded file, and has established the link.
Filetype and pathname are only valid if message_kind is not reedit.
Component Type Default
PathnameChar_Array (1..196)
File_TypeInteger
Session_NumberInteger
Message_KindOLE_Message_Type
Y_CoordinateInteger
X_CoordinateInteger
Window_HandleWimp_Handle_Type
Unique_NameChar_Array (1..16)
HeaderMessage_Event_Header
   
AMEL_Message_OLEOpenSessionAck abstract tagged record
inheritance from Message_EventListener (Message_Event_OLEOpenSessionAck)
Component Type Default
EventMessage_OLEOpenSessionAck_Pointer
   
Message_OLECloseSession record
This message informs one or all clients that one or all of the servers sessions are terminated (Task quit or click on close window).
Component Type Default
Session_NumberInteger
Message_KindOLE_Message_Type
HeaderMessage_Event_Header
   
AMEL_Message_OLECloseSession abstract tagged record
inheritance from Message_EventListener (Message_Event_OLECloseSession)
Component Type Default
EventMessage_OLECloseSession_Pointer
  
Pragmas
Convention(C, Message_OLEFileChanged)
Convention(C, Message_OLEOpenSession)
Convention(C, Message_OLEOpenSessionAck)
Convention(C, Message_OLECloseSession)