audacity::cloud::audiocom::sync::CloudSyncStatusField Class Reference

#include <CloudSyncStatusField.h>

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

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

Classes
class	StatusWidget

Public Member Functions
	CloudSyncStatusField (AudacityProject &project)
	~CloudSyncStatusField () override
int	GetWidth () const
void	OnSize (const wxRect &rect)
bool	IsVisible () const
TranslatableString	GetText () const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static CloudSyncStatusField &	Get (AudacityProject &project)
static const CloudSyncStatusField &	Get (const AudacityProject &project)

Private Types
enum class	State {   Hidden , Dirty , Synced , Failed ,   Uploading }

Private Member Functions
void	MarkDirty ()
void	OnCloudStatusChanged (const CloudStatusChangedMessage &extension)
StatusWidget &	GetStatusWidget ()
const StatusWidget &	GetStatusWidget () const

Private Attributes
AudacityProject &	mProject
ProjectCloudExtension &	mCloudExtension
enum audacity::cloud::audiocom::sync::CloudSyncStatusField::State	Hidden
int	mProgress { 0 }
wxWeakRef< StatusWidget >	mStatusWidget
Observer::Subscription	mCloudStatusChangedSubscription

Detailed Description

Definition at line 30 of file CloudSyncStatusField.h.

Member Enumeration Documentation

State

enum class audacity::cloud::audiocom::sync::CloudSyncStatusField::State

strongprivate

Enumerator
Hidden
Dirty
Synced
Failed
Uploading

Definition at line 58 of file CloudSyncStatusField.h.

   {
      Hidden,
      Dirty,
      Synced,
      Failed,
      Uploading,
   } mState { State::Hidden };

Constructor & Destructor Documentation

CloudSyncStatusField()

audacity::cloud::audiocom::sync::CloudSyncStatusField::CloudSyncStatusField ( AudacityProject &  project )

explicit

Definition at line 339 of file CloudSyncStatusField.cpp.

    : mProject { project }
    , mCloudExtension { ProjectCloudExtension::Get(project) }
    , mCloudStatusChangedSubscription { mCloudExtension.SubscribeStatusChanged(
         [this](const auto& extension) { OnCloudStatusChanged(extension); },
         true) }
{
}

References anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, and OnCloudStatusChanged().

Here is the call graph for this function:

~CloudSyncStatusField()

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

overridedefault

Member Function Documentation

Get() [1/2]

CloudSyncStatusField & audacity::cloud::audiocom::sync::CloudSyncStatusField::Get ( AudacityProject &  project )

static

Definition at line 350 of file CloudSyncStatusField.cpp.

{
   return project.AttachedObjects::Get<CloudSyncStatusField&>(key);
}

References audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::key, and project.

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::GetDefaultWidth(), audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::GetText(), audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::IsVisible(), and audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::OnSize().

Here is the caller graph for this function:

Get() [2/2]

const CloudSyncStatusField & audacity::cloud::audiocom::sync::CloudSyncStatusField::Get ( const AudacityProject &  project )

static

Definition at line 356 of file CloudSyncStatusField.cpp.

{
   return Get(const_cast<AudacityProject&>(project));
}

References project.

GetStatusWidget() [1/2]

CloudSyncStatusField::StatusWidget & audacity::cloud::audiocom::sync::CloudSyncStatusField::GetStatusWidget ( )

private

Definition at line 431 of file CloudSyncStatusField.cpp.

{
   if (!mStatusWidget)
   {
      mStatusWidget = safenew StatusWidget(
         *this, ProjectWindow::Get(mProject).GetStatusBar());
 
      mStatusWidget->Show(mCloudExtension.IsCloudProject());
   }
 
   return *mStatusWidget;
}

References ProjectWindow::Get(), and safenew.

Here is the call graph for this function:

GetStatusWidget() [2/2]

const CloudSyncStatusField::StatusWidget & audacity::cloud::audiocom::sync::CloudSyncStatusField::GetStatusWidget ( ) const

private

Definition at line 445 of file CloudSyncStatusField.cpp.

{
   return const_cast<CloudSyncStatusField*>(this)->GetStatusWidget();
}

GetText()

TranslatableString audacity::cloud::audiocom::sync::CloudSyncStatusField::GetText

(

)

const

Definition at line 379 of file CloudSyncStatusField.cpp.

{
   return {};
}

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::GetText().

Here is the caller graph for this function:

GetWidth()

