Audacity 3.2.0
Classes | Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
PluginRegistrationDialog Class Referencefinal

#include <PluginRegistrationDialog.h>

Inheritance diagram for PluginRegistrationDialog:
[legend]
Collaboration diagram for PluginRegistrationDialog:
[legend]

Classes

struct  ItemData
 

Public Member Functions

 PluginRegistrationDialog (wxWindow *parent)
 
- Public Member Functions inherited from wxDialogWrapper
 wxDialogWrapper ()
 
 wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
 
bool Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
 
void SetTitle (const TranslatableString &title)
 
void SetLabel (const TranslatableString &title)
 
void SetName (const TranslatableString &title)
 
void SetName ()
 
- Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
 wxTabTraversalWrapper (Args &&... args)
 
 wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
 
 wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
 
wxTabTraversalWrapperoperator= (const wxTabTraversalWrapper &)=delete
 
wxTabTraversalWrapperoperator= (wxTabTraversalWrapper &&)=delete
 

Private Types

using ItemDataMap = std::unordered_map< PluginPath, ItemData >
 

Private Member Functions

void Populate ()
 
void PopulateOrExchange (ShuttleGui &S)
 Defines the dialog and does data exchange with it. More...
 
void PopulateItemsList (PluginManager &pm)
 
void RegenerateEffectsList (int iShowWhat)
 
void SetState (int i, bool toggle, bool state=true)
 
int SortCompare (ItemData *item1, ItemData *item2)
 
void OnChangedVisibility (wxCommandEvent &evt)
 
void OnSort (wxListEvent &evt)
 
void DoSort (int col)
 
void OnListChar (wxKeyEvent &evt)
 
void OnOK (wxCommandEvent &evt)
 
void OnCancel (wxCommandEvent &evt)
 
void OnSelectAll (wxCommandEvent &evt)
 
void OnClearAll (wxCommandEvent &evt)
 
void OnRescan (wxCommandEvent &evt)
 
void OnEnable (wxCommandEvent &evt)
 
void OnDisable (wxCommandEvent &evt)
 

Static Private Member Functions

static int wxCALLBACK SortCompare (wxIntPtr item1, wxIntPtr item2, wxIntPtr sortData)
 

Private Attributes

int mFilter
 
wxArrayString mStates
 
ItemDataMap mItems
 
int mSortColumn
 
int mSortDirection
 
PluginPath mLongestPath
 
wxListCtrl * mEffects
 

Detailed Description

Definition at line 25 of file PluginRegistrationDialog.h.

Member Typedef Documentation

◆ ItemDataMap

using PluginRegistrationDialog::ItemDataMap = std::unordered_map<PluginPath, ItemData>
private

Definition at line 44 of file PluginRegistrationDialog.h.

Constructor & Destructor Documentation

◆ PluginRegistrationDialog()

PluginRegistrationDialog::PluginRegistrationDialog ( wxWindow *  parent)

Definition at line 397 of file PluginRegistrationDialog.cpp.

