KiCad PCB EDA Suite
DIALOG_TEXT_PROPERTIES Class Reference

#include <dialog_text_properties.h>

Inheritance diagram for DIALOG_TEXT_PROPERTIES:
DIALOG_TEXT_PROPERTIES_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_TEXT_PROPERTIES (PCB_BASE_EDIT_FRAME *aParent, BOARD_ITEM *aItem)
 
 ~DIALOG_TEXT_PROPERTIES ()
 
virtual void OnSetFocusText (wxFocusEvent &event) override
 Used to select the variant part of some text fields (for instance, the question mark or number in a reference). 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)
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
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

virtual void OnInitDlg (wxInitDialogEvent &event)
 
virtual void OnOkClick (wxCommandEvent &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) 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...
 

Protected Attributes

wxBoxSizer * m_MultiLineSizer
 
wxStyledTextCtrl * m_MultiLineText
 
wxBoxSizer * m_SingleLineSizer
 
wxStaticText * m_TextLabel
 
wxTextCtrl * m_SingleLineText
 
wxCheckBox * m_cbLocked
 
wxStaticText * m_LayerLabel
 
PCB_LAYER_BOX_SELECTORm_LayerSelectionCtrl
 
wxCheckBox * m_Visible
 
wxStaticText * m_SizeXLabel
 
wxTextCtrl * m_SizeXCtrl
 
wxStaticText * m_SizeXUnits
 
wxCheckBox * m_Italic
 
wxStaticText * m_SizeYLabel
 
wxTextCtrl * m_SizeYCtrl
 
wxStaticText * m_SizeYUnits
 
wxStaticText * m_staticText11
 
wxChoice * m_JustifyChoice
 
wxStaticText * m_ThicknessLabel
 
wxTextCtrl * m_ThicknessCtrl
 
wxStaticText * m_ThicknessUnits
 
wxStaticText * m_OrientLabel
 
wxComboBox * m_OrientCtrl
 
wxStaticText * m_PositionXLabel
 
wxTextCtrl * m_PositionXCtrl
 
wxStaticText * m_PositionXUnits
 
wxCheckBox * m_Mirrored
 
wxStaticText * m_PositionYLabel
 
wxTextCtrl * m_PositionYCtrl
 
wxStaticText * m_PositionYUnits
 
wxCheckBox * m_KeepUpright
 
wxStaticText * m_statusLine
 
wxStaticLine * m_staticline
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
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

bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void OnCharHook (wxKeyEvent &aEvent) override
 

Private Attributes

PCB_BASE_EDIT_FRAMEm_Parent
 
BOARD_ITEMm_item
 
EDA_TEXTm_edaText
 
FP_TEXTm_fpText
 
PCB_TEXTm_pcbText
 
UNIT_BINDER m_textWidth
 
UNIT_BINDER m_textHeight
 
UNIT_BINDER m_thickness
 
UNIT_BINDER m_posX
 
UNIT_BINDER m_posY
 
UNIT_BINDER m_orientation
 
double m_OrientValue
 

Detailed Description

Definition at line 40 of file dialog_text_properties.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_TEXT_PROPERTIES()

DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES ( PCB_BASE_EDIT_FRAME aParent,
BOARD_ITEM aItem 
)

Definition at line 40 of file dialog_text_properties.cpp.

