KiCad PCB EDA Suite
kiway_express.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2014 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2014-202 KiCad Developers, see CHANGELOG.TXT for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef KIWAY_EXPRESS_H_
26 #define KIWAY_EXPRESS_H_
27 
28 // @see http://wiki.wxwidgets.org/Custom_Events_Tutorial
29 #include <frame_type.h>
30 #include <mail_type.h>
31 #include <wx/string.h>
32 #include <wx/event.h>
33 
34 
38 class KIWAY_EXPRESS : public wxEvent
39 {
40 public:
44  FRAME_T Dest() { return m_destination; }
45 
50  {
51  return (MAIL_T) GetId(); // re-purposed control id.
52  }
53 
57  std::string& GetPayload() { return m_payload; }
58  void SetPayload( const std::string& aPayload ) { m_payload = aPayload; }
59 
60  KIWAY_EXPRESS* Clone() const override { return new KIWAY_EXPRESS( *this ); }
61 
62  //KIWAY_EXPRESS() {}
63 
64  KIWAY_EXPRESS( FRAME_T aDestination, MAIL_T aCommand, std::string& aPayload,
65  wxWindow* aSource = nullptr );
66 
67  KIWAY_EXPRESS( const KIWAY_EXPRESS& anOther );
68 
72  static const wxEventType wxEVENT_ID;
73 
74  //DECLARE_DYNAMIC_CLASS( KIWAY_EXPRESS )
75 
76 private:
78  std::string& m_payload;
79 
80  // possible new ideas here.
81 };
82 
83 
84 typedef void ( wxEvtHandler::*kiwayExpressFunction )( KIWAY_EXPRESS& );
85 
87 #define kiwayExpressHandler( func ) wxEVENT_HANDLER_CAST( kiwayExpressFunction, func )
88 
90 #define EVT_KIWAY_EXPRESS( func ) \
91  wx__DECLARE_EVT0( KIWAY_EXPRESS::wxEVENT_ID, kiwayExpressHandler( func ) )
92 
93 #endif // KIWAY_EXPRESS_H_
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
Definition: kiway_express.h:38
void(wxEvtHandler::* kiwayExpressFunction)(KIWAY_EXPRESS &)
Definition: kiway_express.h:84
static const wxEventType wxEVENT_ID
The wxEventType argument to wxEvent() and identifies an event class in a hurry.
Definition: kiway_express.h:72
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:32
void SetPayload(const std::string &aPayload)
Definition: kiway_express.h:58
FRAME_T m_destination
could have been a bitmap indicating multiple recipients.
Definition: kiway_express.h:77
MAIL_T
The set of mail types sendable via KIWAY::ExpressMail() and supplied as the aCommand parameter to tha...
Definition: mail_type.h:37
std::string & m_payload
very often s-expression text, but not always.
Definition: kiway_express.h:78
FRAME_T Dest()
Return the destination player id of the message.
Definition: kiway_express.h:44
KIWAY_EXPRESS(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
KIWAY_EXPRESS * Clone() const override
Definition: kiway_express.h:60
MAIL_T Command()
Returns the MAIL_T associated with this mail.
Definition: kiway_express.h:49
std::string & GetPayload()
Return the payload, which can be any text but it typically self identifying s-expression.
Definition: kiway_express.h:57