int audacity::cloud::audiocom::sync::CloudSyncStatusField::GetWidth

(

)

const

Definition at line 361 of file CloudSyncStatusField.cpp.

{
   return mCloudExtension.IsCloudProject() ?
             (GetStatusWidget().GetPreferredWidth(mState) +
              StatusFieldPadding) :
             0;
}

References mState, and audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::StatusFieldPadding.

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::GetDefaultWidth().

Here is the caller graph for this function:

IsVisible()

bool audacity::cloud::audiocom::sync::CloudSyncStatusField::IsVisible

(

)

const

Definition at line 374 of file CloudSyncStatusField.cpp.

{
   return mState != State::Hidden;
}

References mState.

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::IsVisible().

Here is the caller graph for this function:

MarkDirty()

void audacity::cloud::audiocom::sync::CloudSyncStatusField::MarkDirty ( )

private

Definition at line 384 of file CloudSyncStatusField.cpp.

{
   auto field = dynamic_cast<CloudSyncStatusBarFieldItem*>(
      ProjectStatusFieldsRegistry::Get(FieldId));
 
   if (field)
      field->MarkDirty(mProject);
 
   auto& statusWidget = GetStatusWidget();
 
   statusWidget.Show(mState != State::Hidden);
   statusWidget.UpdateName();
 
   if (statusWidget.GetParent())
      statusWidget.GetParent()->Refresh();
   else
      statusWidget.Refresh();
}

References field, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::FieldId, ProjectStatusFieldsRegistry::Get(), and mState.

Here is the call graph for this function:

OnCloudStatusChanged()

void audacity::cloud::audiocom::sync::CloudSyncStatusField::OnCloudStatusChanged ( const CloudStatusChangedMessage &  extension )

private

Definition at line 403 of file CloudSyncStatusField.cpp.

{
   mState = [](ProjectSyncStatus status)
   {
      switch (status)
      {
      case ProjectSyncStatus::Local:
         return State::Hidden;
      case ProjectSyncStatus::Unsynced:
         return State::Dirty;
      case ProjectSyncStatus::Synced:
         return State::Synced;
      case ProjectSyncStatus::Failed:
         return State::Failed;
      case ProjectSyncStatus::Syncing:
         return State::Uploading;
      default:
         return State::Hidden;
      }
   }(message.Status);
 
   if (mState == State::Uploading)
      mProgress = static_cast<int>(message.Progress * 100.0);
 
   MarkDirty();
}

References mState, audacity::cloud::audiocom::sync::CloudStatusChangedMessage::Progress, and audacity::cloud::audiocom::sync::CloudStatusChangedMessage::Status.

Referenced by CloudSyncStatusField().

Here is the caller graph for this function:

OnSize()

void audacity::cloud::audiocom::sync::CloudSyncStatusField::OnSize

(

const wxRect &

rect

)

Definition at line 369 of file CloudSyncStatusField.cpp.

{
   GetStatusWidget().SetRect(rect);
}

Referenced by audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncStatusBarFieldItem::OnSize().

Here is the caller graph for this function:

Member Data Documentation

Hidden

enum audacity::cloud::audiocom::sync::CloudSyncStatusField::State audacity::cloud::audiocom::sync::CloudSyncStatusField::Hidden

private

mCloudExtension

ProjectCloudExtension& audacity::cloud::audiocom::sync::CloudSyncStatusField::mCloudExtension

private

Definition at line 56 of file CloudSyncStatusField.h.

mCloudStatusChangedSubscription

Observer::Subscription audacity::cloud::audiocom::sync::CloudSyncStatusField::mCloudStatusChangedSubscription

private

Definition at line 71 of file CloudSyncStatusField.h.

mProgress

int audacity::cloud::audiocom::sync::CloudSyncStatusField::mProgress { 0 }

private

Definition at line 67 of file CloudSyncStatusField.h.

Referenced by audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::GetTranslatableText(), and audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::OnPaint().

mProject

AudacityProject& audacity::cloud::audiocom::sync::CloudSyncStatusField::mProject

private

Definition at line 55 of file CloudSyncStatusField.h.

mStatusWidget

wxWeakRef<StatusWidget> audacity::cloud::audiocom::sync::CloudSyncStatusField::mStatusWidget

private

Definition at line 69 of file CloudSyncStatusField.h.

---

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

• CloudSyncStatusField.h
• CloudSyncStatusField.cpp