KiCad PCB EDA Suite
PANEL_DISPLAY_OPTIONS_BASE Class Referenceabstract

Class PANEL_DISPLAY_OPTIONS_BASE. More...

#include <panel_display_options_base.h>

Inheritance diagram for PANEL_DISPLAY_OPTIONS_BASE:
RESETTABLE_PANEL PANEL_DISPLAY_OPTIONS

Public Member Functions

 PANEL_DISPLAY_OPTIONS_BASE (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxTAB_TRAVERSAL, const wxString &name=wxEmptyString)
 
 ~PANEL_DISPLAY_OPTIONS_BASE ()
 
virtual void ResetPanel ()=0
 Reset the contents of this panel. More...
 
virtual wxString GetResetTooltip () const
 Get the tooltip the reset button should display when showing this panel. More...
 
wxString GetHelpTextAtPoint (const wxPoint &aPt, wxHelpEvent::Origin aOrigin) const override
 Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }. More...
 

Protected Types

enum  { ID_SHOW_CLEARANCE = 1000 }
 

Protected Attributes

wxBoxSizer * m_galOptionsSizer
 
wxSimplebook * m_optionsBook
 
wxRadioBox * m_ShowNetNamesOption
 
wxCheckBox * m_OptDisplayPadNumber
 
wxCheckBox * m_OptDisplayPadNoConn
 
wxRadioBox * m_OptDisplayTracksClearance
 
wxCheckBox * m_OptDisplayPadClearence
 
wxCheckBox * m_checkCrossProbeOnSelection
 
wxCheckBox * m_checkCrossProbeCenter
 
wxCheckBox * m_checkCrossProbeZoom
 
wxCheckBox * m_checkCrossProbeAutoHighlight
 
wxCheckBox * m_live3Drefresh
 

Detailed Description

Class PANEL_DISPLAY_OPTIONS_BASE.

Definition at line 31 of file panel_display_options_base.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
ID_SHOW_CLEARANCE 

Definition at line 36 of file panel_display_options_base.h.

Constructor & Destructor Documentation

◆ PANEL_DISPLAY_OPTIONS_BASE()

PANEL_DISPLAY_OPTIONS_BASE::PANEL_DISPLAY_OPTIONS_BASE ( wxWindow *  parent,
wxWindowID  id = wxID_ANY,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize( -1,-1 ),
long  style = wxTAB_TRAVERSAL,
const wxString &  name = wxEmptyString 
)

Definition at line 12 of file panel_display_options_base.cpp.