398: wxDialogWrapper(parent,
399 wxID_ANY,
400 XO("Manage Plugins"),
401 wxDefaultPosition, wxDefaultSize,
402 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
403{
404 mEffects = NULL;
405 SetName();
406
407 mStates.resize(STATE_COUNT);
408 mStates[STATE_Enabled] = _("Enabled");
409 mStates[STATE_Disabled] = _("Disabled");
410#ifndef DISABLE_STATE_NEW
411 mStates[STATE_New] = _("New");
412#endif
413
415 mSortDirection = 1;
416
417 Populate();
418
420}
XO("Cut/Copy/Paste")
#define _(s)
Definition: Internat.h:75

References _, COL_Name, STATE_COUNT, STATE_Disabled, and STATE_Enabled.

Member Function Documentation

◆ DoSort()

void PluginRegistrationDialog::DoSort ( int  col)
private

Definition at line 812 of file PluginRegistrationDialog.cpp.

813{
814 if (col != mSortColumn)
815 {
816 mSortDirection = 1;
817 }
818 else
819 {
820 mSortDirection *= -1;
821 }
822
823 mSortColumn = col;
824 mEffects->SortItems(SortCompare, (wxUIntPtr) this);
825
826 // Without a refresh, wxMac doesn't redisplay the list properly after a sort
827 mEffects->Refresh();
828}
static int wxCALLBACK SortCompare(wxIntPtr item1, wxIntPtr item2, wxIntPtr sortData)

References mEffects, mSortColumn, mSortDirection, and SortCompare().

Referenced by OnSort().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnCancel()

void PluginRegistrationDialog::OnCancel ( wxCommandEvent &  evt)
private

Definition at line 1066 of file PluginRegistrationDialog.cpp.

1067{
1068 EndModal(wxID_CANCEL);
1069}

◆ OnChangedVisibility()

void PluginRegistrationDialog::OnChangedVisibility ( wxCommandEvent &  evt)
private

Definition at line 800 of file PluginRegistrationDialog.cpp.

801{
802 // Go and show the relevant items.
803 RegenerateEffectsList(evt.GetId());
804}
void RegenerateEffectsList(int iShowWhat)

References RegenerateEffectsList().

Here is the call graph for this function:

◆ OnClearAll()

void PluginRegistrationDialog::OnClearAll ( wxCommandEvent &  evt)
private

Definition at line 864 of file PluginRegistrationDialog.cpp.

865{
866 for (int i = 0, cnt = mEffects->GetItemCount(); i < cnt; i++)
867 {
868 mEffects->SetItemState(i, 0, wxLIST_STATE_SELECTED);
869 }
870}

References mEffects.

◆ OnDisable()

void PluginRegistrationDialog::OnDisable ( wxCommandEvent &  evt)
private

Definition at line 950 of file PluginRegistrationDialog.cpp.

951{
952 std::vector<long> items;
953
954 {
955 long i = mEffects->GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
956 while (i != wxNOT_FOUND)
957 {
958 items.insert(items.begin(), i);
959 i = mEffects->GetNextItem(i, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
960 }
961 }
962
963 for (size_t i = 0, cnt = items.size(); i < cnt; i++)
964 {
965 SetState(items[i], false, STATE_Disabled);
966 }
967}
void SetState(int i, bool toggle, bool state=true)

References mEffects, SetState(), and STATE_Disabled.

Here is the call graph for this function:

◆ OnEnable()

void PluginRegistrationDialog::OnEnable ( wxCommandEvent &  evt)
private

Definition at line 931 of file PluginRegistrationDialog.cpp.

932{
933 std::vector<long> items;
934
935 {
936 long i = mEffects->GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
937 while (i != wxNOT_FOUND)
938 {
939 items.insert(items.begin(), i);
940 i = mEffects->GetNextItem(i, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
941 }
942 }
943
944 for (size_t i = 0, cnt = items.size(); i < cnt; i++)
945 {
946 SetState(items[i], false, STATE_Enabled);
947 }
948}

References mEffects, SetState(), and STATE_Enabled.

Here is the call graph for this function:

◆ OnListChar()

void PluginRegistrationDialog::OnListChar ( wxKeyEvent &  evt)
private

Definition at line 830 of file PluginRegistrationDialog.cpp.

831{
832 switch (evt.GetKeyCode())
833 {
834 case WXK_SPACE:
835 {
836 int item = mEffects->GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
837 if (item != wxNOT_FOUND)
838 {
839 SetState(item, true);
840 }
841 }
842 break;
843
844 case WXK_RETURN:
845 // Don't know why wxListCtrls prevent default dialog action,
846 // but they do, so handle it.
847 EmulateButtonClickIfPresent(GetAffirmativeId());
848 break;
849
850 default:
851 evt.Skip();
852 break;
853 }
854}

References mEffects, and SetState().

Referenced by PopulateOrExchange().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnOK()

void PluginRegistrationDialog::OnOK ( wxCommandEvent &  evt)
private

Definition at line 969 of file PluginRegistrationDialog.cpp.

970{
973
974 int enableCount = 0;
975 for (ItemDataMap::iterator iter = mItems.begin(); iter != mItems.end(); ++iter)
976 {
977 ItemData & item = iter->second;
978 wxString path = item.path;
979
980 if (item.state == STATE_Enabled && item.plugs[0]->GetPluginType() == PluginTypeStub)
981 {
982 enableCount++;
983 }
984 }
985
986 wxString last3 = mLongestPath + wxT("\n") +
987 mLongestPath + wxT("\n") +
988 mLongestPath + wxT("\n");
989
990 auto msg = XO("Enabling effects or commands:\n\n%s").Format( last3 );
991
992 // Make sure the progress dialog is deleted before we call EndModal() or
993 // we will leave the project window in an unusable state on OSX.
994 // See bug #1192.
995 {
996 ProgressDialog progress{
997 Verbatim( GetTitle() ), msg, pdlgHideStopButton };
998 progress.CenterOnParent();
999
1000 int i = 0;
1001 for (ItemDataMap::iterator iter = mItems.begin(); iter != mItems.end(); ++iter)
1002 {
1003 ItemData & item = iter->second;
1004 wxString path = item.path;
1005
1006 if (item.state == STATE_Enabled && item.plugs[0]->GetPluginType() == PluginTypeStub)
1007 {
1008 last3 = last3.AfterFirst(wxT('\n')) + item.path + wxT("\n");
1009 auto status = progress.Update(++i, enableCount,
1010 XO("Enabling effect or command:\n\n%s").Format( last3 ));
1011 if (status == ProgressResult::Cancelled)
1012 {
1013 break;
1014 }
1015
1016 TranslatableString errMsgs;
1017
1018 // Try to register the plugin via each provider until one succeeds
1019 for (size_t j = 0, cntj = item.plugs.size(); j < cntj; j++)
1020 {
1021 TranslatableString errMsg;
1022 if (mm.RegisterEffectPlugin(item.plugs[j]->GetProviderID(), path,
1023 errMsg))
1024 {
1025 for (auto plug : item.plugs)
1027 plug->GetProviderID() + wxT("_") + path);
1028 // Bug 1893. We've found a provider that works.
1029 // Error messages from any that failed are no longer useful.
1030 errMsgs = {};
1031 break;
1032 }
1033 else
1034 {
1035 if (!errMsgs.empty())
1036 errMsgs.Join( errMsg, '\n' );
1037 else
1038 errMsgs = errMsg;
1039 }
1040 }
1041 if (!errMsgs.empty())
1043 XO("Effect or Command at %s failed to register:\n%s")
1044 .Format( path, errMsgs ) );
1045 }
1046#ifndef DISABLE_STATE_NEW
1047 else if (item.state == STATE_New) {
1048 for (auto plug : item.plugs)
1049 plug->SetValid(false);
1050 }
1051#endif
1052 else {
1053 for (auto plug : item.plugs) {
1054 plug->SetEnabled(item.state == STATE_Enabled);
1055 plug->SetValid(item.valid);
1056 }
1057 }
1058 }
1059
1060 pm.Save();
1061 }
1062
1063 EndModal(wxID_OK);
1064}
wxT("CloseDown"))
int AudacityMessageBox(const TranslatableString &message, const TranslatableString &caption, long style, wxWindow *parent, int x, int y)
@ PluginTypeStub
@ pdlgHideStopButton
TranslatableString Verbatim(wxString str)
Require calls to the one-argument constructor to go through this distinct global function name.
Abstract base class used in importing a file.
static ModuleManager & Get()
bool RegisterEffectPlugin(const PluginID &provider, const PluginPath &path, TranslatableString &errMsg)
PluginManager maintains a list of all plug ins. That covers modules, effects, generators,...
Definition: PluginManager.h:42
void Save()
Save to preferences.
void UnregisterPlugin(const PluginID &ID)
static PluginManager & Get()
ProgressDialog Class.
Holds a msgid for the translation catalog; may also bind format arguments.
TranslatableString & Join(TranslatableString arg, const wxString &separator={}) &
Append another translatable string.

