KiCad PCB EDA Suite
symbol_preview_widget.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) 2018-2020 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation, either version 3 of the License, or (at your
9  * option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef SYMBOL_PREVIEW_WIDGET_H
21 #define SYMBOL_PREVIEW_WIDGET_H
22 
23 #include <wx/panel.h>
24 #include <kiway.h>
26 #include <class_draw_panel_gal.h>
27 
28 
29 class LIB_ID;
30 class LIB_PART;
31 class wxStaticText;
32 class wxSizer;
33 
34 
35 class SYMBOL_PREVIEW_WIDGET: public wxPanel
36 {
37 public:
38 
46  SYMBOL_PREVIEW_WIDGET( wxWindow* aParent, KIWAY& aKiway,
47  EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType );
48 
49  ~SYMBOL_PREVIEW_WIDGET() override;
50 
54  void SetStatusText( wxString const& aText );
55 
59  void DisplaySymbol( const LIB_ID& aSymbolID, int aUnit, int aConvert = 0 );
60 
61  void DisplayPart( LIB_PART* aPart, int aUnit, int aConvert = 0 );
62 
63 private:
64  void onSize( wxSizeEvent& aEvent );
65 
66  void fitOnDrawArea(); // set the view scale to fit the item on screen and center
67 
69 
72 
73  wxStaticText* m_status;
74  wxSizer* m_statusSizer;
75 
80 
83 };
84 
85 
86 #endif // SYMBOL_PREVIEW_WIDGET_H
SYMBOL_PREVIEW_WIDGET(wxWindow *aParent, KIWAY &aKiway, EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Construct a symbol preview widget.
void onSize(wxSizeEvent &aEvent)
void DisplayPart(LIB_PART *aPart, int aUnit, int aConvert=0)
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
EDA_DRAW_PANEL_GAL * m_preview
Define a library symbol object.
KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the s...
Definition: kiway.h:273
LIB_PART * m_previewItem
A local copy of the LIB_PART to display on the canvas.
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit, int aConvert=0)
Set the currently displayed symbol.
BOX2I m_itemBBox
The bounding box of the current item.