KIWAY_EXPRESS Class Reference

Carry a payload from one KIWAY_PLAYER to another within a PROJECT. More...

#include <kiway_express.h>

Inheritance diagram for KIWAY_EXPRESS:

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 54 of file kiway_express.cpp.

KIWAY_EXPRESS() [2/2]

KIWAY_EXPRESS::KIWAY_EXPRESS

(

const KIWAY_EXPRESS &

anOther

)

Definition at line 46 of file kiway_express.cpp.

Member Function Documentation

Clone()

KIWAY_EXPRESS * KIWAY_EXPRESS::Clone ( ) const

inlineoverride

Definition at line 61 of file kiway_express.h.

Command()

MAIL_T 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(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), FOOTPRINT_CHOOSER_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), and FOOTPRINT_VIEWER_FRAME::KiwayMailIn().

Dest()

FRAME_T KIWAY_EXPRESS::Dest ( )

inline

Return the destination player id of the message.

Definition at line 45 of file kiway_express.h.

Referenced by KIWAY::ProcessEvent().

GetPayload()

std::string & KIWAY_EXPRESS::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.

Referenced by CVPCB_MAINFRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), FOOTPRINT_CHOOSER_FRAME::KiwayMailIn(), and FOOTPRINT_EDIT_FRAME::KiwayMailIn().

SetPayload()

void KIWAY_EXPRESS::SetPayload ( const std::string &  aPayload )

inline

Definition at line 59 of file kiway_express.h.

Member Data Documentation

m_destination

FRAME_T KIWAY_EXPRESS::m_destination

private

could have been a bitmap indicating multiple recipients.

Definition at line 78 of file kiway_express.h.

m_payload

std::string& KIWAY_EXPRESS::m_payload

private

very often s-expression text, but not always.

Definition at line 79 of file kiway_express.h.

wxEVENT_ID

const wxEventType KIWAY_EXPRESS::wxEVENT_ID = 30000

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.

---

The documentation for this class was generated from the following files:

• kiway_express.h
• kiway_express.cpp