KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema/dialogs/dialog_text_properties.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2013 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2013 Wayne Stambaugh <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22#include <bitmaps.h>
23#include <sch_edit_frame.h>
24#include <symbol_edit_frame.h>
26#include <widgets/font_choice.h>
28#include <widgets/wx_combobox.h>
30#include <widgets/wx_infobar.h>
31#include <sch_textbox.h>
32#include <confirm.h>
33#include <schematic.h>
34#include <sch_commit.h>
36#include <scintilla_tricks.h>
38#include <string_utils.h>
39
40
43 m_frame( aParent ),
44 m_currentItem( aTextItem ),
45 m_currentText( dynamic_cast<EDA_TEXT*>( aTextItem ) ),
48 m_scintillaTricks( nullptr ),
49 m_helpWindow( nullptr )
50{
51 m_isSymbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( aParent ) != nullptr;
52
53 COLOR_SETTINGS* colorSettings = m_frame->GetColorSettings();
54 COLOR4D schematicBackground = colorSettings->GetColor( LAYER_SCHEMATIC_BACKGROUND );
55
56 if( aTextItem->Type() == SCH_TEXTBOX_T )
57 {
58 SetTitle( _( "Text Box Properties" ) );
59
60 m_borderColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
61 m_borderColorSwatch->SetSwatchBackground( schematicBackground );
62
63 for( const auto& [ lineStyle, lineStyleDesc ] : lineTypeNames )
64 m_borderStyleCombo->Append( lineStyleDesc.name, KiBitmapBundle( lineStyleDesc.bitmap ) );
65
66 m_fillColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
67 m_fillColorSwatch->SetSwatchBackground( schematicBackground );
68
69 if( m_frame->GetColorSettings()->GetOverrideSchItemColors() )
70 m_infoBar->ShowMessage( _( "Note: individual item colors overridden in "
71 "Preferences." ) );
72 }
73 else
74 {
75 m_borderCheckbox->Show( false );
76 m_borderWidth.Show( false );
77 m_borderColorLabel->Show( false );
78 m_panelBorderColor->Show( false );
79 m_borderStyleLabel->Show( false );
80 m_borderStyleCombo->Show( false );
81 m_fillColorLabel->Show( false );
82 m_panelFillColor->Show( false );
83 m_filledCtrl->Show( false );
84 }
85
86 // DIALOG_SHIM needs a unique hash_key because classname is not sufficient because the
87 // different text item types (and even whether or not we're within the symbol editor) cause
88 // different dialog layouts).
89 m_hash_key = TO_UTF8( GetTitle() + aParent->GetName() );
90
91 m_textCtrl->SetEOLMode( wxSTC_EOL_LF );
92
93 // Wrapping is display-only and does not insert newlines into the stored text.
94 m_textCtrl->SetWrapMode( wxSTC_WRAP_WORD );
95 m_textCtrl->SetWrapVisualFlags( wxSTC_WRAPVISUALFLAG_END );
96 m_textCtrl->SetWrapIndentMode( wxSTC_WRAPINDENT_INDENT );
97
98#ifdef _WIN32
99 // Without this setting, on Windows, some esoteric unicode chars create display issue
100 // in a wxStyledTextCtrl.
101 // for SetTechnology() info, see https://www.scintilla.org/ScintillaDoc.html#SCI_SETTECHNOLOGY
102 m_textCtrl->SetTechnology( wxSTC_TECHNOLOGY_DIRECTWRITE );
103#endif
104
105 m_scintillaTricks = new SCINTILLA_TRICKS( m_textCtrl, wxT( "{}" ), false,
106 // onAcceptFn
107 [this]( wxKeyEvent& aEvent )
108 {
109 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
110 },
111
112 // onCharFn
113 [this]( wxStyledTextEvent& aEvent )
114 {
115 m_scintillaTricks->DoTextVarAutocomplete(
116 // getTokensFn
117 [this]( const wxString& xRef, wxArrayString* tokens )
118 {
119 getContextualTextVars( xRef, tokens );
120 } );
121 } );
122
123 // A hack which causes Scintilla to auto-size the text editor canvas
124 // See: https://github.com/jacobslusser/ScintillaNET/issues/216
125 m_textCtrl->SetScrollWidth( 1 );
126 m_textCtrl->SetScrollWidthTracking( true );
127
128 m_textEntrySizer->AddGrowableRow( 0 );
129
130 m_textColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
131 m_textColorSwatch->SetSwatchBackground( schematicBackground );
132
134
135 m_separator1->SetIsSeparator();
136
137 m_bold->SetIsCheckButton();
139 m_italic->SetIsCheckButton();
141
142 m_separator2->SetIsSeparator();
143
144 m_hAlignLeft->SetIsRadioButton();
146 m_hAlignCenter->SetIsRadioButton();
148 m_hAlignRight->SetIsRadioButton();
150
151 m_separator3->SetIsSeparator();
152
153 m_vAlignTop->SetIsRadioButton();
155 m_vAlignCenter->SetIsRadioButton();
157 m_vAlignBottom->SetIsRadioButton();
159
160 m_separator4->SetIsSeparator();
161
162 m_horizontal->SetIsRadioButton();
164 m_vertical->SetIsRadioButton();
166
167 m_separator5->SetIsSeparator();
168
170
171 if( SCH_EDIT_FRAME* schematicEditor = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
172 {
173 const SCHEMATIC& schematic = schematicEditor->Schematic();
174
175 for( const SCH_SHEET_PATH& sheet : schematic.Hierarchy() )
176 {
177 wxString sheetPageNum = sheet.GetPageNumber();
178 wxString sheetName = sheet.size() == 1 ? _( "<root sheet>" )
179 : sheet.Last()->GetName();
180
181 m_hyperlinkCombo->Append( wxT( "#" ) + sheetPageNum,
182 wxString::Format( _( "Page %s (%s)" ),
183 sheetPageNum,
184 sheetName ) );
185 m_pageNumbers.push_back( sheetPageNum );
186 }
187
188 m_hyperlinkCombo->Append( wxT( "---" ) );
189 m_hyperlinkCombo->Append( wxT( "file://" ), wxT( "file://..." ) );
190 m_hyperlinkCombo->Append( wxT( "http://" ), wxT( "http://..." ) );
191 m_hyperlinkCombo->Append( wxT( "https://" ), wxT( "https://..." ) );
192 }
193 else
194 {
195 m_excludeFromSim->Hide();
196 m_syntaxHelp->Hide();
197 m_hyperlinkCb->Hide();
198 m_hyperlinkCombo->Hide();
199 }
200
202 Layout();
203
204 m_hAlignLeft->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onHAlignButton, this );
205 m_hAlignCenter->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onHAlignButton, this );
206 m_hAlignRight->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onHAlignButton, this );
207 m_vAlignTop->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onVAlignButton, this );
208 m_vAlignCenter->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onVAlignButton, this );
209 m_vAlignBottom->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onVAlignButton, this );
210 m_horizontal->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onTextAngleButton, this );
211 m_vertical->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onTextAngleButton, this );
212
213 // Now all widgets have the size fixed, call FinishDialogSettings
215}
216
217
219{
220 delete m_scintillaTricks;
221 m_scintillaTricks = nullptr;
222
223 if( m_helpWindow )
224 m_helpWindow->Destroy();
225}
226
227
228void DIALOG_TEXT_PROPERTIES::getContextualTextVars( const wxString& aCrossRef,
229 wxArrayString* aTokens )
230{
231 SCHEMATIC* schematic = m_currentItem->Schematic();
232
233 if( !aCrossRef.IsEmpty() )
234 {
235 SCH_SYMBOL* refSymbol = nullptr;
236
237 if( schematic )
238 {
240 schematic->Hierarchy().GetSymbols( refs, SYMBOL_FILTER_NON_POWER );
241
242 for( int jj = 0; jj < (int) refs.GetCount(); jj++ )
243 {
244 SCH_REFERENCE& ref = refs[jj];
245
246 if( ref.GetSymbol()->GetRef( &ref.GetSheetPath(), true ) == aCrossRef )
247 {
248 refSymbol = ref.GetSymbol();
249 break;
250 }
251 }
252 }
253
254 if( refSymbol )
255 refSymbol->GetContextualTextVars( aTokens );
256 }
257 else
258 {
259 if( schematic && schematic->CurrentSheet().Last() )
260 {
261 schematic->CurrentSheet().Last()->GetContextualTextVars( aTokens );
262 }
263 else
264 {
265 for( std::pair<wxString, wxString> entry : Prj().GetTextVars() )
266 aTokens->push_back( entry.first );
267 }
268 }
269}
270
271
273{
274 if( !wxDialog::TransferDataToWindow() )
275 return false;
276
277 m_hyperlinkCb->SetValue( m_currentText->HasHyperlink() );
278 m_hyperlinkCombo->SetValue( m_currentText->GetHyperlink() );
279
280 wxString text = m_currentText->GetText();
281
282 // show text variable cross-references in a human-readable format
283 if( SCHEMATIC* schematic = m_currentItem->Schematic() )
284 text = schematic->ConvertKIIDsToRefs( text );
285
286 m_textCtrl->SetValue( text );
287 m_textCtrl->EmptyUndoBuffer();
288
289 if( !m_isSymbolEditor )
290 m_excludeFromSim->SetValue( m_currentItem->GetExcludedFromSim() );
291
292 m_fontCtrl->SetFontSelection( m_currentText->GetFont() );
293 m_textSize.SetValue( m_currentText->GetTextWidth() );
294 m_textColorSwatch->SetSwatchColor( m_currentText->GetTextColor(), false );
295
296 m_bold->Check( m_currentText->IsBold() );
297 m_italic->Check( m_currentText->IsItalic() );
298
299 switch( m_currentText->GetHorizJustify() )
300 {
301 case GR_TEXT_H_ALIGN_LEFT: m_hAlignLeft->Check(); break;
302 case GR_TEXT_H_ALIGN_CENTER: m_hAlignCenter->Check(); break;
303 case GR_TEXT_H_ALIGN_RIGHT: m_hAlignRight->Check(); break;
305 }
306
307 switch( m_currentText->GetVertJustify() )
308 {
309 case GR_TEXT_V_ALIGN_TOP: m_vAlignTop->Check(); break;
310 case GR_TEXT_V_ALIGN_CENTER: m_vAlignCenter->Check(); break;
311 case GR_TEXT_V_ALIGN_BOTTOM: m_vAlignBottom->Check(); break;
313 }
314
315 if( m_currentText->GetTextAngle() == ANGLE_VERTICAL )
316 m_vertical->Check();
317 else
318 m_horizontal->Check();
319
320 if( m_currentItem->Type() == SCH_TEXTBOX_T )
321 {
322 SCH_TEXTBOX* textBox = static_cast<SCH_TEXTBOX*>( m_currentItem );
323
324 m_borderCheckbox->SetValue( textBox->GetWidth() >= 0 );
325
326 if( textBox->GetWidth() >= 0 )
327 m_borderWidth.SetValue( textBox->GetWidth() );
328
329 m_borderColorSwatch->SetSwatchColor( textBox->GetStroke().GetColor(), false );
330
331 int style = static_cast<int>( textBox->GetStroke().GetLineStyle() );
332
333 if( style >= 0 && style < (int) lineTypeNames.size() )
334 m_borderStyleCombo->SetSelection( style );
335 else
336 m_borderStyleCombo->SetSelection( 0 );
337
338 m_borderWidth.Enable( textBox->GetWidth() >= 0 );
339 m_borderColorLabel->Enable( textBox->GetWidth() >= 0 );
340 m_borderColorSwatch->Enable( textBox->GetWidth() >= 0 );
341 m_borderStyleLabel->Enable( textBox->GetWidth() >= 0 );
342 m_borderStyleCombo->Enable( textBox->GetWidth() >= 0 );
343
344 m_filledCtrl->SetValue( textBox->IsSolidFill() );
345 m_fillColorSwatch->SetSwatchColor( textBox->GetFillColor(), false );
346
347 m_fillColorLabel->Enable( textBox->IsSolidFill() );
348 m_fillColorSwatch->Enable( textBox->IsSolidFill() );
349 }
350
351 if( m_isSymbolEditor )
352 {
353 SYMBOL* symbol = m_currentItem->GetParentSymbol();
354
355 m_privateCheckbox->SetValue( m_currentItem->IsPrivate() );
356 m_commonToAllUnits->SetValue( symbol->IsMultiUnit() && m_currentItem->GetUnit() == ALL_UNITS );
357 m_commonToAllUnits->Enable( symbol->IsMultiUnit() );
358 m_commonToAllBodyStyles->SetValue( symbol->IsMultiBodyStyle() && m_currentItem->GetBodyStyle() == ALL_BODY_STYLES );
359 m_commonToAllBodyStyles->Enable( symbol->IsMultiBodyStyle() );
360 }
361
362 return true;
363}
364
365
366void DIALOG_TEXT_PROPERTIES::onBorderChecked( wxCommandEvent& aEvent )
367{
368 bool border = m_borderCheckbox->GetValue();
369
370 if( border && m_borderWidth.GetValue() < 0 )
371 m_borderWidth.SetValue( m_frame->eeconfig()->m_Drawing.default_line_thickness );
372
373 m_borderWidth.Enable( border );
374 m_borderColorLabel->Enable( border );
375 m_borderColorSwatch->Enable( border );
376 m_borderStyleLabel->Enable( border );
377 m_borderStyleCombo->Enable( border );
378}
379
380
381void DIALOG_TEXT_PROPERTIES::onFillChecked( wxCommandEvent& aEvent )
382{
383 bool fill = m_filledCtrl->GetValue();
384
385 m_fillColorLabel->Enable( fill );
386 m_fillColorSwatch->Enable( fill );
387}
388
389
390void DIALOG_TEXT_PROPERTIES::onHyperlinkChecked( wxCommandEvent& aEvent )
391{
392 if( aEvent.IsChecked() && m_hyperlinkCombo->GetValue().IsEmpty() )
393 {
394 m_hyperlinkCombo->ChangeValue( m_lastLink );
395 }
396 else if( !aEvent.IsChecked() && !m_hyperlinkCombo->GetValue().IsEmpty() )
397 {
398 m_lastLink = m_hyperlinkCombo->GetValue();
399 m_hyperlinkCombo->SetValue( wxEmptyString );
400 }
401
402 aEvent.Skip();
403}
404
405
406void DIALOG_TEXT_PROPERTIES::onHyperlinkText( wxCommandEvent& event )
407{
408 if( !m_hyperlinkCombo->GetValue().IsEmpty() )
409 m_hyperlinkCb->SetValue( true );
410}
411
412
413void DIALOG_TEXT_PROPERTIES::onHyperlinkCombo( wxCommandEvent& aEvent )
414{
415 if( aEvent.GetSelection() >= 0 )
416 {
417 m_hyperlinkCb->SetValue( true );
418 m_hyperlinkCombo->SetInsertionPointEnd();
419 }
420}
421
422
423void DIALOG_TEXT_PROPERTIES::onHAlignButton( wxCommandEvent& aEvent )
424{
426 {
427 if( btn->IsChecked() && btn != aEvent.GetEventObject() )
428 btn->Check( false );
429 }
430}
431
432
433void DIALOG_TEXT_PROPERTIES::onVAlignButton( wxCommandEvent& aEvent )
434{
436 {
437 if( btn->IsChecked() && btn != aEvent.GetEventObject() )
438 btn->Check( false );
439 }
440}
441
442
443void DIALOG_TEXT_PROPERTIES::onTextAngleButton( wxCommandEvent& aEvent )
444{
445 for( BITMAP_BUTTON* btn : { m_horizontal, m_vertical } )
446 {
447 if( btn->IsChecked() && btn != aEvent.GetEventObject() )
448 btn->Check( false );
449 }
450}
451
452
454{
455 if( !wxDialog::TransferDataFromWindow() )
456 return false;
457
458 // Don't allow text to disappear; it can be difficult to correct if you can't select it
459 if( !m_textSize.Validate( 0.01, 1000.0, EDA_UNITS::MM ) )
460 return false;
461
463 {
464 DisplayError( this, _( "Invalid hyperlink destination. Please enter either a valid URL "
465 "(e.g. file:// or http(s)://) or \"#<page number>\" to create "
466 "a hyperlink to a page in this schematic." ) );
467 return false;
468 }
469
470 SCH_COMMIT commit( m_frame );
471
472 /* save old text in undo list if not already in edit */
473 if( m_currentItem->GetEditFlags() == 0 )
474 commit.Modify( m_currentItem, m_frame->GetScreen() );
475
476 m_frame->GetCanvas()->Refresh();
477
478 wxString text = m_textCtrl->GetValue();
479
480 // convert any text variable cross-references to their UUIDs
481 if( SCHEMATIC* schematic = m_currentItem->Schematic() )
482 text = schematic->ConvertRefsToKIIDs( text );
483
484#ifdef __WXMAC__
485 // On macOS CTRL+Enter produces '\r' instead of '\n' regardless of EOL setting
486 text.Replace( "\r", "\n" );
487#elif defined( __WINDOWS__ )
488 // On Windows, a new line is coded as \r\n. We use only \n in KiCad files and in
489 // drawing routines so strip the \r char.
490 text.Replace( "\r", "" );
491#endif
492
493 m_currentText->SetText( text );
494 m_currentItem->SetExcludedFromSim( m_excludeFromSim->GetValue() );
495
496 if( SYMBOL_EDIT_FRAME* symbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) )
497 {
498 m_currentItem->SetPrivate( m_privateCheckbox->GetValue() );
499
500 if( !m_commonToAllUnits->GetValue() )
501 m_currentItem->SetUnit( symbolEditor->GetUnit() );
502 else
503 m_currentItem->SetUnit( 0 );
504
505 if( !m_commonToAllBodyStyles->GetValue() )
506 m_currentItem->SetBodyStyle( symbolEditor->GetBodyStyle() );
507 else
508 m_currentItem->SetBodyStyle( 0 );
509 }
510
511 m_currentText->SetHyperlink( m_hyperlinkCombo->GetValue() );
512
513 if( m_currentText->GetTextWidth() != m_textSize.GetValue() )
514 m_currentText->SetTextSize( VECTOR2I( m_textSize.GetIntValue(), m_textSize.GetIntValue() ) );
515
516 if( m_fontCtrl->HaveFontSelection() )
517 m_currentText->SetFont( m_fontCtrl->GetFontSelection( m_bold->IsChecked(), m_italic->IsChecked() ) );
518
519 // Must come after SetTextSize()
520 m_currentText->SetBold( m_bold->IsChecked() );
521 m_currentText->SetItalic( m_italic->IsChecked() );
522
523 m_currentText->SetTextColor( m_textColorSwatch->GetSwatchColor() );
524
525 if( m_hAlignRight->IsChecked() )
526 m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
527 else if( m_hAlignCenter->IsChecked() )
528 m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
529 else
530 m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
531
532 if( m_vAlignBottom->IsChecked() )
533 m_currentText->SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
534 else if( m_vAlignCenter->IsChecked() )
535 m_currentText->SetVertJustify( GR_TEXT_V_ALIGN_CENTER );
536 else
537 m_currentText->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
538
539 if( m_vertical->IsChecked() )
540 m_currentText->SetTextAngle( ANGLE_VERTICAL );
541 else
542 m_currentText->SetTextAngle( ANGLE_HORIZONTAL );
543
544 if( m_currentItem->Type() == SCH_TEXTBOX_T )
545 {
546 SCH_TEXTBOX* textBox = static_cast<SCH_TEXTBOX*>( m_currentItem );
547
548 STROKE_PARAMS stroke = textBox->GetStroke();
549
550 if( m_borderCheckbox->GetValue() )
551 stroke.SetWidth( std::max( 0, m_borderWidth.GetIntValue() ) );
552 else
553 stroke.SetWidth( -1 );
554
555 auto it = lineTypeNames.begin();
556 std::advance( it, m_borderStyleCombo->GetSelection() );
557
558 if( it == lineTypeNames.end() )
560 else
561 stroke.SetLineStyle( it->first );
562
563 stroke.SetColor( m_borderColorSwatch->GetSwatchColor() );
564
565 textBox->SetStroke( stroke );
566
568 textBox->SetFillColor( m_fillColorSwatch->GetSwatchColor() );
569
570 textBox->ClearBoundingBoxCache();
571 textBox->ClearRenderCache();
572
573 VECTOR2I minBoxSize = textBox->GetMinSize();
574 VECTOR2I start = textBox->GetStart();
575 VECTOR2I end = textBox->GetEnd();
576 bool expanded = false;
577
578 if( minBoxSize.x > 0 && std::abs( end.x - start.x ) < minBoxSize.x )
579 {
580 end.x = ( end.x >= start.x ) ? start.x + minBoxSize.x : start.x - minBoxSize.x;
581 expanded = true;
582 }
583
584 if( minBoxSize.y > 0 && std::abs( end.y - start.y ) < minBoxSize.y )
585 {
586 end.y = ( end.y >= start.y ) ? start.y + minBoxSize.y : start.y - minBoxSize.y;
587 expanded = true;
588 }
589
590 if( expanded )
591 textBox->SetEnd( end );
592 }
593
594 if( !commit.Empty() )
595 commit.Push( _( "Edit Text Properties" ) );
596
597 return true;
598}
599
600
601void DIALOG_TEXT_PROPERTIES::OnFormattingHelp( wxHyperlinkEvent& aEvent )
602{
604}
605
606
608{
610 m_scintillaTricks->CancelAutocomplete();
611
612 event.Skip();
613}
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition bitmap.cpp:106
@ text_align_right
@ text_valign_top
@ text_align_left
@ text_valign_center
@ text_align_center
@ text_horizontal
@ text_valign_bottom
A bitmap button widget that behaves like an AUI toolbar item's button when it is drawn.
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition color4d.h:400
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
bool Empty() const
Definition commit.h:145
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition commit.h:102
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition dialog_shim.h:94
void SetupStandardButtons(std::map< int, wxString > aLabels={})
std::string m_hash_key
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
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)
void onHyperlinkText(wxCommandEvent &aEvent) override
void onFillChecked(wxCommandEvent &aEvent) override
void onMultiLineTCLostFocus(wxFocusEvent &event) override
void onBorderChecked(wxCommandEvent &aEvent) override
void OnFormattingHelp(wxHyperlinkEvent &aEvent) override
DIALOG_TEXT_PROPERTIES(SCH_BASE_FRAME *parent, SCH_ITEM *aTextItem)
void onHyperlinkCombo(wxCommandEvent &aEvent) override
void getContextualTextVars(const wxString &aCrossRef, wxArrayString *aTokens)
void onHyperlinkChecked(wxCommandEvent &aEvent) override
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
virtual void SetEnd(const VECTOR2I &aEnd)
Definition eda_shape.h:337
void SetFillColor(const COLOR4D &aColor)
Definition eda_shape.h:162
bool IsSolidFill() const
Definition eda_shape.h:125
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
Definition eda_shape.h:333
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
Definition eda_shape.h:283
COLOR4D GetFillColor() const
Definition eda_shape.h:161
virtual int GetWidth() const
Definition eda_shape.h:165
void SetFillMode(FILL_T aFill)
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:94
virtual void ClearBoundingBoxCache()
Definition eda_text.cpp:675
virtual void ClearRenderCache()
Definition eda_text.cpp:669
static bool ValidateHyperlink(const wxString &aURL)
Check if aURL is a valid hyperlink.
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:101
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Holds all the data relating to one schematic.
Definition schematic.h:149
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
SCH_SHEET_PATH & CurrentSheet() const
Definition schematic.h:312
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Commit for the schematic and symbol editors.
Definition sch_commit.h:54
void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Execute the changes.
Schematic editor (Eeschema) main window.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:170
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
A helper to define a symbol's reference designator in a schematic.
const SCH_SHEET_PATH & GetSheetPath() const
SCH_SYMBOL * GetSymbol() const
void SetStroke(const STROKE_PARAMS &aStroke) override
Definition sch_shape.cpp:98
STROKE_PARAMS GetStroke() const override
Definition sch_shape.h:59
void GetSymbols(SCH_REFERENCE_LIST &aReferences, SYMBOL_FILTER aSymbolFilter, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this sheet.
Schematic symbol object.
Definition sch_symbol.h:75
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this symbol.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
VECTOR2I GetMinSize() const
Return the minimum height needed to contain the textbox's wrapped text content plus margins.
static HTML_MESSAGE_BOX * ShowSyntaxHelp(wxWindow *aParentWindow)
Add cut/copy/paste, dark theme, autocomplete and brace highlighting to a wxStyleTextCtrl instance.
Simple container to manage line stroke parameters.
void SetLineStyle(LINE_STYLE aLineStyle)
void SetWidth(int aWidth)
void SetColor(const KIGFX::COLOR4D &aColor)
KIGFX::COLOR4D GetColor() const
The symbol library editor main window.
A base class for LIB_SYMBOL and SCH_SYMBOL.
Definition symbol.h:60
virtual bool IsMultiUnit() const =0
virtual bool IsMultiBodyStyle() const =0
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
Definition confirm.cpp:192
This file is part of the common library.
#define _(s)
static constexpr EDA_ANGLE ANGLE_VERTICAL
Definition eda_angle.h:445
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
Definition eda_angle.h:444
@ FILLED_WITH_COLOR
Definition eda_fill.h:33
@ NO_FILL
Definition eda_fill.h:30
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition idf_helpers.h:37
@ LAYER_SCHEMATIC_BACKGROUND
Definition layer_ids.h:516
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition eda_angle.h:437
@ SYMBOL_FILTER_NON_POWER
const std::map< LINE_STYLE, struct LINE_STYLE_DESC > lineTypeNames
Conversion map between LINE_STYLE values and style names displayed.
#define ALL_UNITS
Definition symbol.h:150
#define ALL_BODY_STYLES
Definition symbol.h:151
VECTOR2I end
@ GR_TEXT_H_ALIGN_CENTER
@ GR_TEXT_H_ALIGN_RIGHT
@ GR_TEXT_H_ALIGN_LEFT
@ GR_TEXT_H_ALIGN_INDETERMINATE
@ GR_TEXT_V_ALIGN_BOTTOM
@ GR_TEXT_V_ALIGN_INDETERMINATE
@ GR_TEXT_V_ALIGN_CENTER
@ GR_TEXT_V_ALIGN_TOP
@ SCH_TEXTBOX_T
Definition typeinfo.h:148
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:708