KiCad PCB EDA Suite
DIALOG_FIND Class Reference

#include <dialog_find.h>

Inheritance diagram for DIALOG_FIND:
DIALOG_FIND_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_FIND (PCB_BASE_FRAME *aParent)
 
BOARD_ITEMGetItem () const
 Returns the currently found item or nullptr in the case of no items found. More...
 
void SetCallback (boost::function< void(BOARD_ITEM *)> aCallback)
 Function to be called on each found event. More...
 
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 () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

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

Protected Member Functions

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) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

wxStaticText * searchStringLabel
 
wxComboBox * m_searchCombo
 
wxCheckBox * m_matchCase
 
wxCheckBox * m_matchWords
 
wxCheckBox * m_wildcards
 
wxCheckBox * m_wrap
 
wxCheckBox * m_includeReferences
 
wxCheckBox * m_includeValues
 
wxCheckBox * m_includeTexts
 
wxCheckBox * m_includeMarkers
 
wxCheckBox * m_includeVias
 
wxButton * m_findNext
 
wxButton * m_findPrevious
 
wxButton * m_searchAgain
 
wxButton * m_closeButton
 
wxStaticText * m_status
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

void onTextEnter (wxCommandEvent &event) override
 
void onFindNextClick (wxCommandEvent &event) override
 
void onFindPreviousClick (wxCommandEvent &event) override
 
void onSearchAgainClick (wxCommandEvent &event) override
 
void onClose (wxCommandEvent &event) override
 
void search (bool direction)
 

Private Attributes

PCB_BASE_FRAMEm_frame
 
std::deque< BOARD_ITEM * > m_hitList
 
std::deque< BOARD_ITEM * >::iterator m_it
 
bool m_upToDate
 
boost::function< void(BOARD_ITEM *)> m_highlightCallback
 

Detailed Description

Definition at line 40 of file dialog_find.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_FIND()

DIALOG_FIND::DIALOG_FIND ( PCB_BASE_FRAME aParent)

Definition at line 52 of file dialog_find.cpp.

52  : DIALOG_FIND_BASE( aFrame )
53 {
54  m_frame = aFrame;
55  GetSizer()->SetSizeHints( this );
56 
58 
59  while( m_searchCombo->GetCount() > 10 )
60  {
61  m_frame->GetFindHistoryList().pop_back();
62  m_searchCombo->Delete( 9 );
63  }
64 
65  if( m_searchCombo->GetCount() )
66  {
67  m_searchCombo->SetSelection( 0 );
68  m_searchCombo->SelectAll();
69  }
70 
71  m_matchCase->SetValue( FindOptionCase );
72  m_matchWords->SetValue( FindOptionWords );
73  m_wildcards->SetValue( FindOptionWildcards );
74  m_wrap->SetValue( FindOptionWrap );
75 
76  m_includeTexts->SetValue( FindIncludeTexts );
80 
81  m_status->SetLabel( wxEmptyString);
82  m_upToDate = false;
83 
84  m_hitList.clear();
85  m_it = m_hitList.begin();
86 
87  m_findNext->SetDefault();
89 
90  Center();
91 }
wxCheckBox * m_includeReferences
bool FindOptionWords
Definition: dialog_find.cpp:42
DIALOG_FIND_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE)
bool FindIncludeTexts
Definition: dialog_find.cpp:46
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
bool FindIncludeMarkers
Definition: dialog_find.cpp:49
wxStaticText * m_status
PCB_BASE_FRAME * m_frame
Definition: dialog_find.h:69
bool FindIncludeValues
Definition: dialog_find.cpp:47
wxComboBox * m_searchCombo
wxCheckBox * m_includeTexts
wxCheckBox * m_matchCase
wxCheckBox * m_wildcards
bool FindIncludeReferences
Definition: dialog_find.cpp:48
wxCheckBox * m_includeMarkers
wxCheckBox * m_matchWords
bool m_upToDate
Definition: dialog_find.h:72
std::deque< BOARD_ITEM * >::iterator m_it
Definition: dialog_find.h:71
wxArrayString & GetFindHistoryList()
std::deque< BOARD_ITEM * > m_hitList
Definition: dialog_find.h:70
bool FindOptionWrap
Definition: dialog_find.cpp:44
bool FindOptionWildcards
Definition: dialog_find.cpp:43
bool FindOptionCase
Definition: dialog_find.cpp:41
wxCheckBox * m_wrap
wxCheckBox * m_includeValues
wxButton * m_findNext

