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 <ian.s.mcinerney@ieee.org>
 * Copyright (C) 2020 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 <core/optional.h>
#include <wx/event.h>
#include <wx/infobar.h>
#include <wx/timer.h>
#include <wx/panel.h>
#include <wx/sizer.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
    };

    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;

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

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

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

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

    void Dismiss() override;

    void DismissOutdatedSave();

    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 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;           

    OPT<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;
};

#endif // INFOBAR_H_