EffectsLocationPanel Class Reference

Inheritance diagram for EffectsLocationPanel:

Collaboration diagram for EffectsLocationPanel:

Public Member Functions
template<typename... Args>
	EffectsLocationPanel (Args &&... args)
void	InitUI ()
void	AddLocation (const PluginPath &path, bool setFocus=false)
void	AddLocations (const PluginPaths &paths)
PluginPaths	GetLocations () const
void	OnAddNewLocationClicked (wxCommandEvent &)
void	OnRemoveClicked (wxCommandEvent &evt)
void	OnBrowseClicked (wxCommandEvent &evt)
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Static Private Member Functions
static int	BaseRowIdForIndex (int index)
static int	IndexForId (int id)

Private Attributes
std::vector< wxString >	mPaths
std::vector< wxTextCtrl * >	mPathCtrls
wxSizer *	mRows {}
wxButton *	mAddNewLocation {}

Detailed Description

Definition at line 43 of file EffectsPrefs.cpp.

Constructor & Destructor Documentation

EffectsLocationPanel()

template<typename... Args>

EffectsLocationPanel::EffectsLocationPanel ( Args &&...  args )

inline

Definition at line 74 of file EffectsPrefs.cpp.

      : wxPanelWrapper(std::forward<Args>(args)...)
   {
      InitUI();
   }

References InitUI().

Here is the call graph for this function:

Member Function Documentation

AddLocation()

void EffectsLocationPanel::AddLocation ( const PluginPath &  path, bool  setFocus = false  )

inline

Definition at line 93 of file EffectsPrefs.cpp.

   {
      const auto baseId = BaseRowIdForIndex(mPathCtrls.size());
 
      auto rowSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      wxTextCtrl* text;
      wxButton* remove;
      wxButton* browse;
      rowSizer->Add(
         text = safenew wxTextCtrl(this, baseId, path),
         1, wxEXPAND | wxALL, 3
      );
      rowSizer->Add(
         browse = safenew wxButton(this, baseId + 1, _("Browse...")),
         0, wxALL, 3
      );
      rowSizer->Add(
         remove = safenew wxButton(this, baseId + 2, _("Remove")),
         0, wxALL, 3
      );
      text->Bind(wxEVT_TEXT, [this](wxCommandEvent& evt)
      {
         const auto index = IndexForId(evt.GetId());
         mPaths[index] = evt.GetString();
         evt.Skip();
      });
 
      browse->Bind(wxEVT_BUTTON, &EffectsLocationPanel::OnBrowseClicked, this);
      remove->Bind(wxEVT_BUTTON, &EffectsLocationPanel::OnRemoveClicked, this);
      mPathCtrls.push_back(text);
      mPaths.push_back(path);
 
      mRows->Add(rowSizer.release(), 0, wxEXPAND);
 
      mAddNewLocation->MoveAfterInTabOrder(remove);
 
      if(setFocus)
         text->SetFocus();
 
      wxPostEvent(this, wxCommandEvent(EVT_PLUGIN_LOCATIONS_CHANGED));
   }

References _, BaseRowIdForIndex(), IndexForId(), mAddNewLocation, mPathCtrls, mPaths, mRows, OnBrowseClicked(), OnRemoveClicked(), and safenew.

Referenced by AddLocations(), and OnAddNewLocationClicked().

Here is the call graph for this function:

Here is the caller graph for this function:

AddLocations()

void EffectsLocationPanel::AddLocations ( const PluginPaths &  paths )

inline

Definition at line 135 of file EffectsPrefs.cpp.

   {
      for(const auto& location : paths)
         AddLocation(location);
   }

References AddLocation().

Here is the call graph for this function:

BaseRowIdForIndex()

static int EffectsLocationPanel::BaseRowIdForIndex ( int  index )

inlinestaticprivate

Definition at line 61 of file EffectsPrefs.cpp.

   {
      return wxID_HIGHEST + index * 3;
   }

Referenced by AddLocation(), and OnRemoveClicked().

Here is the caller graph for this function:

GetLocations()

PluginPaths EffectsLocationPanel::GetLocations ( ) const

inline

Definition at line 141 of file EffectsPrefs.cpp.

   {
      PluginPaths paths;
      for(const auto& text : mPaths)
      {
         if(!text.IsEmpty())
            paths.push_back(text);
      }
      return paths;
   }

References mPaths.

IndexForId()