References PCAD2KICAD::Center, FindIncludeMarkers, FindIncludeReferences, FindIncludeTexts, FindIncludeValues, FindOptionCase, FindOptionWildcards, FindOptionWords, FindOptionWrap, EDA_DRAW_FRAME::GetFindHistoryList(), DIALOG_FIND_BASE::m_findNext, m_frame, m_hitList, DIALOG_FIND_BASE::m_includeMarkers, DIALOG_FIND_BASE::m_includeReferences, DIALOG_FIND_BASE::m_includeTexts, DIALOG_FIND_BASE::m_includeValues, m_it, DIALOG_FIND_BASE::m_matchCase, DIALOG_FIND_BASE::m_matchWords, DIALOG_FIND_BASE::m_searchCombo, DIALOG_FIND_BASE::m_status, m_upToDate, DIALOG_FIND_BASE::m_wildcards, DIALOG_FIND_BASE::m_wrap, and DIALOG_SHIM::SetInitialFocus().

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 277 of file dialog_shim.cpp.

278 {
279  // so we can do logging of this state change:
280  return wxDialog::Enable( enable );
281 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 415 of file dialog_shim.cpp.

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

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_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_SYMBOL::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_SYMBOL::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 after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 148 of file dialog_shim.cpp.

149 {
150  // must be called from the constructor of derived classes,
151  // when all widgets are initialized, and therefore their size fixed
152 
153  // SetSizeHints fixes the minimal size of sizers in the dialog
154  // (SetSizeHints calls Fit(), so no need to call it)
155  GetSizer()->SetSizeHints( this );
156 }

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), 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_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), 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_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), 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_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), 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_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), 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_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetItem()

BOARD_ITEM* DIALOG_FIND::GetItem ( ) const
inline

Returns the currently found item or nullptr in the case of no items found.

Returns

Definition at line 49 of file dialog_find.h.

50  {
51  if( m_it != m_hitList.end() )
52  return *m_it;
53  else
54  return nullptr;
55  }
std::deque< BOARD_ITEM * >::iterator m_it
Definition: dialog_find.h:71
std::deque< BOARD_ITEM * > m_hitList
Definition: dialog_find.h:70

Referenced by search().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

167 {
168  wxSize sz( x, 0 );
169  return ConvertDialogToPixels( sz ).x;
170 }

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

◆ IsCtrl()

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

Definition at line 120 of file dialog_shim.h.

