26 #ifndef TBX_WIMPMESSAGELISTENER_H_
27 #define TBX_WIMPMESSAGELISTENER_H_
191 enum SendType {User = 17, Recorded = 18, Acknowledge = 19};
196 int send(
SendType type,
int destination,
int icon_handle = 0);
int message_id() const
Get the message ID.
Definition: wimpmessagelistener.h:110
void claim()
Claim the event so no other listeners process it.
Definition: wimpmessagelistener.h:229
A library for creating RISC OS toolbox applications.
Definition: abouttobeshownlistener.cc:35
virtual ~WimpMessageListener()
Destructor.
Definition: wimpmessagelistener.h:246
const char * str(int index) const
Return char * for part of the message.
Definition: wimpmessagelistener.h:175
void my_ref(int ref)
Set my reference for the message.
Definition: wimpmessagelistener.h:117
Class to represent toolbox iconbar icon.
Definition: iconbar.h:45
virtual ~WimpRecordedMessageListener()
Destructor does nothing.
Definition: wimpmessagelistener.h:275
int operator[](int index) const
Get message word (integer)
Definition: wimpmessagelistener.h:156
Base for listener for wimp messages.
Definition: wimpmessagelistener.h:241
SendType
Enumeration specifying the type of message to send.
Definition: wimpmessagelistener.h:191
Structure holding the raw data from a call to Wimp_Poll.
Definition: pollinfo.h:72
Listener to handle WimpRecordedMessages (event code 18)
Definition: wimpmessagelistener.h:270
SpecialDestination
Enumeration with special targets for sending messages to.
Definition: wimpmessagelistener.h:195
int word(int index) const
Get message word (integer)
Definition: wimpmessagelistener.h:138
virtual ~WimpUserMessageListener()
Destructor does nothing.
Definition: wimpmessagelistener.h:258
Wimp message information.
Definition: wimpmessagelistener.h:37
void your_ref(int ref)
Set your reference for the message.
Definition: wimpmessagelistener.h:123
int my_ref() const
Get my reference from the message.
Definition: wimpmessagelistener.h:102
int send(SendType type, int destination, int icon_handle=0)
Send a message to another application.
Definition: wimpmessagelistener.cc:107
virtual void user_message(WimpMessageEvent &event)
Override this to process user messages.
Definition: wimpmessagelistener.h:263
WimpMessage & operator=(const WimpMessage &other)
Assignment creates a copy of an existing message.
Definition: wimpmessagelistener.cc:75
virtual void recorded_message(WimpMessageEvent &event, int reply_to)
Override this to process recorded user messages.
Definition: wimpmessagelistener.h:283
WimpMessageEvent(PollBlock &poll_block)
Constructor.
Definition: wimpmessagelistener.h:219
const WimpMessage & message() const
WimpMessage that was received.
Definition: wimpmessagelistener.h:224
void message_id(int id)
Set the message id for the message.
Definition: wimpmessagelistener.h:129
virtual ~WimpAcknowledgeMessageListener()
Destructor does nothing.
Definition: wimpmessagelistener.h:295
Listener to handle WimpUserMessages (event code 17)
Definition: wimpmessagelistener.h:253
virtual ~WimpMessage()
Destructor for WimpMessage.
Definition: wimpmessagelistener.cc:90
Wimp message received event.
Definition: wimpmessagelistener.h:210
WimpMessage(PollBlock &poll_block)
Use to refer to a message in an existing wimp poll block.
Definition: wimpmessagelistener.cc:31
char * str(int index)
Return char * for part of the message.
Definition: wimpmessagelistener.h:185
virtual void acknowledge_message(WimpMessageEvent &event)
Override this to process an acknowledgement.
Definition: wimpmessagelistener.h:299
int sender_task_handle() const
Get task handle of sender.
Definition: wimpmessagelistener.h:98
bool _owns_block
True if the message data will be deleted when this object is deleted.
Definition: wimpmessagelistener.h:200
bool claimed() const
Has the event been claimed.
Definition: wimpmessagelistener.h:234
Listener to handle WimpAcnowledgeMessages (event code 19)
Definition: wimpmessagelistener.h:290
int your_ref() const
Get your reference from the message.
Definition: wimpmessagelistener.h:106
int & word(int index)
Return reference to message word so it can be updated.
Definition: wimpmessagelistener.h:147
int block_size() const
Get length of block, 20 - 256 bytes, a whole number of words.
Definition: wimpmessagelistener.h:94
int * _message_block
pointer to the message data
Definition: wimpmessagelistener.h:199