KiCad PCB EDA Suite
indicator_icon.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef ROW_INDICATOR__H_
25#define ROW_INDICATOR__H_
26
27#include <wx/statbmp.h>
28#include <wx/panel.h>
29
30class wxStaticBitmap;
31
36class INDICATOR_ICON : public wxPanel
37{
38public:
39
46 using ICON_ID = int;
47
53 {
54 public:
55
56 virtual ~ICON_PROVIDER() {};
57
64 virtual const wxBitmap& GetIndicatorIcon( ICON_ID aIconId ) const = 0;
65 };
66
74 static ICON_PROVIDER& GetDefaultRowIconProvider( bool aAlternative );
75
84 INDICATOR_ICON( wxWindow* aParent, ICON_PROVIDER& aIconProvider,
85 ICON_ID aInitialIcon, int aID );
86
92 void SetIndicatorState( ICON_ID aIconId );
93
94
99
104 void SetWindowID( wxWindowID aId )
105 {
106 SetId( aId );
107 m_bitmap->SetId( aId );
108 }
109
110private:
111
115
117 wxStaticBitmap* m_bitmap;
118
121};
122
123
128{
129public:
130
132 enum STATE
133 {
139 };
140
145 ROW_ICON_PROVIDER( int aSize );
146
148 const wxBitmap& GetIndicatorIcon( INDICATOR_ICON::ICON_ID aIconId ) const override;
149
150private:
155 wxBitmap m_dotBitmap;
156};
157
158
159#endif // ROW_INDICATOR__H_
A simple object that can provide fixed bitmaps for use as row indicators.
virtual const wxBitmap & GetIndicatorIcon(ICON_ID aIconId) const =0
Get a reference to the row icon in the given mode.
representing a row indicator icon for use in places like the layer widget
ICON_PROVIDER & m_iconProvider
< An class that delivers icons for the indicator (currently just uses a default implementation).
int ICON_ID
An id that refers to a certain icon state.
INDICATOR_ICON(wxWindow *aParent, ICON_PROVIDER &aIconProvider, ICON_ID aInitialIcon, int aID)
void SetIndicatorState(ICON_ID aIconId)
Set the row indicator to the given state.
static ICON_PROVIDER & GetDefaultRowIconProvider(bool aAlternative)
Accessor for the default icon providers, which take true and false for IDs, meaning on/off.
void SetWindowID(wxWindowID aId)
Updates the window ID of this control and its children.
wxStaticBitmap * m_bitmap
Is the icon currently "on".
ICON_ID GetIndicatorState() const
Icon provider for the "standard" row indicators, for example in layer selection lists.
const wxBitmap & GetIndicatorIcon(INDICATOR_ICON::ICON_ID aIconId) const override
Get a reference to the row icon in the given mode.
wxBitmap m_rightArrowBitmap
STATE
< State constants to select the right icons
@ UP
Row above design alpha.
@ DIMMED
Row "dimmed".
@ DOWN
Row below design alpha.
@ OFF
Row "off" or "deselected".
@ ON
Row "on" or "selected".
ROW_ICON_PROVIDER(int aSize)
wxBitmap m_upArrowBitmap
wxBitmap m_downArrowBitmap