84 lines
2.9 KiB
C++
84 lines
2.9 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2014 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
|
|
* Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#ifndef KIWAY_MAIL_H
|
|
#define KIWAY_MAIL_H
|
|
|
|
#include <frame_type.h>
|
|
#include <mail_type.h>
|
|
#include <kicommon.h>
|
|
#include <wx/string.h>
|
|
#include <wx/event.h>
|
|
|
|
/**
|
|
* Carry a payload from one #KIWAY_PLAYER to another within a #PROJECT.
|
|
*/
|
|
class KICOMMON_API KIWAY_MAIL_EVENT : public wxEvent
|
|
{
|
|
public:
|
|
/**
|
|
* Return the destination player id of the message.
|
|
*/
|
|
FRAME_T Dest() { return m_destination; }
|
|
|
|
/**
|
|
* Returns the #MAIL_T associated with this mail.
|
|
*/
|
|
MAIL_T Command()
|
|
{
|
|
return (MAIL_T) GetId(); // re-purposed control id.
|
|
}
|
|
|
|
/**
|
|
* Return the payload, which can be any text but it typically self identifying s-expression.
|
|
*/
|
|
std::string& GetPayload() { return m_payload; }
|
|
void SetPayload( const std::string& aPayload ) { m_payload = aPayload; }
|
|
|
|
KIWAY_MAIL_EVENT* Clone() const override { return new KIWAY_MAIL_EVENT( *this ); }
|
|
|
|
KIWAY_MAIL_EVENT( FRAME_T aDestination, MAIL_T aCommand, std::string& aPayload,
|
|
wxWindow* aSource = nullptr );
|
|
|
|
KIWAY_MAIL_EVENT( const KIWAY_MAIL_EVENT& anOther );
|
|
|
|
private:
|
|
FRAME_T m_destination; ///< could have been a bitmap indicating multiple recipients.
|
|
std::string& m_payload; ///< very often s-expression text, but not always.
|
|
};
|
|
|
|
|
|
typedef void ( wxEvtHandler::*kiwayMailFunction )( KIWAY_MAIL_EVENT& );
|
|
|
|
/// Typecast an event handler for the KIWAY_ROUTED_EVENT event class
|
|
#define kiwayMailHandler( func ) wxEVENT_HANDLER_CAST( kiwayMailFunction, func )
|
|
|
|
/// Event table definition for the KIWAY_ROUTED_EVENT event class
|
|
#define EVT_KIWAY_EXPRESS( func ) \
|
|
wx__DECLARE_EVT0( EDA_KIWAY_MAIL_RECEIVED, kiwayMailHandler( func ) )
|
|
|
|
wxDECLARE_EXPORTED_EVENT( KICOMMON_API, EDA_KIWAY_MAIL_RECEIVED, KIWAY_MAIL_EVENT );
|
|
|
|
#endif // KIWAY_EXPRESS_H_
|