wx_infobar.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Ian McInerney <[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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef INFOBAR_H_
#define INFOBAR_H_
 
#include <functional>
#include <optional>
#include <wx/event.h>
#include <wx/infobar.h>
#include <wx/timer.h>
#include <wx/panel.h>
#include <wx/sizer.h>
#include <reporter.h>
 
 
class wxAuiManager;
class wxHyperlinkCtrl;
 
 
enum
{
    ID_CLOSE_INFOBAR = 2000,
};
 
 
wxDECLARE_EVENT( KIEVT_SHOW_INFOBAR,    wxCommandEvent );
wxDECLARE_EVENT( KIEVT_DISMISS_INFOBAR, wxCommandEvent );

class WX_INFOBAR : public wxInfoBarGeneric
{
public:
    WX_INFOBAR( wxWindow* aParent, wxAuiManager* aMgr = nullptr, wxWindowID aWinid = wxID_ANY );
 
    ~WX_INFOBAR();
 

    enum class MESSAGE_TYPE
    {
        GENERIC,          
        OUTDATED_SAVE,    
        DRC_RULES_ERROR,
        DRC_VIOLATION
    };
 
    MESSAGE_TYPE GetMessageType() const { return m_type; }

    void SetShowTime( int aTime );

    void AddCloseButton( const wxString& aTooltip = _( "Hide this message." ) );

    void AddButton( wxButton* aButton );

    void AddButton( wxHyperlinkCtrl* aHypertextButton );

    void AddButton( wxWindowID aId, const wxString& aLabel = wxEmptyString ) override;

    void RemoveAllButtons();
 
    bool HasCloseButton() const;
 
    wxBitmapButton* GetCloseButton() const;

    void SetCallback( std::function<void(void)> aCallback )
    {
        m_callback = aCallback;
    }

    void ShowMessageFor( const wxString& aMessage, int aTime, int aFlags = wxICON_INFORMATION,
                         MESSAGE_TYPE aType = WX_INFOBAR::MESSAGE_TYPE::GENERIC );

    void ShowMessage( const wxString& aMessage, int aFlags = wxICON_INFORMATION ) override;

    void ShowMessage( const wxString& aMessage, int aFlags, MESSAGE_TYPE aType );

    void Dismiss() override;

    void QueueShowMessage( const wxString& aMessage, int aFlags = wxICON_INFORMATION );

    void QueueDismiss();

    bool IsLocked()
    {
        return m_updateLock;
    }
 
protected:
    void onShowInfoBar( wxCommandEvent& aEvent );

    void onDismissInfoBar( wxCommandEvent& aEvent );

    void onCloseButton( wxCommandEvent& aEvent );

    void onThemeChange( wxSysColourChangedEvent& aEvent );

    void onTimer( wxTimerEvent& aEvent );
 
    void onSize( wxSizeEvent& aEvent );

    void updateAuiLayout( bool aShow );
 
protected:
    int           m_showTime;       
    bool          m_updateLock;     
    wxTimer*      m_showTimer;      
    wxAuiManager* m_auiManager;     
    MESSAGE_TYPE  m_type;           
    wxString      m_message;        
 
    std::optional<std::function<void(void)>> m_callback;   
 
    DECLARE_EVENT_TABLE()
};
 

class EDA_INFOBAR_PANEL : public wxPanel
{
public:
    EDA_INFOBAR_PANEL( wxWindow* aParent, wxWindowID aId = wxID_ANY,
                       const wxPoint& aPos = wxDefaultPosition,
                       const wxSize& aSize = wxSize( -1,-1 ),
                       long aStyle = wxTAB_TRAVERSAL,
                       const wxString& aName = wxEmptyString );

    void AddInfoBar( WX_INFOBAR* aInfoBar );

    void AddOtherItem( wxWindow* aOtherItem );
 
protected:
    // The sizer containing the infobar and the other object
    wxFlexGridSizer* m_mainSizer;
};
 

class INFOBAR_REPORTER : public REPORTER
{
public:
    INFOBAR_REPORTER( WX_INFOBAR* aInfoBar ) :
            REPORTER(),
            m_messageSet( false ),
            m_infoBar( aInfoBar ),
            m_severity( RPT_SEVERITY_UNDEFINED )
    {
    }
 
    virtual ~INFOBAR_REPORTER() {};
 
    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    bool HasMessage() const override;

    void Finalize();
 
private:
    bool                      m_messageSet;
    WX_INFOBAR*               m_infoBar;
    std::unique_ptr<wxString> m_message;
    SEVERITY                  m_severity;
};
#endif // INFOBAR_H_