KiCad PCB EDA Suite
DIALOG_FOOTPRINT_FP_EDITOR Class Reference

#include <dialog_edit_footprint_for_fp_editor.h>

Inheritance diagram for DIALOG_FOOTPRINT_FP_EDITOR:
DIALOG_FOOTPRINT_FP_EDITOR_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 DIALOG_FOOTPRINT_FP_EDITOR (FOOTPRINT_EDIT_FRAME *aParent, MODULE *aModule)
 
 ~DIALOG_FOOTPRINT_FP_EDITOR () override
 
bool Validate () override
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 

Protected Member Functions

virtual void OnInitDlg (wxInitDialogEvent &event)
 
void FinishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void SetSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int HorizPixelsFromDU (int x)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 
void ResetSize ()
 Clear the existing dialog size and position. More...
 

Protected Attributes

wxNotebook * m_NoteBook
 
wxPanel * m_PanelGeneral
 
WX_GRIDm_itemsGrid
 
wxBitmapButton * m_bpAdd
 
wxBitmapButton * m_bpDelete
 
wxTextCtrl * m_FootprintNameCtrl
 
wxTextCtrl * m_DocCtrl
 
wxStaticText * staticKeywordsLabel
 
wxTextCtrl * m_KeywordCtrl
 
wxRadioBox * m_AutoPlaceCtrl
 
wxStaticBoxSizer * m_sizerAP
 
wxBoxSizer * m_sizerAllow90
 
wxStaticText * m_allow90Label
 
wxSlider * m_CostRot90Ctrl
 
wxBoxSizer * m_sizerAllow180
 
wxStaticText * m_allow180Label
 
wxSlider * m_CostRot180Ctrl
 
wxRadioBox * m_AttributsCtrl
 
wxPanel * m_PanelClearances
 
wxStaticText * m_staticTextInfo
 
wxStaticText * m_staticTextInfoValPos
 
wxStaticText * m_staticTextInfoValNeg
 
wxStaticText * m_NetClearanceLabel
 
wxTextCtrl * m_NetClearanceCtrl
 
wxStaticText * m_NetClearanceUnits
 
wxStaticText * m_SolderMaskMarginLabel
 
wxTextCtrl * m_SolderMaskMarginCtrl
 
wxStaticText * m_SolderMaskMarginUnits
 
wxStaticText * m_SolderPasteMarginLabel
 
wxTextCtrl * m_SolderPasteMarginCtrl
 
wxStaticText * m_SolderPasteMarginUnits
 
wxStaticText * m_staticTextRatio
 
TEXT_CTRL_EVALm_SolderPasteMarginRatioCtrl
 
wxStaticText * m_SolderPasteRatioMarginUnits
 
wxStaticText * m_staticTextInfoCopper
 
wxStaticText * m_staticTextInfoPaste
 
wxStaticText * m_staticText16
 
wxChoice * m_ZoneConnectionChoice
 
wxPanel * m_Panel3D
 
wxBoxSizer * bSizerMain3D
 
WX_GRIDm_modelsGrid
 
wxBitmapButton * m_button3DShapeAdd
 
wxBitmapButton * m_button3DShapeBrowse
 
wxBitmapButton * m_button3DShapeRemove
 
wxButton * m_buttonConfig3DPaths
 
wxBoxSizer * bLowerSizer3D
 
wxStdDialogButtonSizer * m_sdbSizerStdButtons
 
wxButton * m_sdbSizerStdButtonsOK
 
wxButton * m_sdbSizerStdButtonsCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

void On3DModelSelected (wxGridEvent &) override
 
void On3DModelCellChanged (wxGridEvent &aEvent) override
 
void OnRemove3DModel (wxCommandEvent &event) override
 
void OnAdd3DModel (wxCommandEvent &event) override
 
void OnAdd3DRow (wxCommandEvent &event) override
 
void Cfg3DPath (wxCommandEvent &event) override
 
void OnGridSize (wxSizeEvent &event) override
 
void OnFootprintNameText (wxCommandEvent &event) override
 
void OnGridCellChanging (wxGridEvent &event)
 
void OnAddField (wxCommandEvent &event) override
 
void OnDeleteField (wxCommandEvent &event) override
 
void OnUpdateUI (wxUpdateUIEvent &event) override
 
bool checkFootprintName (const wxString &aFootprintName)
 
void select3DModel (int aModelIdx)
 
void adjustGridColumns (int aWidth)
 

Private Attributes

FOOTPRINT_EDIT_FRAMEm_frame
 
MODULEm_footprint
 
TEXT_MOD_GRID_TABLEm_texts
 
UNIT_BINDER m_netClearance
 
UNIT_BINDER m_solderMask
 
UNIT_BINDER m_solderPaste
 
std::vector< MODULE_3D_SETTINGSm_shapes3D_list
 
PANEL_PREV_3Dm_PreviewPane
 
wxControl * m_delayedFocusCtrl
 
int m_delayedFocusPage
 
WX_GRIDm_delayedFocusGrid
 
int m_delayedFocusRow
 
int m_delayedFocusColumn
 
wxString m_delayedErrorMessage
 
bool m_inSelect
 

Static Private Attributes

static int m_page = 0
 

Detailed Description

Definition at line 39 of file dialog_edit_footprint_for_fp_editor.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_FOOTPRINT_FP_EDITOR()

DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR ( FOOTPRINT_EDIT_FRAME aParent,
MODULE aModule 
)

Definition at line 55 of file dialog_edit_footprint_for_fp_editor.cpp.