References AudacityMessageBox(), RefreshCode::Cancelled, TranslatableString::empty(), ModuleManager::Get(), PluginManager::Get(), TranslatableString::Join(), mItems, mLongestPath, PluginRegistrationDialog::ItemData::path, pdlgHideStopButton, PluginTypeStub, PluginRegistrationDialog::ItemData::plugs, ModuleManager::RegisterEffectPlugin(), PluginManager::Save(), PluginRegistrationDialog::ItemData::state, STATE_Enabled, PluginManager::UnregisterPlugin(), PluginRegistrationDialog::ItemData::valid, Verbatim(), wxT(), and XO().

Here is the call graph for this function:

◆ OnRescan()

void PluginRegistrationDialog::OnRescan ( wxCommandEvent &  evt)
private

Definition at line 872 of file PluginRegistrationDialog.cpp.

873{
874 mItems.clear();
875 mEffects->DeleteAllItems();
876 mEffects->Update();
877
878 wxTheApp->CallAfter([this] {
879 std::set<PluginPath> disabledPlugins;
880 std::vector<wxString> failedPlugins;
881
882 auto& pm = PluginManager::Get();
883
884 // Record list of plugins that are currently disabled
885 for (auto& plug : pm.AllPlugins())
886 {
887 PluginType plugType = plug.GetPluginType();
888 if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
889 continue;
890
891 if (!plug.IsEnabled())
892 disabledPlugins.insert(plug.GetPath());
893 }
894
895 pm.ClearEffectPlugins();
896
897 auto newPlugins = PluginManager::Get().CheckPluginUpdates();
898 if (!newPlugins.empty())
899 {
900 PluginStartupRegistration reg(newPlugins);
901 reg.Run();
902
903 failedPlugins = reg.GetFailedPluginsPaths();
904 }
905
906 // Disable all plugins which were previously disabled
907 for (auto& plug : pm.AllPlugins())
908 {
909 PluginType plugType = plug.GetPluginType();
910 if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
911 continue;
912
913 const auto& path = plug.GetPath();
914 if (disabledPlugins.find(path) != disabledPlugins.end())
915 plug.SetEnabled(false);
916 }
917
918 pm.Save();
919
920 if (!failedPlugins.empty())
921 {
922 auto dialog = safenew IncompatiblePluginsDialog(this, wxID_ANY, ScanType::Manual, failedPlugins);
923 dialog->ShowModal();
924 }
925
928 });
929}
#define safenew
Definition: MemoryX.h:10
PluginType
@ PluginTypeEffect
std::map< wxString, std::vector< wxString > > CheckPluginUpdates()
Ensures that all currently registered plugins still exist and scans for new ones.
void PopulateItemsList(PluginManager &pm)
BuiltinCommandsModule::Registration< CompareAudioCommand > reg

