KiCad PCB EDA Suite
Loading...
Searching...
No Matches
field_warning_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 The 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, see <https://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
22#include <kicommon.h>
24#include <wx/arrstr.h>
25#include <wx/generic/statbmpg.h>
26
27class wxEvent;
28class wxWindowDestroyEvent;
29
30
43class KICOMMON_API FIELD_WARNING_ICON : public wxGenericStaticBitmap
44{
45public:
47 static constexpr size_t MAX_LINES = 10;
48
52 explicit FIELD_WARNING_ICON( wxWindow* aField, BITMAPS aIcon = BITMAPS::small_warning, int aSlot = 0 );
53 ~FIELD_WARNING_ICON() override;
54
57 void SetWarnings( const wxArrayString& aMessages );
58
60 void SetWarning( const wxString& aMessage );
61
63 void ShowAsBadge();
64
66 void Reposition();
67
68private:
69 void onFieldChanged( wxEvent& aEvent );
70 void onFieldDestroyed( wxWindowDestroyEvent& aEvent );
71
72 wxWindow* m_field;
73 int m_slot;
74};
BITMAPS
A list of all bitmap identifiers.
FIELD_WARNING_ICON(wxWindow *aField, BITMAPS aIcon=BITMAPS::small_warning, int aSlot=0)
static constexpr size_t MAX_LINES
The most warnings listed in the tooltip, with a count of the rest.
wxWindow * m_field
Null once the field has been destroyed.
void ShowAsBadge()
Shows the icon with no tooltip of its own, for one that opens something on click or hover.
void onFieldChanged(wxEvent &aEvent)
void Reposition()
Moves the icon back over the field after the field has moved or changed size.
void SetWarnings(const wxArrayString &aMessages)
Lists aMessages in the tooltip, once each with a count when repeated, and shows the icon,...
void SetWarning(const wxString &aMessage)
Shows aMessage as the tooltip, or hides the icon when it is empty.
void onFieldDestroyed(wxWindowDestroyEvent &aEvent)
#define KICOMMON_API
Definition kicommon.h:27