KIWAY_MAIL_EVENT Class Reference

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

#include <kiway_mail.h>

Inheritance diagram for KIWAY_MAIL_EVENT:

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_MAIL_EVENT *	Clone () const override
	KIWAY_MAIL_EVENT (FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
	KIWAY_MAIL_EVENT (const KIWAY_MAIL_EVENT &anOther)

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 37 of file kiway_mail.h.

Constructor & Destructor Documentation

KIWAY_MAIL_EVENT() [1/2]

KIWAY_MAIL_EVENT::KIWAY_MAIL_EVENT	(	FRAME_T	aDestination,
		MAIL_T	aCommand,
		std::string &	aPayload,
		wxWindow *	aSource = nullptr )

Definition at line 39 of file kiway_mail.cpp.

References m_destination, and m_payload.

Referenced by Clone(), and KIWAY_MAIL_EVENT().

KIWAY_MAIL_EVENT() [2/2]

KIWAY_MAIL_EVENT::KIWAY_MAIL_EVENT

(

const KIWAY_MAIL_EVENT &

anOther

)

Definition at line 31 of file kiway_mail.cpp.

References KIWAY_MAIL_EVENT(), m_destination, and m_payload.

Member Function Documentation

Clone()

KIWAY_MAIL_EVENT * KIWAY_MAIL_EVENT::Clone ( ) const

inlineoverride

Definition at line 59 of file kiway_mail.h.

References KIWAY_MAIL_EVENT().

Command()

MAIL_T KIWAY_MAIL_EVENT::Command ( )

inline

Returns the MAIL_T associated with this mail.

Definition at line 48 of file kiway_mail.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()

FRAME_T KIWAY_MAIL_EVENT::Dest ( )

inline

Return the destination player id of the message.

Definition at line 43 of file kiway_mail.h.

References m_destination.

Referenced by KIWAY::ProcessEvent(), and KIWAY::QueueEvent().

GetPayload()

std::string & KIWAY_MAIL_EVENT::GetPayload ( )

inline

Return the payload, which can be any text but it typically self identifying s-expression.

Definition at line 56 of file kiway_mail.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()

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

inline

Definition at line 57 of file kiway_mail.h.

References m_payload.

Member Data Documentation

m_destination

FRAME_T KIWAY_MAIL_EVENT::m_destination

private

could have been a bitmap indicating multiple recipients.

Definition at line 67 of file kiway_mail.h.

Referenced by Dest(), KIWAY_MAIL_EVENT(), and KIWAY_MAIL_EVENT().

m_payload

std::string& KIWAY_MAIL_EVENT::m_payload

private

very often s-expression text, but not always.

Definition at line 68 of file kiway_mail.h.

Referenced by GetPayload(), KIWAY_MAIL_EVENT(), KIWAY_MAIL_EVENT(), and SetPayload().

---

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

• kiway_mail.h
• kiway_mail.cpp