static int EffectsLocationPanel::IndexForId ( int  id )

inlinestaticprivate

Definition at line 66 of file EffectsPrefs.cpp.

   {
      return (id - wxID_HIGHEST) / 3;
   }

Referenced by AddLocation(), OnBrowseClicked(), and OnRemoveClicked().

Here is the caller graph for this function:

InitUI()

void EffectsLocationPanel::InitUI ( )

inline

Definition at line 80 of file EffectsPrefs.cpp.

   {
      auto mainSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
      mainSizer->Add(mRows = safenew wxBoxSizer(wxVERTICAL), 0, wxEXPAND);
      mainSizer->Add(
         mAddNewLocation = safenew wxButton(this, wxID_ANY, _("Add new location")),
         0, wxALL, 3
      );
      SetSizer(mainSizer.release());
 
      mAddNewLocation->Bind(wxEVT_BUTTON, &EffectsLocationPanel::OnAddNewLocationClicked, this);
   }

References _, mAddNewLocation, mRows, OnAddNewLocationClicked(), and safenew.

Referenced by EffectsLocationPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

OnAddNewLocationClicked()

void EffectsLocationPanel::OnAddNewLocationClicked ( wxCommandEvent &  )

inline

Definition at line 152 of file EffectsPrefs.cpp.

   {
      AddLocation("", true);
   }

References AddLocation().

Referenced by InitUI().

Here is the call graph for this function:

Here is the caller graph for this function:

OnBrowseClicked()

void EffectsLocationPanel::OnBrowseClicked ( wxCommandEvent &  evt )

inline

Definition at line 181 of file EffectsPrefs.cpp.

   {
      const auto index =  IndexForId(evt.GetId());
 
      wxDirDialogWrapper dirDialog(
         wxGetTopLevelParent(this),
         wxDirDialogWrapper::DefaultDialogPrompt,
         mPathCtrls[index]->GetValue()
      );
      if(dirDialog.ShowModal() == wxID_OK)
         mPathCtrls[index]->SetValue(dirDialog.GetPath());//also invoke wxEVT_TEXT
   }

References wxDirDialogWrapper::DefaultDialogPrompt, IndexForId(), and mPathCtrls.

Referenced by AddLocation().

Here is the call graph for this function:

Here is the caller graph for this function:

OnRemoveClicked()

void EffectsLocationPanel::OnRemoveClicked ( wxCommandEvent &  evt )

inline

Definition at line 157 of file EffectsPrefs.cpp.

   {
      const auto index = IndexForId(evt.GetId());
      const auto baseId = BaseRowIdForIndex(index);
      //When item is removed from the sizer the tail gets shifted,
      //but items in mPathCtrls are not. We need to map index from
      //mPathCtrls to index in mRows
      mRows->Remove(
         std::count_if(
            mPathCtrls.begin(),
            mPathCtrls.begin() + index,
            [](const auto ptr) { return ptr != nullptr; }
         )
      );
 
      FindWindowById(baseId, this)->Destroy();
      FindWindowById(baseId + 1, this)->Destroy();
      FindWindowById(baseId + 2, this)->Destroy();
      mPathCtrls[index] = nullptr;
      mPaths[index] = wxString{};//Don't save path on commit
 
      wxPostEvent(this, wxCommandEvent(EVT_PLUGIN_LOCATIONS_CHANGED));
   }

References BaseRowIdForIndex(), IndexForId(), mPathCtrls, mPaths, and mRows.

Referenced by AddLocation().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mAddNewLocation

wxButton* EffectsLocationPanel::mAddNewLocation {}

private

Definition at line 57 of file EffectsPrefs.cpp.

Referenced by AddLocation(), and InitUI().

mPathCtrls

std::vector<wxTextCtrl*> EffectsLocationPanel::mPathCtrls

private

Definition at line 51 of file EffectsPrefs.cpp.

Referenced by AddLocation(), OnBrowseClicked(), and OnRemoveClicked().

mPaths

std::vector<wxString> EffectsLocationPanel::mPaths

private

Definition at line 48 of file EffectsPrefs.cpp.

Referenced by AddLocation(), GetLocations(), and OnRemoveClicked().

mRows

wxSizer* EffectsLocationPanel::mRows {}

private

Definition at line 56 of file EffectsPrefs.cpp.

Referenced by AddLocation(), InitUI(), and OnRemoveClicked().

---

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

• EffectsPrefs.cpp