40  :
41  DIALOG_TEXT_PROPERTIES_BASE( aParent ),
42  m_Parent( aParent ),
43  m_item( aItem ),
44  m_edaText( nullptr ),
45  m_fpText( nullptr ),
46  m_pcbText( nullptr ),
52  m_orientation( aParent, m_OrientLabel, m_OrientCtrl, nullptr )
53 {
54  wxString title;
55 
56  // Configure display origin transforms
59 
60  m_MultiLineText->SetEOLMode( wxSTC_EOL_LF );
61 
62  // A hack which causes Scintilla to auto-size the text editor canvas
63  // See: https://github.com/jacobslusser/ScintillaNET/issues/216
64  m_MultiLineText->SetScrollWidth( 1 );
65  m_MultiLineText->SetScrollWidthTracking( true );
66 
67  if( m_item->Type() == PCB_FP_TEXT_T )
68  {
69  title = _( "Footprint Text Properties" );
70 
71  m_fpText = (FP_TEXT*) m_item;
72  m_edaText = static_cast<EDA_TEXT*>( m_fpText );
73 
74  switch( m_fpText->GetType() )
75  {
76  case FP_TEXT::TEXT_is_REFERENCE: m_TextLabel->SetLabel( _( "Reference:" ) ); break;
77  case FP_TEXT::TEXT_is_VALUE: m_TextLabel->SetLabel( _( "Value:" ) ); break;
78  case FP_TEXT::TEXT_is_DIVERS: m_TextLabel->SetLabel( _( "Text:" ) ); break;
79  }
80 
82  m_MultiLineSizer->Show( false );
83  }
84  else
85  {
86  title = _( "Text Properties" );
87 
88  m_pcbText = (PCB_TEXT*) aItem;
89  m_edaText = static_cast<EDA_TEXT*>( m_pcbText );
90 
92  m_SingleLineSizer->Show( false );
93 
94  int size = wxNORMAL_FONT->GetPointSize();
95  wxFont fixedFont( size, wxFONTFAMILY_TELETYPE, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL );
96 
97  for( size_t i = 0; i < wxSTC_STYLE_MAX; ++i )
98  m_MultiLineText->StyleSetFont( i, fixedFont );
99 
100  // Addresses a bug in wx3.0 where styles are not correctly set
101  m_MultiLineText->StyleClearAll();
102 
103  // This option makes sense only for footprint texts; texts on board are always visible.
104  m_Visible->SetValue( true );
105  m_Visible->Enable( false );
106 
107  m_KeepUpright->Show( false );
108  m_statusLine->Show( false );
109  }
110 
111  SetTitle( title );
112  m_hash_key = title;
113 
114  // Configure the layers list selector. Note that footprints are built outside the current
115  // board and so we may need to show all layers if the text is on an unactivated layer.
118 
122 
123  m_OrientValue = 0.0;
126 
127  // Set predefined rotations in combo dropdown, according to the locale floating point
128  // separator notation
129  double rot_list[] = { 0.0, 90.0, -90.0, 180.0 };
130 
131  for( size_t ii = 0; ii < m_OrientCtrl->GetCount() && ii < 4; ++ii )
132  m_OrientCtrl->SetString( ii, wxString::Format( "%.1f", rot_list[ii] ) );
133 
134  // Set font sizes
135  wxFont infoFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
136  infoFont.SetSymbolicSize( wxFONTSIZE_X_SMALL );
137  m_statusLine->SetFont( infoFont );
138 
139  m_sdbSizerOK->SetDefault();
140 
141  // We can't set the tab order through wxWidgets due to shortcomings in their mnemonics
142  // implementation on MSW
143  m_tabOrder = {
144  m_LayerLabel,
146  m_SizeXCtrl,
147  m_SizeYCtrl,
151  m_Visible,
152  m_Italic,
154  m_OrientCtrl,
155  m_Mirrored,
157  m_sdbSizerOK,
159  };
160 
161  // wxTextCtrls fail to generate wxEVT_CHAR events when the wxTE_MULTILINE flag is set,
162  // so we have to listen to wxEVT_CHAR_HOOK events instead.
163  Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( DIALOG_TEXT_PROPERTIES::OnCharHook ), NULL, this );
164 
166 }
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
std::string m_hash_key
Definition: dialog_shim.h:200
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:219
DIALOG_TEXT_PROPERTIES_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Text Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxSYSTEM_MENU)
void SetBoardFrame(PCB_BASE_FRAME *aFrame)
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.h:515
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
virtual void SetPrecision(int aLength)
Normally not needed, but can be used to set the precision when using internal units that are floats (...
Definition: unit_binder.cpp:90
#define NULL
TEXT_TYPE GetType() const
Definition: fp_text.h:141
void ShowNonActivatedLayers(bool aShow)
bool SetLayersHotkeys(bool value)
PCB_BASE_EDIT_FRAME * m_Parent
void OnCharHook(wxKeyEvent &aEvent) override
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual void SetUnits(EDA_UNITS aUnits)
Normally not needed (as the UNIT_BINDER inherits from the parent frame), but can be used to set to DE...
Definition: unit_binder.cpp:81
PCB_LAYER_BOX_SELECTOR * m_LayerSelectionCtrl
#define _(s)
Definition: 3d_actions.cpp:33
void SetCoordType(ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType)
Set the current origin transform mode.
Definition: unit_binder.h:173
BOARD * GetBoard() const
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References _, ORIGIN_TRANSFORMS::ABS_X_COORD, ORIGIN_TRANSFORMS::ABS_Y_COORD, DEGREES, DIALOG_SHIM::finishDialogSettings(), Format(), PCB_BASE_FRAME::GetBoard(), BOARD_ITEM::GetLayer(), FP_TEXT::GetType(), BOARD::IsLayerEnabled(), m_edaText, m_fpText, DIALOG_SHIM::m_hash_key, DIALOG_TEXT_PROPERTIES_BASE::m_Italic, m_item, DIALOG_TEXT_PROPERTIES_BASE::m_JustifyChoice, DIALOG_TEXT_PROPERTIES_BASE::m_KeepUpright, DIALOG_TEXT_PROPERTIES_BASE::m_LayerLabel, DIALOG_TEXT_PROPERTIES_BASE::m_LayerSelectionCtrl, DIALOG_TEXT_PROPERTIES_BASE::m_Mirrored, DIALOG_TEXT_PROPERTIES_BASE::m_MultiLineSizer, DIALOG_TEXT_PROPERTIES_BASE::m_MultiLineText, m_orientation, DIALOG_TEXT_PROPERTIES_BASE::m_OrientCtrl, m_OrientValue, m_Parent, m_pcbText, DIALOG_TEXT_PROPERTIES_BASE::m_PositionXCtrl, DIALOG_TEXT_PROPERTIES_BASE::m_PositionYCtrl, m_posX, m_posY, DIALOG_TEXT_PROPERTIES_BASE::m_sdbSizerCancel, DIALOG_TEXT_PROPERTIES_BASE::m_sdbSizerOK, DIALOG_TEXT_PROPERTIES_BASE::m_SingleLineSizer, DIALOG_TEXT_PROPERTIES_BASE::m_SingleLineText, DIALOG_TEXT_PROPERTIES_BASE::m_SizeXCtrl, DIALOG_TEXT_PROPERTIES_BASE::m_SizeYCtrl, DIALOG_TEXT_PROPERTIES_BASE::m_statusLine, DIALOG_SHIM::m_tabOrder, DIALOG_TEXT_PROPERTIES_BASE::m_TextLabel, DIALOG_TEXT_PROPERTIES_BASE::m_ThicknessCtrl, DIALOG_TEXT_PROPERTIES_BASE::m_Visible, NULL, OnCharHook(), PCB_FP_TEXT_T, PCB_LAYER_BOX_SELECTOR::Resync(), PCB_LAYER_BOX_SELECTOR::SetBoardFrame(), UNIT_BINDER::SetCoordType(), DIALOG_SHIM::SetInitialFocus(), LAYER_SELECTOR::SetLayersHotkeys(), UNIT_BINDER::SetPrecision(), UNIT_BINDER::SetUnits(), PCB_LAYER_BOX_SELECTOR::ShowNonActivatedLayers(), FP_TEXT::TEXT_is_DIVERS, FP_TEXT::TEXT_is_REFERENCE, FP_TEXT::TEXT_is_VALUE, and EDA_ITEM::Type().

◆ ~DIALOG_TEXT_PROPERTIES()

DIALOG_TEXT_PROPERTIES::~DIALOG_TEXT_PROPERTIES ( )

Definition at line 169 of file dialog_text_properties.cpp.

170 {
171  Disconnect( wxEVT_CHAR_HOOK, wxKeyEventHandler( DIALOG_TEXT_PROPERTIES::OnCharHook ), NULL, this );
172 }
#define NULL
void OnCharHook(wxKeyEvent &aEvent) override

References NULL, and OnCharHook().

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 307 of file dialog_shim.cpp.

308 {
309  // so we can do logging of this state change:
310  return wxDialog::Enable( enable );
311 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 445 of file dialog_shim.cpp.

446 {
447  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
448  // handle validation in the same way as other dialogs.
449  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
450  return;
451 
452  SetReturnCode( retCode );
453 
454  if( !IsQuasiModal() )
455  {
456  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
457  "wasn't called" );
458  return;
459  }
460 
461  if( m_qmodal_loop )
462  {
463  if( m_qmodal_loop->IsRunning() )
464  m_qmodal_loop->Exit( 0 );
465  else
466  m_qmodal_loop->ScheduleExit( 0 );
467 
468  m_qmodal_loop = nullptr;
469  }
470 
472  m_qmodal_parent_disabler = nullptr;
473 
474  Show( false );
475 }
bool IsQuasiModal() const
Definition: dialog_shim.h:107
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_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_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), 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_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(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), 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().

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

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

