kistatusbar.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Mark Roszko <[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 KISTATUSBAR_H
#define KISTATUSBAR_H
 
#include <kicommon.h>
#include <optional>
#include <mutex>
#include <vector>
#include <widgets/report_severity.h>
#include <wx/statusbr.h>
 
class wxGauge;
class wxButton;
class wxStaticText;
class BITMAP_BUTTON;


struct LOAD_MESSAGE
{
    wxString  message;
    SEVERITY  severity;
};
 
 
class KICOMMON_API KISTATUSBAR : public wxStatusBar
{
public:
    enum STYLE_FLAGS : int
    {
        NONE_STYLE        = 0x00,
        NOTIFICATION_ICON = 0x01,
        CANCEL_BUTTON     = 0x02,
        WARNING_ICON      = 0x04,
    };
 
    static constexpr auto DEFAULT_STYLE =
            static_cast<STYLE_FLAGS>( NOTIFICATION_ICON | CANCEL_BUTTON );
 
    KISTATUSBAR( int aNumberFields, wxWindow* parent, wxWindowID id,
                 STYLE_FLAGS aFlags = DEFAULT_STYLE );
 
    ~KISTATUSBAR();

    void SetEllipsedTextField( const wxString& aText, int aFieldId );

    void ShowBackgroundProgressBar( bool aCancellable = false );

    void HideBackgroundProgressBar();

    void SetBackgroundProgress( int aAmount );

    void SetBackgroundProgressMax( int aAmount );

    void SetBackgroundStatusText( const wxString& aTxt );

    void SetNotificationCount( int aCount );
 
    void SetLoadWarningMessages( const wxString& aMessages );
    void ClearLoadWarningMessages();

    void AddLoadWarningMessages( const std::vector<LOAD_MESSAGE>& aMessages );

    size_t GetLoadWarningCount() const;
 
private:
    void onSize( wxSizeEvent& aEvent );
    void onBackgroundProgressClick( wxMouseEvent& aEvent );
    void onNotificationsIconClick( wxCommandEvent& aEvent );
    void onLoadWarningsIconClick( wxCommandEvent& aEvent );
    void updateWarningUI();  
 
    enum class FIELD
    {
        BGJOB_LABEL,
        BGJOB_GAUGE,
        BGJOB_CANCEL,
        WARNING,
        NOTIFICATION
    };
 
    std::optional<int> fieldIndex( FIELD aField ) const;
 
private:
    wxGauge*       m_backgroundProgressBar;
    wxButton*      m_backgroundStopButton;
    wxStaticText*  m_backgroundTxt;
    BITMAP_BUTTON* m_notificationsButton;
    BITMAP_BUTTON* m_warningButton;
    mutable std::mutex m_loadWarningMutex;  
    std::vector<LOAD_MESSAGE> m_loadWarningMessages;
    int            m_normalFieldsCount;
    STYLE_FLAGS    m_styleFlags;
};
 
#endif