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, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <sch_edit_frame.h>
27#include <symbol_edit_frame.h>
29#include <widgets/font_choice.h>
31#include <widgets/wx_combobox.h>
33#include <sch_textbox.h>
34#include <confirm.h>
35#include <schematic.h>
36#include <sch_commit.h>
38#include <scintilla_tricks.h>
40#include <string_utils.h>
41
42
45 m_frame( aParent ),
46 m_currentItem( aTextItem ),
47 m_currentText( dynamic_cast<EDA_TEXT*>( aTextItem ) ),
50 m_scintillaTricks( nullptr ),
51 m_helpWindow( nullptr )
52{
53 m_isSymbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( aParent ) != nullptr;
54
55 COLOR_SETTINGS* colorSettings = m_frame->GetColorSettings();
56 COLOR4D schematicBackground = colorSettings->GetColor( LAYER_SCHEMATIC_BACKGROUND );
57
58 if( aTextItem->Type() == SCH_TEXTBOX_T )
59 {
60 SetTitle( _( "Text Box Properties" ) );
61
62 m_borderColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
63 m_borderColorSwatch->SetSwatchBackground( schematicBackground );
64
65 for( const auto& [ lineStyle, lineStyleDesc ] : lineTypeNames )
66 m_borderStyleCombo->Append( lineStyleDesc.name, KiBitmapBundle( lineStyleDesc.bitmap ) );
67
68 m_fillColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
69 m_fillColorSwatch->SetSwatchBackground( schematicBackground );
70
71 if( m_frame->GetColorSettings()->GetOverrideSchItemColors() )
72 m_infoBar->ShowMessage( _( "Note: individual item colors overridden in "
73 "Preferences." ) );
74 }
75 else
76 {
77 m_borderCheckbox->Show( false );
78 m_borderWidth.Show( false );
79 m_borderColorLabel->Show( false );
80 m_panelBorderColor->Show( false );
81 m_borderStyleLabel->Show( false );
82 m_borderStyleCombo->Show( false );
83 m_fillColorLabel->Show( false );
84 m_panelFillColor->Show( false );
85 m_filledCtrl->Show( false );
86 }
87
88 // DIALOG_SHIM needs a unique hash_key because classname is not sufficient because the
89 // different text item types (and even whether or not we're within the symbol editor) cause
90 // different dialog layouts).
91 m_hash_key = TO_UTF8( GetTitle() + aParent->GetName() );
92
93 m_textCtrl->SetEOLMode( wxSTC_EOL_LF );
94
95#ifdef _WIN32
96 // Without this setting, on Windows, some esoteric unicode chars create display issue
97 // in a wxStyledTextCtrl.
98 // for SetTechnology() info, see https://www.scintilla.org/ScintillaDoc.html#SCI_SETTECHNOLOGY
99 m_textCtrl->SetTechnology( wxSTC_TECHNOLOGY_DIRECTWRITE );
100#endif
101
102 m_scintillaTricks = new SCINTILLA_TRICKS( m_textCtrl, wxT( "{}" ), false,
103 // onAcceptFn
104 [this]( wxKeyEvent& aEvent )
105 {
106 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
107 },
108
109 // onCharFn
110 [this]( wxStyledTextEvent& aEvent )
111 {
112 m_scintillaTricks->DoTextVarAutocomplete(
113 // getTokensFn
114 [this]( const wxString& xRef, wxArrayString* tokens )
115 {
116 getContextualTextVars( xRef, tokens );
117 } );
118 } );
119
120 // A hack which causes Scintilla to auto-size the text editor canvas
121 // See: https://github.com/jacobslusser/ScintillaNET/issues/216
122 m_textCtrl->SetScrollWidth( 1 );
123 m_textCtrl->SetScrollWidthTracking( true );
124
125 m_textEntrySizer->AddGrowableRow( 0 );
126
127 m_textColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
128 m_textColorSwatch->SetSwatchBackground( schematicBackground );
129
131
132 m_separator1->SetIsSeparator();
133
134 m_bold->SetIsCheckButton();
136 m_italic->SetIsCheckButton();
138
139 m_separator2->SetIsSeparator();
140
141 m_hAlignLeft->SetIsRadioButton();
143 m_hAlignCenter->SetIsRadioButton();
145 m_hAlignRight->SetIsRadioButton();
147
148 m_separator3->SetIsSeparator();
149
150 m_vAlignTop->SetIsRadioButton();
152 m_vAlignCenter->SetIsRadioButton();
154 m_vAlignBottom->SetIsRadioButton();
156
157 m_separator4->SetIsSeparator();
158
159 m_horizontal->SetIsRadioButton();
161 m_vertical->SetIsRadioButton();
163
164 m_separator5->SetIsSeparator();
165
167
168 if( SCH_EDIT_FRAME* schematicEditor = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
169 {
170 const SCHEMATIC& schematic = schematicEditor->Schematic();
171
172 for( const SCH_SHEET_PATH& sheet : schematic.Hierarchy() )
173 {
174 wxString sheetPageNum = sheet.GetPageNumber();
175 wxString sheetName = sheet.size() == 1 ? _( "<root sheet>" )
176 : sheet.Last()->GetName();
177
178 m_hyperlinkCombo->Append( wxT( "#" ) + sheetPageNum,
179 wxString::Format( _( "Page %s (%s)" ),
180 sheetPageNum,
181 sheetName ) );
182 m_pageNumbers.push_back( sheetPageNum );
183 }
184
185 m_hyperlinkCombo->Append( wxT( "---" ) );
186 m_hyperlinkCombo->Append( wxT( "file://" ), wxT( "file://..." ) );
187 m_hyperlinkCombo->Append( wxT( "http://" ), wxT( "http://..." ) );
188 m_hyperlinkCombo->Append( wxT( "https://" ), wxT( "https://..." ) );
189 }
190 else
191 {
192 m_excludeFromSim->Hide();
193 m_syntaxHelp->Hide();
194 m_hyperlinkCb->Hide();
195 m_hyperlinkCombo->Hide();
196 }
197
199 Layout();
200
201 m_hAlignLeft->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onHAlignButton, this );
202 m_hAlignCenter->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onHAlignButton, this );
203 m_hAlignRight->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onHAlignButton, this );
204 m_vAlignTop->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onVAlignButton, this );
205 m_vAlignCenter->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onVAlignButton, this );
206 m_vAlignBottom->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onVAlignButton, this );
207 m_horizontal->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onTextAngleButton, this );
208 m_vertical->Bind( wxEVT_BUTTON, &DIALOG_TEXT_PROPERTIES::onTextAngleButton, this );
209
210 // Now all widgets have the size fixed, call FinishDialogSettings
212}
213
214
216{
217 delete m_scintillaTricks;
218 m_scintillaTricks = nullptr;
219
220 if( m_helpWindow )
221 m_helpWindow->Destroy();
222}
223
224
225void DIALOG_TEXT_PROPERTIES::getContextualTextVars( const wxString& aCrossRef,
226 wxArrayString* aTokens )
227{
228 SCHEMATIC* schematic = m_currentItem->Schematic();
229
230 if( !aCrossRef.IsEmpty() )
231 {
232 SCH_SYMBOL* refSymbol = nullptr;
233
234 if( schematic )
235 {
237 schematic->Hierarchy().GetSymbols( refs );
238
239 for( int jj = 0; jj < (int) refs.GetCount(); jj++ )
240 {
241 SCH_REFERENCE& ref = refs[jj];
242
243 if( ref.GetSymbol()->GetRef( &ref.GetSheetPath(), true ) == aCrossRef )
244 {
245 refSymbol = ref.GetSymbol();
246 break;
247 }
248 }
249 }
250
251 if( refSymbol )
252 refSymbol->GetContextualTextVars( aTokens );
253 }
254 else
255 {
256 if( schematic && schematic->CurrentSheet().Last() )
257 {
258 schematic->CurrentSheet().Last()->GetContextualTextVars( aTokens );
259 }
260 else
261 {
262 for( std::pair<wxString, wxString> entry : Prj().GetTextVars() )
263 aTokens->push_back( entry.first );
264 }
265 }
266}
267
268
270{
271 if( !wxDialog::TransferDataToWindow() )
272 return false;
273
274 m_hyperlinkCb->SetValue( m_currentText->HasHyperlink() );
275 m_hyperlinkCombo->SetValue( m_currentText->GetHyperlink() );
276
277 wxString text = m_currentText->GetText();
278
279 // show text variable cross-references in a human-readable format
280 if( SCHEMATIC* schematic = m_currentItem->Schematic() )
281 text = schematic->ConvertKIIDsToRefs( text );
282
283 m_textCtrl->SetValue( text );
284 m_textCtrl->EmptyUndoBuffer();
285
286 if( !m_isSymbolEditor )
287 m_excludeFromSim->SetValue( m_currentItem->GetExcludedFromSim() );
288
289 m_fontCtrl->SetFontSelection( m_currentText->GetFont() );
290 m_textSize.SetValue( m_currentText->GetTextWidth() );
291 m_textColorSwatch->SetSwatchColor( m_currentText->GetTextColor(), false );
292
293 m_bold->Check( m_currentText->IsBold() );
294 m_italic->Check( m_currentText->IsItalic() );
295
296 switch( m_currentText->GetHorizJustify() )
297 {
298 case GR_TEXT_H_ALIGN_LEFT: m_hAlignLeft->Check(); break;
299 case GR_TEXT_H_ALIGN_CENTER: m_hAlignCenter->Check(); break;
300 case GR_TEXT_H_ALIGN_RIGHT: m_hAlignRight->Check(); break;
302 }
303
304 switch( m_currentText->GetVertJustify() )
305 {
306 case GR_TEXT_V_ALIGN_TOP: m_vAlignTop->Check(); break;
307 case GR_TEXT_V_ALIGN_CENTER: m_vAlignCenter->Check(); break;
308 case GR_TEXT_V_ALIGN_BOTTOM: m_vAlignBottom->Check(); break;
310 }
311
312 if( m_currentText->GetTextAngle() == ANGLE_VERTICAL )
313 m_vertical->Check();
314 else
315 m_horizontal->Check();
316
317 if( m_currentItem->Type() == SCH_TEXTBOX_T )
318 {
319 SCH_TEXTBOX* textBox = static_cast<SCH_TEXTBOX*>( m_currentItem );
320
321 m_borderCheckbox->SetValue( textBox->GetWidth() >= 0 );
322
323 if( textBox->GetWidth() >= 0 )
324 m_borderWidth.SetValue( textBox->GetWidth() );
325
326 m_borderColorSwatch->SetSwatchColor( textBox->GetStroke().GetColor(), false );
327
328 int style = static_cast<int>( textBox->GetStroke().GetLineStyle() );
329
330 if( style >= 0 && style < (int) lineTypeNames.size() )
331 m_borderStyleCombo->SetSelection( style );
332 else
333 m_borderStyleCombo->SetSelection( 0 );
334
335 m_borderWidth.Enable( textBox->GetWidth() >= 0 );
336 m_borderColorLabel->Enable( textBox->GetWidth() >= 0 );
337 m_borderColorSwatch->Enable( textBox->GetWidth() >= 0 );
338 m_borderStyleLabel->Enable( textBox->GetWidth() >= 0 );
339 m_borderStyleCombo->Enable( textBox->GetWidth() >= 0 );
340
341 m_filledCtrl->SetValue( textBox->IsSolidFill() );
342 m_fillColorSwatch->SetSwatchColor( textBox->GetFillColor(), false );
343
344 m_fillColorLabel->Enable( textBox->IsSolidFill() );
345 m_fillColorSwatch->Enable( textBox->IsSolidFill() );
346 }
347
348 if( m_isSymbolEditor )
349 {
350 SYMBOL* symbol = m_currentItem->GetParentSymbol();
351
352 m_privateCheckbox->SetValue( m_currentItem->IsPrivate() );
353 m_commonToAllUnits->SetValue( symbol->IsMultiUnit() && m_currentItem->GetUnit() == 0 );
354 m_commonToAllUnits->Enable( symbol->IsMultiUnit() );
355 m_commonToAllBodyStyles->SetValue( symbol->IsMultiBodyStyle() && m_currentItem->GetBodyStyle() == 0 );
356 m_commonToAllBodyStyles->Enable( symbol->IsMultiBodyStyle() );
357 }
358
359 return true;
360}
361
362
363void DIALOG_TEXT_PROPERTIES::onBorderChecked( wxCommandEvent& aEvent )
364{
365 bool border = m_borderCheckbox->GetValue();
366
367 if( border && m_borderWidth.GetValue() < 0 )
368 m_borderWidth.SetValue( m_frame->eeconfig()->m_Drawing.default_line_thickness );
369
370 m_borderWidth.Enable( border );
371 m_borderColorLabel->Enable( border );
372 m_borderColorSwatch->Enable( border );
373 m_borderStyleLabel->Enable( border );
374 m_borderStyleCombo->Enable( border );
375}
376
377
378void DIALOG_TEXT_PROPERTIES::onFillChecked( wxCommandEvent& aEvent )
379{
380 bool fill = m_filledCtrl->GetValue();
381
382 m_fillColorLabel->Enable( fill );
383 m_fillColorSwatch->Enable( fill );
384}
385
386
387void DIALOG_TEXT_PROPERTIES::onHyperlinkChecked( wxCommandEvent& aEvent )
388{
389 if( aEvent.IsChecked() && m_hyperlinkCombo->GetValue().IsEmpty() )
390 {
391 m_hyperlinkCombo->ChangeValue( m_lastLink );
392 }
393 else if( !aEvent.IsChecked() && !m_hyperlinkCombo->GetValue().IsEmpty() )
394 {
395 m_lastLink = m_hyperlinkCombo->GetValue();
396 m_hyperlinkCombo->SetValue( wxEmptyString );
397 }
398
399 aEvent.Skip();
400}
401
402
403void DIALOG_TEXT_PROPERTIES::onHyperlinkText( wxCommandEvent& event )
404{
405 if( !m_hyperlinkCombo->GetValue().IsEmpty() )
406 m_hyperlinkCb->SetValue( true );
407}
408
409
410void DIALOG_TEXT_PROPERTIES::onHyperlinkCombo( wxCommandEvent& aEvent )
411{
412 if( aEvent.GetSelection() >= 0 )
413 {
414 m_hyperlinkCb->SetValue( true );
415 m_hyperlinkCombo->SetInsertionPointEnd();
416 }
417}
418
419
420void DIALOG_TEXT_PROPERTIES::onHAlignButton( wxCommandEvent& aEvent )
421{
423 {
424 if( btn->IsChecked() && btn != aEvent.GetEventObject() )
425 btn->Check( false );
426 }
427}
428
429
430void DIALOG_TEXT_PROPERTIES::onVAlignButton( wxCommandEvent& aEvent )
431{
433 {
434 if( btn->IsChecked() && btn != aEvent.GetEventObject() )
435 btn->Check( false );
436 }
437}
438
439
440void DIALOG_TEXT_PROPERTIES::onTextAngleButton( wxCommandEvent& aEvent )
441{
442 for( BITMAP_BUTTON* btn : { m_horizontal, m_vertical } )
443 {
444 if( btn->IsChecked() && btn != aEvent.GetEventObject() )
445 btn->Check( false );
446 }
447}
448
449
451{
452 if( !wxDialog::TransferDataFromWindow() )
453 return false;
454
455 // Don't allow text to disappear; it can be difficult to correct if you can't select it
456 if( !m_textSize.Validate( 0.01, 1000.0, EDA_UNITS::MM ) )
457 return false;
458
459 SCH_COMMIT commit( m_frame );
460
461 /* save old text in undo list if not already in edit */
462 if( m_currentItem->GetEditFlags() == 0 )
463 commit.Modify( m_currentItem, m_frame->GetScreen() );
464
465 m_frame->GetCanvas()->Refresh();
466
467 wxString text = m_textCtrl->GetValue();
468
469 // convert any text variable cross-references to their UUIDs
470 if( SCHEMATIC* schematic = m_currentItem->Schematic() )
471 text = schematic->ConvertRefsToKIIDs( text );
472
473#ifdef __WXMAC__
474 // On macOS CTRL+Enter produces '\r' instead of '\n' regardless of EOL setting
475 text.Replace( "\r", "\n" );
476#elif defined( __WINDOWS__ )
477 // On Windows, a new line is coded as \r\n. We use only \n in KiCad files and in
478 // drawing routines so strip the \r char.
479 text.Replace( "\r", "" );
480#endif
481
482 if( m_currentItem->Type() == SCH_TEXTBOX_T )
483 {
484 // Textboxes have a defined extent and so are allowed to be empty
485 m_currentText->SetText( text );
486 }
487 else if( !text.IsEmpty() )
488 {
489 m_currentText->SetText( text );
490 }
491 else
492 {
493 // Other text items do not have defined extents, and so will disappear if empty
494 DisplayError( this, _( "Text can not be empty." ) );
495 return false;
496 }
497
498 m_currentItem->SetExcludedFromSim( m_excludeFromSim->GetValue() );
499
500 if( SYMBOL_EDIT_FRAME* symbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) )
501 {
502 m_currentItem->SetPrivate( m_privateCheckbox->GetValue() );
503
504 if( !m_commonToAllUnits->GetValue() )
505 m_currentItem->SetUnit( symbolEditor->GetUnit() );
506 else
507 m_currentItem->SetUnit( 0 );
508
509 if( !m_commonToAllBodyStyles->GetValue() )
510 m_currentItem->SetBodyStyle( symbolEditor->GetBodyStyle() );
511 else
512 m_currentItem->SetBodyStyle( 0 );
513 }
514
516 {
517 DisplayError( this, _( "Invalid hyperlink destination. Please enter either a valid URL "
518 "(e.g. file:// or http(s)://) or \"#<page number>\" to create "
519 "a hyperlink to a page in this schematic." ) );
520 return false;
521 }
522 else
523 {
524 m_currentText->SetHyperlink( m_hyperlinkCombo->GetValue() );
525 }
526
527 if( m_currentText->GetTextWidth() != m_textSize.GetValue() )
528 m_currentText->SetTextSize( VECTOR2I( m_textSize.GetIntValue(),
529 m_textSize.GetIntValue() ) );
530
531 if( m_fontCtrl->HaveFontSelection() )
532 {
533 m_currentText->SetFont( m_fontCtrl->GetFontSelection( m_bold->IsChecked(),
534 m_italic->IsChecked() ) );
535 }
536
537 // Must come after SetTextSize()
538 m_currentText->SetBold( m_bold->IsChecked() );
539 m_currentText->SetItalic( m_italic->IsChecked() );
540
541 m_currentText->SetTextColor( m_textColorSwatch->GetSwatchColor() );
542
543 if( m_hAlignRight->IsChecked() )
544 m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
545 else if( m_hAlignCenter->IsChecked() )
546 m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
547 else
548 m_currentText->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
549
550 if( m_vAlignBottom->IsChecked() )
551 m_currentText->SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
552 else if( m_vAlignCenter->IsChecked() )
553 m_currentText->SetVertJustify( GR_TEXT_V_ALIGN_CENTER );
554 else
555 m_currentText->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
556
557 if( m_vertical->IsChecked() )
558 m_currentText->SetTextAngle( ANGLE_VERTICAL );
559 else
560 m_currentText->SetTextAngle( ANGLE_HORIZONTAL );
561
562 if( m_currentItem->Type() == SCH_TEXTBOX_T )
563 {
564 SCH_TEXTBOX* textBox = static_cast<SCH_TEXTBOX*>( m_currentItem );
565
566 STROKE_PARAMS stroke = textBox->GetStroke();
567
568 if( m_borderCheckbox->GetValue() )
569 stroke.SetWidth( std::max( 0, m_borderWidth.GetIntValue() ) );
570 else
571 stroke.SetWidth( -1 );
572
573 auto it = lineTypeNames.begin();
574 std::advance( it, m_borderStyleCombo->GetSelection() );
575
576 if( it == lineTypeNames.end() )
578 else
579 stroke.SetLineStyle( it->first );
580
581 stroke.SetColor( m_borderColorSwatch->GetSwatchColor() );
582
583 textBox->SetStroke( stroke );
584
586 : FILL_T::NO_FILL );
587 textBox->SetFillColor( m_fillColorSwatch->GetSwatchColor() );
588 }
589
590 if( !commit.Empty() )
591 commit.Push( _( "Edit Text Properties" ) );
592
593 return true;
594}
595
596
597void DIALOG_TEXT_PROPERTIES::OnFormattingHelp( wxHyperlinkEvent& aEvent )
598{
600}
601
602
604{
606 m_scintillaTricks->CancelAutocomplete();
607
608 event.Skip();
609}
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition bitmap.cpp:110
@ 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:402
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:137
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:106
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition dialog_shim.h:82
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
void SetFillColor(const COLOR4D &aColor)
Definition eda_shape.h:154
bool IsSolidFill() const
Definition eda_shape.h:117
COLOR4D GetFillColor() const
Definition eda_shape.h:153
virtual int GetWidth() const
Definition eda_shape.h:157
void SetFillMode(FILL_T aFill)
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:80
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:105
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Holds all the data relating to one schematic.
Definition schematic.h:88
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
SCH_SHEET_PATH & CurrentSheet() const
Definition schematic.h:187
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
virtual void Push(const wxString &aMessage=wxT("A commit"), 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:167
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:61
STROKE_PARAMS GetStroke() const override
Definition sch_shape.h:58
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, 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:76
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
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:63
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:177
This file is part of the common library.
#define _(s)
static constexpr EDA_ANGLE ANGLE_VERTICAL
Definition eda_angle.h:408
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
Definition eda_angle.h:407
@ FILLED_WITH_COLOR
Definition eda_shape.h:60
@ NO_FILL
Definition eda_shape.h:57
@ LAYER_SCHEMATIC_BACKGROUND
Definition layer_ids.h:488
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
const std::map< LINE_STYLE, struct LINE_STYLE_DESC > lineTypeNames
Conversion map between LINE_STYLE values and style names displayed.
@ 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:156
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695