number_badge.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef NUMBER_BADGE_H_
#define NUMBER_BADGE_H_
 
#include <widgets/ui_common.h>
#include <wx/dcclient.h>
#include <wx/panel.h>
#include <kicommon.h>
 

class KICOMMON_API NUMBER_BADGE : public wxPanel
{
public:
    NUMBER_BADGE( wxWindow* aParent, wxWindowID aId, const wxPoint& aPos,
                  const wxSize& aSize, int aStyles );

    void UpdateNumber( int aNumber, SEVERITY aSeverity );

    void SetMaximumNumber( int aMax );

    void SetTextSize( int aSize );
 
protected:
    void computeSize();

    void onPaint( wxPaintEvent& aEvt );
 
    int      m_textSize;        // The text size to use
    int      m_maxNumber;       // The maximum number allowed to be shown on the badge
 
    int      m_currentNumber;   // The current number to display
    bool     m_showBadge;       // If true, displays the actual badge otherwise it is invisible
    wxColour m_badgeColour;     // The color of the badge
    wxColour m_textColour;      // The color of the text on the badge
};
 
#endif