12 : RESETTABLE_PANEL( parent, id, pos, size, style, name )
13{
14 wxBoxSizer* bMainSizer;
15 bMainSizer = new wxBoxSizer( wxVERTICAL );
16
17 wxBoxSizer* bupperSizer;
18 bupperSizer = new wxBoxSizer( wxHORIZONTAL );
19
20 m_galOptionsSizer = new wxBoxSizer( wxVERTICAL );
21
22
23 bupperSizer->Add( m_galOptionsSizer, 1, wxEXPAND, 5 );
24
25 m_optionsBook = new wxSimplebook( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, 0 );
26 wxPanel* emptyPage;
27 emptyPage = new wxPanel( m_optionsBook, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
28 m_optionsBook->AddPage( emptyPage, _("a page"), false );
29 wxPanel* pcbPage;
30 pcbPage = new wxPanel( m_optionsBook, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
31 wxBoxSizer* pcbOptionsSizer;
32 pcbOptionsSizer = new wxBoxSizer( wxVERTICAL );
33
34 wxStaticBoxSizer* sbAnnotations;
35 sbAnnotations = new wxStaticBoxSizer( new wxStaticBox( pcbPage, wxID_ANY, _("Annotations") ), wxVERTICAL );
36
37 wxString m_ShowNetNamesOptionChoices[] = { _("Do not show"), _("Show on pads"), _("Show on tracks"), _("Show on pads and tracks") };
38 int m_ShowNetNamesOptionNChoices = sizeof( m_ShowNetNamesOptionChoices ) / sizeof( wxString );
39 m_ShowNetNamesOption = new wxRadioBox( sbAnnotations->GetStaticBox(), wxID_ANY, _("Net Names"), wxDefaultPosition, wxDefaultSize, m_ShowNetNamesOptionNChoices, m_ShowNetNamesOptionChoices, 1, wxRA_SPECIFY_COLS );
40 m_ShowNetNamesOption->SetSelection( 0 );
41 m_ShowNetNamesOption->SetToolTip( _("Show or hide net names on pads and/or tracks.") );
42
43 sbAnnotations->Add( m_ShowNetNamesOption, 0, wxEXPAND|wxRIGHT|wxLEFT, 5 );
44
45 m_OptDisplayPadNumber = new wxCheckBox( sbAnnotations->GetStaticBox(), wxID_ANY, _("Show pad numbers"), wxDefaultPosition, wxDefaultSize, 0 );
46 m_OptDisplayPadNumber->SetValue(true);
47 sbAnnotations->Add( m_OptDisplayPadNumber, 0, wxALL, 6 );
48
49 m_OptDisplayPadNoConn = new wxCheckBox( sbAnnotations->GetStaticBox(), wxID_ANY, _("Show pad <no net> indicator"), wxDefaultPosition, wxDefaultSize, 0 );
50 m_OptDisplayPadNoConn->SetValue(true);
51 sbAnnotations->Add( m_OptDisplayPadNoConn, 0, wxBOTTOM|wxLEFT|wxRIGHT, 6 );
52
53
54 pcbOptionsSizer->Add( sbAnnotations, 0, wxEXPAND|wxBOTTOM, 5 );
55
56 wxStaticBoxSizer* sbClearance;
57 sbClearance = new wxStaticBoxSizer( new wxStaticBox( pcbPage, wxID_ANY, _("Clearance Outlines") ), wxVERTICAL );
58
59 wxString m_OptDisplayTracksClearanceChoices[] = { _("Do not show"), _("Show when routing"), _("Show when routing w/ via clearance at end"), _("Show when routing and editing"), _("Show always") };
60 int m_OptDisplayTracksClearanceNChoices = sizeof( m_OptDisplayTracksClearanceChoices ) / sizeof( wxString );
61 m_OptDisplayTracksClearance = new wxRadioBox( sbClearance->GetStaticBox(), ID_SHOW_CLEARANCE, _("Track && Via Clearances"), wxDefaultPosition, wxDefaultSize, m_OptDisplayTracksClearanceNChoices, m_OptDisplayTracksClearanceChoices, 1, wxRA_SPECIFY_COLS );
62 m_OptDisplayTracksClearance->SetSelection( 3 );
63 m_OptDisplayTracksClearance->SetToolTip( _("Show clearance outlines around tracks, and optionally the via clearance around the end of the track while routing.") );
64
65 sbClearance->Add( m_OptDisplayTracksClearance, 0, wxEXPAND|wxRIGHT|wxLEFT, 5 );
66
67 m_OptDisplayPadClearence = new wxCheckBox( sbClearance->GetStaticBox(), wxID_ANY, _("Show pad clearance"), wxDefaultPosition, wxDefaultSize, 0 );
68 sbClearance->Add( m_OptDisplayPadClearence, 0, wxALL, 6 );
69
70
71 pcbOptionsSizer->Add( sbClearance, 0, wxBOTTOM|wxEXPAND|wxTOP, 5 );
72
73 wxStaticBoxSizer* sbSizer3;
74 sbSizer3 = new wxStaticBoxSizer( new wxStaticBox( pcbPage, wxID_ANY, _("Cross-probing") ), wxVERTICAL );
75
76 m_checkCrossProbeOnSelection = new wxCheckBox( sbSizer3->GetStaticBox(), wxID_ANY, _("Highlight footprints when symbols selected"), wxDefaultPosition, wxDefaultSize, 0 );
77 m_checkCrossProbeOnSelection->SetValue(true);
78 m_checkCrossProbeOnSelection->SetToolTip( _("Highlight footprints corresponding to selected symbols") );
79
80 sbSizer3->Add( m_checkCrossProbeOnSelection, 0, wxALL, 5 );
81
82 m_checkCrossProbeCenter = new wxCheckBox( sbSizer3->GetStaticBox(), wxID_ANY, _("Center view on cross-probed items"), wxDefaultPosition, wxDefaultSize, 0 );
83 m_checkCrossProbeCenter->SetValue(true);
84 m_checkCrossProbeCenter->SetToolTip( _("Ensures that cross-probed footprints are visible in the current view") );
85
86 sbSizer3->Add( m_checkCrossProbeCenter, 0, wxBOTTOM|wxRIGHT|wxLEFT, 5 );
87
88 m_checkCrossProbeZoom = new wxCheckBox( sbSizer3->GetStaticBox(), wxID_ANY, _("Zoom to fit cross-probed items"), wxDefaultPosition, wxDefaultSize, 0 );
89 m_checkCrossProbeZoom->SetValue(true);
90 sbSizer3->Add( m_checkCrossProbeZoom, 0, wxBOTTOM|wxRIGHT|wxLEFT, 5 );
91
92 m_checkCrossProbeAutoHighlight = new wxCheckBox( sbSizer3->GetStaticBox(), wxID_ANY, _("Highlight cross-probed nets"), wxDefaultPosition, wxDefaultSize, 0 );
93 m_checkCrossProbeAutoHighlight->SetValue(true);
94 m_checkCrossProbeAutoHighlight->SetToolTip( _("Highlight nets when they are highlighted in the schematic editor") );
95
96 sbSizer3->Add( m_checkCrossProbeAutoHighlight, 0, wxBOTTOM|wxRIGHT|wxLEFT, 5 );
97
98 m_live3Drefresh = new wxCheckBox( sbSizer3->GetStaticBox(), wxID_ANY, _("Refresh 3D view automatically"), wxDefaultPosition, wxDefaultSize, 0 );
99 m_live3Drefresh->SetToolTip( _("When enabled, edits to the board will cause the 3D view to refresh (may be slow with larger boards)") );
100
101 sbSizer3->Add( m_live3Drefresh, 0, wxBOTTOM|wxLEFT|wxRIGHT, 5 );
102
103
104 pcbOptionsSizer->Add( sbSizer3, 1, wxEXPAND|wxTOP, 5 );
105
106
107 pcbPage->SetSizer( pcbOptionsSizer );
108 pcbPage->Layout();
109 pcbOptionsSizer->Fit( pcbPage );
110 m_optionsBook->AddPage( pcbPage, _("a page"), false );
111
112 bupperSizer->Add( m_optionsBook, 1, wxEXPAND|wxTOP|wxRIGHT|wxLEFT, 5 );
113
114
115 bMainSizer->Add( bupperSizer, 0, wxEXPAND|wxRIGHT|wxLEFT, 5 );
116
117
118 this->SetSizer( bMainSizer );
119 this->Layout();
120 bMainSizer->Fit( this );
121}
const char * name
Definition: DXF_plotter.cpp:56
RESETTABLE_PANEL(wxWindow *aParent, wxWindowID aId=wxID_ANY, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxSize(-1,-1), long aStyle=wxTAB_TRAVERSAL, const wxString &aName=wxEmptyString)
#define _(s)

References _, ID_SHOW_CLEARANCE, m_checkCrossProbeAutoHighlight, m_checkCrossProbeCenter, m_checkCrossProbeOnSelection, m_checkCrossProbeZoom, m_galOptionsSizer, m_live3Drefresh, m_OptDisplayPadClearence, m_OptDisplayPadNoConn, m_OptDisplayPadNumber, m_OptDisplayTracksClearance, m_optionsBook, and m_ShowNetNamesOption.

◆ ~PANEL_DISPLAY_OPTIONS_BASE()

PANEL_DISPLAY_OPTIONS_BASE::~PANEL_DISPLAY_OPTIONS_BASE ( )

Definition at line 123 of file panel_display_options_base.cpp.

124{
125}

Member Function Documentation

◆ GetHelpTextAtPoint()

wxString RESETTABLE_PANEL::GetHelpTextAtPoint ( const wxPoint &  aPt,
wxHelpEvent::Origin  aOrigin 
) const
inlineoverrideinherited

Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.

Definition at line 72 of file resettable_panel.h.

73 {
74 if( aPt == wxPoint( -INT_MAX, INT_MAX ) )
75 return GetResetTooltip();
76 else
77 return wxPanel::GetHelpTextAtPoint( aPt, aOrigin );
78 }
virtual wxString GetResetTooltip() const
Get the tooltip the reset button should display when showing this panel.

References RESETTABLE_PANEL::GetResetTooltip().

◆ GetResetTooltip()

virtual wxString RESETTABLE_PANEL::GetResetTooltip ( ) const
inlinevirtualinherited

Get the tooltip the reset button should display when showing this panel.

Returns
the tooltip

Reimplemented in PANEL_COLOR_SETTINGS, and PANEL_HOTKEYS_EDITOR.

Definition at line 64 of file resettable_panel.h.

65 {
66 return _( "Reset all settings on this page to their default" );
67 }

References _.

Referenced by RESETTABLE_PANEL::GetHelpTextAtPoint().

◆ ResetPanel()

Member Data Documentation

◆ m_checkCrossProbeAutoHighlight

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_checkCrossProbeAutoHighlight
protected

◆ m_checkCrossProbeCenter

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_checkCrossProbeCenter
protected

◆ m_checkCrossProbeOnSelection

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_checkCrossProbeOnSelection
protected

◆ m_checkCrossProbeZoom

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_checkCrossProbeZoom
protected

◆ m_galOptionsSizer

wxBoxSizer* PANEL_DISPLAY_OPTIONS_BASE::m_galOptionsSizer
protected

◆ m_live3Drefresh

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_live3Drefresh
protected

◆ m_OptDisplayPadClearence

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_OptDisplayPadClearence
protected

◆ m_OptDisplayPadNoConn

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_OptDisplayPadNoConn
protected

◆ m_OptDisplayPadNumber

wxCheckBox* PANEL_DISPLAY_OPTIONS_BASE::m_OptDisplayPadNumber
protected

◆ m_OptDisplayTracksClearance

wxRadioBox* PANEL_DISPLAY_OPTIONS_BASE::m_OptDisplayTracksClearance
protected

◆ m_optionsBook

wxSimplebook* PANEL_DISPLAY_OPTIONS_BASE::m_optionsBook
protected

◆ m_ShowNetNamesOption

wxRadioBox* PANEL_DISPLAY_OPTIONS_BASE::m_ShowNetNamesOption
protected

The documentation for this class was generated from the following files: