audacity::cloud::audiocom::sync::ProjectsListDialog Class Reference

#include <ProjectsListDialog.h>

Inheritance diagram for audacity::cloud::audiocom::sync::ProjectsListDialog:

Collaboration diagram for audacity::cloud::audiocom::sync::ProjectsListDialog:

Classes
class	ProjectsTableData

Public Member Functions
	ProjectsListDialog (wxWindow *parent, AudacityProject *project)
	~ProjectsListDialog () override
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 Member Functions
void	SetupHandlers ()
void	OnBeforeRefresh ()
void	OnRefreshCompleted (bool success)
void	FormatPageLabel ()
void	OnOpen ()
void	OnOpenAudioCom ()
void	OnGridSelect (wxGridRangeSelectEvent &event)
void	OnSelectCell (wxGridEvent &event)
void	OnSearchTextChanged ()
void	OnSearchTextSubmitted ()

Private Attributes
AudacityProject *	mProject { nullptr }
wxTextCtrl *	mSearchCtrl { nullptr }
wxGrid *	mProjectsTable { nullptr }
ProjectsTableData *	mProjectsTableData { nullptr }
wxStaticText *	mPageLabel { nullptr }
wxButton *	mPrevPageButton { nullptr }
wxButton *	mNextPageButton { nullptr }
wxButton *	mOpenButton { nullptr }
wxButton *	mOpenAudioCom { nullptr }
wxString	mLastSearchValue
std::unique_ptr< wxTimer >	mSearchTimer
bool	mInRangeSelection { false }

Detailed Description

Definition at line 33 of file ProjectsListDialog.h.

Constructor & Destructor Documentation

ProjectsListDialog()

audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsListDialog	(	wxWindow *	parent,
		AudacityProject *	project
	)

Definition at line 540 of file ProjectsListDialog.cpp.

    : wxDialogWrapper { parent, wxID_ANY, OpenFromCloudTitle }
    , mProject { project }
{
   auto header =
      safenew wxStaticText { this, wxID_ANY,
                             XO("Cloud saved projects").Translation() };
   auto searchHeader =
      safenew wxStaticText { this, wxID_ANY, XO("Search:").Translation() };
 
   mSearchCtrl = safenew wxTextCtrl { this,          wxID_ANY,
                                      wxEmptyString, wxDefaultPosition,
                                      wxDefaultSize, wxTE_PROCESS_ENTER };
 
   mProjectsTable = safenew wxGrid { this, wxID_ANY };
 
   mProjectsTableData = safenew ProjectsTableData { *this, 7 };
 
   mProjectsTable->SetDefaultRowSize(32);
 
   mProjectsTable->SetGridLineColour(
      mProjectsTable->GetDefaultCellBackgroundColour());
   mProjectsTable->SetCellHighlightPenWidth(0);
 
   mProjectsTable->SetDefaultCellAlignment(wxALIGN_LEFT, wxALIGN_CENTER);
   mProjectsTable->SetTable(mProjectsTableData, true);
   mProjectsTable->SetRowLabelSize(0);
 
   mProjectsTable->EnableEditing(false);
   mProjectsTable->SetSelectionMode(wxGrid::wxGridSelectRows);
   mProjectsTable->SetTabBehaviour(wxGrid::Tab_Leave);
 
   mProjectsTable->SetMinSize({ -1, 32 * 8 + 9 });
 
   for (auto i = 0; i < mProjectsTableData->GetNumberCols(); ++i)
      mProjectsTable->SetColSize(i, mProjectsTableData->GetColWidth(i));
 
#if wxUSE_ACCESSIBILITY
   mAccessible =
      safenew ProjectListAccessible { *mProjectsTable, *mProjectsTableData };
   mProjectsTable->GetGridWindow()->SetAccessible(mAccessible);
#endif
 
   mPageLabel = safenew wxStaticText { this, wxID_ANY, {} };
   mPrevPageButton =
      safenew wxButton { this, wxID_ANY, XO("Prev").Translation() };
   mNextPageButton =
      safenew wxButton { this, wxID_ANY, XO("Next").Translation() };
   mOpenButton = safenew wxButton { this, wxID_ANY, XO("Open").Translation() };
   mOpenAudioCom = safenew wxButton { this, wxID_ANY,
                                      XO("View in audio.com").Translation() };
 
   auto topSizer = safenew wxBoxSizer { wxVERTICAL };
 
   auto headerSizer = safenew wxBoxSizer { wxHORIZONTAL };
   headerSizer->Add(header, wxSizerFlags().CenterVertical().Left());
   headerSizer->AddStretchSpacer();
   headerSizer->Add(
      searchHeader, wxSizerFlags().CenterVertical().Border(wxRIGHT, 4));
   headerSizer->Add(mSearchCtrl, wxSizerFlags().CenterVertical());
 
   topSizer->Add(headerSizer, wxSizerFlags().Expand().Border(wxALL, 16));
   topSizer->Add(
      mProjectsTable, wxSizerFlags().Expand().Border(wxLEFT | wxRIGHT, 16));
 
   auto pageSizer = safenew wxBoxSizer { wxHORIZONTAL };
   pageSizer->Add(mPageLabel, wxSizerFlags().CenterVertical());
   pageSizer->AddStretchSpacer();
   pageSizer->Add(mPrevPageButton, wxSizerFlags().CenterVertical());
   pageSizer->Add(mNextPageButton, wxSizerFlags().CenterVertical());
   topSizer->AddSpacer(8);
   topSizer->Add(
      pageSizer, wxSizerFlags().Expand().Border(wxLEFT | wxRIGHT, 16));
 
   auto buttonsSizer = safenew wxBoxSizer { wxHORIZONTAL };
   buttonsSizer->Add(mOpenAudioCom, wxSizerFlags().CenterVertical());
   buttonsSizer->AddStretchSpacer();
   buttonsSizer->Add(mOpenButton, wxSizerFlags().CenterVertical());
 
   topSizer->Add(buttonsSizer, wxSizerFlags().Expand().Border(wxALL, 16));
 
   mOpenButton->Disable();
   mOpenAudioCom->Disable();
 
   mSearchTimer = std::make_unique<wxTimer>(this);
 
   SetSizer(topSizer);
   Fit();
   Center();
 
   SetupHandlers();
   BasicUI::CallAfter([this]
                      { mProjectsTableData->Refresh(1, mLastSearchValue); });
}

References BasicUI::CallAfter(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetColWidth(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetNumberCols(), mLastSearchValue, mNextPageButton, mOpenAudioCom, mOpenButton, mPageLabel, mPrevPageButton, mProjectsTable, mProjectsTableData, mSearchCtrl, mSearchTimer, audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::Refresh(), safenew, SetupHandlers(), and XO().

Here is the call graph for this function:

~ProjectsListDialog()

audacity::cloud::audiocom::sync::ProjectsListDialog::~ProjectsListDialog ( )

overridedefault

Member Function Documentation

FormatPageLabel()

void audacity::cloud::audiocom::sync::ProjectsListDialog::FormatPageLabel ( )

private

Definition at line 762 of file ProjectsListDialog.cpp.

{
   if (mProjectsTableData->GetPagesCount() == 0)
   {
      mPageLabel->SetLabel({});
      return;
   }
 
   mPageLabel->SetLabel(XO("Page %d of %d")
                           .Format(
                              mProjectsTableData->GetCurrentPage(),
                              mProjectsTableData->GetPagesCount())
                           .Translation());
}

References audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetCurrentPage(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetPagesCount(), mPageLabel, mProjectsTableData, and XO().

Referenced by OnRefreshCompleted().

Here is the call graph for this function:

Here is the caller graph for this function:

OnBeforeRefresh()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnBeforeRefresh ( )

private

Definition at line 739 of file ProjectsListDialog.cpp.

{
   mProjectsTable->Enable(false);
   mPrevPageButton->Enable(false);
   mNextPageButton->Enable(false);
}

References mNextPageButton, mPrevPageButton, and mProjectsTable.

Referenced by audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::Refresh().

Here is the caller graph for this function:

OnGridSelect()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnGridSelect ( wxGridRangeSelectEvent &  event )

private

Definition at line 832 of file ProjectsListDialog.cpp.

{
   event.Skip();
 
   if (!event.Selecting())
   {
      mOpenButton->Disable();
      mOpenAudioCom->Disable();
      return;
   }
 
   mOpenButton->Enable();
   mOpenAudioCom->Enable();
 
   const auto topRow     = event.GetTopRow();
   const auto bottomRow  = event.GetBottomRow();
   const auto currentRow = mProjectsTable->GetGridCursorRow();
 
   if (topRow != bottomRow)
   {
      if (mInRangeSelection)
         return;
 
      mInRangeSelection = true;
      auto switcher     = finally([this] { mInRangeSelection = false; });
 
      mProjectsTable->SelectRow(currentRow == topRow ? bottomRow : topRow);
   }
}

Referenced by SetupHandlers().

Here is the caller graph for this function:

OnOpen()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnOpen ( )

private

Definition at line 777 of file ProjectsListDialog.cpp.

{
   if (mProjectsTable->GetSelectedRows().empty())
      return;
 
   const auto projectInfo = mProjectsTableData->GetSelectedProjectInfo();
 
   if (projectInfo == nullptr)
      return;
 
   if (projectInfo->HeadSnapshot.Synced == 0)
   {
      const auto state = CloudSyncService::GetProjectState(projectInfo->Id);
 
      if (state != CloudSyncService::ProjectState::PendingSync)
      {
         const bool hasValidSnapshot =
            !projectInfo->LastSyncedSnapshotId.empty();
 
         const auto result =
            UnsyncedProjectDialog { mProject, hasValidSnapshot }.ShowDialog();
 
         if (result == UnsyncedProjectDialog::VisitAudioComButtonIdentifier())
         {
            BasicUI::OpenInDefaultBrowser(
               ToWXString(mProjectsTableData->GetSelectedProjectUrl()));
 
            return;
         }
 
         if (result == UnsyncedProjectDialog::CancelButtonIdentifier())
            return;
      }
   }
 
   EndModal(wxID_OK);
 
   BasicUI::CallAfter(
      [project = mProject, selectedProjectId = projectInfo->Id]
      { OpenProjectFromCloud(project, selectedProjectId, {}, false); });
}

References BasicUI::CallAfter(), audacity::cloud::audiocom::sync::AudioComDialogBase::CancelButtonIdentifier(), audacity::cloud::audiocom::CloudSyncService::GetProjectState(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetSelectedProjectInfo(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetSelectedProjectUrl(), mProject, mProjectsTable, mProjectsTableData, BasicUI::OpenInDefaultBrowser(), audacity::cloud::audiocom::CloudSyncService::PendingSync, project, audacity::ToWXString(), and audacity::cloud::audiocom::sync::UnsyncedProjectDialog::VisitAudioComButtonIdentifier().

Referenced by SetupHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

OnOpenAudioCom()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnOpenAudioCom ( )

private

Definition at line 819 of file ProjectsListDialog.cpp.

{
   if (mProjectsTable->GetSelectedRows().empty())
      return;
 
   const auto selectedProjectUrl = mProjectsTableData->GetSelectedProjectUrl();
 
   if (selectedProjectUrl.empty())
      return;
 
   BasicUI::OpenInDefaultBrowser(ToWXString(selectedProjectUrl));
}

References BasicUI::OpenInDefaultBrowser(), and audacity::ToWXString().

Referenced by SetupHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

OnRefreshCompleted()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnRefreshCompleted ( bool  success )

private

Definition at line 746 of file ProjectsListDialog.cpp.

{
   mProjectsTable->Enable(success);
 
   mPrevPageButton->Enable(success && mProjectsTableData->HasPrevPage());
   mNextPageButton->Enable(success && mProjectsTableData->HasNextPage());
 
   FormatPageLabel();
 
   mProjectsTable->ForceRefresh();
 
#if wxUSE_ACCESSIBILITY
   mAccessible->TableDataUpdated();
#endif
}

References FormatPageLabel(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::HasNextPage(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::HasPrevPage(), mNextPageButton, mPrevPageButton, mProjectsTable, and mProjectsTableData.

Referenced by audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::Refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSearchTextChanged()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnSearchTextChanged ( )

private

Definition at line 872 of file ProjectsListDialog.cpp.

{
   mSearchTimer->StartOnce(500);
}

Referenced by SetupHandlers().

Here is the caller graph for this function:

OnSearchTextSubmitted()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnSearchTextSubmitted ( )

private

Definition at line 877 of file ProjectsListDialog.cpp.

{
   if (mSearchTimer->IsRunning())
      mSearchTimer->Stop();
 
   const auto searchTerm = mSearchCtrl->GetValue();
 
   if (searchTerm == mLastSearchValue)
      return;
 
   mLastSearchValue = searchTerm;
 
   mProjectsTableData->Refresh(1, mLastSearchValue);
}

Referenced by SetupHandlers().

Here is the caller graph for this function:

OnSelectCell()

void audacity::cloud::audiocom::sync::ProjectsListDialog::OnSelectCell ( wxGridEvent &  event )

private

Definition at line 862 of file ProjectsListDialog.cpp.

{
   event.Skip();
   mProjectsTable->SelectRow(event.GetRow());
 
#if wxUSE_ACCESSIBILITY
   mAccessible->SetSelectedRow(event.GetRow());
#endif
}

Referenced by SetupHandlers().

Here is the caller graph for this function:

SetupHandlers()

void audacity::cloud::audiocom::sync::ProjectsListDialog::SetupHandlers ( )

private

Definition at line 638 of file ProjectsListDialog.cpp.

{
   mPrevPageButton->Bind(
      wxEVT_BUTTON, [this](auto&) { mProjectsTableData->PrevPage(); });
 
   mNextPageButton->Bind(
      wxEVT_BUTTON, [this](auto&) { mProjectsTableData->NextPage(); });
 
   mOpenButton->Bind(wxEVT_BUTTON, [this](auto&) { OnOpen(); });
 
   mOpenAudioCom->Bind(wxEVT_BUTTON, [this](auto&) { OnOpenAudioCom(); });
 
   mProjectsTable->Bind(
      wxEVT_GRID_CELL_LEFT_DCLICK, [this](auto&) { OnOpen(); });
 
   Bind(
      wxEVT_CHAR_HOOK,
      [this](auto& evt)
      {
         if (!IsEscapeKey(evt))
         {
            evt.Skip();
            return;
         }
 
         EndModal(wxID_CANCEL);
      });
 
   mProjectsTable->Bind(
      wxEVT_GRID_RANGE_SELECT, [this](auto& evt) { OnGridSelect(evt); });
 
   mProjectsTable->Bind(
      wxEVT_GRID_SELECT_CELL, [this](auto& evt) { OnSelectCell(evt); });
 
   mProjectsTable->Bind(
      wxEVT_KEY_UP,
      [this](auto& evt)
      {
         const auto keyCode = evt.GetKeyCode();
         if (keyCode != WXK_RETURN && keyCode != WXK_NUMPAD_ENTER)
         {
            evt.Skip();
            return;
         }
 
         OnOpen();
      });
 
   mProjectsTable->Bind(
      wxEVT_KEY_DOWN,
      [this](auto& evt)
      {
         const auto keyCode = evt.GetKeyCode();
         // prevent being able to up arrow past the first row (issue #6251)
         if (keyCode == WXK_UP && mProjectsTable->GetGridCursorRow() == 0) {
               return;
         }
         // prevent being able to down arrow past the last row (issue #6251)
         if (keyCode == WXK_DOWN &&
            mProjectsTable->GetGridCursorRow() ==
            mProjectsTable->GetNumberRows() - 1) {
               return;
         }
         if (keyCode != WXK_RETURN && keyCode != WXK_NUMPAD_ENTER)
         {
            evt.Skip();
            return;
         }
      });
 
   mProjectsTable->Bind(
      wxEVT_GRID_TABBING,
      [this](auto& evt)
      {
         // needed for correct tabbing - see issue #6190
         NavigateIn(evt.ShiftDown() ? wxNavigationKeyEvent::IsBackward :
            wxNavigationKeyEvent::IsForward);
      });
 
   mProjectsTable->Bind(
      wxEVT_SET_FOCUS,
      [this](auto& evt)
      {
         // needed so that for screen readers a row rather than the whole
         // table is the initial focus - see issue #6190
#if wxUSE_ACCESSIBILITY
         int row = mProjectsTable->GetGridCursorRow();
         if (row != -1)
            mAccessible->SetSelectedRow(row);
#endif
         evt.Skip();
      });
 
   mSearchCtrl->Bind(wxEVT_TEXT, [this](auto&) { OnSearchTextChanged(); });
 
   mSearchCtrl->Bind(
      wxEVT_TEXT_ENTER, [this](auto&) { OnSearchTextSubmitted(); });
 
   Bind(wxEVT_TIMER, [this](auto&) { OnSearchTextSubmitted(); });
}

References mNextPageButton, mOpenAudioCom, mOpenButton, mPrevPageButton, mProjectsTable, mProjectsTableData, mSearchCtrl, audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::NextPage(), OnGridSelect(), OnOpen(), OnOpenAudioCom(), OnSearchTextChanged(), OnSearchTextSubmitted(), OnSelectCell(), and audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::PrevPage().

Referenced by ProjectsListDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mInRangeSelection

bool audacity::cloud::audiocom::sync::ProjectsListDialog::mInRangeSelection { false }

private

Definition at line 82 of file ProjectsListDialog.h.

mLastSearchValue

wxString audacity::cloud::audiocom::sync::ProjectsListDialog::mLastSearchValue

private

Definition at line 74 of file ProjectsListDialog.h.

Referenced by audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::NextPage(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::PrevPage(), and ProjectsListDialog().

mNextPageButton

wxButton* audacity::cloud::audiocom::sync::ProjectsListDialog::mNextPageButton { nullptr }

private

Definition at line 69 of file ProjectsListDialog.h.

Referenced by OnBeforeRefresh(), OnRefreshCompleted(), ProjectsListDialog(), and SetupHandlers().

mOpenAudioCom

wxButton* audacity::cloud::audiocom::sync::ProjectsListDialog::mOpenAudioCom { nullptr }

private

Definition at line 72 of file ProjectsListDialog.h.

Referenced by ProjectsListDialog(), and SetupHandlers().

mOpenButton

wxButton* audacity::cloud::audiocom::sync::ProjectsListDialog::mOpenButton { nullptr }

private

Definition at line 71 of file ProjectsListDialog.h.

Referenced by ProjectsListDialog(), and SetupHandlers().

mPageLabel

wxStaticText* audacity::cloud::audiocom::sync::ProjectsListDialog::mPageLabel { nullptr }

private

Definition at line 67 of file ProjectsListDialog.h.

Referenced by FormatPageLabel(), and ProjectsListDialog().

mPrevPageButton

wxButton* audacity::cloud::audiocom::sync::ProjectsListDialog::mPrevPageButton { nullptr }

private

Definition at line 68 of file ProjectsListDialog.h.

Referenced by OnBeforeRefresh(), OnRefreshCompleted(), ProjectsListDialog(), and SetupHandlers().

mProject

AudacityProject* audacity::cloud::audiocom::sync::ProjectsListDialog::mProject { nullptr }

private

Definition at line 60 of file ProjectsListDialog.h.

Referenced by OnOpen(), and audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::Refresh().

mProjectsTable

wxGrid* audacity::cloud::audiocom::sync::ProjectsListDialog::mProjectsTable { nullptr }

private

Definition at line 64 of file ProjectsListDialog.h.

Referenced by audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetSelectedProjectInfo(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::GetSelectedProjectUrl(), OnBeforeRefresh(), OnOpen(), OnRefreshCompleted(), ProjectsListDialog(), and SetupHandlers().

mProjectsTableData

ProjectsTableData* audacity::cloud::audiocom::sync::ProjectsListDialog::mProjectsTableData { nullptr }

private

Definition at line 65 of file ProjectsListDialog.h.

Referenced by FormatPageLabel(), OnOpen(), OnRefreshCompleted(), ProjectsListDialog(), and SetupHandlers().

mSearchCtrl

wxTextCtrl* audacity::cloud::audiocom::sync::ProjectsListDialog::mSearchCtrl { nullptr }

private

Definition at line 62 of file ProjectsListDialog.h.

Referenced by ProjectsListDialog(), and SetupHandlers().

mSearchTimer

std::unique_ptr<wxTimer> audacity::cloud::audiocom::sync::ProjectsListDialog::mSearchTimer

private

Definition at line 76 of file ProjectsListDialog.h.

Referenced by ProjectsListDialog().

---

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

• ProjectsListDialog.h
• ProjectsListDialog.cpp