56  :
61  m_inSelect( false )
62 {
63  m_frame = aParent;
64  m_footprint = aModule;
65 
67 
68  m_delayedErrorMessage = wxEmptyString;
69  m_delayedFocusCtrl = nullptr;
70  m_delayedFocusGrid = nullptr;
71  m_delayedFocusRow = -1;
73  m_delayedFocusPage = -1;
74 
75  // Give an icon
76  wxIcon icon;
77  icon.CopyFromBitmap( KiBitmap( icon_modedit_xpm ) );
78  SetIcon( icon );
79 
80  // Give a bit more room for combobox editors
81  m_itemsGrid->SetDefaultRowSize( m_itemsGrid->GetDefaultRowSize() + 4 );
82  m_modelsGrid->SetDefaultRowSize( m_modelsGrid->GetDefaultRowSize() + 4 );
83 
85  m_itemsGrid->PushEventHandler( new GRID_TRICKS( m_itemsGrid ) );
86  m_modelsGrid->PushEventHandler( new GRID_TRICKS( m_modelsGrid ) );
87 
88  // Show/hide columns according to the user's preference
90 
91  // Set up the 3D models grid
92  wxGridCellAttr* attr = new wxGridCellAttr;
93  attr->SetRenderer( new wxGridCellBoolRenderer() );
94  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
95  attr->SetAlignment( wxALIGN_CENTER, wxALIGN_BOTTOM );
96  m_modelsGrid->SetColAttr( 1, attr );
97  m_modelsGrid->SetWindowStyleFlag( m_modelsGrid->GetWindowStyle() & ~wxHSCROLL );
98 
99  aParent->Prj().Get3DCacheManager()->GetResolver()->SetProgramBase( &Pgm() );
100 
102 
103  bLowerSizer3D->Add( m_PreviewPane, 1, wxEXPAND, 5 );
104 
106 
107  // Set font sizes
108  wxFont infoFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
109  infoFont.SetSymbolicSize( wxFONTSIZE_SMALL );
110  m_allow90Label->SetFont( infoFont );
111  m_allow180Label->SetFont( infoFont );
112  m_staticTextInfoCopper->SetFont( infoFont );
113  m_staticTextInfoPaste->SetFont( infoFont );
114 
115  infoFont.SetStyle( wxFONTSTYLE_ITALIC );
116  m_staticTextInfoValNeg->SetFont( infoFont );
117  m_staticTextInfoValPos->SetFont( infoFont );
118 
119  if( m_page >= 0 )
120  m_NoteBook->SetSelection( (unsigned) m_page );
121 
122  if( m_page == 0 )
123  {
125  m_delayedFocusRow = 0;
127  m_delayedFocusPage = 0;
128  }
129  else if ( m_page == 1 )
131  else
132  {
134  m_delayedFocusRow = 0;
136  m_delayedFocusPage = 2;
137  }
138 
139  m_sdbSizerStdButtonsOK->SetDefault();
140 
141  // Configure button logos
142  m_bpAdd->SetBitmap( KiBitmap( small_plus_xpm ) );
143  m_bpDelete->SetBitmap( KiBitmap( trash_xpm ) );
144  m_button3DShapeAdd->SetBitmap( KiBitmap( small_plus_xpm ) );
145  m_button3DShapeBrowse->SetBitmap( KiBitmap( folder_xpm ) );
146  m_button3DShapeRemove->SetBitmap( KiBitmap( trash_xpm ) );
147 
148  // wxFormBuilder doesn't include this event...
149  m_itemsGrid->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_FOOTPRINT_FP_EDITOR::OnGridCellChanging ), NULL, this );
150 
152 }
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:46
const BITMAP_OPAQUE folder_xpm[1]
Definition: folder.cpp:20
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:103
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:119
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GRID ins...
Definition: grid_tricks.h:51
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:57
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:115
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
const BITMAP_OPAQUE icon_modedit_xpm[1]
DIALOG_FOOTPRINT_FP_EDITOR_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Footprint Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
EDA_UNITS m_units
Definition: dialog_shim.h:196
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References DIALOG_FOOTPRINT_FP_EDITOR_BASE::bLowerSizer3D, DIALOG_SHIM::FinishDialogSettings(), folder_xpm, FOOTPRINT_EDIT_FRAME::GetSettings(), icon_modedit_xpm, KiBitmap(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow180Label, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow90Label, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_bpAdd, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_bpDelete, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeAdd, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeBrowse, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeRemove, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, m_footprint, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, FOOTPRINT_EDITOR_SETTINGS::m_FootprintTextShownColumns, m_frame, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook, m_page, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D, m_PreviewPane, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtonsOK, m_shapes3D_list, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoCopper, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoPaste, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValNeg, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValPos, m_texts, DIALOG_SHIM::m_units, NULL, OnGridCellChanging(), Pgm(), KIWAY_HOLDER::Prj(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), WX_GRID::ShowHideColumns(), small_plus_xpm, and trash_xpm.

◆ ~DIALOG_FOOTPRINT_FP_EDITOR()

DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR ( )
override

Definition at line 155 of file dialog_edit_footprint_for_fp_editor.cpp.

156 {
158  m_itemsGrid->GetShownColumns().ToStdString();
159 
160  // Prevents crash bug in wxGrid's d'tor
162 
163  m_itemsGrid->Disconnect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_FOOTPRINT_FP_EDITOR::OnGridCellChanging ), NULL, this );
164 
165  // Delete the GRID_TRICKS.
166  m_itemsGrid->PopEventHandler( true );
167  m_modelsGrid->PopEventHandler( true );
168 
169  // free the memory used by all models, otherwise models which were
170  // browsed but not used would consume memory
171  Prj().Get3DCacheManager()->FlushCache( false );
172 
173  // the GL canvas has to be visible before it is destroyed
174  m_page = m_NoteBook->GetSelection();
175  m_NoteBook->SetSelection( 1 );
176 
177  delete m_PreviewPane;
178 }
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:88
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:101
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References WX_GRID::DestroyTable(), FOOTPRINT_EDIT_FRAME::GetSettings(), WX_GRID::GetShownColumns(), FOOTPRINT_EDITOR_SETTINGS::m_FootprintTextShownColumns, m_frame, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook, m_page, m_PreviewPane, m_texts, NULL, OnGridCellChanging(), and KIWAY_HOLDER::Prj().

Member Function Documentation

◆ adjustGridColumns()

void DIALOG_FOOTPRINT_FP_EDITOR::adjustGridColumns ( int  aWidth)
private

Definition at line 777 of file dialog_edit_footprint_for_fp_editor.cpp.

778 {
779  // Account for scroll bars
780  int itemsWidth = aWidth - ( m_itemsGrid->GetSize().x - m_itemsGrid->GetClientSize().x );
781  int modelsWidth = aWidth - ( m_modelsGrid->GetSize().x - m_modelsGrid->GetClientSize().x );
782 
783  itemsWidth -= m_itemsGrid->GetRowLabelSize();
784 
785  for( int i = 1; i < m_itemsGrid->GetNumberCols(); i++ )
786  itemsWidth -= m_itemsGrid->GetColSize( i );
787 
788  if( itemsWidth > 0 )
789  m_itemsGrid->SetColSize( 0, std::max( itemsWidth,
790  m_itemsGrid->GetVisibleWidth( 0, true, false, false ) ) );
791 
792  m_modelsGrid->SetColSize( 0, modelsWidth - m_modelsGrid->GetColSize( 1 ) - 5 );
793 }
int GetVisibleWidth(int aCol, bool aHeader=true, bool aContents=false, bool aKeep=true)
Calculates the specified column based on the actual size of the text on screen.
Definition: wx_grid.cpp:228

