indicator_icon.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017-2021 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 ROW_INDICATOR__H_
#define ROW_INDICATOR__H_

#include <wx/statbmp.h>
#include <wx/panel.h>

class wxStaticBitmap;

class INDICATOR_ICON : public wxPanel
{
public:

 using ICON_ID = int;

 class ICON_PROVIDER
 {
 public:

 virtual ~ICON_PROVIDER() {};

 virtual const wxBitmap& GetIndicatorIcon( ICON_ID aIconId ) const = 0;
 };

 static ICON_PROVIDER& GetDefaultRowIconProvider( bool aAlternative );

 INDICATOR_ICON( wxWindow* aParent, ICON_PROVIDER& aIconProvider,
 ICON_ID aInitialIcon, int aID );

 void SetIndicatorState( ICON_ID aIconId );


 ICON_ID GetIndicatorState() const;

 void SetWindowID( wxWindowID aId )
 {
 SetId( aId );
 m_bitmap->SetId( aId );
 }

private:

 ICON_PROVIDER& m_iconProvider;

 wxStaticBitmap* m_bitmap;

 ICON_ID m_currentId;
};


class ROW_ICON_PROVIDER: public INDICATOR_ICON::ICON_PROVIDER
{
public:

 enum STATE
 {
 OFF, 
 DIMMED, 
 ON, 
 UP, 
 DOWN, 
 };

 ROW_ICON_PROVIDER( int aSize );

 const wxBitmap& GetIndicatorIcon( INDICATOR_ICON::ICON_ID aIconId ) const override;

private:
 wxBitmap m_blankBitmap;
 wxBitmap m_rightArrowBitmap;
 wxBitmap m_upArrowBitmap;
 wxBitmap m_downArrowBitmap;
 wxBitmap m_dotBitmap;
};


#endif // ROW_INDICATOR__H_