KiCad PCB EDA Suite
status_text_reporter.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) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
29 #ifndef STATUS_TEXT_REPORTER_H_
30 #define STATUS_TEXT_REPORTER_H_
31 
32 #include <reporter.h>
33 
39 {
40 private:
41  wxStatusBar *m_parentStatusBar;
44 
45 public:
46  STATUS_TEXT_REPORTER( wxStatusBar* aParentStatusBar, int aPosition = 0 ) :
47  REPORTER(),
48  m_parentStatusBar( aParentStatusBar ), m_position( aPosition )
49  {
50  m_hasMessage = false;
51  }
52 
53  REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED ) override
54  {
55  if( !aText.IsEmpty() )
56  m_hasMessage = true;
57 
58  if( m_parentStatusBar )
59  m_parentStatusBar->SetStatusText( aText, m_position );
60 
61  return *this;
62  }
63 
64  bool HasMessage() const { return m_hasMessage; }
65 };
66 
67 
68 #endif // STATUS_TEXT_REPORTER_H_
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
SEVERITY
Severity of the reported messages.
Definition: reporter.h:65
wxStatusBar * m_parentStatusBar
Class STATUS_TEXT_REPORTER is a wrapper for reporting to a wxString in a wxFrame status text...
STATUS_TEXT_REPORTER(wxStatusBar *aParentStatusBar, int aPosition=0)
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED) override
Function Report is a pure virtual function to override in the derived object.