References PluginManager::CheckPluginUpdates(), PluginManager::Get(), Manual, mEffects, mFilter, mItems, PluginTypeEffect, PluginTypeStub, PopulateItemsList(), anonymous_namespace{CompareAudioCommand.cpp}::reg, RegenerateEffectsList(), and safenew.

Here is the call graph for this function:

◆ OnSelectAll()

void PluginRegistrationDialog::OnSelectAll ( wxCommandEvent &  evt)
private

Definition at line 856 of file PluginRegistrationDialog.cpp.

857{
858 for (int i = 0, cnt = mEffects->GetItemCount(); i < cnt; i++)
859 {
860 mEffects->SetItemState(i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
861 }
862}

References mEffects.

◆ OnSort()

void PluginRegistrationDialog::OnSort ( wxListEvent &  evt)
private

Definition at line 806 of file PluginRegistrationDialog.cpp.

807{
808 int col = evt.GetColumn();
809 DoSort( col );
810}

References DoSort().

Here is the call graph for this function:

◆ Populate()

void PluginRegistrationDialog::Populate ( )
private

Definition at line 422 of file PluginRegistrationDialog.cpp.

423{
424 //------------------------- Main section --------------------
425 ShuttleGui S(this, eIsCreating);
427 // ----------------------- End of main section --------------
428}
@ eIsCreating
Definition: ShuttleGui.h:39
#define S(N)
Definition: ToChars.cpp:64
void PopulateOrExchange(ShuttleGui &S)
Defines the dialog and does data exchange with it.
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:628

References eIsCreating, PopulateOrExchange(), and S.

Here is the call graph for this function:

◆ PopulateItemsList()

void PluginRegistrationDialog::PopulateItemsList ( PluginManager pm)
private

Definition at line 611 of file PluginRegistrationDialog.cpp.

612{
613 for (auto& plug : pm.AllPlugins())
614 {
615 PluginType plugType = plug.GetPluginType();
616 if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
617 continue;
618
619 const auto& path = plug.GetPath();
620 ItemData& item = mItems[path]; // will create NEW entry
621 item.plugs.push_back(&plug);
622 item.path = path;
623 item.state = plug.IsEnabled() ? STATE_Enabled : STATE_Disabled;
624 item.valid = plug.IsValid();
625
626 if (plugType == PluginTypeEffect)
627 {
628 item.name = plug.GetSymbol().Translation();
629 }
630 // This is not right and will not work when other plugin types are added.
631 // But it's presumed that the plugin manager dialog will be fully developed
632 // by then.
633 else if (plugType == PluginTypeStub)
634 {
635 wxFileName fname{ path };
636 item.name = fname.GetName().Trim(false).Trim(true);
637#ifndef DISABLE_STATE_NEW
638 if (!item.valid)
639 {
640 item.state = STATE_New;
641 }
642#endif
643 }
644 }
645}
Range AllPlugins()

References PluginManager::AllPlugins(), mItems, PluginRegistrationDialog::ItemData::name, PluginRegistrationDialog::ItemData::path, PluginTypeEffect, PluginTypeStub, PluginRegistrationDialog::ItemData::plugs, PluginRegistrationDialog::ItemData::state, STATE_Disabled, STATE_Enabled, and PluginRegistrationDialog::ItemData::valid.

Referenced by OnRescan(), and PopulateOrExchange().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PopulateOrExchange()

void PluginRegistrationDialog::PopulateOrExchange ( ShuttleGui S)
private

Defines the dialog and does data exchange with it.

Definition at line 431 of file PluginRegistrationDialog.cpp.

432{
433 S.StartVerticalLay(true);
434 {
435 /*i18n-hint: The dialog shows a list of plugins with check-boxes
436 beside each one.*/
437// S.StartStatic(XO("Effects"), true);
438 S.StartVerticalLay();
439 {
440 S.StartHorizontalLay(wxEXPAND, 0);
441 {
442 S.StartHorizontalLay(wxALIGN_LEFT, 0);
443 {
444 S.AddPrompt(XXO("Select effects, click the Enable or Disable button, then click OK."));
445 }
446 S.EndHorizontalLay();
447
448 S.StartHorizontalLay(wxCENTER, 1);
449 {
450 S.AddSpace(1);
451 }
452 S.EndHorizontalLay();
453
454 S.StartHorizontalLay(wxALIGN_NOT | wxALIGN_LEFT, 0);
455 {
456 wxRadioButton *rb;
457
458 /* i18n-hint: This is before radio buttons selecting which effects to show */
459 S.AddPrompt(XXO("Show:"));
460 rb = S.Id(ID_ShowAll)
461 /* i18n-hint: Radio button to show all effects */
462 .Name(XO("Show all"))
463 /* i18n-hint: Radio button to show all effects */
464 .AddRadioButton(XXO("&All"));
465#if wxUSE_ACCESSIBILITY
466 // so that name can be set on a standard control
467 rb->SetAccessible(safenew WindowAccessible(rb));
468#endif
469
470 rb = S.Id(ID_ShowDisabled)
471 /* i18n-hint: Radio button to show just the currently disabled effects */
472 .Name(XO("Show disabled"))
473 /* i18n-hint: Radio button to show just the currently disabled effects */
474 .AddRadioButtonToGroup(XXO("D&isabled"));
475#if wxUSE_ACCESSIBILITY
476 // so that name can be set on a standard control
477 rb->SetAccessible(safenew WindowAccessible(rb));
478#endif
479
480 rb = S.Id(ID_ShowEnabled)
481 /* i18n-hint: Radio button to show just the currently enabled effects */
482 .Name(XO("Show enabled"))
483 /* i18n-hint: Radio button to show just the currently enabled effects */
484 .AddRadioButtonToGroup(XXO("E&nabled"));
485#if wxUSE_ACCESSIBILITY
486 // so that name can be set on a standard control
487 rb->SetAccessible(safenew WindowAccessible(rb));
488#endif
489
490#ifndef DISABLE_STATE_NEW
491 rb = S.Id(ID_ShowNew)
492 /* i18n-hint: Radio button to show just the newly discovered effects */
493 .Name(XO("Show new"))
494 /* i18n-hint: Radio button to show just the newly discovered effects */
495 .AddRadioButtonToGroup(XXO("Ne&w"));
496#if wxUSE_ACCESSIBILITY
497 // so that name can be set on a standard control
498 rb->SetAccessible(safenew WindowAccessible(rb));
499#endif
500#endif
501 }
502 S.EndHorizontalLay();
503 }
504 S.EndHorizontalLay();
505
506 mEffects = S.Id(ID_List)
507 .Style(wxSUNKEN_BORDER | wxLC_REPORT | wxLC_HRULES | wxLC_VRULES )
508 .ConnectRoot(wxEVT_KEY_DOWN,
510 .AddListControlReportMode({ XO("Name"), XO("State"), XO("Path") });
511#if wxUSE_ACCESSIBILITY
512 mEffects->SetAccessible(mAx = safenew CheckListAx(mEffects));
513#endif
514
515 S.StartHorizontalLay(wxALIGN_LEFT | wxEXPAND, 0);
516 {
517 S.Id(ID_SelectAll).AddButton(XXO("&Select All"));
518 S.Id(ID_ClearAll).AddButton(XXO("C&lear All"));
519 S.Id(ID_Rescan).AddButton(XXO("Rescan"));
520
521 S.StartHorizontalLay(wxALIGN_CENTER);
522 {
523 S.AddSpace(1);
524 }
525 S.EndHorizontalLay();
526
527 S.Id(ID_Enable).AddButton(XXO("&Enable"));
528 S.Id(ID_Disable).AddButton(XXO("&Disable"));
529 }
530 S.EndHorizontalLay();
531 }
532// S.EndStatic();
533 S.EndVerticalLay();
534
535 S.AddStandardButtons(eOkButton | eCancelButton);
536 }
537 S.EndVerticalLay();
538
539 std::vector<int> colWidths;
540 for (int i = 0, cnt = mEffects->GetColumnCount(); i < cnt; i++)
541 {
542 colWidths.push_back(0);
543 }
544
545 for (int i = 0, cnt = mStates.size(); i < cnt; i++)
546 {
547 int x;
548 mEffects->GetTextExtent(mStates[i], &x, NULL);
549 colWidths[COL_State] = wxMax(colWidths[COL_State], x + 4); // 2 pixel margin on each side
550 }
551
554
555 for (const auto& item : mItems)
556 {
557 const auto& itemData = item.second;
558
559 int x;
560 mEffects->GetTextExtent(itemData.name, &x, NULL);
561 colWidths[COL_Name] = wxMax(colWidths[COL_Name], x);
562
563 mEffects->GetTextExtent(itemData.path, &x, NULL);
564 if (x > colWidths[COL_Path])
565 {
566 mLongestPath = itemData.path;
567 }
568 colWidths[COL_Path] = wxMax(colWidths[COL_Path], x);
569 }
570
571 wxRect r = wxGetClientDisplayRect();
572
573 int maxW = 0;
574 for (int i = 0, cnt = mEffects->GetColumnCount(); i < cnt; i++)
575 {
576 int w = colWidths[i] + /* fudge */ 10;
577 mEffects->SetColumnWidth(i, w);
578 maxW += w;
579 }
580
581 // Keep dialog from getting too wide
582 int w = r.GetWidth() - (GetClientSize().GetWidth() - mEffects->GetSize().GetWidth());
583 mEffects->SetMinSize({ std::min(maxW, w), 200 });
584 mEffects->SetMaxSize({ w, -1 });
585
587
588 Layout();
589 Fit();
590
591 wxSize sz = GetSize();
592 sz.SetWidth(wxMin(sz.GetWidth(), r.GetWidth()));
593 sz.SetHeight(wxMin(sz.GetHeight(), r.GetHeight()));
594 SetMinSize(sz);
595
596 // Parent window is usually not there yet, so centre on screen rather than on parent.
597 CenterOnScreen();
598
599 if (mEffects->GetItemCount() > 0)
600 {
601 // Make sure first item is selected/focused.
602 mEffects->SetFocus();
603 mEffects->SetItemState(0, wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED, wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED);
604#if wxUSE_ACCESSIBILITY
605 mAx->SetSelected(0);
606#endif
607 }
608
609}
int min(int a, int b)
XXO("&Cut/Copy/Paste Toolbar")
@ eOkButton
Definition: ShuttleGui.h:597
@ eCancelButton
Definition: ShuttleGui.h:598
An alternative to using wxWindowAccessible, which in wxWidgets 3.1.1 contained GetParent() which was ...

References COL_Name, COL_Path, COL_State, eCancelButton, eOkButton, PluginManager::Get(), ID_ClearAll, ID_Disable, ID_Enable, ID_List, ID_Rescan, ID_SelectAll, ID_ShowAll, ID_ShowDisabled, ID_ShowEnabled, mEffects, min(), mItems, mLongestPath, mStates, OnListChar(), PopulateItemsList(), RegenerateEffectsList(), S, safenew, XO(), and XXO().

Referenced by Populate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RegenerateEffectsList()

void PluginRegistrationDialog::RegenerateEffectsList ( int  iShowWhat)
private

Definition at line 647 of file PluginRegistrationDialog.cpp.

648{
649 mFilter = filter;
650
651 mEffects->DeleteAllItems();
652
653 int i = 0;
654 for (ItemDataMap::iterator iter = mItems.begin(); iter != mItems.end(); ++iter)
655 {
656 ItemData & item = iter->second;
657 bool add = false;
658
659 switch (mFilter)
660 {
661 case ID_ShowAll:
662 add = true;
663 break;
664#ifndef DISABLE_STATE_NEW
665 case ID_ShowNew:
666 if (item.state == STATE_New)
667 {
668 add = true;
669 }
670 break;
671#endif
672 case ID_ShowEnabled:
673 if (item.state == STATE_Enabled)
674 {
675 add = true;
676 }
677 break;
678 case ID_ShowDisabled:
679 if (item.state == STATE_Disabled)
680 {
681 add = true;
682 }
683 break;
684 }
685
686 if (add)
687 {
688 mEffects->InsertItem(i, item.name);
689 mEffects->SetItem(i, COL_State, mStates[item.state]);
690 mEffects->SetItem(i, COL_Path, item.path);
691 mEffects->SetItemPtrData(i, (wxUIntPtr) &item);
692
693 ++i;
694 }
695 }
696
697 mEffects->SortItems(SortCompare, (wxUIntPtr) this);
698
699 if (mEffects->GetItemCount() > 0)
700 {
701 // Make sure first item is selected/focused.
702// mEffects->SetFocus();
703 mEffects->SetItemState(0, wxLIST_STATE_FOCUSED|wxLIST_STATE_SELECTED, wxLIST_STATE_FOCUSED|wxLIST_STATE_SELECTED);
704#if wxUSE_ACCESSIBILITY
705 mAx->SetSelected(0, false);
706#endif
707 }
708}

References COL_Path, COL_State, ID_ShowAll, ID_ShowDisabled, ID_ShowEnabled, mEffects, mFilter, mItems, mStates, PluginRegistrationDialog::ItemData::name, PluginRegistrationDialog::ItemData::path, SortCompare(), PluginRegistrationDialog::ItemData::state, STATE_Disabled, and STATE_Enabled.

Referenced by OnChangedVisibility(), OnRescan(), and PopulateOrExchange().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetState()

void PluginRegistrationDialog::SetState ( int  i,
bool  toggle,
bool  state = true 
)
private

Definition at line 710 of file PluginRegistrationDialog.cpp.

711{
712 wxListItem li;
713
714 li.m_mask = wxLIST_MASK_DATA;
715 li.m_itemId = i;
716
717 mEffects->GetItem(li);
718
719 ItemData *item = (ItemData *) li.m_data;
720
721#ifndef DISABLE_STATE_NEW
722 // If changing the state of a "New" (stub) entry, then we mark it as valid
723 // since it will either be registered if "Enabled" or ignored if "Disabled".
724 if (item->state == STATE_New)
725 {
726 item->valid = true;
727 }
728#endif
729
730 if (toggle)
731 {
732 item->state = item->state == STATE_Enabled ? STATE_Disabled : STATE_Enabled;
733 }
734 else
735 {
736 item->state = state;
737 }
738
739#ifndef DISABLE_STATE_NEW
740 if (mFilter == ID_ShowNew && item->state != STATE_New)
741 {
742 mEffects->DeleteItem(i);
743 }
744 else//if
745#endif
746 if (mFilter == ID_ShowDisabled && item->state != STATE_Disabled)
747 {
748 mEffects->DeleteItem(i);
749 }
750 else if (mFilter == ID_ShowEnabled && item->state != STATE_Enabled)
751 {
752 mEffects->DeleteItem(i);
753 }
754 else
755 {
756 mEffects->SetItem(i, COL_State, mStates[item->state]);
757#if wxUSE_ACCESSIBILITY
758 mAx->SetSelected(i);
759#endif
760 }
761}
#define DISABLE_STATE_NEW

References COL_State, DISABLE_STATE_NEW, ID_ShowDisabled, ID_ShowEnabled, mEffects, mFilter, mStates, PluginRegistrationDialog::ItemData::state, STATE_Disabled, STATE_Enabled, and PluginRegistrationDialog::ItemData::valid.

Referenced by OnDisable(), OnEnable(), and OnListChar().

Here is the caller graph for this function:

◆ SortCompare() [1/2]

int PluginRegistrationDialog::SortCompare ( ItemData item1,
ItemData item2 
)
private

Definition at line 772 of file PluginRegistrationDialog.cpp.

773{
774 // This function is a three-valued comparator
775
776 wxString *str1;
777 wxString *str2;
778
779 switch (mSortColumn)
780 {
781 case COL_Name:
782 str1 = &item1->name;
783 str2 = &item2->name;
784 break;
785 case COL_State:
786 str1 = &mStates[item1->state];
787 str2 = &mStates[item2->state];
788 break;
789 case COL_Path:
790 str1 = &item1->path;
791 str2 = &item2->path;
792 break;
793 default:
794 return 0;
795 }
796
797 return str2->CmpNoCase(*str1) * mSortDirection;
798}

References COL_Name, COL_Path, COL_State, mSortColumn, mSortDirection, mStates, PluginRegistrationDialog::ItemData::name, PluginRegistrationDialog::ItemData::path, and PluginRegistrationDialog::ItemData::state.

◆ SortCompare() [2/2]

int wxCALLBACK PluginRegistrationDialog::SortCompare ( wxIntPtr  item1,
wxIntPtr  item2,
wxIntPtr  sortData 
)
staticprivate

Definition at line 763 of file PluginRegistrationDialog.cpp.

764{
766 ItemData *i1 = (ItemData *) item1;
767 ItemData *i2 = (ItemData *) item2;
768
769 return dlg->SortCompare(i1, i2);
770}

References SortCompare().

Referenced by DoSort(), RegenerateEffectsList(), and SortCompare().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ mEffects

wxListCtrl* PluginRegistrationDialog::mEffects
private

◆ mFilter

int PluginRegistrationDialog::mFilter
private

Definition at line 68 of file PluginRegistrationDialog.h.

Referenced by OnRescan(), RegenerateEffectsList(), and SetState().

◆ mItems

ItemDataMap PluginRegistrationDialog::mItems
private

◆ mLongestPath

PluginPath PluginRegistrationDialog::mLongestPath
private

Definition at line 76 of file PluginRegistrationDialog.h.

Referenced by OnOK(), and PopulateOrExchange().

◆ mSortColumn

int PluginRegistrationDialog::mSortColumn
private

Definition at line 73 of file PluginRegistrationDialog.h.

Referenced by DoSort(), and SortCompare().

◆ mSortDirection

int PluginRegistrationDialog::mSortDirection
private

Definition at line 74 of file PluginRegistrationDialog.h.

Referenced by DoSort(), and SortCompare().

◆ mStates

wxArrayString PluginRegistrationDialog::mStates
private

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