Referenced by OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 131 of file dialog_shim.h.

132  {
133  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
134  e.ShiftDown() && !e.MetaDown();
135  }

Referenced by 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::BuildLibrariesListBox(), 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(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), 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(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnCharHook()

void DIALOG_TEXT_PROPERTIES::OnCharHook ( wxKeyEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_SHIM.

Definition at line 183 of file dialog_text_properties.cpp.

184 {
185  if( aEvent.GetKeyCode() == WXK_RETURN && aEvent.ShiftDown() )
186  {
187  if( TransferDataFromWindow() )
188  {
189  // Do not use EndModal to close the dialog that can be opened
190  // in quasi modal mode
191  SetReturnCode( wxID_OK );
192  Close();
193  }
194  }
195  else if( m_MultiLineText->IsShown() && m_MultiLineText->HasFocus() )
196  {
197  if( aEvent.GetKeyCode() == WXK_TAB && !aEvent.ControlDown() )
198  {
199  m_MultiLineText->Tab();
200  }
201  else if( IsCtrl( 'Z', aEvent ) )
202  {
203  m_MultiLineText->Undo();
204  }
205  else if( IsShiftCtrl( 'Z', aEvent ) || IsCtrl( 'Y', aEvent ) )
206  {
207  m_MultiLineText->Redo();
208  }
209  else if( IsCtrl( 'X', aEvent ) )
210  {
211  m_MultiLineText->Cut();
212  }
213  else if( IsCtrl( 'C', aEvent ) )
214  {
215  m_MultiLineText->Copy();
216  }
217  else if( IsCtrl( 'V', aEvent ) )
218  {
219  m_MultiLineText->Paste();
220  }
221  else if( IsCtrl( 'A', aEvent ) )
222  {
223  m_MultiLineText->SelectAll();
224  }
225  else
226  {
227  aEvent.Skip();
228  }
229  }
230  else
231  {
232  aEvent.Skip();
233  }
234 }
static bool IsShiftCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:131
static bool IsCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:125

References DIALOG_SHIM::IsCtrl(), DIALOG_SHIM::IsShiftCtrl(), DIALOG_TEXT_PROPERTIES_BASE::m_MultiLineText, and TransferDataFromWindow().

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

◆ OnInitDlg()

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

◆ OnOkClick()

virtual void DIALOG_TEXT_PROPERTIES_BASE::OnOkClick ( wxCommandEvent &  event)
inlineprotectedvirtualinherited

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 352 of file dialog_shim.cpp.

353 {
354  if( m_firstPaintEvent )
355  {
357 
358  selectAllInTextCtrls( GetChildren() );
359 
362  else
363  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
364 
365  m_firstPaintEvent = false;
366  }
367 
368  event.Skip();
369 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210
bool m_firstPaintEvent
Definition: dialog_shim.h:209
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
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().

◆ OnSetFocusText()

void DIALOG_TEXT_PROPERTIES::OnSetFocusText ( wxFocusEvent &  event)
overridevirtual

Used to select the variant part of some text fields (for instance, the question mark or number in a reference).

Parameters
event

Reimplemented from DIALOG_TEXT_PROPERTIES_BASE.

Definition at line 237 of file dialog_text_properties.cpp.

238 {
239 #ifdef __WXGTK__
240  // Force an update of the text control before setting the text selection
241  // This is needed because GTK seems to ignore the selection on first update
242  //
243  // Note that we can't do this on OSX as it tends to provoke Apple's
244  // "[NSAlert runModal] may not be invoked inside of transaction begin/commit pair"
245  // bug. See: https://bugs.launchpad.net/kicad/+bug/1837225
247  m_SingleLineText->Update();
248 #endif
249 
251  KIUI::SelectReferenceNumber( static_cast<wxTextEntry*>( m_SingleLineText ) );
252  else
253  m_SingleLineText->SetSelection( -1, -1 );
254 
255  event.Skip();
256 }
void SelectReferenceNumber(wxTextEntry *aTextEntry)
Select the number (or "?") in a reference for ease of editing.
Definition: ui_common.cpp:102
TEXT_TYPE GetType() const
Definition: fp_text.h:141

References FP_TEXT::GetType(), m_fpText, DIALOG_TEXT_PROPERTIES_BASE::m_SingleLineText, KIUI::SelectReferenceNumber(), and FP_TEXT::TEXT_is_REFERENCE.

◆ 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:184

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::BuildLibrariesListBox(), SIM_PLOT_FRAME::canCloseWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), 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_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), SCH_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(), BOARD_EDITOR_CONTROL::ExportNetlist(), 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(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SIM_PLOT_FRAME::initWorkbook(), 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(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_PROPERTIES_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_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), 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(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_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(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), 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::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), 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_PROPERTIES_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_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), 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 282 of file dialog_shim.cpp.

283 {
284  const char* hash_key;
285 
286  if( m_hash_key.size() )
287  {
288  // a special case like EDA_LIST_DIALOG, which has multiple uses.
289  hash_key = m_hash_key.c_str();
290  }
291  else
292  {
293  hash_key = typeid(*this).name();
294  }
295 
296  RECT_MAP::iterator it = class_map.find( hash_key );
297 
298  if( it == class_map.end() )
299  return;
300 
301  EDA_RECT rect = it->second;
302  rect.SetSize( 0, 0 );
303  class_map[ hash_key ] = rect;
304 }
std::string m_hash_key
Definition: dialog_shim.h:200
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().

◆ 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:210

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_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), 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_INSPECTION_REPORTER::DIALOG_INSPECTION_REPORTER(), 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_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_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::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(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 187 of file dialog_shim.cpp.

188 {
189  wxDialog::SetPosition( aNewPosition );
190 
191  // Now update the stored position:
192  const char* hash_key;
193 
194  if( m_hash_key.size() )
195  {
196  // a special case like EDA_LIST_DIALOG, which has multiple uses.
197  hash_key = m_hash_key.c_str();
198  }
199  else
200  {
201  hash_key = typeid(*this).name();
202  }
203 
204  RECT_MAP::iterator it = class_map.find( hash_key );
205 
206  if( it == class_map.end() )
207  return;
208 
209  EDA_RECT rect = it->second;
210  rect.SetOrigin( aNewPosition );
211 
212  class_map[ hash_key ] = rect;
213 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
std::string m_hash_key
Definition: dialog_shim.h:200
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:126
static RECT_MAP class_map
Handle the component boundary box.
Definition: eda_rect.h:42

References class_map, DIALOG_SHIM::m_hash_key, EDA_RECT::SetOrigin(), and PCAD2KICAD::SetPosition().

Referenced by DIALOG_SCH_FIND::DIALOG_SCH_FIND(), and PCB_BASE_FRAME::SelectOneLayer().

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

217 {
218  bool ret;
219  const char* hash_key;
220 
221  if( m_hash_key.size() )
222  {
223  // a special case like EDA_LIST_DIALOG, which has multiple uses.
224  hash_key = m_hash_key.c_str();
225  }
226  else
227  {
228  hash_key = typeid(*this).name();
229  }
230 
231  // Show or hide the window. If hiding, save current position and size.
232  // If showing, use previous position and size.
233  if( show )
234  {
235 #ifndef __WINDOWS__
236  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
237 #endif
238  ret = wxDialog::Show( show );
239 
240  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
241  EDA_RECT savedDialogRect = class_map[ hash_key ];
242 
243  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
244  {
245  if( m_useCalculatedSize )
246  {
247  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
248  wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
249  }
250  else
251  {
252  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
253  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
254  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
255  0 );
256  }
257  }
258 
259  // Be sure that the dialog appears in a visible area
260  // (the dialog position might have been stored at the time when it was
261  // shown on another display)
262  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
263  Centre();
264  }
265  else
266  {
267  // Save the dialog's position & size before hiding, using classname as key
268  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
269 
270 #ifdef __WXMAC__
271  if ( m_eventLoop )
272  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
273 #endif
274 
275  ret = wxDialog::Show( show );
276  }
277 
278  return ret;
279 }
std::string m_hash_key
Definition: dialog_shim.h:200
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:204
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 395 of file dialog_shim.cpp.

396 {
397  // This is an exception safe way to zero a pointer before returning.
398  // Yes, even though DismissModal() clears this first normally, this is
399  // here in case there's an exception before the dialog is dismissed.
400  struct NULLER
401  {
402  void*& m_what;
403  NULLER( void*& aPtr ) : m_what( aPtr ) {}
404  ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
405  } clear_this( (void*&) m_qmodal_loop );
406 
407  // release the mouse if it's currently captured as the window having it
408  // will be disabled when this dialog is shown -- but will still keep the
409  // capture making it impossible to do anything in the modal dialog itself
410  wxWindow* win = wxWindow::GetCapture();
411  if( win )
412  win->ReleaseMouse();
413 
414  // Get the optimal parent
415  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
416 
417  wxASSERT_MSG( !m_qmodal_parent_disabler,
418  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
419 
420  // quasi-modal: disable only my "optimal" parent
422 
423  // Apple in its infinite wisdom will raise a disabled window before even passing
424  // us the event, so we have no way to stop it. Instead, we must set an order on
425  // the windows so that the quasi-modal will be pushed in front of the disabled
426  // window when it is raised.
428 
429  Show( true );
430 
431  m_qmodal_showing = true;
432 
433  WX_EVENT_LOOP event_loop;
434 
435  m_qmodal_loop = &event_loop;
436 
437  event_loop.Run();
438 
439  m_qmodal_showing = false;
440 
441  return GetReturnCode();
442 }
bool m_qmodal_showing
Definition: dialog_shim.h:214
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215
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:65

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(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), 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::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ TransferDataFromWindow()

bool DIALOG_TEXT_PROPERTIES::TransferDataFromWindow ( )
overrideprivate

Definition at line 325 of file dialog_text_properties.cpp.

326 {
327  if( !DIALOG_TEXT_PROPERTIES_BASE::TransferDataFromWindow() )
328  return false;
329 
332  {
333  return false;
334  }
335 
336  BOARD_COMMIT commit( m_Parent );
337  commit.Modify( m_item );
338 
339  // If no other command in progress, prepare undo command
340  // (for a command in progress, will be made later, at the completion of command)
341  bool pushCommit = ( m_item->GetEditFlags() == 0 );
342 
343  // Set IN_EDIT flag to force undo/redo/abort proper operation and avoid new calls to
344  // SaveCopyInUndoList for the same text if is moved, and then rotated, edited, etc....
345  if( !pushCommit )
346  m_item->SetFlags( IN_EDIT );
347 
348  // Set the new text content
349  if( m_SingleLineText->IsShown() )
350  {
351  if( !m_SingleLineText->GetValue().IsEmpty() )
352  m_edaText->SetText( m_SingleLineText->GetValue() );
353  }
354  else if( m_MultiLineText->IsShown() )
355  {
356  if( !m_MultiLineText->GetValue().IsEmpty() )
357  {
358  BOARD* board = m_Parent->GetBoard();
359  wxString txt = board->ConvertCrossReferencesToKIIDs( m_MultiLineText->GetValue() );
360 
361 #ifdef __WINDOWS__
362  // On Windows, a new line is coded as \r\n. We use only \n in kicad files and in
363  // drawing routines so strip the \r char.
364  txt.Replace( "\r", "" );
365 #endif
367  }
368  }
369 
370  m_item->SetLocked( m_cbLocked->GetValue() );
371 
373 
376  m_edaText->SetTextPos( wxPoint( m_posX.GetValue(), m_posY.GetValue() ) );
377 
378  if( m_fpText )
380 
381  // Test for acceptable values for thickness and size and clamp if fails
383 
384  if( m_edaText->GetTextThickness() > maxPenWidth )
385  {
386  DisplayError( this, _( "The text thickness is too large for the text size.\n"
387  "It will be clamped." ) );
388  m_edaText->SetTextThickness( maxPenWidth );
389  }
390 
391  m_edaText->SetVisible( m_Visible->GetValue() );
392  m_edaText->SetItalic( m_Italic->GetValue() );
395  m_edaText->SetMirrored( m_Mirrored->GetValue() );
396 
397  if( m_fpText )
398  m_fpText->SetKeepUpright( m_KeepUpright->GetValue() );
399 
400  switch( m_JustifyChoice->GetSelection() )
401  {
405  default: break;
406  }
407 
408  if( pushCommit )
409  commit.Push( _( "Change text properties" ) );
410 
411  return true;
412 }
void SetMirrored(bool isMirrored)
Definition: eda_text.h:195
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:194
void SetItalic(bool isItalic)
Definition: eda_text.h:186
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
void SetVisible(bool aVisible)
Definition: eda_text.h:192
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:244
virtual void SetLocked(bool aLocked)
Modify the 'lock' status for of the item.
Definition: board_item.h:257
int GetTextThickness() const
Definition: eda_text.h:167
LAYER_NUM GetLayerSelection() const
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.
Definition: gr_text.cpp:69
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:203
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
STATUS_FLAGS GetEditFlags() const
Definition: eda_item.h:208
const wxSize & GetTextSize() const
Definition: eda_text.h:245
#define IN_EDIT
Item currently edited.
Definition: eda_item.h:105
#define TEXTS_MAX_SIZE
Maximum text size in internal units (10 inches)
Definition: pcbnew.h:32
PCB_BASE_EDIT_FRAME * m_Parent
#define TEXTS_MIN_SIZE
Minimum text size in internal units (1 mil)
Definition: pcbnew.h:31
void SetKeepUpright(bool aKeepUpright)
Definition: fp_text.h:115
virtual bool Validate(double aMin, double aMax, EDA_UNITS aUnits=EDA_UNITS::UNSCALED)
Validate the control against the given range, informing the user of any errors found.
PCB_LAYER_BOX_SELECTOR * m_LayerSelectionCtrl
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:208
#define _(s)
Definition: 3d_actions.cpp:33
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
These Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which ar...
Definition: string.cpp:78
wxString ConvertCrossReferencesToKIIDs(const wxString &aSource) const
Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.
Definition: board.cpp:930
void SetLocalCoord()
Definition: fp_text.cpp:206
virtual long long int GetValue()
Return the current value in Internal Units.
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:166
virtual void SetTextAngle(double aAngle)
Definition: eda_text.h:174
BOARD * GetBoard() const
virtual double GetDoubleValue()
Return the current value in Internal Units.
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:905

References _, Clamp_Text_PenSize(), BOARD::ConvertCrossReferencesToKIIDs(), CTX_QUOTED_STR, DisplayError(), EscapeString(), PCB_BASE_FRAME::GetBoard(), UNIT_BINDER::GetDoubleValue(), EDA_ITEM::GetEditFlags(), LAYER_BOX_SELECTOR::GetLayerSelection(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), UNIT_BINDER::GetValue(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, IN_EDIT, DIALOG_TEXT_PROPERTIES_BASE::m_cbLocked, m_edaText, m_fpText, DIALOG_TEXT_PROPERTIES_BASE::m_Italic, m_item, DIALOG_TEXT_PROPERTIES_BASE::m_JustifyChoice, DIALOG_TEXT_PROPERTIES_BASE::m_KeepUpright, DIALOG_TEXT_PROPERTIES_BASE::m_LayerSelectionCtrl, DIALOG_TEXT_PROPERTIES_BASE::m_Mirrored, DIALOG_TEXT_PROPERTIES_BASE::m_MultiLineText, m_orientation, m_OrientValue, m_Parent, m_posX, m_posY, DIALOG_TEXT_PROPERTIES_BASE::m_SingleLineText, m_textHeight, m_textWidth, m_thickness, DIALOG_TEXT_PROPERTIES_BASE::m_Visible, COMMIT::Modify(), BOARD_COMMIT::Push(), EDA_ITEM::SetFlags(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), FP_TEXT::SetKeepUpright(), BOARD_ITEM::SetLayer(), FP_TEXT::SetLocalCoord(), BOARD_ITEM::SetLocked(), EDA_TEXT::SetMirrored(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), EDA_TEXT::SetVisible(), TEXTS_MAX_SIZE, TEXTS_MIN_SIZE, ToLAYER_ID(), and UNIT_BINDER::Validate().

Referenced by OnCharHook().

◆ TransferDataToWindow()

bool DIALOG_TEXT_PROPERTIES::TransferDataToWindow ( )
overrideprivate

Definition at line 259 of file dialog_text_properties.cpp.

260 {
261  if( m_SingleLineText->IsShown() )
262  {
263  m_SingleLineText->SetValue( m_edaText->GetText() );
264 
266  KIUI::SelectReferenceNumber( static_cast<wxTextEntry*>( m_SingleLineText ) );
267  else
268  m_SingleLineText->SetSelection( -1, -1 );
269  }
270  else if( m_MultiLineText->IsShown() )
271  {
272  BOARD* board = m_Parent->GetBoard();
273  wxString converted = board->ConvertKIIDsToCrossReferences( m_edaText->GetText() );
274 
275  m_MultiLineText->SetValue( converted );
276  m_MultiLineText->SetSelection( -1, -1 );
277  }
278 
279  if( m_item->Type() == PCB_FP_TEXT_T && m_fpText )
280  {
281  FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( m_fpText->GetParent() );
282  wxString msg;
283 
284  if( footprint )
285  {
286  msg.Printf( _( "Footprint %s (%s), %s, rotated %.1f deg"),
287  footprint->GetReference(),
288  footprint->GetValue(),
289  footprint->IsFlipped() ? _( "back side (mirrored)" ) : _( "front side" ),
290  footprint->GetOrientation() / 10.0 );
291  }
292 
293  m_statusLine->SetLabel( msg );
294  }
295  else
296  {
297  m_statusLine->Show( false );
298  }
299 
300  m_cbLocked->SetValue( m_item->IsLocked() );
301 
303 
309 
310  m_Visible->SetValue( m_edaText->IsVisible() );
311  m_Italic->SetValue( m_edaText->IsItalic() );
313  m_JustifyChoice->SetSelection( (int) hJustify + 1 );
316  m_Mirrored->SetValue( m_edaText->IsMirrored() );
317 
318  if( m_fpText )
319  m_KeepUpright->SetValue( m_fpText->IsKeepUpright() );
320 
321  return DIALOG_TEXT_PROPERTIES_BASE::TransferDataToWindow();
322 }
void SelectReferenceNumber(wxTextEntry *aTextEntry)
Select the number (or "?") in a reference for ease of editing.
Definition: ui_common.cpp:102
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:61
bool IsMirrored() const
Definition: eda_text.h:196
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
const wxString & GetValue() const
Definition: footprint.h:448
bool IsKeepUpright() const
Definition: fp_text.h:110
bool IsVisible() const
Definition: eda_text.h:193
double GetTextAngle() const
Definition: eda_text.h:181
int GetTextThickness() const
Definition: eda_text.h:167
bool IsItalic() const
Definition: eda_text.h:187
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:205
TEXT_TYPE GetType() const
Definition: fp_text.h:141
const wxSize & GetTextSize() const
Definition: eda_text.h:245
const wxString & GetReference() const
Definition: footprint.h:426
int SetLayerSelection(LAYER_NUM layer)
PCB_BASE_EDIT_FRAME * m_Parent
bool IsFlipped() const
Definition: footprint.h:266
virtual bool IsLocked() const
Definition: board_item.h:249
PCB_LAYER_BOX_SELECTOR * m_LayerSelectionCtrl
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
#define _(s)
Definition: 3d_actions.cpp:33
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
wxString ConvertKIIDsToCrossReferences(const wxString &aSource) const
Definition: board.cpp:984
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
BOARD * GetBoard() const
virtual void SetDoubleValue(double aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:168
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References _, BOARD::ConvertKIIDsToCrossReferences(), PCB_BASE_FRAME::GetBoard(), EDA_TEXT::GetHorizJustify(), BOARD_ITEM::GetLayer(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParent(), FOOTPRINT::GetReference(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), FP_TEXT::GetType(), FOOTPRINT::GetValue(), FOOTPRINT::IsFlipped(), EDA_TEXT::IsItalic(), FP_TEXT::IsKeepUpright(), BOARD_ITEM::IsLocked(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsVisible(), DIALOG_TEXT_PROPERTIES_BASE::m_cbLocked, m_edaText, m_fpText, DIALOG_TEXT_PROPERTIES_BASE::m_Italic, m_item, DIALOG_TEXT_PROPERTIES_BASE::m_JustifyChoice, DIALOG_TEXT_PROPERTIES_BASE::m_KeepUpright, DIALOG_TEXT_PROPERTIES_BASE::m_LayerSelectionCtrl, DIALOG_TEXT_PROPERTIES_BASE::m_Mirrored, DIALOG_TEXT_PROPERTIES_BASE::m_MultiLineText, m_orientation, m_OrientValue, m_Parent, m_posX, m_posY, DIALOG_TEXT_PROPERTIES_BASE::m_SingleLineText, DIALOG_TEXT_PROPERTIES_BASE::m_statusLine, m_textHeight, m_textWidth, m_thickness, DIALOG_TEXT_PROPERTIES_BASE::m_Visible, PCB_FP_TEXT_T, KIUI::SelectReferenceNumber(), UNIT_BINDER::SetDoubleValue(), LAYER_BOX_SELECTOR::SetLayerSelection(), UNIT_BINDER::SetValue(), FP_TEXT::TEXT_is_REFERENCE, and EDA_ITEM::Type().

◆ 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_cbLocked

wxCheckBox* DIALOG_TEXT_PROPERTIES_BASE::m_cbLocked
protectedinherited

◆ m_edaText

EDA_TEXT* DIALOG_TEXT_PROPERTIES::m_edaText
private

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 209 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_fpText

FP_TEXT* DIALOG_TEXT_PROPERTIES::m_fpText
private

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 210 of file dialog_shim.h.

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

◆ m_Italic

wxCheckBox* DIALOG_TEXT_PROPERTIES_BASE::m_Italic
protectedinherited

◆ m_item

BOARD_ITEM* DIALOG_TEXT_PROPERTIES::m_item
private

◆ m_JustifyChoice

wxChoice* DIALOG_TEXT_PROPERTIES_BASE::m_JustifyChoice
protectedinherited

◆ m_KeepUpright

wxCheckBox* DIALOG_TEXT_PROPERTIES_BASE::m_KeepUpright
protectedinherited

◆ m_LayerLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_LayerLabel
protectedinherited

◆ m_LayerSelectionCtrl

PCB_LAYER_BOX_SELECTOR* DIALOG_TEXT_PROPERTIES_BASE::m_LayerSelectionCtrl
protectedinherited

◆ m_Mirrored

wxCheckBox* DIALOG_TEXT_PROPERTIES_BASE::m_Mirrored
protectedinherited

◆ m_MultiLineSizer

wxBoxSizer* DIALOG_TEXT_PROPERTIES_BASE::m_MultiLineSizer
protectedinherited

◆ m_MultiLineText

wxStyledTextCtrl* DIALOG_TEXT_PROPERTIES_BASE::m_MultiLineText
protectedinherited

◆ m_orientation

UNIT_BINDER DIALOG_TEXT_PROPERTIES::m_orientation
private

◆ m_OrientCtrl

wxComboBox* DIALOG_TEXT_PROPERTIES_BASE::m_OrientCtrl
protectedinherited

◆ m_OrientLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_OrientLabel
protectedinherited

◆ m_OrientValue

double DIALOG_TEXT_PROPERTIES::m_OrientValue
private

◆ m_Parent

PCB_BASE_EDIT_FRAME* DIALOG_TEXT_PROPERTIES::m_Parent
private

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 217 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_pcbText

PCB_TEXT* DIALOG_TEXT_PROPERTIES::m_pcbText
private

Definition at line 58 of file dialog_text_properties.h.

Referenced by DIALOG_TEXT_PROPERTIES().

◆ m_PositionXCtrl

wxTextCtrl* DIALOG_TEXT_PROPERTIES_BASE::m_PositionXCtrl
protectedinherited

◆ m_PositionXLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_PositionXLabel
protectedinherited

◆ m_PositionXUnits

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_PositionXUnits
protectedinherited

◆ m_PositionYCtrl

wxTextCtrl* DIALOG_TEXT_PROPERTIES_BASE::m_PositionYCtrl
protectedinherited

◆ m_PositionYLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_PositionYLabel
protectedinherited

◆ m_PositionYUnits

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_PositionYUnits
protectedinherited

◆ m_posX

UNIT_BINDER DIALOG_TEXT_PROPERTIES::m_posX
private

◆ m_posY

UNIT_BINDER DIALOG_TEXT_PROPERTIES::m_posY
private

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_TEXT_PROPERTIES_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_TEXT_PROPERTIES_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_TEXT_PROPERTIES_BASE::m_sdbSizerOK
protectedinherited

◆ m_SingleLineSizer

wxBoxSizer* DIALOG_TEXT_PROPERTIES_BASE::m_SingleLineSizer
protectedinherited

◆ m_SingleLineText

◆ m_SizeXCtrl

wxTextCtrl* DIALOG_TEXT_PROPERTIES_BASE::m_SizeXCtrl
protectedinherited

◆ m_SizeXLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_SizeXLabel
protectedinherited

◆ m_SizeXUnits

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_SizeXUnits
protectedinherited

◆ m_SizeYCtrl

wxTextCtrl* DIALOG_TEXT_PROPERTIES_BASE::m_SizeYCtrl
protectedinherited

◆ m_SizeYLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_SizeYLabel
protectedinherited

◆ m_SizeYUnits

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_SizeYUnits
protectedinherited

◆ m_staticline

wxStaticLine* DIALOG_TEXT_PROPERTIES_BASE::m_staticline
protectedinherited

◆ m_staticText11

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_staticText11
protectedinherited

◆ m_statusLine

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_statusLine
protectedinherited

◆ m_tabOrder

◆ m_textHeight

UNIT_BINDER DIALOG_TEXT_PROPERTIES::m_textHeight
private

Definition at line 61 of file dialog_text_properties.h.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

◆ m_TextLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_TextLabel
protectedinherited

◆ m_textWidth

UNIT_BINDER DIALOG_TEXT_PROPERTIES::m_textWidth
private

Definition at line 60 of file dialog_text_properties.h.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

◆ m_thickness

UNIT_BINDER DIALOG_TEXT_PROPERTIES::m_thickness
private

Definition at line 62 of file dialog_text_properties.h.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

◆ m_ThicknessCtrl

wxTextCtrl* DIALOG_TEXT_PROPERTIES_BASE::m_ThicknessCtrl
protectedinherited

◆ m_ThicknessLabel

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_ThicknessLabel
protectedinherited

◆ m_ThicknessUnits

wxStaticText* DIALOG_TEXT_PROPERTIES_BASE::m_ThicknessUnits
protectedinherited

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_Visible

wxCheckBox* DIALOG_TEXT_PROPERTIES_BASE::m_Visible
protectedinherited

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