References WX_GRID::GetVisibleWidth(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, and DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid.

Referenced by OnGridSize(), OnUpdateUI(), and TransferDataToWindow().

◆ Cfg3DPath()

void DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 770 of file dialog_edit_footprint_for_fp_editor.cpp.

771 {
772  if( S3D::Configure3DPaths( this, Prj().Get3DCacheManager()->GetResolver() ) )
774 }
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool Configure3DPaths(wxWindow *aParent, FILENAME_RESOLVER *aResolver)

References S3D::Configure3DPaths(), m_PreviewPane, KIWAY_HOLDER::Prj(), and PANEL_PREV_3D::UpdateDummyModule().

◆ checkFootprintName()

bool DIALOG_FOOTPRINT_FP_EDITOR::checkFootprintName ( const wxString &  aFootprintName)
private

Definition at line 508 of file dialog_edit_footprint_for_fp_editor.cpp.

509 {
510  if( aFootprintName.IsEmpty() )
511  {
512  m_delayedErrorMessage = _( "Footprint must have a name." );
513  return false;
514  }
515  else if( !MODULE::IsLibNameValid( aFootprintName ) )
516  {
517  m_delayedErrorMessage.Printf( _( "Footprint name may not contain \"%s\"." ),
519  return false;
520  }
521 
522  return true;
523 }
static const wxChar * StringLibNameInvalidChars(bool aUserReadable)
static function StringLibNameInvalidChars Test for validity of the name in a library of the footprint...
static bool IsLibNameValid(const wxString &aName)
static function IsLibNameValid Test for validity of a name of a footprint to be used in a footprint l...
#define _(s)
Definition: 3d_actions.cpp:33

References _, MODULE::IsLibNameValid(), m_delayedErrorMessage, and MODULE::StringLibNameInvalidChars().

Referenced by Validate().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 262 of file dialog_shim.cpp.

263 {
264  // so we can do logging of this state change:
265 
266 #if 0 && defined(DEBUG)
267  const char* type_id = typeid( *this ).name();
268  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
269  fflush(0); //Needed on msys2 to immediately print the message
270 #endif
271 
272  return wxDialog::Enable( enable );
273 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 419 of file dialog_shim.cpp.

420 {
421  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
422  // handle validation in the same way as other dialogs.
423  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
424  return;
425 
426  SetReturnCode( retCode );
427 
428  if( !IsQuasiModal() )
429  {
430  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
431  "wasn't called" );
432  return;
433  }
434 
435  if( m_qmodal_loop )
436  {
437  if( m_qmodal_loop->IsRunning() )
438  m_qmodal_loop->Exit( 0 );
439  else
440  m_qmodal_loop->ScheduleExit( 0 );
441 
443  }
444 
447 
448  Show( false );
449 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
#define NULL
bool IsQuasiModal()
Definition: dialog_shim.h:124
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, NULL, and DIALOG_SHIM::Show().

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

FinishDialogSettings must be called from derived classes, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

In any case, the best way is to call it in a wxInitDialogEvent handler after calling TransfertDataToWindow(), which is the default wxInitDialogEvent handler wxDialog

Definition at line 137 of file dialog_shim.cpp.

138 {
139  // must be called from the constructor of derived classes,
140  // when all widgets are initialized, and therefore their size fixed
141 
142  // SetSizeHints fixes the minimal size of sizers in the dialog
143  // (SetSizeHints calls Fit(), so no need to call it)
144  GetSizer()->SetSizeHints( this );
145 
146  // the default position, when calling the first time the dlg
147  Center();
148 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_EDITOR_DATA::DIALOG_EDITOR_DATA(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SCH_SHEET_PROPS::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 158 of file dialog_shim.cpp.

159 {
160  wxSize sz( x, 0 );
161  return ConvertDialogToPixels( sz ).x;
162 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), and DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT().

◆ IsCtrl()

static bool DIALOG_SHIM::IsCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 137 of file dialog_shim.h.

138  {
139  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
140  !e.ShiftDown() && !e.MetaDown();
141  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 143 of file dialog_shim.h.

144  {
145  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
146  e.ShiftDown() && !e.MetaDown();
147  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow(), LIB_MANAGER::UpdatePart(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ On3DModelCellChanged()

void DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged ( wxGridEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 359 of file dialog_edit_footprint_for_fp_editor.cpp.

360 {
361  if( aEvent.GetCol() == 0 )
362  {
363  bool hasAlias = false;
364  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
365  wxString filename = m_modelsGrid->GetCellValue( aEvent.GetRow(), 0 );
366 
367  filename.Replace( "\n", "" );
368  filename.Replace( "\r", "" );
369  filename.Replace( "\t", "" );
370 
371  if( filename.empty() || !res->ValidateFileName( filename, hasAlias ) )
372  {
373  m_delayedErrorMessage = wxString::Format( _( "Invalid filename: %s" ), filename );
375  m_delayedFocusRow = aEvent.GetRow();
376  m_delayedFocusColumn = aEvent.GetCol();
377  m_delayedFocusPage = 2;
378  aEvent.Veto();
379  }
380 
381  // if the user has specified an alias in the name then prepend ':'
382  if( hasAlias )
383  filename.insert( 0, wxT( ":" ) );
384 
385 #ifdef __WINDOWS__
386  // In Kicad files, filenames and paths are stored using Unix notation
387  filename.Replace( wxT( "\\" ), wxT( "/" ) );
388 #endif
389 
390  m_shapes3D_list[ aEvent.GetRow() ].m_Filename = filename;
391  m_modelsGrid->SetCellValue( aEvent.GetRow(), 0, filename );
392  }
393  else if( aEvent.GetCol() == 1 )
394  {
395  wxString previewValue = m_modelsGrid->GetCellValue( aEvent.GetRow(), 1 );
396 
397  m_shapes3D_list[ aEvent.GetRow() ].m_Preview = previewValue == wxT( "1" );
398  }
399 
401 }
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define _(s)
Definition: 3d_actions.cpp:33
bool ValidateFileName(const wxString &aFileName, bool &hasAlias)
Function ValidateName returns true if the given path is a valid aliased relative path.
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References _, Format(), m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_PreviewPane, m_shapes3D_list, KIWAY_HOLDER::Prj(), PANEL_PREV_3D::UpdateDummyModule(), and FILENAME_RESOLVER::ValidateFileName().

◆ On3DModelSelected()

void DIALOG_FOOTPRINT_FP_EDITOR::On3DModelSelected ( wxGridEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 352 of file dialog_edit_footprint_for_fp_editor.cpp.

353 {
354  if( !m_inSelect )
355  select3DModel( aEvent.GetRow() );
356 }

References m_inSelect, and select3DModel().

◆ OnAdd3DModel()

void DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 422 of file dialog_edit_footprint_for_fp_editor.cpp.

423 {
425  return;
426 
427  PROJECT& prj = Prj();
428  MODULE_3D_SETTINGS model;
429 
430  wxString initialpath = prj.GetRString( PROJECT::VIEWER_3D_PATH );
431  wxString sidx = prj.GetRString( PROJECT::VIEWER_3D_FILTER_INDEX );
432  int filter = 0;
433 
434  // If the PROJECT::VIEWER_3D_PATH hasn't been set yet, use the KISYS3DMOD environment
435  // varaible and fall back to the project path if necessary.
436  if( initialpath.IsEmpty() )
437  {
438  if( !wxGetEnv( "KISYS3DMOD", &initialpath ) || initialpath.IsEmpty() )
439  initialpath = prj.GetProjectPath();
440  }
441 
442  if( !sidx.empty() )
443  {
444  long tmp;
445  sidx.ToLong( &tmp );
446 
447  if( tmp > 0 && tmp <= INT_MAX )
448  filter = (int) tmp;
449  }
450 
451  if( !S3D::Select3DModel( this, Prj().Get3DCacheManager(), initialpath, filter, &model )
452  || model.m_Filename.empty() )
453  {
454  return;
455  }
456 
457  prj.SetRString( PROJECT::VIEWER_3D_PATH, initialpath );
458  sidx = wxString::Format( wxT( "%i" ), filter );
460  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
461  wxString alias;
462  wxString shortPath;
463  wxString filename = model.m_Filename;
464 
465  if( res && res->SplitAlias( filename, alias, shortPath ) )
466  filename = alias + wxT( ":" ) + shortPath;
467 
468 #ifdef __WINDOWS__
469  // In Kicad files, filenames and paths are stored using Unix notation
470  model.m_Filename.Replace( "\\", "/" );
471 #endif
472 
473  model.m_Preview = true;
474  m_shapes3D_list.push_back( model );
475 
476  int idx = m_modelsGrid->GetNumberRows();
477  m_modelsGrid->AppendRows( 1 );
478  m_modelsGrid->SetCellValue( idx, 0, filename );
479  m_modelsGrid->SetCellValue( idx, 1, wxT( "1" ) );
480 
482 }
PROJECT holds project specific data.
Definition: project.h:59
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
bool m_Preview
Include module in 3D preview.
Definition: class_module.h:101
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:102
bool SplitAlias(const wxString &aFileName, wxString &anAlias, wxString &aRelPath)
Function SplitAlias returns true if the given name contains an alias and populates the string anAlias...
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
wxString m_Filename
The 3D shape filename in 3D library.
Definition: class_module.h:100
VTBL_ENTRY void SetRString(RSTRING_T aStringId, const wxString &aString)
Function SetRString stores a "retained string", which is any session and project specific string iden...
Definition: project.cpp:198
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:213
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool Select3DModel(wxWindow *aParent, S3D_CACHE *aCache, wxString &prevModelSelectDir, int &prevModelWildcard, MODULE_3D_SETTINGS *aModel)
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References WX_GRID::CommitPendingChanges(), Format(), PROJECT::GetProjectPath(), PROJECT::GetRString(), MODULE_3D_SETTINGS::m_Filename, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, MODULE_3D_SETTINGS::m_Preview, m_PreviewPane, m_shapes3D_list, KIWAY_HOLDER::Prj(), S3D::Select3DModel(), PROJECT::SetRString(), FILENAME_RESOLVER::SplitAlias(), PANEL_PREV_3D::UpdateDummyModule(), PROJECT::VIEWER_3D_FILTER_INDEX, and PROJECT::VIEWER_3D_PATH.

◆ OnAdd3DRow()

void DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DRow ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 485 of file dialog_edit_footprint_for_fp_editor.cpp.

486 {
488  return;
489 
490  MODULE_3D_SETTINGS model;
491 
492  model.m_Preview = true;
493  m_shapes3D_list.push_back( model );
494 
495  int row = m_modelsGrid->GetNumberRows();
496  m_modelsGrid->AppendRows( 1 );
497  m_modelsGrid->SetCellValue( row, 1, wxT( "1" ) );
498 
499  m_modelsGrid->SetFocus();
500  m_modelsGrid->MakeCellVisible( row, 0 );
501  m_modelsGrid->SetGridCursor( row, 0 );
502 
503  m_modelsGrid->EnableCellEditControl( true );
504  m_modelsGrid->ShowCellEditControl();
505 }
bool m_Preview
Include module in 3D preview.
Definition: class_module.h:101
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References WX_GRID::CommitPendingChanges(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, MODULE_3D_SETTINGS::m_Preview, and m_shapes3D_list.

◆ OnAddField()

void DIALOG_FOOTPRINT_FP_EDITOR::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 708 of file dialog_edit_footprint_for_fp_editor.cpp.

709 {
711  return;
712 
713  const BOARD_DESIGN_SETTINGS& dsnSettings = m_frame->GetDesignSettings();
714  TEXTE_MODULE textMod( m_footprint );
715 
716  // Set active layer if legal; otherwise copy layer from previous text item
717  if( LSET::AllTechMask().test( m_frame->GetActiveLayer() ) )
718  textMod.SetLayer( m_frame->GetActiveLayer() );
719  else
720  textMod.SetLayer( m_texts->at( m_texts->size() - 1 ).GetLayer() );
721 
722  textMod.SetTextSize( dsnSettings.GetTextSize( textMod.GetLayer() ) );
723  textMod.SetThickness( dsnSettings.GetTextThickness( textMod.GetLayer() ) );
724  textMod.SetItalic( dsnSettings.GetTextItalic( textMod.GetLayer() ) );
725 
726  m_texts->push_back( textMod );
727 
728  // notify the grid
729  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
730  m_itemsGrid->ProcessTableMessage( msg );
731 
732  m_itemsGrid->SetFocus();
733  m_itemsGrid->MakeCellVisible( m_texts->size() - 1, 0 );
734  m_itemsGrid->SetGridCursor( m_texts->size() - 1, 0 );
735 
736  m_itemsGrid->EnableCellEditControl( true );
737  m_itemsGrid->ShowCellEditControl();
738 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Function GetDesignSettings returns the BOARD_DESIGN_SETTINGS for the BOARD owned by this frame.
int GetTextThickness(PCB_LAYER_ID aLayer) const
Function GetTextThickness Returns the default text thickness from the layer class for the given layer...
static LSET AllTechMask()
Function AllTechMask returns a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:756
bool GetTextItalic(PCB_LAYER_ID aLayer) const
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
static bool GetLayer(MODEL_VRML &aModel, LAYER_NUM layer, VRML_LAYER **vlayer)
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Function GetTextSize Returns the default text size from the layer class for the given layer.
BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References LSET::AllTechMask(), WX_GRID::CommitPendingChanges(), PCB_BASE_FRAME::GetActiveLayer(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), BOARD_ITEM::GetLayer(), GetLayer(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), m_footprint, m_frame, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, m_texts, EDA_TEXT::SetItalic(), BOARD_ITEM::SetLayer(), EDA_TEXT::SetTextSize(), and EDA_TEXT::SetThickness().

◆ OnDeleteField()

void DIALOG_FOOTPRINT_FP_EDITOR::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 741 of file dialog_edit_footprint_for_fp_editor.cpp.

742 {
744  return;
745 
746  int curRow = m_itemsGrid->GetGridCursorRow();
747 
748  if( curRow < 0 )
749  return;
750  else if( curRow < 2 )
751  {
752  DisplayError( nullptr, _( "Reference and value are mandatory." ) );
753  return;
754  }
755 
756  m_texts->erase( m_texts->begin() + curRow );
757 
758  // notify the grid
759  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_DELETED, curRow, 1 );
760  m_itemsGrid->ProcessTableMessage( msg );
761 
762  if( m_itemsGrid->GetNumberRows() > 0 )
763  {
764  m_itemsGrid->MakeCellVisible( std::max( 0, curRow-1 ), m_itemsGrid->GetGridCursorCol() );
765  m_itemsGrid->SetGridCursor( std::max( 0, curRow-1 ), m_itemsGrid->GetGridCursorCol() );
766  }
767 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
#define _(s)
Definition: 3d_actions.cpp:33

References _, WX_GRID::CommitPendingChanges(), DisplayError(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, and m_texts.

◆ OnFootprintNameText()

void DIALOG_FOOTPRINT_FP_EDITOR::OnFootprintNameText ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 699 of file dialog_edit_footprint_for_fp_editor.cpp.

700 {
702  {
703  // Currently: nothing to do
704  }
705 }
static bool footprintIsFromBoard(MODULE *aFootprint)

References footprintIsFromBoard(), and m_footprint.

◆ OnGridCellChanging()

void DIALOG_FOOTPRINT_FP_EDITOR::OnGridCellChanging ( wxGridEvent &  event)
private

Definition at line 693 of file dialog_edit_footprint_for_fp_editor.cpp.

694 {
695  // Currently: nothing to do
696 }

Referenced by DIALOG_FOOTPRINT_FP_EDITOR(), and ~DIALOG_FOOTPRINT_FP_EDITOR().

◆ OnGridSize()

void DIALOG_FOOTPRINT_FP_EDITOR::OnGridSize ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 857 of file dialog_edit_footprint_for_fp_editor.cpp.

858 {
859  adjustGridColumns( event.GetSize().GetX());
860 
861  event.Skip();
862 }

References adjustGridColumns().

◆ OnInitDlg()

virtual void DIALOG_FOOTPRINT_FP_EDITOR_BASE::OnInitDlg ( wxInitDialogEvent &  event)
inlineprotectedvirtualinherited

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 320 of file dialog_shim.cpp.

321 {
322  if( m_firstPaintEvent )
323  {
324 #ifdef __WXMAC__
325  fixOSXCancelButtonIssue( this );
326 #endif
327 
328  selectAllInTextCtrls( GetChildren() );
329 
331  m_initialFocusTarget->SetFocus();
332  else
333  SetFocus(); // Focus the dialog itself
334 
335  m_firstPaintEvent = false;
336  }
337 
338  event.Skip();
339 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203
bool m_firstPaintEvent
Definition: dialog_shim.h:202
static void selectAllInTextCtrls(wxWindowList &children)

References DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnRemove3DModel()

void DIALOG_FOOTPRINT_FP_EDITOR::OnRemove3DModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 404 of file dialog_edit_footprint_for_fp_editor.cpp.

405 {
407  return;
408 
409  int idx = m_modelsGrid->GetGridCursorRow();
410 
411  if( idx >= 0 && m_modelsGrid->GetNumberRows() && !m_shapes3D_list.empty() )
412  {
413  m_shapes3D_list.erase( m_shapes3D_list.begin() + idx );
414  m_modelsGrid->DeleteRows( idx );
415 
416  select3DModel( idx-1 ); // will clamp idx within bounds
418  }
419 }
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References WX_GRID::CommitPendingChanges(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_PreviewPane, m_shapes3D_list, select3DModel(), and PANEL_PREV_3D::UpdateDummyModule().

◆ OnUpdateUI()

void DIALOG_FOOTPRINT_FP_EDITOR::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 796 of file dialog_edit_footprint_for_fp_editor.cpp.

797 {
798  if( !m_itemsGrid->IsCellEditControlShown() && !m_modelsGrid->IsCellEditControlShown() )
799  adjustGridColumns( m_itemsGrid->GetRect().GetWidth());
800 
801  if( m_itemsGrid->IsCellEditControlShown() )
802  {
803  // Currently: nonthing to do
804  }
805 
806  // Handle a delayed focus. The delay allows us to:
807  // a) change focus when the error was triggered from within a killFocus handler
808  // b) show the correct notebook page in the background before the error dialog comes up
809  // when triggered from an OK or a notebook page change
810 
811  if( m_delayedFocusPage >= 0 )
812  {
813  if( m_NoteBook->GetSelection() != m_delayedFocusPage )
814  m_NoteBook->SetSelection( (unsigned) m_delayedFocusPage );
815 
816  m_delayedFocusPage = -1;
817  }
818 
819  if( !m_delayedErrorMessage.IsEmpty() )
820  {
821  // We will re-enter this routine when the error dialog is displayed, so make
822  // sure we don't keep putting up more dialogs.
823  wxString msg = m_delayedErrorMessage;
824  m_delayedErrorMessage = wxEmptyString;
825 
826  // Do not use DisplayErrorMessage(); it screws up window order on Mac
827  DisplayError( nullptr, msg );
828  }
829 
830  if( m_delayedFocusCtrl )
831  {
832  m_delayedFocusCtrl->SetFocus();
833 
834  if( auto textEntry = dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl ) )
835  textEntry->SelectAll();
836 
837  m_delayedFocusCtrl = nullptr;
838  }
839  else if( m_delayedFocusGrid )
840  {
841  m_delayedFocusGrid->SetFocus();
844 
845  m_delayedFocusGrid->EnableCellEditControl( true );
846  m_delayedFocusGrid->ShowCellEditControl();
847 
848  m_delayedFocusGrid = nullptr;
849  m_delayedFocusRow = -1;
851  }
852 
853  m_button3DShapeRemove->Enable( m_modelsGrid->GetNumberRows() > 0 );
854 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239

References adjustGridColumns(), DisplayError(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeRemove, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, and DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:171

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), ~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ ResetSize()

void DIALOG_SHIM::ResetSize ( )
protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 237 of file dialog_shim.cpp.

238 {
239  const char* hash_key;
240 
241  if( m_hash_key.size() )
242  {
243  // a special case like EDA_LIST_DIALOG, which has multiple uses.
244  hash_key = m_hash_key.c_str();
245  }
246  else
247  {
248  hash_key = typeid(*this).name();
249  }
250 
251  RECT_MAP::iterator it = class_map.find( hash_key );
252 
253  if( it == class_map.end() )
254  return;
255 
256  EDA_RECT rect = it->second;
257  rect.SetSize( 0, 0 );
258  class_map[ hash_key ] = rect;
259 }
std::string m_hash_key
Definition: dialog_shim.h:197
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

◆ select3DModel()

void DIALOG_FOOTPRINT_FP_EDITOR::select3DModel ( int  aModelIdx)
private

Definition at line 333 of file dialog_edit_footprint_for_fp_editor.cpp.

334 {
335  m_inSelect = true;
336 
337  aModelIdx = std::max( 0, aModelIdx );
338  aModelIdx = std::min( aModelIdx, m_modelsGrid->GetNumberRows() - 1 );
339 
340  if( m_modelsGrid->GetNumberRows() )
341  {
342  m_modelsGrid->SelectRow( aModelIdx );
343  m_modelsGrid->SetGridCursor( aModelIdx, 0 );
344  }
345 
346  m_PreviewPane->SetSelectedModel( aModelIdx );
347 
348  m_inSelect = false;
349 }
void SetSelectedModel(int idx)
SetModelDataIdx - Sets the currently selected index in the model list so that the scale/rotation/offs...

References m_inSelect, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_PreviewPane, and PANEL_PREV_3D::SetSelectedModel().

Referenced by On3DModelSelected(), OnRemove3DModel(), and TransferDataToWindow().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 115 of file dialog_shim.h.

116  {
117  m_initialFocusTarget = aWindow;
118  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

43 {
44 #if defined(DEBUG)
45  // offer a trap point for debugging most any window
46  wxASSERT( aDest );
47  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
48  {
49  int breakhere=1;
50  (void) breakhere;
51  }
52 #endif
53 
54  (void) aDest;
55 
56  m_kiway = aKiway;
57 }
KIWAY * m_kiway
Definition: kiway_holder.h:81
const char * name
Definition: DXF_plotter.cpp:60

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetSizeInDU()

void DIALOG_SHIM::SetSizeInDU ( int  x,
int  y 
)
protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 151 of file dialog_shim.cpp.

152 {
153  wxSize sz( x, y );
154  SetSize( ConvertDialogToPixels( sz ) );
155 }

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 178 of file dialog_shim.cpp.

179 {
180  bool ret;
181  const char* hash_key;
182 
183  if( m_hash_key.size() )
184  {
185  // a special case like EDA_LIST_DIALOG, which has multiple uses.
186  hash_key = m_hash_key.c_str();
187  }
188  else
189  {
190  hash_key = typeid(*this).name();
191  }
192 
193  // Show or hide the window. If hiding, save current position and size.
194  // If showing, use previous position and size.
195  if( show )
196  {
197 #ifndef __WINDOWS__
198  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
199 #endif
200  ret = wxDialog::Show( show );
201 
202  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
203  EDA_RECT savedDialogRect = class_map[ hash_key ];
204 
205  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
206  {
207  SetSize( savedDialogRect.GetPosition().x,
208  savedDialogRect.GetPosition().y,
209  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
210  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
211  0 );
212  }
213 
214  // Be sure that the dialog appears in a visible area
215  // (the dialog position might have been stored at the time when it was
216  // shown on another display)
217  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
218  Centre();
219  }
220  else
221  {
222  // Save the dialog's position & size before hiding, using classname as key
223  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
224 
225 #ifdef __WXMAC__
226  if ( m_eventLoop )
227  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
228 #endif
229 
230  ret = wxDialog::Show( show );
231  }
232 
233  return ret;
234 }
std::string m_hash_key
Definition: dialog_shim.h:197
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:115
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxSize GetSize() const
Definition: eda_rect.h:103

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 365 of file dialog_shim.cpp.

366 {
367  // This is an exception safe way to zero a pointer before returning.
368  // Yes, even though DismissModal() clears this first normally, this is
369  // here in case there's an exception before the dialog is dismissed.
370  struct NULLER
371  {
372  void*& m_what;
373  NULLER( void*& aPtr ) : m_what( aPtr ) {}
374  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
375  } clear_this( (void*&) m_qmodal_loop );
376 
377  // release the mouse if it's currently captured as the window having it
378  // will be disabled when this dialog is shown -- but will still keep the
379  // capture making it impossible to do anything in the modal dialog itself
380  wxWindow* win = wxWindow::GetCapture();
381  if( win )
382  win->ReleaseMouse();
383 
384  // Get the optimal parent
385  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
386 
387  // Show the optimal parent
388  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
389 
390  wxASSERT_MSG( !m_qmodal_parent_disabler,
391  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
392 
393  // quasi-modal: disable only my "optimal" parent
395 
396 #ifdef __WXMAC__
397  // Apple in its infinite wisdom will raise a disabled window before even passing
398  // us the event, so we have no way to stop it. Instead, we must set an order on
399  // the windows so that the quasi-modal will be pushed in front of the disabled
400  // window when it is raised.
401  ReparentQuasiModal();
402 #endif
403  Show( true );
404 
405  m_qmodal_showing = true;
406 
407  WX_EVENT_LOOP event_loop;
408 
409  m_qmodal_loop = &event_loop;
410 
411  event_loop.Run();
412 
413  m_qmodal_showing = false;
414 
415  return GetReturnCode();
416 }
bool m_qmodal_showing
Definition: dialog_shim.h:207
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
#define DBG(x)
Definition: fctsys.h:33

References DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by PCB_EDIT_FRAME::DoShowBoardSetupDialog(), SCH_EDIT_FRAME::DoShowSchematicSetupDialog(), LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ TransferDataFromWindow()

bool DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow ( )
override

Definition at line 574 of file dialog_edit_footprint_for_fp_editor.cpp.

575 {
576  if( !Validate() )
577  return false;
578 
579  if( !DIALOG_SHIM::TransferDataFromWindow() )
580  return false;
581 
582  if( !m_PanelGeneral->TransferDataFromWindow() )
583  return false;
584 
585  if( !m_Panel3D->TransferDataFromWindow() )
586  return false;
587 
588  auto view = m_frame->GetCanvas()->GetView();
589  BOARD_COMMIT commit( m_frame );
590  commit.Modify( m_footprint );
591 
592  LIB_ID fpID = m_footprint->GetFPID();
593  fpID.SetLibItemName( m_FootprintNameCtrl->GetValue(), false );
594  m_footprint->SetFPID( fpID );
595 
596  m_footprint->SetDescription( m_DocCtrl->GetValue() );
597  m_footprint->SetKeywords( m_KeywordCtrl->GetValue() );
598 
599  // copy reference and value
600  m_footprint->Reference() = m_texts->at( 0 );
601  m_footprint->Value() = m_texts->at( 1 );
602 
603  size_t i = 2;
604  for( auto item : m_footprint->GraphicalItems() )
605  {
606  TEXTE_MODULE* textModule = dyn_cast<TEXTE_MODULE*>( item );
607 
608  if( textModule )
609  {
610  // copy grid table entries till we run out, then delete any remaining texts
611  if( i < m_texts->size() )
612  *textModule = m_texts->at( i++ );
613  else
614  textModule->DeleteStructure();
615  }
616  }
617 
618  // if there are still grid table entries, create new texts for them
619  while( i < m_texts->size() )
620  {
621  auto newText = new TEXTE_MODULE( m_texts->at( i++ ) );
622  m_footprint->Add( newText, ADD_MODE::APPEND );
623  view->Add( newText );
624  }
625 
626  m_footprint->SetLocked( m_AutoPlaceCtrl->GetSelection() == 1 );
627 
628  switch( m_AttributsCtrl->GetSelection() )
629  {
630  case 0: m_footprint->SetAttributes( 0 ); break;
631  case 1: m_footprint->SetAttributes( MOD_CMS ); break;
632  case 2: m_footprint->SetAttributes( MOD_VIRTUAL ); break;
633  default: wxFAIL;
634  }
635 
638 
639  // Initialize masks clearances
643 
644  double dtmp = 0.0;
645  wxString msg = m_SolderPasteMarginRatioCtrl->GetValue();
646  msg.ToDouble( &dtmp );
647 
648  // A -50% margin ratio means no paste on a pad, the ratio must be >= -50%
649  if( dtmp < -50.0 )
650  dtmp = -50.0;
651  // A margin ratio is always <= 0
652  // 0 means use full pad copper area
653  if( dtmp > 0.0 )
654  dtmp = 0.0;
655 
657 
658  switch( m_ZoneConnectionChoice->GetSelection() )
659  {
660  default:
661  case 0:
663  break;
664  case 1:
666  break;
667  case 2:
669  break;
670  case 3:
672  break;
673  }
674 
675  std::list<MODULE_3D_SETTINGS>* draw3D = &m_footprint->Models();
676  draw3D->clear();
677  draw3D->insert( draw3D->end(), m_shapes3D_list.begin(), m_shapes3D_list.end() );
678 
680 
681  commit.Push( _( "Modify module properties" ) );
682 
683  return true;
684 }
void SetPlacementCost90(int aCost)
Definition: class_module.h:556
TEXTE_MODULE & Reference()
Definition: class_module.h:477
void SetLocalClearance(int aClearance)
Definition: class_module.h:235
void SetPlacementCost180(int aCost)
Definition: class_module.h:553
void CalculateBoundingBox()
Function CalculateBoundingBox calculates the bounding box in board coordinates.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:74
void DeleteStructure()
Function DeleteStructure deletes this object after removing from its parent if it has one.
const LIB_ID & GetFPID() const
Definition: class_module.h:219
DRAWINGS & GraphicalItems()
Definition: class_module.h:183
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_module.h:241
pads are covered by copper
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:476
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_module.h:232
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Use thermal relief for pads.
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_module.h:238
std::list< MODULE_3D_SETTINGS > & Models()
Definition: class_module.h:205
void SetLocked(bool isLocked) override
Function SetLocked sets the MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: class_module.h:311
#define _(s)
Definition: 3d_actions.cpp:33
Virtual component: when created by copper shapes on board (Like edge card connectors,...
Definition: class_module.h:76
void SetZoneConnection(ZONE_CONNECTION aType)
Definition: class_module.h:243
Pads are not covered.
virtual long long int GetValue()
Function GetValue Returns the current value in Internal Units.
void SetKeywords(const wxString &aKeywords)
Definition: class_module.h:226
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:220
void SetAttributes(int aAttributes)
Definition: class_module.h:260
void SetDescription(const wxString &aDoc)
Definition: class_module.h:223
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References _, MODULE::Add(), APPEND, MODULE::CalculateBoundingBox(), BOARD_ITEM::DeleteStructure(), FULL, PCB_BASE_FRAME::GetCanvas(), MODULE::GetFPID(), UNIT_BINDER::GetValue(), PCB_DRAW_PANEL_GAL::GetView(), MODULE::GraphicalItems(), INHERITED, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AttributsCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AutoPlaceCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot180Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot90Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_DocCtrl, m_footprint, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, m_frame, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_KeywordCtrl, m_netClearance, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelGeneral, m_shapes3D_list, m_solderMask, m_solderPaste, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl, m_texts, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_ZoneConnectionChoice, MOD_CMS, MOD_VIRTUAL, MODULE::Models(), COMMIT::Modify(), NONE, BOARD_COMMIT::Push(), MODULE::Reference(), MODULE::SetAttributes(), MODULE::SetDescription(), MODULE::SetFPID(), MODULE::SetKeywords(), LIB_ID::SetLibItemName(), MODULE::SetLocalClearance(), MODULE::SetLocalSolderMaskMargin(), MODULE::SetLocalSolderPasteMargin(), MODULE::SetLocalSolderPasteMarginRatio(), MODULE::SetLocked(), MODULE::SetPlacementCost180(), MODULE::SetPlacementCost90(), MODULE::SetZoneConnection(), THERMAL, Validate(), and MODULE::Value().

◆ TransferDataToWindow()

bool DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow ( )
override

Definition at line 181 of file dialog_edit_footprint_for_fp_editor.cpp.

182 {
183  LIB_ID fpID = m_footprint->GetFPID();
184  wxString footprintName = fpID.GetLibItemName();
185 
186  m_FootprintNameCtrl->ChangeValue( footprintName );
187 
188  m_DocCtrl->SetValue( m_footprint->GetDescription() );
189  m_KeywordCtrl->SetValue( m_footprint->GetKeywords() );
190 
191  if( !wxDialog::TransferDataToWindow() )
192  return false;
193 
194  if( !m_PanelGeneral->TransferDataToWindow() )
195  return false;
196 
197  if( !m_Panel3D->TransferDataToWindow() )
198  return false;
199 
200  // Module Texts
201 
202  m_texts->push_back( m_footprint->Reference() );
203  m_texts->push_back( m_footprint->Value() );
204 
205  for( auto item : m_footprint->GraphicalItems() )
206  {
207  auto textModule = dyn_cast<TEXTE_MODULE*>( item );
208 
209  if( textModule )
210  m_texts->push_back( *textModule );
211  }
212 
213  // notify the grid
214  wxGridTableMessage tmsg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_texts->GetNumberRows() );
215  m_itemsGrid->ProcessTableMessage( tmsg );
216 
217  // Module Properties
218 
219  m_AutoPlaceCtrl->SetSelection( (m_footprint->IsLocked()) ? 1 : 0 );
220  m_AutoPlaceCtrl->SetItemToolTip( 0, _( "Enable hotkey move commands and Auto Placement" ) );
221  m_AutoPlaceCtrl->SetItemToolTip( 1, _( "Disable hotkey move commands and Auto Placement" ) );
222 
225 
226  m_AttributsCtrl->SetItemToolTip( 0, _( "Use this attribute for most non SMD footprints\n"
227  "Footprints with this option are not put in the footprint position list file" ) );
228  m_AttributsCtrl->SetItemToolTip( 1, _( "Use this attribute for SMD footprints.\n"
229  "Only footprints with this option are put in the footprint position list file" ) );
230  m_AttributsCtrl->SetItemToolTip( 2, _( "Use this attribute for \"virtual\" footprints drawn on board\n"
231  "such as an edge connector (old ISA PC bus for instance)" ) );
232 
233  switch( m_footprint->GetAttributes() & 255 )
234  {
235  case MOD_CMS: m_AttributsCtrl->SetSelection( 1 ); break;
236  case MOD_VIRTUAL: m_AttributsCtrl->SetSelection( 2 ); break;
237  case 0:
238  default: m_AttributsCtrl->SetSelection( 0 ); break;
239  }
240 
241  // Local Clearances
242 
246 
247  // Prefer "-0" to "0" for normally negative values
249  m_SolderPasteMarginCtrl->SetValue( wxT( "-" ) + m_SolderPasteMarginCtrl->GetValue() );
250 
251  // Add solder paste margin ratio in percent
252  // for the usual default value 0.0, display -0.0 (or -0,0 in some countries)
253  wxString msg;
254  msg.Printf( wxT( "%f" ), m_footprint->GetLocalSolderPasteMarginRatio() * 100.0 );
255 
257  msg[0] == '0') // Sometimes Printf adds a sign if the value is very small (0.0)
258  m_SolderPasteMarginRatioCtrl->SetValue( wxT("-") + msg );
259  else
261 
262  switch( m_footprint->GetZoneConnection() )
263  {
264  default:
266  m_ZoneConnectionChoice->SetSelection( 0 );
267  break;
269  m_ZoneConnectionChoice->SetSelection( 1 );
270  break;
272  m_ZoneConnectionChoice->SetSelection( 2 );
273  break;
275  m_ZoneConnectionChoice->SetSelection( 3 );
276  break;
277  }
278 
279  // 3D Settings
280 
281  wxString default_path;
282  wxGetEnv( KISYS3DMOD, &default_path );
283 #ifdef __WINDOWS__
284  default_path.Replace( wxT( "/" ), wxT( "\\" ) );
285 #endif
286 
287  m_shapes3D_list.clear();
288  m_modelsGrid->DeleteRows( 0, m_modelsGrid->GetNumberRows() );
289 
290  wxString origPath, alias, shortPath;
291  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
292 
293  for( const MODULE_3D_SETTINGS& model : m_footprint->Models() )
294  {
295  m_shapes3D_list.push_back( model );
296  origPath = model.m_Filename;
297 
298  if( res && res->SplitAlias( origPath, alias, shortPath ) )
299  origPath = alias + wxT( ":" ) + shortPath;
300 
301  m_modelsGrid->AppendRows( 1 );
302  int row = m_modelsGrid->GetNumberRows() - 1;
303  m_modelsGrid->SetCellValue( row, 0, origPath );
304  m_modelsGrid->SetCellValue( row, 1, model.m_Preview ? wxT( "1" ) : wxT( "0" ) );
305  }
306 
307  select3DModel( 0 ); // will clamp idx within bounds
308 
309  for( int col = 0; col < m_itemsGrid->GetNumberCols(); col++ )
310  {
311  // Adjust min size to the column label size
312  m_itemsGrid->SetColMinimalWidth( col, m_itemsGrid->GetVisibleWidth( col, true, false, false ) );
313  // Adjust the column size. The column 6 has a small bitmap, so its width must be taken in account
314  int col_size = m_itemsGrid->GetVisibleWidth( col, true, true, false );
315 
316  if( col == 6 )
317  col_size += 20;
318 
319  if( m_itemsGrid->IsColShown( col ) )
320  m_itemsGrid->SetColSize( col, col_size );
321  }
322 
323  m_itemsGrid->SetRowLabelSize( m_itemsGrid->GetVisibleWidth( -1, true, true, true ) );
324  m_modelsGrid->SetColSize( 1, m_modelsGrid->GetVisibleWidth( 1, true, false, false ) );
325 
326  Layout();
327  adjustGridColumns( m_itemsGrid->GetRect().GetWidth());
328 
329  return true;
330 }
int GetAttributes() const
Definition: class_module.h:259
int GetPlacementCost90() const
Definition: class_module.h:555
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
TEXTE_MODULE & Reference()
Definition: class_module.h:477
ZONE_CONNECTION GetZoneConnection() const
Definition: class_module.h:248
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:74
const LIB_ID & GetFPID() const
Definition: class_module.h:219
#define KISYS3DMOD
A variable name whose value holds the path of 3D shape files.
Definition: eda_3d_viewer.h:44
DRAWINGS & GraphicalItems()
Definition: class_module.h:183
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int GetLocalSolderMaskMargin() const
Definition: class_module.h:231
void SetValue(const wxString &aValue) override
Set a new value in evaluator buffer, and display it in the wxTextCtrl.
int GetVisibleWidth(int aCol, bool aHeader=true, bool aContents=false, bool aKeep=true)
Calculates the specified column based on the actual size of the text on screen.
Definition: wx_grid.cpp:228
bool SplitAlias(const wxString &aFileName, wxString &anAlias, wxString &aRelPath)
Function SplitAlias returns true if the given name contains an alias and populates the string anAlias...
pads are covered by copper
int GetLocalClearance() const
Definition: class_module.h:234
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:476
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:301
const wxString & GetKeywords() const
Definition: class_module.h:225
int GetLocalSolderPasteMargin() const
Definition: class_module.h:237
int GetPlacementCost180() const
Definition: class_module.h:552
Use thermal relief for pads.
const wxString & GetDescription() const
Definition: class_module.h:222
double GetLocalSolderPasteMarginRatio() const
Definition: class_module.h:240
std::list< MODULE_3D_SETTINGS > & Models()
Definition: class_module.h:205
#define _(s)
Definition: 3d_actions.cpp:33
Virtual component: when created by copper shapes on board (Like edge card connectors,...
Definition: class_module.h:76
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
Pads are not covered.
int GetNumberRows() override
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References _, adjustGridColumns(), FULL, MODULE::GetAttributes(), MODULE::GetDescription(), MODULE::GetFPID(), MODULE::GetKeywords(), LIB_ID::GetLibItemName(), MODULE::GetLocalClearance(), MODULE::GetLocalSolderMaskMargin(), MODULE::GetLocalSolderPasteMargin(), MODULE::GetLocalSolderPasteMarginRatio(), TEXT_MOD_GRID_TABLE::GetNumberRows(), MODULE::GetPlacementCost180(), MODULE::GetPlacementCost90(), WX_GRID::GetVisibleWidth(), MODULE::GetZoneConnection(), MODULE::GraphicalItems(), INHERITED, MODULE::IsLocked(), KISYS3DMOD, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AttributsCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AutoPlaceCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot180Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot90Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_DocCtrl, m_footprint, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_KeywordCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_netClearance, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelGeneral, m_shapes3D_list, m_solderMask, m_solderPaste, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl, m_texts, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_ZoneConnectionChoice, MOD_CMS, MOD_VIRTUAL, MODULE::Models(), NONE, KIWAY_HOLDER::Prj(), MODULE::Reference(), select3DModel(), TEXT_CTRL_EVAL::SetValue(), UNIT_BINDER::SetValue(), FILENAME_RESOLVER::SplitAlias(), THERMAL, and MODULE::Value().

◆ Validate()

bool DIALOG_FOOTPRINT_FP_EDITOR::Validate ( )
override

Definition at line 526 of file dialog_edit_footprint_for_fp_editor.cpp.

527 {
529  return false;
530 
531  if( !DIALOG_SHIM::Validate() )
532  return false;
533 
534  // First, test for invalid chars in module name
535  wxString footprintName = m_FootprintNameCtrl->GetValue();
536 
537  if( !checkFootprintName( footprintName ) )
538  {
539  if( m_NoteBook->GetSelection() != 0 )
540  m_NoteBook->SetSelection( 0 );
541 
543  m_delayedFocusPage = 0;
544 
545  return false;
546  }
547 
548  // Check for empty texts.
549  for( size_t i = 2; i < m_texts->size(); ++i )
550  {
551  TEXTE_MODULE& text = m_texts->at( i );
552 
553  if( text.GetText().IsEmpty() )
554  {
555  if( m_NoteBook->GetSelection() != 0 )
556  m_NoteBook->SetSelection( 0 );
557 
558  m_delayedErrorMessage = _( "Text items must have some content." );
561  m_delayedFocusRow = i;
562 
563  return false;
564  }
565  }
566 
567  if( !m_netClearance.Validate( 0, INT_MAX ) )
568  return false;
569 
570  return true;
571 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
virtual bool Validate(long long int aMin, long long int aMax, bool setFocusOnError=true)
Function Validate Validates the control against the given range, informing the user of any errors fou...
#define _(s)
Definition: 3d_actions.cpp:33
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123
bool checkFootprintName(const wxString &aFootprintName)

References _, checkFootprintName(), WX_GRID::CommitPendingChanges(), EDA_TEXT::GetText(), m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, m_netClearance, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook, m_texts, TMC_TEXT, and UNIT_BINDER::Validate().

Referenced by TransferDataFromWindow().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 165 of file dialog_shim.cpp.

166 {
167  wxSize sz( 0, y );
168  return ConvertDialogToPixels( sz ).y;
169 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

Member Data Documentation

◆ bLowerSizer3D

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::bLowerSizer3D
protectedinherited

◆ bSizerMain3D

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::bSizerMain3D
protectedinherited

◆ m_allow180Label

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow180Label
protectedinherited

◆ m_allow90Label

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow90Label
protectedinherited

◆ m_AttributsCtrl

wxRadioBox* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AttributsCtrl
protectedinherited

◆ m_AutoPlaceCtrl

wxRadioBox* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AutoPlaceCtrl
protectedinherited

◆ m_bpAdd

◆ m_bpDelete

◆ m_button3DShapeAdd

wxBitmapButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeAdd
protectedinherited

◆ m_button3DShapeBrowse

wxBitmapButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeBrowse
protectedinherited

◆ m_button3DShapeRemove

wxBitmapButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeRemove
protectedinherited

◆ m_buttonConfig3DPaths

wxButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_buttonConfig3DPaths
protectedinherited

◆ m_CostRot180Ctrl

wxSlider* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot180Ctrl
protectedinherited

◆ m_CostRot90Ctrl

wxSlider* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot90Ctrl
protectedinherited

◆ m_delayedErrorMessage

wxString DIALOG_FOOTPRINT_FP_EDITOR::m_delayedErrorMessage
private

◆ m_delayedFocusColumn

int DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusColumn
private

◆ m_delayedFocusCtrl

wxControl* DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusCtrl
private

◆ m_delayedFocusGrid

WX_GRID* DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusGrid
private

◆ m_delayedFocusPage

int DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusPage
private

◆ m_delayedFocusRow

int DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusRow
private

◆ m_DocCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_DocCtrl
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 202 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_footprint

MODULE* DIALOG_FOOTPRINT_FP_EDITOR::m_footprint
private

◆ m_FootprintNameCtrl

◆ m_frame

FOOTPRINT_EDIT_FRAME* DIALOG_FOOTPRINT_FP_EDITOR::m_frame
private

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 203 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SetInitialFocus().

◆ m_inSelect

bool DIALOG_FOOTPRINT_FP_EDITOR::m_inSelect
private

Definition at line 64 of file dialog_edit_footprint_for_fp_editor.h.

Referenced by On3DModelSelected(), and select3DModel().

◆ m_itemsGrid

◆ m_KeywordCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_KeywordCtrl
protectedinherited

◆ m_modelsGrid

◆ m_netClearance

UNIT_BINDER DIALOG_FOOTPRINT_FP_EDITOR::m_netClearance
private

◆ m_NetClearanceCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceCtrl
protectedinherited

◆ m_NetClearanceLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceLabel
protectedinherited

◆ m_NetClearanceUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceUnits
protectedinherited

◆ m_NoteBook

wxNotebook* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook
protectedinherited

◆ m_page

int DIALOG_FOOTPRINT_FP_EDITOR::m_page = 0
staticprivate

◆ m_Panel3D

wxPanel* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D
protectedinherited

◆ m_PanelClearances

wxPanel* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelClearances
protectedinherited

◆ m_PanelGeneral

wxPanel* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelGeneral
protectedinherited

◆ m_PreviewPane

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 205 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 207 of file dialog_shim.h.

Referenced by DIALOG_SHIM::IsQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_sdbSizerStdButtons

wxStdDialogButtonSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtons
protectedinherited

◆ m_sdbSizerStdButtonsCancel

wxButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtonsCancel
protectedinherited

◆ m_sdbSizerStdButtonsOK

wxButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtonsOK
protectedinherited

◆ m_shapes3D_list

◆ m_sizerAllow180

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sizerAllow180
protectedinherited

◆ m_sizerAllow90

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sizerAllow90
protectedinherited

◆ m_sizerAP

wxStaticBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sizerAP
protectedinherited

◆ m_solderMask

UNIT_BINDER DIALOG_FOOTPRINT_FP_EDITOR::m_solderMask
private

◆ m_SolderMaskMarginCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderMaskMarginCtrl
protectedinherited

◆ m_SolderMaskMarginLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderMaskMarginLabel
protectedinherited

◆ m_SolderMaskMarginUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderMaskMarginUnits
protectedinherited

◆ m_solderPaste

UNIT_BINDER DIALOG_FOOTPRINT_FP_EDITOR::m_solderPaste
private

◆ m_SolderPasteMarginCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginCtrl
protectedinherited

◆ m_SolderPasteMarginLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginLabel
protectedinherited

◆ m_SolderPasteMarginRatioCtrl

TEXT_CTRL_EVAL* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl
protectedinherited

◆ m_SolderPasteMarginUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginUnits
protectedinherited

◆ m_SolderPasteRatioMarginUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteRatioMarginUnits
protectedinherited

◆ m_staticText16

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticText16
protectedinherited

◆ m_staticTextInfo

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfo
protectedinherited

◆ m_staticTextInfoCopper

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoCopper
protectedinherited

◆ m_staticTextInfoPaste

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoPaste
protectedinherited

◆ m_staticTextInfoValNeg

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValNeg
protectedinherited

◆ m_staticTextInfoValPos

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValPos
protectedinherited

◆ m_staticTextRatio

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextRatio
protectedinherited

◆ m_tabOrder

◆ m_texts

◆ m_units

◆ m_ZoneConnectionChoice

wxChoice* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_ZoneConnectionChoice
protectedinherited

◆ staticKeywordsLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::staticKeywordsLabel
protectedinherited

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