121  {
122  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
123  !e.ShiftDown() && !e.MetaDown();
124  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 126 of file dialog_shim.h.

127  {
128  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
129  e.ShiftDown() && !e.MetaDown();
130  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return 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:78

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), 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(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), 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(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), SYMBOL_EDITOR_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 506 of file dialog_shim.cpp.

507 {
508  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
509  {
510  if( m_parentFrame )
511  {
513  return;
514  }
515  }
516  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
517  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
518  {
519  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
520  return;
521  }
522  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
523  {
524  wxWindow* currentWindow = wxWindow::FindFocus();
525  int currentIdx = -1;
526  int delta = aEvt.ShiftDown() ? -1 : 1;
527 
528  auto advance = [&]( int& idx )
529  {
530  // Wrap-around modulus
531  int size = m_tabOrder.size();
532  idx = ( ( idx + delta ) % size + size ) % size;
533  };
534 
535  for( size_t i = 0; i < m_tabOrder.size(); ++i )
536  {
537  if( m_tabOrder[i] == currentWindow )
538  {
539  currentIdx = (int) i;
540  break;
541  }
542  }
543 
544  if( currentIdx >= 0 )
545  {
546  advance( currentIdx );
547 
548  //todo: We don't currently have non-textentry dialog boxes but this will break if
549  // we add them.
550 #ifdef __APPLE__
551  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
552  advance( currentIdx );
553 #endif
554 
555  m_tabOrder[ currentIdx ]->SetFocus();
556  return;
557  }
558  }
559 
560  aEvt.Skip();
561 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:214
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:212
virtual void ToggleUserUnits()

References DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

◆ onClose()

void DIALOG_FIND::onClose ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FIND_BASE.

Definition at line 365 of file dialog_find.cpp.

366 {
367  FindOptionCase = m_matchCase->GetValue();
368  FindOptionWords = m_matchWords->GetValue();
369  FindOptionWildcards = m_wildcards->GetValue();
370  FindOptionWrap = m_wrap->GetValue();
371 
372  FindIncludeTexts = m_includeTexts->GetValue();
373  FindIncludeValues = m_includeValues->GetValue();
374  FindIncludeMarkers = m_includeMarkers->GetValue();
376 
377  EndModal( 1 );
378 }
wxCheckBox * m_includeReferences
bool FindOptionWords
Definition: dialog_find.cpp:42
bool FindIncludeTexts
Definition: dialog_find.cpp:46
bool FindIncludeMarkers
Definition: dialog_find.cpp:49
bool FindIncludeValues
Definition: dialog_find.cpp:47
wxCheckBox * m_includeTexts
wxCheckBox * m_matchCase
wxCheckBox * m_wildcards
bool FindIncludeReferences
Definition: dialog_find.cpp:48
wxCheckBox * m_includeMarkers
wxCheckBox * m_matchWords
bool FindOptionWrap
Definition: dialog_find.cpp:44
bool FindOptionWildcards
Definition: dialog_find.cpp:43
bool FindOptionCase
Definition: dialog_find.cpp:41
wxCheckBox * m_wrap
wxCheckBox * m_includeValues

References FindIncludeMarkers, FindIncludeReferences, FindIncludeTexts, FindIncludeValues, FindOptionCase, FindOptionWildcards, FindOptionWords, FindOptionWrap, DIALOG_FIND_BASE::m_includeMarkers, DIALOG_FIND_BASE::m_includeReferences, DIALOG_FIND_BASE::m_includeTexts, DIALOG_FIND_BASE::m_includeValues, DIALOG_FIND_BASE::m_matchCase, DIALOG_FIND_BASE::m_matchWords, DIALOG_FIND_BASE::m_wildcards, and DIALOG_FIND_BASE::m_wrap.

◆ onFindNextClick()

void DIALOG_FIND::onFindNextClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FIND_BASE.

Definition at line 98 of file dialog_find.cpp.

99 {
100  search( true );
101 }
void search(bool direction)

References search().

◆ onFindPreviousClick()

void DIALOG_FIND::onFindPreviousClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FIND_BASE.

Definition at line 103 of file dialog_find.cpp.

104 {
105  search( false );
106 }
void search(bool direction)

References search().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 322 of file dialog_shim.cpp.

323 {
324  if( m_firstPaintEvent )
325  {
327 
328  selectAllInTextCtrls( GetChildren() );
329 
332  else
333  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
334 
335  m_firstPaintEvent = false;
336  }
337 
338  event.Skip();
339 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:205
bool m_firstPaintEvent
Definition: dialog_shim.h:204
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:56
static void selectAllInTextCtrls(wxWindowList &children)

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onSearchAgainClick()

void DIALOG_FIND::onSearchAgainClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FIND_BASE.

Definition at line 108 of file dialog_find.cpp.

109 {
110  m_upToDate = false;
111  search( true );
112 }
void search(bool direction)
bool m_upToDate
Definition: dialog_find.h:72

References m_upToDate, and search().

◆ onTextEnter()

void DIALOG_FIND::onTextEnter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FIND_BASE.

Definition at line 93 of file dialog_find.cpp.

94 {
95  search( true );
96 }
void search(bool direction)

References search().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return 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
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:174

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_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(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and SCH_EDIT_FRAME::~SCH_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 252 of file dialog_shim.cpp.

253 {
254  const char* hash_key;
255 
256  if( m_hash_key.size() )
257  {
258  // a special case like EDA_LIST_DIALOG, which has multiple uses.
259  hash_key = m_hash_key.c_str();
260  }
261  else
262  {
263  hash_key = typeid(*this).name();
264  }
265 
266  RECT_MAP::iterator it = class_map.find( hash_key );
267 
268  if( it == class_map.end() )
269  return;
270 
271  EDA_RECT rect = it->second;
272  rect.SetSize( 0, 0 );
273  class_map[ hash_key ] = rect;
274 }
std::string m_hash_key
Definition: dialog_shim.h:195
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:139
Handle the component boundary box.
Definition: eda_rect.h:42

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

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ search()

void DIALOG_FIND::search ( bool  direction)
private

Definition at line 114 of file dialog_find.cpp.

115 {
116  PCB_SCREEN* screen = m_frame->GetScreen();
117  int flags;
118  int index;
119  wxString msg;
120  wxString searchString;
121  bool endIsReached = false;
122  bool isFirstSearch = false;
123 
124  // Add/move the search string to the top of the list if it isn't already there
125  searchString = m_searchCombo->GetValue();
126  index = m_searchCombo->FindString( searchString, true );
127 
128  if( index == wxNOT_FOUND )
129  {
130  m_searchCombo->Insert( searchString, 0 );
131  m_searchCombo->SetSelection( 0 );
132  m_upToDate = false;
133  m_frame->GetFindHistoryList().Insert( searchString, 0 );
134 
135  if( m_searchCombo->GetCount() > 10 )
136  {
137  m_frame->GetFindHistoryList().pop_back();
138  m_searchCombo->Delete( 10 );
139  }
140  }
141  else if( index != 0 )
142  {
143  m_searchCombo->Delete( index );
144  m_searchCombo->Insert( searchString, 0 );
145  m_searchCombo->SetSelection( 0 );
146  m_upToDate = false;
147 
148  if( m_frame->GetFindHistoryList().Index( searchString ) )
149  m_frame->GetFindHistoryList().Remove( searchString );
150 
151  m_frame->GetFindHistoryList().Insert( searchString, 0 );
152  }
153 
154  // Update search flags
155  flags = 0;
156 
157  if( FindOptionCase != m_matchCase->GetValue() )
158  {
159  FindOptionCase = m_matchCase->GetValue();
160  m_upToDate = false;
161  }
162 
163  if( FindOptionWords != m_matchWords->GetValue() )
164  {
165  FindOptionWords = m_matchWords->GetValue();
166  m_upToDate = false;
167  }
168 
169  if( FindOptionWildcards != m_wildcards->GetValue() )
170  {
171  FindOptionWildcards = m_wildcards->GetValue();
172  m_upToDate = false;
173  }
174 
175  FindOptionWrap = m_wrap->GetValue();
176 
177  if( FindIncludeTexts != m_includeTexts->GetValue() )
178  {
179  FindIncludeTexts = m_includeTexts->GetValue();
180  m_upToDate = false;
181  }
182 
183  if( FindIncludeValues != m_includeValues->GetValue() )
184  {
185  FindIncludeValues = m_includeValues->GetValue();
186  m_upToDate = false;
187  }
188 
189  if( FindIncludeReferences != m_includeReferences->GetValue() )
190  {
192  m_upToDate = false;
193  }
194 
195  if( FindIncludeMarkers != m_includeMarkers->GetValue() )
196  {
197  FindIncludeMarkers = m_includeMarkers->GetValue();
198  m_upToDate = false;
199  }
200 
201  if( FindOptionCase )
202  flags |= wxFR_MATCHCASE;
203 
204  if( FindOptionWords )
205  flags |= wxFR_WHOLEWORD;
206 
207  if( FindOptionWildcards )
208  flags |= FR_MATCH_WILDCARD;
209 
210  // Search parameters
211  m_frame->GetFindReplaceData().SetFindString( searchString );
212  m_frame->GetFindReplaceData().SetFlags( flags );
213 
215  m_frame->GetCanvas()->GetViewStart( &screen->m_StartVisu.x, &screen->m_StartVisu.y );
216 
217  // Refresh the list of results
218  if( !m_upToDate )
219  {
220  m_status->SetLabel( _( "Searching..." ) );
221  m_hitList.clear();
222 
224  {
225  for( FOOTPRINT* fp : m_frame->GetBoard()->Footprints() )
226  {
227  if( ( fp->Reference().Matches( m_frame->GetFindReplaceData(), nullptr )
229  || ( fp->Value().Matches( m_frame->GetFindReplaceData(), nullptr )
230  && FindIncludeValues ) )
231  {
232  m_hitList.push_back( fp );
233  }
234 
235  if( m_includeTexts->GetValue() )
236  {
237  for( BOARD_ITEM* item : fp->GraphicalItems() )
238  {
239  FP_TEXT* textItem = dynamic_cast<FP_TEXT*>( item );
240 
241  if( textItem && textItem->Matches( m_frame->GetFindReplaceData(), nullptr ) )
242  {
243  m_hitList.push_back( fp );
244  }
245  }
246  }
247  }
248 
249  if( FindIncludeTexts )
250  {
251  for( BOARD_ITEM* item : m_frame->GetBoard()->Drawings() )
252  {
253  PCB_TEXT* textItem = dynamic_cast<PCB_TEXT*>( item );
254 
255  if( textItem && textItem->Matches( m_frame->GetFindReplaceData(), nullptr ) )
256  {
257  m_hitList.push_back( textItem );
258  }
259  }
260 
261  for( BOARD_ITEM* item : m_frame->GetBoard()->Zones() )
262  {
263  ZONE* zoneItem = dynamic_cast<ZONE*>( item );
264  if( zoneItem && zoneItem->Matches( m_frame->GetFindReplaceData(), nullptr ) )
265  {
266  m_hitList.push_back( zoneItem );
267  }
268  }
269  }
270  }
271 
272  if( FindIncludeMarkers )
273  {
274  for( PCB_MARKER* marker : m_frame->GetBoard()->Markers() )
275  {
276  if( marker->Matches( m_frame->GetFindReplaceData(), nullptr ) )
277  m_hitList.push_back( marker );
278  }
279  }
280 
281  m_upToDate = true;
282  isFirstSearch = true;
283 
284  if( aDirection )
285  m_it = m_hitList.begin();
286  else
287  m_it = m_hitList.end();
288  }
289 
290  // Do we want a sorting algorithm ? If so, implement it here.
291 
292  // Get the item to display
293  if( m_hitList.empty() )
294  {
295  m_frame->SetStatusText( wxEmptyString );
296  }
297  else
298  {
299  if( aDirection )
300  {
301  if( m_it != m_hitList.end() && !isFirstSearch )
302  m_it++;
303 
304  if( m_it == m_hitList.end() )
305  {
306  if( m_wrap->GetValue() )
307  {
308  m_it = m_hitList.begin();
309  }
310  else
311  {
312  endIsReached = true;
313  m_it--; // point to the last REAL result
314  }
315  }
316  }
317  else
318  {
319  if( m_it == m_hitList.begin() )
320  {
321  if( m_wrap->GetValue() )
322  m_it = m_hitList.end();
323  else
324  endIsReached = true;
325  }
326 
327  if( m_it != m_hitList.begin() )
328  m_it--;
329  }
330  }
331 
332  // Display the item
333  if( m_hitList.empty() )
334  {
335  m_frame->SetStatusText( wxEmptyString );
336  msg.Printf( _( "\"%s\" not found" ), searchString );
337  m_frame->ShowInfoBarMsg( msg );
338 
339  m_status->SetLabel( msg );
340  }
341  else if( endIsReached )
342  {
343  m_frame->SetStatusText( wxEmptyString );
344  m_frame->ShowInfoBarMsg( _( "No more items to show" ) );
345 
346  m_status->SetLabel( _( "No hits" ) );
347  }
348  else
349  {
351  m_frame->FocusOnLocation( ( *m_it )->GetPosition() );
352 
353  msg.Printf( _( "\"%s\" found" ), searchString );
354  m_frame->SetStatusText( msg );
355 
356  msg.Printf( _( "Hit(s): %ld / %lu" ), std::distance( m_hitList.begin(), m_it ) + 1,
357  m_hitList.size() );
358  m_status->SetLabel( msg );
359  }
360 
361  if( m_highlightCallback )
363 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:62
ZONES & Zones()
Definition: board.h:292
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
MARKERS & Markers()
Definition: board.h:295
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
wxCheckBox * m_includeReferences
bool Matches(const wxFindReplaceData &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: zone.h:134
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
bool FindOptionWords
Definition: dialog_find.cpp:42
bool FindIncludeTexts
Definition: dialog_find.cpp:46
bool FindIncludeMarkers
Definition: dialog_find.cpp:49
wxStaticText * m_status
wxFindReplaceData & GetFindReplaceData()
BOARD_ITEM * GetItem() const
Returns the currently found item or nullptr in the case of no items found.
Definition: dialog_find.h:49
PCB_BASE_FRAME * m_frame
Definition: dialog_find.h:69
void ShowInfoBarMsg(const wxString &aMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of...
wxPoint m_StartVisu
Coordinates in drawing units of the current view position (upper left corner of device)
Definition: base_screen.h:97
bool FindIncludeValues
Definition: dialog_find.cpp:47
wxComboBox * m_searchCombo
wxCheckBox * m_includeTexts
wxCheckBox * m_matchCase
FOOTPRINTS & Footprints()
Definition: board.h:286
bool Matches(const wxFindReplaceData &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: fp_text.h:81
ZONE handles a list of polygons defining a copper zone.
Definition: zone.h:57
wxCheckBox * m_wildcards
static float distance(const SFVEC2UI &a, const SFVEC2UI &b)
bool FindIncludeReferences
Definition: dialog_find.cpp:48
wxCheckBox * m_includeMarkers
wxCheckBox * m_matchWords
bool m_upToDate
Definition: dialog_find.h:72
std::deque< BOARD_ITEM * >::iterator m_it
Definition: dialog_find.h:71
#define _(s)
Definition: 3d_actions.cpp:33
wxArrayString & GetFindHistoryList()
static TOOL_ACTION selectItem
Selects an item (specified as the event parameter).
Definition: pcb_actions.h:65
std::deque< BOARD_ITEM * > m_hitList
Definition: dialog_find.h:70
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool FindOptionWrap
Definition: dialog_find.cpp:44
bool FindOptionWildcards
Definition: dialog_find.cpp:43
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
bool Matches(const wxFindReplaceData &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: pcb_text.h:67
bool FindOptionCase
Definition: dialog_find.cpp:41
BOARD * GetBoard() const
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions.
wxCheckBox * m_wrap
DRAWINGS & Drawings()
Definition: board.h:289
boost::function< void(BOARD_ITEM *)> m_highlightCallback
Definition: dialog_find.h:74
wxCheckBox * m_includeValues

References _, distance(), BOARD::Drawings(), FindIncludeMarkers, FindIncludeReferences, FindIncludeTexts, FindIncludeValues, FindOptionCase, FindOptionWildcards, FindOptionWords, FindOptionWrap, EDA_DRAW_FRAME::FocusOnLocation(), BOARD::Footprints(), FR_MATCH_WILDCARD, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetFindHistoryList(), EDA_DRAW_FRAME::GetFindReplaceData(), GetItem(), PCB_BASE_FRAME::GetScreen(), TOOLS_HOLDER::GetToolManager(), m_frame, m_highlightCallback, m_hitList, DIALOG_FIND_BASE::m_includeMarkers, DIALOG_FIND_BASE::m_includeReferences, DIALOG_FIND_BASE::m_includeTexts, DIALOG_FIND_BASE::m_includeValues, m_it, DIALOG_FIND_BASE::m_matchCase, DIALOG_FIND_BASE::m_matchWords, DIALOG_FIND_BASE::m_searchCombo, BASE_SCREEN::m_StartVisu, DIALOG_FIND_BASE::m_status, m_upToDate, DIALOG_FIND_BASE::m_wildcards, DIALOG_FIND_BASE::m_wrap, BOARD::Markers(), PCB_TEXT::Matches(), FP_TEXT::Matches(), ZONE::Matches(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, PCB_ACTIONS::selectItem, EDA_BASE_FRAME::ShowInfoBarMsg(), and BOARD::Zones().

Referenced by onFindNextClick(), onFindPreviousClick(), onSearchAgainClick(), and onTextEnter().

◆ SetCallback()

void DIALOG_FIND::SetCallback ( boost::function< void(BOARD_ITEM *)>  aCallback)
inline

Function to be called on each found event.

Must be able to handle nullptr in the case where no item is found

Parameters
aCallback

Definition at line 62 of file dialog_find.h.

63  {
64  m_highlightCallback = aCallback;
65  }
boost::function< void(BOARD_ITEM *)> m_highlightCallback
Definition: dialog_find.h:74

Referenced by PCB_SELECTION_TOOL::find().

◆ 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 98 of file dialog_shim.h.

99  {
100  m_initialFocusTarget = aWindow;
101  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:205

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), 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(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
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:78
const char * name
Definition: DXF_plotter.cpp:59

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), 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 159 of file dialog_shim.cpp.

160 {
161  wxSize sz( x, y );
162  SetSize( ConvertDialogToPixels( sz ) );
163 }

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 186 of file dialog_shim.cpp.

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

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), 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  wxASSERT_MSG( !m_qmodal_parent_disabler,
388  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
389 
390  // quasi-modal: disable only my "optimal" parent
392 
393  // Apple in its infinite wisdom will raise a disabled window before even passing
394  // us the event, so we have no way to stop it. Instead, we must set an order on
395  // the windows so that the quasi-modal will be pushed in front of the disabled
396  // window when it is raised.
398 
399  Show( true );
400 
401  m_qmodal_showing = true;
402 
403  WX_EVENT_LOOP event_loop;
404 
405  m_qmodal_loop = &event_loop;
406 
407  event_loop.Run();
408 
409  m_qmodal_showing = false;
410 
411  return GetReturnCode();
412 }
bool m_qmodal_showing
Definition: dialog_shim.h:209
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:207
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:210
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:42
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:50

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 173 of file dialog_shim.cpp.

174 {
175  wxSize sz( 0, y );
176  return ConvertDialogToPixels( sz ).y;
177 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_closeButton

wxButton* DIALOG_FIND_BASE::m_closeButton
protectedinherited

◆ m_findNext

wxButton* DIALOG_FIND_BASE::m_findNext
protectedinherited

◆ m_findPrevious

wxButton* DIALOG_FIND_BASE::m_findPrevious
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 204 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_frame

PCB_BASE_FRAME* DIALOG_FIND::m_frame
private

Definition at line 69 of file dialog_find.h.

Referenced by DIALOG_FIND(), and search().

◆ m_hash_key

◆ m_highlightCallback

boost::function<void( BOARD_ITEM* )> DIALOG_FIND::m_highlightCallback
private

Definition at line 74 of file dialog_find.h.

Referenced by search().

◆ m_hitList

std::deque<BOARD_ITEM*> DIALOG_FIND::m_hitList
private

Definition at line 70 of file dialog_find.h.

Referenced by DIALOG_FIND(), and search().

◆ m_includeMarkers

wxCheckBox* DIALOG_FIND_BASE::m_includeMarkers
protectedinherited

◆ m_includeReferences

wxCheckBox* DIALOG_FIND_BASE::m_includeReferences
protectedinherited

◆ m_includeTexts

wxCheckBox* DIALOG_FIND_BASE::m_includeTexts
protectedinherited

◆ m_includeValues

wxCheckBox* DIALOG_FIND_BASE::m_includeValues
protectedinherited

◆ m_includeVias

wxCheckBox* DIALOG_FIND_BASE::m_includeVias
protectedinherited

Definition at line 51 of file dialog_find_base.h.

Referenced by DIALOG_FIND_BASE::DIALOG_FIND_BASE().

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 205 of file dialog_shim.h.

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

◆ m_it

std::deque<BOARD_ITEM*>::iterator DIALOG_FIND::m_it
private

Definition at line 71 of file dialog_find.h.

Referenced by DIALOG_FIND(), and search().

◆ m_matchCase

wxCheckBox* DIALOG_FIND_BASE::m_matchCase
protectedinherited

◆ m_matchWords

wxCheckBox* DIALOG_FIND_BASE::m_matchWords
protectedinherited

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 212 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 207 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 209 of file dialog_shim.h.

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

◆ m_searchAgain

wxButton* DIALOG_FIND_BASE::m_searchAgain
protectedinherited

◆ m_searchCombo

wxComboBox* DIALOG_FIND_BASE::m_searchCombo
protectedinherited

◆ m_status

wxStaticText* DIALOG_FIND_BASE::m_status
protectedinherited

Definition at line 56 of file dialog_find_base.h.

Referenced by DIALOG_FIND(), DIALOG_FIND_BASE::DIALOG_FIND_BASE(), and search().

◆ m_tabOrder

◆ m_units

◆ m_upToDate

bool DIALOG_FIND::m_upToDate
private

Definition at line 72 of file dialog_find.h.

Referenced by DIALOG_FIND(), onSearchAgainClick(), and search().

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_wildcards

wxCheckBox* DIALOG_FIND_BASE::m_wildcards
protectedinherited

◆ m_wrap

wxCheckBox* DIALOG_FIND_BASE::m_wrap
protectedinherited

◆ searchStringLabel

wxStaticText* DIALOG_FIND_BASE::searchStringLabel
protectedinherited

Definition at line 41 of file dialog_find_base.h.

Referenced by DIALOG_FIND_BASE::DIALOG_FIND_BASE().


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