forked from Sneeds-Feed-and-Seed/sneedacity
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathShuttleGui.cpp
2496 lines (2167 loc) · 71.8 KB
/
ShuttleGui.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**********************************************************************
Sneedacity: A Digital Audio Editor
ShuttleGui.cpp
James Crook
Sneedacity is free software.
This file is licensed under the wxWidgets license, see License.txt
**********************************************************************//**
\file ShuttleGui.cpp
\brief Implements ShuttleGui, ShuttleGuiBase and InvisiblePanel.
*//***************************************************************//**
\class ShuttleGui
\brief
Derived from ShuttleGuiBase, an Sneedacity specific class for shuttling
data to and from GUI.
ShuttleGui extends the idea of the data Shuttle class to include creation
of dialog controls. As part of this it provides an interface to sizers
that leads to shorter more readable code.
It also allows the code that is used to create dialogs to be reused
to shuttle information in and out.
Most of the ShuttleGui functions are actually defined in
ShuttleGuiBase.
- wxWidgets widgets are dealt with by ShuttleGuiBase.
- Sneedacity specific widgets are dealt with by ShuttleGui
There is documentation on how to use this class in \ref ShuttleSystem
*//***************************************************************//**
\class ShuttleGuiBase
\brief Base class for shuttling data to and from a GUI.
see also ShuttleGui
Use the:
- \p Start / \p End methods for containers, like two-column-layout.
- \p Add methods if you are only interested in creating the controls.
- \p Tie methods if you also want to exchange data using ShuttleGui.
The code in this file is fairly repetitive. We are dealing with
- Many different types of Widget.
- Creation / Reading / Writing / Exporting / Importing
- int, float, string variants (for example of TextCtrl contents).
A technique used to reduce the size of the \p Tie functions is to
have one generic \p Tie function that uses WrappedType for its
data type. Type specific \p Tie functions themselves call the generic
variant.
A second technique used to reduce the size of \p Tie functions
only comes into play for two-step \p Tie functions. (A two step
\p Tie function is one that transfers data between the registry
and the GUI via an intermediate temporary variable). In the two
step style, a function ShuttleGuiBase::DoStep() determines which
transfers in the function are to be done, reducing repetitive
if-then-else's.
Although unusual, these two techniques make the code easier to
add to and much easier to check for correctness. The alternative
'more obvious' code that just repeats code as needed is
considerably longer.
You would rarely use ShuttleGuiBase directly, instead you'd use
ShuttleGui.
There is DOxygen documentation on how to use the ShuttleGui
class in \ref ShuttleSystem .
*//***************************************************************//**
\class InvisiblePanel
\brief An InvisiblePanel is a panel which does not repaint its
own background.
It is used (a) To group together widgets which need to be refreshed
together. A single refresh of the panel causes all the subwindows to
refresh. (b) as a base class for some flicker-free classes for which
the background is never repainted.
JKC: InvisiblePanel will probably be replaced in time by a mechanism
for registering for changes.
*//******************************************************************/
#include "ShuttleGui.h"
#include "Prefs.h"
#include "ShuttlePrefs.h"
#include "Theme.h"
#include <wx/setup.h> // for wxUSE_* macros
#include <wx/wx.h>
#include <wx/wxprec.h>
#include <wx/grid.h>
#include <wx/listctrl.h>
#include <wx/notebook.h>
#include <wx/simplebook.h>
#include <wx/treectrl.h>
#include <wx/spinctrl.h>
#include <wx/stattext.h>
#include <wx/bmpbuttn.h>
#include "../include/sneedacity/ComponentInterface.h"
#include "widgets/ReadOnlyText.h"
#include "widgets/wxPanelWrapper.h"
#include "widgets/wxTextCtrlWrapper.h"
#include "AllThemeResources.h"
#if wxUSE_ACCESSIBILITY
#include "widgets/WindowAccessible.h"
#endif
ShuttleGuiBase::ShuttleGuiBase(
wxWindow * pParent, teShuttleMode ShuttleMode, bool vertical, wxSize minSize )
: mpDlg{ pParent }
{
wxASSERT( (pParent != NULL ) || ( ShuttleMode != eIsCreating));
mpbOptionalFlag = nullptr;
mpParent = pParent;
mShuttleMode = ShuttleMode;
Init( vertical, minSize );
}
ShuttleGuiBase::~ShuttleGuiBase()
{
}
void ShuttleGuiBase::Init(bool vertical, wxSize minSize)
{
mpShuttle = NULL;
mpSizer = NULL;
mpWind = NULL;
mpSubSizer = NULL;
mRadioSettingName = wxT("");
mRadioCount = -1;
miBorder = 5;
miProp=0;
miPropSetByUser=-1;
miSizerProp=0;
mSizerDepth=-1;
ResetId();
miNoMatchSelector = 0;
if( mShuttleMode != eIsCreating )
return;
mpSizer = mpParent->GetSizer();
#if 0
if( mpSizer == NULL )
{
wxWindow * pGrandParent = mpParent->GetParent();
if( pGrandParent )
{
mpSizer = pGrandParent->GetSizer();
}
}
#endif
if( !mpSizer )
{
mpParent->SetSizer(
mpSizer = safenew wxBoxSizer(vertical ? wxVERTICAL : wxHORIZONTAL));
}
PushSizer();
mpSizer->SetMinSize(minSize);
}
void ShuttleGuiBase::ResetId()
{
miIdSetByUser = -1;
miId = -1;
miIdNext = 3000;
}
/// Used to modify an already placed FlexGridSizer to make a column stretchy.
void ShuttleGuiBase::SetStretchyCol( int i )
{
if( mShuttleMode != eIsCreating )
return;
wxFlexGridSizer *pSizer = wxDynamicCast(mpSizer, wxFlexGridSizer);
wxASSERT( pSizer );
pSizer->AddGrowableCol( i, 1 );
}
/// Used to modify an already placed FlexGridSizer to make a row stretchy.
void ShuttleGuiBase::SetStretchyRow( int i )
{
if( mShuttleMode != eIsCreating )
return;
wxFlexGridSizer *pSizer = wxDynamicCast(mpSizer, wxFlexGridSizer);
wxASSERT( pSizer );
pSizer->AddGrowableRow( i, 1 );
}
//---- Add Functions.
void ShuttleGuiBase::HandleOptionality(const TranslatableString &Prompt)
{
// If creating, will be handled by an AddPrompt.
if( mShuttleMode == eIsCreating )
return;
//wxLogDebug( "Optionality: [%s] Id:%i (%i)", Prompt.c_str(), miId, miIdSetByUser ) ;
if( mpbOptionalFlag ){
bool * pVar = mpbOptionalFlag;
mpbOptionalFlag = nullptr;
TieCheckBox( Prompt, *pVar);
}
}
/// Right aligned text string.
void ShuttleGuiBase::AddPrompt(const TranslatableString &Prompt, int wrapWidth)
{
if( mShuttleMode != eIsCreating )
return;
//wxLogDebug( "Prompt: [%s] Id:%i (%i)", Prompt.c_str(), miId, miIdSetByUser ) ;
if( mpbOptionalFlag ){
bool * pVar = mpbOptionalFlag;
mpbOptionalFlag = nullptr;
TieCheckBox( {}, *pVar);
//return;
}
if( Prompt.empty() )
return;
miProp=1;
const auto translated = Prompt.Translation();
auto text = safenew wxStaticText(GetParent(), -1, translated, wxDefaultPosition, wxDefaultSize,
GetStyle( wxALIGN_RIGHT ));
mpWind = text;
if (wrapWidth > 0)
text->Wrap(wrapWidth);
mpWind->SetName(wxStripMenuCodes(translated)); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
UpdateSizersCore( false, wxALL | wxALIGN_CENTRE_VERTICAL, true );
}
/// Left aligned text string.
void ShuttleGuiBase::AddUnits(const TranslatableString &Prompt, int wrapWidth)
{
if( Prompt.empty() )
return;
if( mShuttleMode != eIsCreating )
return;
miProp = 1;
const auto translated = Prompt.Translation();
auto text = safenew wxStaticText(GetParent(), -1, translated, wxDefaultPosition, wxDefaultSize,
GetStyle( wxALIGN_LEFT ));
mpWind = text;
if (wrapWidth > 0)
text->Wrap(wrapWidth);
mpWind->SetName(translated); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
UpdateSizersCore( false, wxALL | wxALIGN_CENTRE_VERTICAL );
}
/// Centred text string.
void ShuttleGuiBase::AddTitle(const TranslatableString &Prompt, int wrapWidth)
{
if( Prompt.empty() )
return;
if( mShuttleMode != eIsCreating )
return;
const auto translated = Prompt.Translation();
auto text = safenew wxStaticText(GetParent(), -1, translated, wxDefaultPosition, wxDefaultSize,
GetStyle( wxALIGN_CENTRE ));
mpWind = text;
if (wrapWidth > 0)
text->Wrap(wrapWidth);
mpWind->SetName(translated); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
UpdateSizers();
}
/// Very generic 'Add' function. We can add anything we like.
/// Useful for unique controls
wxWindow * ShuttleGuiBase::AddWindow(wxWindow * pWindow)
{
if( mShuttleMode != eIsCreating )
return pWindow;
mpWind = pWindow;
SetProportions( 0 );
UpdateSizersCore(false, wxALIGN_CENTRE | wxALL);
return pWindow;
}
wxCheckBox * ShuttleGuiBase::AddCheckBox( const TranslatableString &Prompt, bool Selected)
{
HandleOptionality( Prompt );
auto realPrompt = Prompt.Translation();
if( mpbOptionalFlag )
{
AddPrompt( {} );
//realPrompt = wxT("");
}
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxCheckBox);
wxCheckBox * pCheckBox;
miProp=0;
mpWind = pCheckBox = safenew wxCheckBox(GetParent(), miId, realPrompt, wxDefaultPosition, wxDefaultSize,
GetStyle( 0 ));
pCheckBox->SetValue(Selected);
if (realPrompt.empty()) {
// NVDA 2018.3 does not read controls which are buttons, check boxes or radio buttons which have
// an accessibility name which is empty. Bug 1980.
#if wxUSE_ACCESSIBILITY
// so that name can be set on a standard control
pCheckBox->SetAccessible(safenew WindowAccessible(pCheckBox));
#endif
pCheckBox->SetName(wxT("\a")); // non-empty string which screen readers do not read
}
UpdateSizers();
return pCheckBox;
}
/// For a consistent two-column layout we want labels on the left and
/// controls on the right. CheckBoxes break that rule, so we fake it by
/// placing a static text label and then a tick box with an empty label.
wxCheckBox * ShuttleGuiBase::AddCheckBoxOnRight( const TranslatableString &Prompt, bool Selected)
{
HandleOptionality( Prompt );
AddPrompt( Prompt );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxCheckBox);
wxCheckBox * pCheckBox;
miProp=0;
mpWind = pCheckBox = safenew wxCheckBox(GetParent(), miId, wxT(""), wxDefaultPosition, wxDefaultSize,
GetStyle( 0 ));
pCheckBox->SetValue(Selected);
pCheckBox->SetName(Prompt.Stripped().Translation());
UpdateSizers();
return pCheckBox;
}
wxButton * ShuttleGuiBase::AddButton(
const TranslatableString &Text, int PositionFlags, bool setDefault)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxButton);
wxButton * pBtn;
const auto translated = Text.Translation();
mpWind = pBtn = safenew wxButton(GetParent(), miId,
translated, wxDefaultPosition, wxDefaultSize,
GetStyle( 0 ) );
mpWind->SetName(wxStripMenuCodes(translated));
miProp=0;
UpdateSizersCore(false, PositionFlags | wxALL);
if (setDefault)
pBtn->SetDefault();
return pBtn;
}
wxBitmapButton * ShuttleGuiBase::AddBitmapButton(
const wxBitmap &Bitmap, int PositionFlags, bool setDefault)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxBitmapButton);
wxBitmapButton * pBtn;
mpWind = pBtn = safenew wxBitmapButton(GetParent(), miId, Bitmap,
wxDefaultPosition, wxDefaultSize, GetStyle( wxBU_AUTODRAW ) );
pBtn->SetBackgroundColour(
wxColour( 246,246,243));
// wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE));
miProp=0;
UpdateSizersCore(false, PositionFlags | wxALL);
if (setDefault)
pBtn->SetDefault();
return pBtn;
}
wxChoice * ShuttleGuiBase::AddChoice( const TranslatableString &Prompt,
const TranslatableStrings &choices, int Selected )
{
HandleOptionality( Prompt );
AddPrompt( Prompt );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxChoice);
wxChoice * pChoice;
miProp=0;
mpWind = pChoice = safenew wxChoice(
GetParent(),
miId,
wxDefaultPosition,
wxDefaultSize,
transform_container<wxArrayString>(
choices, std::mem_fn( &TranslatableString::StrippedTranslation ) ),
GetStyle( 0 ) );
pChoice->SetMinSize( { 180, -1 } );// Use -1 for 'default size' - Platform specific.
#ifdef __WXMAC__
#if wxUSE_ACCESSIBILITY
// so that name can be set on a standard control
mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
#endif
pChoice->SetName(Prompt.Stripped().Translation());
if ( Selected >= 0 && Selected < (int)choices.size() )
pChoice->SetSelection( Selected );
UpdateSizers();
return pChoice;
}
wxChoice * ShuttleGuiBase::AddChoice( const TranslatableString &Prompt,
const TranslatableStrings &choices, const TranslatableString &Selected )
{
return AddChoice(
Prompt, choices, make_iterator_range( choices ).index( Selected ) );
}
void ShuttleGuiBase::AddFixedText(
const TranslatableString &Str, bool bCenter, int wrapWidth)
{
const auto translated = Str.Translation();
UseUpId();
if( mShuttleMode != eIsCreating )
return;
auto text = safenew wxStaticText(GetParent(),
miId, translated, wxDefaultPosition, wxDefaultSize,
GetStyle( wxALIGN_LEFT ));
mpWind = text;
if ( wrapWidth > 0 )
text->Wrap( wrapWidth );
mpWind->SetName(wxStripMenuCodes(translated)); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
if( bCenter )
{
miProp=1;
UpdateSizersC();
}
else
UpdateSizers();
}
wxStaticText * ShuttleGuiBase::AddVariableText(
const TranslatableString &Str,
bool bCenter, int PositionFlags, int wrapWidth )
{
const auto translated = Str.Translation();
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxStaticText);
wxStaticText *pStatic;
auto text = pStatic = safenew wxStaticText(GetParent(), miId, translated,
wxDefaultPosition, wxDefaultSize,
GetStyle( wxALIGN_LEFT ));
mpWind = text;
if ( wrapWidth > 0 )
text->Wrap( wrapWidth );
mpWind->SetName(wxStripMenuCodes(translated)); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
if( bCenter )
{
miProp=1;
if( PositionFlags )
UpdateSizersCore( false, PositionFlags );
else
UpdateSizersC();
}
else
if( PositionFlags )
UpdateSizersCore( false, PositionFlags );
else
UpdateSizers();
return pStatic;
}
ReadOnlyText * ShuttleGuiBase::AddReadOnlyText(
const TranslatableString &Caption, const wxString &Value)
{
const auto translated = Caption.Translation();
auto style = GetStyle( wxBORDER_NONE );
HandleOptionality( Caption );
mItem.miStyle = wxALIGN_CENTER_VERTICAL;
AddPrompt( Caption );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), ReadOnlyText);
ReadOnlyText * pReadOnlyText;
miProp=0;
mpWind = pReadOnlyText = safenew ReadOnlyText(GetParent(), miId, Value,
wxDefaultPosition, wxDefaultSize, GetStyle( style ));
mpWind->SetName(wxStripMenuCodes(translated));
UpdateSizers();
return pReadOnlyText;
}
wxComboBox * ShuttleGuiBase::AddCombo(
const TranslatableString &Prompt,
const wxString &Selected, const wxArrayStringEx & choices )
{
const auto translated = Prompt.Translation();
HandleOptionality( Prompt );
AddPrompt( Prompt );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxComboBox);
wxComboBox * pCombo;
miProp=0;
int n = choices.size();
if( n>50 ) n=50;
int i;
wxString Choices[50];
for(i=0;i<n;i++)
{
Choices[i] = choices[i];
}
mpWind = pCombo = safenew wxComboBox(GetParent(), miId, Selected, wxDefaultPosition, wxDefaultSize,
n, Choices, GetStyle( 0 ));
mpWind->SetName(wxStripMenuCodes(translated));
UpdateSizers();
return pCombo;
}
wxRadioButton * ShuttleGuiBase::DoAddRadioButton(
const TranslatableString &Prompt, int style, int selector, int initValue)
{
const auto translated = Prompt.Translation();
/// \todo This function and the next two, suitably adapted, could be
/// used by TieRadioButton.
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxRadioButton);
wxRadioButton * pRad;
mpWind = pRad = safenew wxRadioButton(GetParent(), miId, translated,
wxDefaultPosition, wxDefaultSize, GetStyle( style ) );
mpWind->SetName(wxStripMenuCodes(translated));
if ( style )
pRad->SetValue( true );
UpdateSizers();
pRad->SetValue( selector == initValue );
return pRad;
}
wxRadioButton * ShuttleGuiBase::AddRadioButton(
const TranslatableString &Prompt, int selector, int initValue)
{
return DoAddRadioButton( Prompt, wxRB_GROUP, selector, initValue );
}
wxRadioButton * ShuttleGuiBase::AddRadioButtonToGroup(
const TranslatableString &Prompt, int selector, int initValue)
{
return DoAddRadioButton( Prompt, 0, selector, initValue );
}
#ifdef __WXMAC__
void wxSliderWrapper::SetFocus()
{
// bypassing the override in wxCompositeWindow<wxSliderBase> which ends up
// doing nothing
return wxSliderBase::SetFocus();
}
#endif
wxSlider * ShuttleGuiBase::AddSlider(
const TranslatableString &Prompt, int pos, int Max, int Min)
{
HandleOptionality( Prompt );
AddPrompt( Prompt );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxSlider);
wxSlider * pSlider;
mpWind = pSlider = safenew wxSliderWrapper(GetParent(), miId,
pos, Min, Max,
wxDefaultPosition,
// Bug2289: On Linux at least, sliders like to be constructed with the
// proper size, not reassigned size later
( ( mItem.mWindowSize == wxSize{} ) ? wxDefaultSize : mItem.mWindowSize ),
GetStyle( wxSL_HORIZONTAL | wxSL_LABELS | wxSL_AUTOTICKS )
);
#if wxUSE_ACCESSIBILITY
// so that name can be set on a standard control
mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
mpWind->SetName(wxStripMenuCodes(Prompt.Translation()));
miProp=1;
UpdateSizers();
return pSlider;
}
wxSpinCtrl * ShuttleGuiBase::AddSpinCtrl(
const TranslatableString &Prompt, int Value, int Max, int Min)
{
const auto translated = Prompt.Translation();
HandleOptionality( Prompt );
AddPrompt( Prompt );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxSpinCtrl);
wxSpinCtrl * pSpinCtrl;
mpWind = pSpinCtrl = safenew wxSpinCtrl(GetParent(), miId,
wxEmptyString,
wxDefaultPosition, wxDefaultSize,
GetStyle( wxSP_VERTICAL | wxSP_ARROW_KEYS ),
Min, Max, Value
);
mpWind->SetName(wxStripMenuCodes(translated));
miProp=1;
UpdateSizers();
return pSpinCtrl;
}
wxTextCtrl * ShuttleGuiBase::AddTextBox(
const TranslatableString &Caption, const wxString &Value, const int nChars)
{
const auto translated = Caption.Translation();
HandleOptionality( Caption );
AddPrompt( Caption );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTextCtrl);
wxTextCtrl * pTextCtrl;
wxSize Size(wxDefaultSize);
if( nChars > 0 )
{
int width;
mpDlg->GetTextExtent( wxT("9"), &width, nullptr );
Size.SetWidth( nChars * width );
}
miProp=0;
#ifdef EXPERIMENTAL_RIGHT_ALIGNED_TEXTBOXES
long flags = wxTE_RIGHT;
#else
long flags = wxTE_LEFT;
#endif
mpWind = pTextCtrl = safenew wxTextCtrlWrapper(GetParent(), miId, Value,
wxDefaultPosition, Size, GetStyle( flags ));
#if wxUSE_ACCESSIBILITY
// so that name can be set on a standard control
mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
mpWind->SetName(wxStripMenuCodes(translated));
UpdateSizers();
return pTextCtrl;
}
wxTextCtrl * ShuttleGuiBase::AddNumericTextBox(
const TranslatableString &Caption, const wxString &Value, const int nChars)
{
const auto translated = Caption.Translation();
HandleOptionality( Caption );
AddPrompt( Caption );
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTextCtrl);
wxTextCtrl * pTextCtrl;
wxSize Size(wxDefaultSize);
if( nChars > 0 )
{
Size.SetWidth( nChars *5 );
}
miProp=0;
#ifdef EXPERIMENTAL_RIGHT_ALIGNED_TEXTBOXES
long flags = wxTE_RIGHT;
#else
long flags = wxTE_LEFT;
#endif
wxTextValidator Validator(wxFILTER_NUMERIC);
mpWind = pTextCtrl = safenew wxTextCtrl(GetParent(), miId, Value,
wxDefaultPosition, Size, GetStyle( flags ),
Validator // It's OK to pass this. It will be cloned.
);
#if wxUSE_ACCESSIBILITY
// so that name can be set on a standard control
mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
mpWind->SetName(wxStripMenuCodes(translated));
UpdateSizers();
return pTextCtrl;
}
/// Multiline text box that grows.
wxTextCtrl * ShuttleGuiBase::AddTextWindow(const wxString &Value)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTextCtrl);
wxTextCtrl * pTextCtrl;
SetProportions( 1 );
mpWind = pTextCtrl = safenew wxTextCtrl(GetParent(), miId, Value,
wxDefaultPosition, wxDefaultSize, GetStyle( wxTE_MULTILINE ));
#if wxUSE_ACCESSIBILITY
// so that name can be set on a standard control
mpWind->SetAccessible(safenew WindowAccessible(mpWind));
#endif
UpdateSizers();
// Start off at start of window...
pTextCtrl->SetInsertionPoint( 0 );
pTextCtrl->ShowPosition( 0 );
return pTextCtrl;
}
/// Single line text box of fixed size.
void ShuttleGuiBase::AddConstTextBox(
const TranslatableString &Prompt, const TranslatableString &Value)
{
HandleOptionality( Prompt );
AddPrompt( Prompt );
UseUpId();
if( mShuttleMode != eIsCreating )
return;
// return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wx);
miProp=0;
UpdateSizers();
miProp=0;
const auto translatedValue = Value.Translation();
mpWind = safenew wxStaticText(GetParent(), miId,
translatedValue, wxDefaultPosition, wxDefaultSize,
GetStyle( 0 ));
mpWind->SetName(translatedValue); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
UpdateSizers();
}
wxListBox * ShuttleGuiBase::AddListBox(const wxArrayStringEx &choices)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxListBox);
wxListBox * pListBox;
SetProportions( 1 );
mpWind = pListBox = safenew wxListBox(GetParent(), miId,
wxDefaultPosition, wxDefaultSize, choices, GetStyle(0));
pListBox->SetMinSize( wxSize( 120,150 ));
UpdateSizers();
return pListBox;
}
wxGrid * ShuttleGuiBase::AddGrid()
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxGrid);
wxGrid * pGrid;
SetProportions( 1 );
mpWind = pGrid = safenew wxGrid(GetParent(), miId, wxDefaultPosition,
wxDefaultSize, GetStyle( wxWANTS_CHARS ));
pGrid->SetMinSize( wxSize( 120, 150 ));
UpdateSizers();
return pGrid;
}
wxListCtrl * ShuttleGuiBase::AddListControl(
std::initializer_list<const ListControlColumn> columns,
long listControlStyles
)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxListCtrl);
wxListCtrl * pListCtrl;
SetProportions( 1 );
mpWind = pListCtrl = safenew wxListCtrl(GetParent(), miId,
wxDefaultPosition, wxDefaultSize, GetStyle( wxLC_ICON ));
pListCtrl->SetMinSize( wxSize( 120,150 ));
UpdateSizers();
DoInsertListColumns( pListCtrl, listControlStyles, columns );
return pListCtrl;
}
wxListCtrl * ShuttleGuiBase::AddListControlReportMode(
std::initializer_list<const ListControlColumn> columns,
long listControlStyles
)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxListCtrl);
wxListCtrl * pListCtrl;
SetProportions( 1 );
mpWind = pListCtrl = safenew wxListCtrl(GetParent(), miId,
wxDefaultPosition, wxSize(230,120),//wxDefaultSize,
GetStyle( wxLC_REPORT | wxLC_HRULES | wxLC_VRULES | wxSUNKEN_BORDER ));
// pListCtrl->SetMinSize( wxSize( 120,150 ));
UpdateSizers();
DoInsertListColumns( pListCtrl, listControlStyles, columns );
return pListCtrl;
}
void ShuttleGuiBase::DoInsertListColumns(
wxListCtrl *pListCtrl,
long listControlStyles,
std::initializer_list<const ListControlColumn> columns )
{
// Old comment from HistoryWindow.cpp follows
// -- is it still correct for wxWidgets 3?
// Do this BEFORE inserting the columns. On the Mac at least, the
// columns are deleted and later InsertItem()s will cause Sneedacity to crash.
for ( auto style = 1l; style <= listControlStyles; style <<= 1 )
if ( (style & listControlStyles) )
pListCtrl->SetSingleStyle(style, true);
long iCol = 0;
bool dummyColumn =
columns.size() > 0 && begin(columns)->format == wxLIST_FORMAT_RIGHT;
//A dummy first column, which is then deleted, is a workaround -
// under Windows the first column can't be right aligned.
if (dummyColumn)
pListCtrl->InsertColumn( iCol++, wxString{} );
for (auto &column : columns)
pListCtrl->InsertColumn(
iCol++, column.heading.Translation(), column.format, column.width );
if (dummyColumn)
pListCtrl->DeleteColumn( 0 );
}
wxTreeCtrl * ShuttleGuiBase::AddTree()
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxTreeCtrl);
wxTreeCtrl * pTreeCtrl;
SetProportions( 1 );
mpWind = pTreeCtrl = safenew wxTreeCtrl(GetParent(), miId, wxDefaultPosition, wxDefaultSize,
GetStyle( wxTR_HAS_BUTTONS ));
pTreeCtrl->SetMinSize( wxSize( 120,650 ));
UpdateSizers();
return pTreeCtrl;
}
void ShuttleGuiBase::AddIcon(wxBitmap *pBmp)
{
UseUpId();
if( mShuttleMode != eIsCreating )
// return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wx);
return;
wxBitmapButton * pBtn;
mpWind = pBtn = safenew wxBitmapButton(GetParent(), miId, *pBmp,
wxDefaultPosition, wxDefaultSize, GetStyle( wxBU_AUTODRAW ) );
pBtn->SetWindowStyle( wxBORDER_NONE );
pBtn->SetCanFocus(false);
UpdateSizersC();
}
ShuttleGuiBase & ShuttleGuiBase::Prop( int iProp )
{
miPropSetByUser = iProp;
return *this;
}
/// Starts a static box around a number of controls.
/// @param Str The text of the title for the box.
/// @param iProp The resizing proportion value.
/// Use iProp == 0 for a minimum sized static box.
/// Use iProp == 1 for a box that grows if there is space to spare.
wxStaticBox * ShuttleGuiBase::StartStatic(const TranslatableString &Str, int iProp)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return NULL;
auto translated = Str.Translation();
wxStaticBox * pBox = safenew wxStaticBoxWrapper(
GetParent(), miId, translated );
pBox->SetLabel( translated );
if (Str.empty()) {
// NVDA 2018.3 or later does not read the controls in a group box which has
// an accessibility name which is empty. Bug 2169.
#if wxUSE_ACCESSIBILITY
// so that name can be set on a standard control
pBox->SetAccessible(safenew WindowAccessible(pBox));
#endif
pBox->SetName(wxT("\a")); // non-empty string which screen readers do not read
}
else
pBox->SetName( wxStripMenuCodes( translated ) );
mpSubSizer = std::make_unique<wxStaticBoxSizer>(
pBox,
wxVERTICAL );
miSizerProp = iProp;
UpdateSizers();
mpParent = pBox;
return pBox;
}
void ShuttleGuiBase::EndStatic()
{
if( mShuttleMode != eIsCreating )
return;
PopSizer();
mpParent = mpParent->GetParent();
}
/// This allows subsequent controls and static boxes to be in
/// a scrolled panel. Very handy if you are running out of space
/// on a dialog.
///
/// The iStyle parameter is used in some very hacky code that
/// dynamically repopulates a dialog. It also controls the
/// background colour. Look at the code for details.
/// @param istyle deprecated parameter, but has been used for hacking.
wxScrolledWindow * ShuttleGuiBase::StartScroller(int iStyle)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxScrolledWindow);
wxScrolledWindow * pScroller;
mpWind = pScroller = safenew wxScrolledWindow(GetParent(), miId, wxDefaultPosition, wxDefaultSize,
GetStyle( wxSUNKEN_BORDER ) );
pScroller->SetScrollRate( 20,20 );
// This fools NVDA into not saying "Panel" when the dialog gets focus
pScroller->SetName(wxT("\a"));
pScroller->SetLabel(wxT("\a"));
SetProportions( 1 );
if( iStyle==2 )
{
UpdateSizersAtStart();
}
else
{
// mpWind->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_MENUBAR));
UpdateSizers(); // adds window in to current sizer.
}
// create a sizer within the window...
mpParent = pScroller;
pScroller->SetSizer(mpSizer = safenew wxBoxSizer(wxVERTICAL));
PushSizer();
return pScroller;
}
void ShuttleGuiBase::EndScroller()
{
if( mShuttleMode != eIsCreating )
return;
wxSize ScrollSize = mpSizer->GetMinSize();
int yMin = ScrollSize.y+4;
int xMin = ScrollSize.x+4;
if( yMin > 400)
{
yMin = 400;
xMin+=50;// extra space for vertical scrollbar.
}
mpParent->SetMinSize( wxSize(xMin, yMin) );
PopSizer();
mpParent = mpParent->GetParent();
}
wxPanel * ShuttleGuiBase::StartPanel(int iStyle)
{
UseUpId();
if( mShuttleMode != eIsCreating )
return wxDynamicCast(wxWindow::FindWindowById( miId, mpDlg), wxPanel);
wxPanel * pPanel;
mpWind = pPanel = safenew wxPanelWrapper( GetParent(), miId, wxDefaultPosition, wxDefaultSize,
GetStyle( wxNO_BORDER ));
if( iStyle != 0 )
{
mpWind->SetBackgroundColour(
iStyle==1
? wxColour( 190,200,230) :
wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)
);
}
SetProportions(0);