#include <PluginRegistrationDialog.h>

Inheritance diagram for PluginRegistrationDialog:

Collaboration diagram for PluginRegistrationDialog:

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

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (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.

:  wxDialogWrapper(parent,
            wxID_ANY,
            XO("Manage Plugins"),
            wxDefaultPosition, wxDefaultSize,
            wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
{
   mEffects = NULL;
   SetName();
 
   mStates.resize(STATE_COUNT);
   mStates[STATE_Enabled] = _("Enabled");
   mStates[STATE_Disabled] = _("Disabled");
#ifndef DISABLE_STATE_NEW
   mStates[STATE_New] = _("New");
#endif
 
   mSortColumn = COL_Name;
   mSortDirection = 1;
 
   Populate();
 
   DoSort( mSortColumn );
}

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.

{
   if (col != mSortColumn)
   {
      mSortDirection = 1;
   }
   else
   {
      mSortDirection *= -1;
   }
 
   mSortColumn = col;
   mEffects->SortItems(SortCompare, (wxUIntPtr) this);
 
   // Without a refresh, wxMac doesn't redisplay the list properly after a sort
   mEffects->Refresh();
}

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 1068 of file PluginRegistrationDialog.cpp.

{
   EndModal(wxID_CANCEL);
}

◆ OnChangedVisibility()

void PluginRegistrationDialog::OnChangedVisibility ( wxCommandEvent & evt )

private

Definition at line 800 of file PluginRegistrationDialog.cpp.

{
   // Go and show the relevant items.
   RegenerateEffectsList(evt.GetId());
}

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.

{
   for (int i = 0, cnt = mEffects->GetItemCount(); i < cnt; i++)
   {
      mEffects->SetItemState(i, 0, wxLIST_STATE_SELECTED);
   }
}

References mEffects.

◆ OnDisable()

void PluginRegistrationDialog::OnDisable ( wxCommandEvent & evt )

private

Definition at line 951 of file PluginRegistrationDialog.cpp.

{
   std::vector<long> items;
 
   {
      long i = mEffects->GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
      while (i != wxNOT_FOUND)
      {
         items.insert(items.begin(), i);
         i = mEffects->GetNextItem(i, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
      }
   }
 
   for (size_t i = 0, cnt = items.size(); i < cnt; i++)
   {
      SetState(items[i], false, STATE_Disabled);
   }
}

References mEffects, SetState(), and STATE_Disabled.

Here is the call graph for this function:

◆ OnEnable()

void PluginRegistrationDialog::OnEnable ( wxCommandEvent & evt )

private

Definition at line 932 of file PluginRegistrationDialog.cpp.

{
   std::vector<long> items;
 
   {
      long i = mEffects->GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
      while (i != wxNOT_FOUND)
      {
         items.insert(items.begin(), i);
         i = mEffects->GetNextItem(i, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
      }
   }
 
   for (size_t i = 0, cnt = items.size(); i < cnt; i++)
   {
      SetState(items[i], false, STATE_Enabled);
   }
}

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.

{
   switch (evt.GetKeyCode())
   {
      case WXK_SPACE:
      {
         int item = mEffects->GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
         if (item != wxNOT_FOUND)
         {
            SetState(item, true);
         }
      }
      break;
 
      case WXK_RETURN:
         // Don't know why wxListCtrls prevent default dialog action,
         // but they do, so handle it.
         EmulateButtonClickIfPresent(GetAffirmativeId());
      break;
 
      default:
         evt.Skip();
      break;
   }
}

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 970 of file PluginRegistrationDialog.cpp.

{
   PluginManager & pm = PluginManager::Get();
   ModuleManager & mm = ModuleManager::Get();
 
   int enableCount = 0;
   for (ItemDataMap::iterator iter = mItems.begin(); iter != mItems.end(); ++iter)
   {
      ItemData & item = iter->second;
      wxString path = item.path;
 
      if (item.state == STATE_Enabled && item.plugs[0]->GetPluginType() == PluginTypeStub)
      {
         enableCount++;
      }
   }
 
   wxString last3 = mLongestPath + wxT("\n") +
                    mLongestPath + wxT("\n") +
                    mLongestPath + wxT("\n");
 
   auto msg = XO("Enabling effects or commands:\n\n%s").Format( last3 );
 
   // Make sure the progress dialog is deleted before we call EndModal() or
   // we will leave the project window in an unusable state on OSX.
   // See bug #1192.
   {
      ProgressDialog progress{
         Verbatim( GetTitle() ), msg, pdlgHideStopButton };
      progress.CenterOnParent();
 
      int i = 0;
      for (ItemDataMap::iterator iter = mItems.begin(); iter != mItems.end(); ++iter)
      {
         ItemData & item = iter->second;
         wxString path = item.path;
 
         if (item.state == STATE_Enabled && item.plugs[0]->GetPluginType() == PluginTypeStub)
         {
            last3 = last3.AfterFirst(wxT('\n')) + item.path + wxT("\n");
            auto status = progress.Update(++i, enableCount,
               XO("Enabling effect or command:\n\n%s").Format( last3 ));
            if (status == ProgressResult::Cancelled)
            {
               break;
            }
 
            TranslatableString errMsgs;
 
            // Try to register the plugin via each provider until one succeeds
            for (size_t j = 0, cntj = item.plugs.size(); j < cntj; j++)
            {
               TranslatableString errMsg;
               if (mm.RegisterEffectPlugin(item.plugs[j]->GetProviderID(), path,
                                     errMsg))
               {
                  for (auto plug : item.plugs)
                     pm.UnregisterPlugin(
                        plug->GetProviderID() + wxT("_") + path);
                  // Bug 1893.  We've found a provider that works.
                  // Error messages from any that failed are no longer useful.
                  errMsgs = {};
                  break;
               }
               else
               {
                  if (!errMsgs.empty())
                     errMsgs.Join( errMsg, '\n' );
                  else
                     errMsgs = errMsg;
               }
            }
            if (!errMsgs.empty())
               AudacityMessageBox(
                  XO("Effect or Command at %s failed to register:\n%s")
                     .Format( path, errMsgs ) );
         }
#ifndef DISABLE_STATE_NEW
         else if (item.state == STATE_New) {
            for (auto plug : item.plugs)
               plug->SetValid(false);
         }
#endif
         else {
            for (auto plug : item.plugs) {
               plug->SetEnabled(item.state == STATE_Enabled);
               plug->SetValid(item.valid);
            }
         }
      }
 
      pm.Save();
      pm.NotifyPluginsChanged();
   }
 
   EndModal(wxID_OK);
}

References AudacityMessageBox(), RefreshCode::Cancelled, TranslatableString::empty(), ModuleManager::Get(), PluginManager::Get(), TranslatableString::Join(), mItems, mLongestPath, PluginManager::NotifyPluginsChanged(), 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.

{
   mItems.clear();
   mEffects->DeleteAllItems();
   mEffects->Update();
 
   wxTheApp->CallAfter([this] {
      std::set<PluginPath> disabledPlugins;
      std::vector<wxString> failedPlugins;
 
      auto& pm = PluginManager::Get();
 
      // Record list of plugins that are currently disabled
      for (auto& plug : pm.AllPlugins())
      {
         PluginType plugType = plug.GetPluginType();
         if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
            continue;
 
         if (!plug.IsEnabled())
            disabledPlugins.insert(plug.GetPath());
      }
 
      pm.ClearEffectPlugins();
 
      auto newPlugins = PluginManager::Get().CheckPluginUpdates();
      if (!newPlugins.empty())
      {
         PluginStartupRegistration reg(newPlugins);
         reg.Run();
 
         failedPlugins = reg.GetFailedPluginsPaths();
      }
 
      // Disable all plugins which were previously disabled
      for (auto& plug : pm.AllPlugins())
      {
         PluginType plugType = plug.GetPluginType();
         if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
            continue;
 
         const auto& path = plug.GetPath();
         if (disabledPlugins.find(path) != disabledPlugins.end())
            plug.SetEnabled(false);
      }
 
      pm.Save();
      pm.NotifyPluginsChanged();
 
      if (!failedPlugins.empty())
      {
         auto dialog = safenew IncompatiblePluginsDialog(this, wxID_ANY, ScanType::Manual, failedPlugins);
         dialog->ShowModal();
      }
 
      PopulateItemsList(pm);
      RegenerateEffectsList(mFilter);
   });
}

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.

{
   for (int i = 0, cnt = mEffects->GetItemCount(); i < cnt; i++)
   {
      mEffects->SetItemState(i, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
   }
}

References mEffects.

◆ OnSort()

void PluginRegistrationDialog::OnSort ( wxListEvent & evt )

private

Definition at line 806 of file PluginRegistrationDialog.cpp.

{
   int col = evt.GetColumn();
   DoSort( col );
}

References DoSort().

Here is the call graph for this function:

◆ Populate()

void PluginRegistrationDialog::Populate ( )

private

Definition at line 422 of file PluginRegistrationDialog.cpp.

{
   //------------------------- Main section --------------------
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

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.

{
   for (auto& plug : pm.AllPlugins())
   {
      PluginType plugType = plug.GetPluginType();
      if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
         continue;
 
      const auto& path = plug.GetPath();
      ItemData& item = mItems[path];  // will create NEW entry
      item.plugs.push_back(&plug);
      item.path = path;
      item.state = plug.IsEnabled() ? STATE_Enabled : STATE_Disabled;
      item.valid = plug.IsValid();
 
      if (plugType == PluginTypeEffect)
      {
         item.name = plug.GetSymbol().Translation();
      }
      // This is not right and will not work when other plugin types are added.
      // But it's presumed that the plugin manager dialog will be fully developed
      // by then.
      else if (plugType == PluginTypeStub)
      {
         wxFileName fname{ path };
         item.name = fname.GetName().Trim(false).Trim(true);
#ifndef DISABLE_STATE_NEW
         if (!item.valid)
         {
            item.state = STATE_New;
         }
#endif
      }
   }
}

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.

{
   S.StartVerticalLay(true);
   {
      /*i18n-hint: The dialog shows a list of plugins with check-boxes
       beside each one.*/
//      S.StartStatic(XO("Effects"), true);
      S.StartVerticalLay();
      {
         S.StartHorizontalLay(wxEXPAND, 0);
         {
            S.StartHorizontalLay(wxALIGN_LEFT, 0);
            {
               S.AddPrompt(XXO("Select effects, click the Enable or Disable button, then click OK."));
            }
            S.EndHorizontalLay();
 
            S.StartHorizontalLay(wxCENTER, 1);
            {
               S.AddSpace(1);
            }
            S.EndHorizontalLay();
 
            S.StartHorizontalLay(wxALIGN_NOT | wxALIGN_LEFT, 0);
            {
               wxRadioButton *rb;
 
               /* i18n-hint: This is before radio buttons selecting which effects to show */
               S.AddPrompt(XXO("Show:"));
               rb = S.Id(ID_ShowAll)
                  /* i18n-hint: Radio button to show all effects */
                  .Name(XO("Show all"))
                  /* i18n-hint: Radio button to show all effects */
                  .AddRadioButton(XXO("&All"));
#if wxUSE_ACCESSIBILITY
               // so that name can be set on a standard control
               rb->SetAccessible(safenew WindowAccessible(rb));
#endif
 
               rb = S.Id(ID_ShowDisabled)
                  /* i18n-hint: Radio button to show just the currently disabled effects */
                  .Name(XO("Show disabled"))
                  /* i18n-hint: Radio button to show just the currently disabled effects */
                  .AddRadioButtonToGroup(XXO("D&isabled"));
#if wxUSE_ACCESSIBILITY
               // so that name can be set on a standard control
               rb->SetAccessible(safenew WindowAccessible(rb));
#endif
 
               rb = S.Id(ID_ShowEnabled)
                  /* i18n-hint: Radio button to show just the currently enabled effects */
                  .Name(XO("Show enabled"))
                  /* i18n-hint: Radio button to show just the currently enabled effects */
                  .AddRadioButtonToGroup(XXO("E&nabled"));
#if wxUSE_ACCESSIBILITY
               // so that name can be set on a standard control
               rb->SetAccessible(safenew WindowAccessible(rb));
#endif
 
#ifndef DISABLE_STATE_NEW
               rb = S.Id(ID_ShowNew)
                  /* i18n-hint: Radio button to show just the newly discovered effects */
                  .Name(XO("Show new"))
                  /* i18n-hint: Radio button to show just the newly discovered effects */
                  .AddRadioButtonToGroup(XXO("Ne&w"));
#if wxUSE_ACCESSIBILITY
               // so that name can be set on a standard control
               rb->SetAccessible(safenew WindowAccessible(rb));
#endif
#endif
            }
            S.EndHorizontalLay();
         }
         S.EndHorizontalLay();
 
         mEffects = S.Id(ID_List)
            .Style(wxSUNKEN_BORDER | wxLC_REPORT | wxLC_HRULES | wxLC_VRULES )
            .ConnectRoot(wxEVT_KEY_DOWN,
                      &PluginRegistrationDialog::OnListChar)
            .AddListControlReportMode({ XO("Name"), XO("State"), XO("Path") });
#if wxUSE_ACCESSIBILITY
         mEffects->SetAccessible(mAx = safenew CheckListAx(mEffects));
#endif
 
         S.StartHorizontalLay(wxALIGN_LEFT | wxEXPAND, 0);
         {
            S.Id(ID_SelectAll).AddButton(XXO("&Select All"));
            S.Id(ID_ClearAll).AddButton(XXO("C&lear All"));
            S.Id(ID_Rescan).AddButton(XXO("Rescan"));
 
            S.StartHorizontalLay(wxALIGN_CENTER);
            {
               S.AddSpace(1);
            }
            S.EndHorizontalLay();
 
            S.Id(ID_Enable).AddButton(XXO("&Enable"));
            S.Id(ID_Disable).AddButton(XXO("&Disable"));
         }
         S.EndHorizontalLay();
      }
//      S.EndStatic();
      S.EndVerticalLay();
 
      S.AddStandardButtons(eOkButton | eCancelButton);
   }
   S.EndVerticalLay();
 
   std::vector<int> colWidths;
   for (int i = 0, cnt = mEffects->GetColumnCount(); i < cnt; i++)
   {
      colWidths.push_back(0);
   }
 
   for (int i = 0, cnt = mStates.size(); i < cnt; i++)
   {
      int x;
      mEffects->GetTextExtent(mStates[i], &x, NULL);
      colWidths[COL_State] = wxMax(colWidths[COL_State], x + 4);  // 2 pixel margin on each side
   }
 
   PluginManager & pm = PluginManager::Get();
   PopulateItemsList(pm);
 
   for (const auto& item : mItems)
   {
      const auto& itemData = item.second;
 
      int x;
      mEffects->GetTextExtent(itemData.name, &x, NULL);
      colWidths[COL_Name] = wxMax(colWidths[COL_Name], x);
 
      mEffects->GetTextExtent(itemData.path, &x, NULL);
      if (x > colWidths[COL_Path])
      {
         mLongestPath = itemData.path;
      }
      colWidths[COL_Path] = wxMax(colWidths[COL_Path], x);
   }
 
   wxRect r = wxGetClientDisplayRect();
 
   int maxW = 0;
   for (int i = 0, cnt = mEffects->GetColumnCount(); i < cnt; i++)
   {
      int w = colWidths[i] + /* fudge */ 10;
      mEffects->SetColumnWidth(i, w);
      maxW += w;
   }
 
   // Keep dialog from getting too wide
   int w = r.GetWidth() - (GetClientSize().GetWidth() - mEffects->GetSize().GetWidth());
   mEffects->SetMinSize({ std::min(maxW, w), 200 });
   mEffects->SetMaxSize({ w, -1 });
 
   RegenerateEffectsList(ID_ShowAll);
 
   Layout();
   Fit();
 
   wxSize sz = GetSize();
   sz.SetWidth(wxMin(sz.GetWidth(), r.GetWidth()));
   sz.SetHeight(wxMin(sz.GetHeight(), r.GetHeight()));
   SetMinSize(sz);
 
   // Parent window is usually not there yet, so centre on screen rather than on parent.
   CenterOnScreen();
 
   if (mEffects->GetItemCount() > 0)
   {
      // Make sure first item is selected/focused.
      mEffects->SetFocus();
      mEffects->SetItemState(0, wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED, wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED);
#if wxUSE_ACCESSIBILITY
      mAx->SetSelected(0);
#endif
   }
 
}

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.

{
   mFilter = filter;
 
   mEffects->DeleteAllItems();
 
   int i = 0;
   for (ItemDataMap::iterator iter = mItems.begin(); iter != mItems.end(); ++iter)
   {
      ItemData & item = iter->second;
      bool add = false;
 
      switch (mFilter)
      {
      case ID_ShowAll:
         add = true;
         break;
#ifndef DISABLE_STATE_NEW
      case ID_ShowNew:
         if (item.state == STATE_New)
         {
            add = true;
         }
         break;
#endif
      case ID_ShowEnabled:
         if (item.state == STATE_Enabled)
         {
            add = true;
         }
         break;
      case ID_ShowDisabled:
         if (item.state == STATE_Disabled)
         {
            add = true;
         }
         break;
      }
 
      if (add)
      {
         mEffects->InsertItem(i, item.name);
         mEffects->SetItem(i, COL_State, mStates[item.state]);
         mEffects->SetItem(i, COL_Path, item.path);
         mEffects->SetItemPtrData(i, (wxUIntPtr) &item);
 
         ++i;
      }
   }
 
   mEffects->SortItems(SortCompare, (wxUIntPtr) this);
 
   if (mEffects->GetItemCount() > 0)
   {
      // Make sure first item is selected/focused.
//      mEffects->SetFocus();
      mEffects->SetItemState(0, wxLIST_STATE_FOCUSED|wxLIST_STATE_SELECTED, wxLIST_STATE_FOCUSED|wxLIST_STATE_SELECTED);
#if wxUSE_ACCESSIBILITY
      mAx->SetSelected(0, false);
#endif
   }
}

References staffpad::vo::add(), 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.

{
    wxListItem li;
 
   li.m_mask = wxLIST_MASK_DATA;
   li.m_itemId = i;
 
   mEffects->GetItem(li);
 
   ItemData *item = (ItemData *) li.m_data;
 
#ifndef DISABLE_STATE_NEW
   // If changing the state of a "New" (stub) entry, then we mark it as valid
   // since it will either be registered if "Enabled" or ignored if "Disabled".
   if (item->state == STATE_New)
   {
      item->valid = true;
   }
#endif
 
   if (toggle)
   {
      item->state = item->state == STATE_Enabled ? STATE_Disabled : STATE_Enabled;
   }
   else
   {
      item->state = state;
   }
   
#ifndef DISABLE_STATE_NEW
   if (mFilter == ID_ShowNew && item->state != STATE_New)
   {
      mEffects->DeleteItem(i);
   }
   else//if
#endif
   if (mFilter == ID_ShowDisabled && item->state != STATE_Disabled)
   {
      mEffects->DeleteItem(i);
   }
   else if (mFilter == ID_ShowEnabled && item->state != STATE_Enabled)
   {
      mEffects->DeleteItem(i);
   }
   else
   {
      mEffects->SetItem(i, COL_State, mStates[item->state]);
#if wxUSE_ACCESSIBILITY
      mAx->SetSelected(i);
#endif
   }
}

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.

{
   // This function is a three-valued comparator
 
   wxString *str1;
   wxString *str2;
 
   switch (mSortColumn)
   {
   case COL_Name:
      str1 = &item1->name;
      str2 = &item2->name;
      break;
   case COL_State:
      str1 = &mStates[item1->state];
      str2 = &mStates[item2->state];
      break;
   case COL_Path:
      str1 = &item1->path;
      str2 = &item2->path;
      break;
   default:
      return 0;
   }
 
   return str2->CmpNoCase(*str1) * mSortDirection;
}

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.

{
   PluginRegistrationDialog *dlg = (PluginRegistrationDialog *) sortData;
   ItemData *i1 = (ItemData *) item1;
   ItemData *i2 = (ItemData *) item2;
 
   return dlg->SortCompare(i1, i2);
}

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

Definition at line 78 of file PluginRegistrationDialog.h.

Referenced by DoSort(), OnClearAll(), OnDisable(), OnEnable(), OnListChar(), OnRescan(), OnSelectAll(), PopulateOrExchange(), RegenerateEffectsList(), and SetState().

◆ mFilter

int PluginRegistrationDialog::mFilter

private

Definition at line 68 of file PluginRegistrationDialog.h.

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

◆ mItems

ItemDataMap PluginRegistrationDialog::mItems

private

Definition at line 71 of file PluginRegistrationDialog.h.

Referenced by OnOK(), OnRescan(), PopulateItemsList(), PopulateOrExchange(), and RegenerateEffectsList().

◆ 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

Definition at line 70 of file PluginRegistrationDialog.h.

Referenced by PopulateOrExchange(), RegenerateEffectsList(), SetState(), and SortCompare().

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

Classes

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ItemDataMap

Constructor & Destructor Documentation

◆ PluginRegistrationDialog()

Member Function Documentation

◆ DoSort()

◆ OnCancel()

◆ OnChangedVisibility()

◆ OnClearAll()

◆ OnDisable()

◆ OnEnable()

◆ OnListChar()

◆ OnOK()

◆ OnRescan()

◆ OnSelectAll()

◆ OnSort()

◆ Populate()

◆ PopulateItemsList()

◆ PopulateOrExchange()

◆ RegenerateEffectsList()

◆ SetState()

◆ SortCompare() [1/2]

◆ SortCompare() [2/2]

Member Data Documentation

◆ mEffects

◆ mFilter

◆ mItems

◆ mLongestPath

◆ mSortColumn

◆ mSortDirection

◆ mStates