Carry a payload from one KIWAY_PLAYER to another within a PROJECT. More...
#include <kiway_express.h>
Public Member Functions | |
| FRAME_T | Dest () |
| Return the destination player id of the message. | |
| MAIL_T | Command () |
| Returns the MAIL_T associated with this mail. | |
| std::string & | GetPayload () |
| Return the payload, which can be any text but it typically self identifying s-expression. | |
| void | SetPayload (const std::string &aPayload) |
| KIWAY_EXPRESS * | Clone () const override |
| KIWAY_EXPRESS (FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr) | |
| KIWAY_EXPRESS (const KIWAY_EXPRESS &anOther) | |
Static Public Attributes | |
| static const wxEventType | wxEVENT_ID = 30000 |
| The wxEventType argument to wxEvent() and identifies an event class in a hurry. | |
Private Attributes | |
| FRAME_T | m_destination |
| could have been a bitmap indicating multiple recipients. | |
| std::string & | m_payload |
| very often s-expression text, but not always. | |
Detailed Description
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
Definition at line 39 of file kiway_express.h.
Constructor & Destructor Documentation
◆ KIWAY_EXPRESS() [1/2]
| KIWAY_EXPRESS::KIWAY_EXPRESS | ( | FRAME_T | aDestination, |
| MAIL_T | aCommand, | ||
| std::string & | aPayload, | ||
| wxWindow * | aSource = nullptr ) |
Definition at line 55 of file kiway_express.cpp.
References m_destination, m_payload, and wxEVENT_ID.
Referenced by Clone(), and KIWAY_EXPRESS().
◆ KIWAY_EXPRESS() [2/2]
| KIWAY_EXPRESS::KIWAY_EXPRESS | ( | const KIWAY_EXPRESS & | anOther | ) |
Definition at line 47 of file kiway_express.cpp.
References KIWAY_EXPRESS(), m_destination, and m_payload.
Member Function Documentation
◆ Clone()
|
inlineoverride |
Definition at line 61 of file kiway_express.h.
References KIWAY_EXPRESS().
◆ Command()
|
inline |
Returns the MAIL_T associated with this mail.
Definition at line 50 of file kiway_express.h.
Referenced by CVPCB_MAINFRAME::KiwayMailIn(), FOOTPRINT_CHOOSER_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_VIEWER_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), and SYMBOL_VIEWER_FRAME::KiwayMailIn().
◆ Dest()
|
inline |
Return the destination player id of the message.
Definition at line 45 of file kiway_express.h.
References m_destination.
Referenced by KIWAY::ProcessEvent(), and KIWAY::QueueEvent().
◆ GetPayload()
|
inline |
Return the payload, which can be any text but it typically self identifying s-expression.
Definition at line 58 of file kiway_express.h.
References m_payload.
Referenced by CVPCB_MAINFRAME::KiwayMailIn(), FOOTPRINT_CHOOSER_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), and SYMBOL_VIEWER_FRAME::KiwayMailIn().
◆ SetPayload()
|
inline |
Definition at line 59 of file kiway_express.h.
References m_payload.
Member Data Documentation
◆ m_destination
|
private |
could have been a bitmap indicating multiple recipients.
Definition at line 78 of file kiway_express.h.
Referenced by Dest(), KIWAY_EXPRESS(), and KIWAY_EXPRESS().
◆ m_payload
|
private |
very often s-expression text, but not always.
Definition at line 79 of file kiway_express.h.
Referenced by GetPayload(), KIWAY_EXPRESS(), KIWAY_EXPRESS(), and SetPayload().
◆ wxEVENT_ID
|
static |
The wxEventType argument to wxEvent() and identifies an event class in a hurry.
These wxEventTypes also allow a common class to be used multiple ways. Should be allocated at startup by wxNewEventType();
Definition at line 73 of file kiway_express.h.
Referenced by KIWAY_EXPRESS().
The documentation for this class was generated from the following files:
