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

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

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

Public Member Functions
	StatusWidget (CloudSyncStatusField &owner, wxWindow *parent)
	~StatusWidget () override
void	SetRect (const wxRect &rect)
int	GetPreferredWidth (State state) const
const wxBitmap *	GetBitmap () const
TranslatableString	GetTranslatableText () const
wxString	GetText () const
void	OnPaint ()
void	UpdatePrefs () override
void	UpdateName ()
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
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Private Attributes
CloudSyncStatusField &	mOwner
const wxBitmap *	mSyncedBitmap {}
const wxBitmap *	mProgressBitmap {}
int	mCloudSyncFailedMessageWidth {}
int	mCloudSyncProgressMessageWidth {}

Additional Inherited Members
Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Detailed Description

Definition at line 114 of file CloudSyncStatusField.cpp.

Constructor & Destructor Documentation

StatusWidget()

audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::StatusWidget ( CloudSyncStatusField &  owner, wxWindow *  parent  )

inline

Definition at line 119 of file CloudSyncStatusField.cpp.

       : wxPanelWrapper { parent }
       , mOwner { owner }
   {
      SetBackgroundStyle(wxBG_STYLE_PAINT);
      UpdatePrefs();
 
      Bind(wxEVT_PAINT, [this](auto&) { OnPaint(); });
 
#if wxUSE_ACCESSIBILITY
      SetAccessible(safenew WindowAccessible(this));
#endif
   }

References OnPaint(), safenew, and UpdatePrefs().

Here is the call graph for this function:

~StatusWidget()

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

inlineoverride

Definition at line 133 of file CloudSyncStatusField.cpp.

   {
   }

Member Function Documentation

GetBitmap()

const wxBitmap * audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::GetBitmap ( ) const

inline

Definition at line 157 of file CloudSyncStatusField.cpp.

   {
      return mOwner.mState == State::Uploading ? mProgressBitmap :
                                                 mSyncedBitmap;
   }

References mOwner, mProgressBitmap, mSyncedBitmap, and audacity::cloud::audiocom::sync::CloudSyncStatusField::Uploading.

Referenced by OnPaint().

Here is the caller graph for this function:

GetPreferredWidth()

int audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::GetPreferredWidth ( State  state ) const

inline

Definition at line 142 of file CloudSyncStatusField.cpp.

   {
      switch (state)
      {
      case State::Failed:
         return mSyncedBitmap->GetWidth() + mCloudSyncFailedMessageWidth +
                Padding * 4;
      case State::Uploading:
         return mProgressBitmap->GetWidth() + mCloudSyncProgressMessageWidth +
                ProgressBarWidth + Padding * 4;
      }
 
      return mSyncedBitmap->GetWidth() + Padding * 2;
   }

References audacity::cloud::audiocom::sync::CloudSyncStatusField::Failed, mCloudSyncFailedMessageWidth, mCloudSyncProgressMessageWidth, mProgressBitmap, mSyncedBitmap, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::Padding, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::ProgressBarWidth, and audacity::cloud::audiocom::sync::CloudSyncStatusField::Uploading.

GetText()

wxString audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::GetText ( ) const

inline

Definition at line 174 of file CloudSyncStatusField.cpp.

   {
      return GetTranslatableText().Translation();
   }

References GetTranslatableText(), and TranslatableString::Translation().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTranslatableText()

TranslatableString audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::GetTranslatableText ( ) const

inline

Definition at line 163 of file CloudSyncStatusField.cpp.

   {
      if (mOwner.mState == State::Uploading)
         return TranslatableString { CloudSyncProgressMessage }.Format(
            mOwner.mProgress);
      else if (mOwner.mState == State::Failed)
         return CloudSyncFailedMessage;
 
      return {};
   }

References audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncFailedMessage, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncProgressMessage, audacity::cloud::audiocom::sync::CloudSyncStatusField::Failed, mOwner, audacity::cloud::audiocom::sync::CloudSyncStatusField::mProgress, and audacity::cloud::audiocom::sync::CloudSyncStatusField::Uploading.

Referenced by GetText(), and UpdateName().

Here is the caller graph for this function:

OnPaint()

void audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::OnPaint ( )

inline

Definition at line 179 of file CloudSyncStatusField.cpp.

   {
      wxAutoBufferedPaintDC dc(this);
      std::unique_ptr<wxGraphicsContext> gc(wxGraphicsContext::Create(dc));
 
      auto bitmap = GetBitmap();
 
      const wxSize widgetSize = GetSize();
      const wxSize bitmapSize = bitmap->GetSize();
 
      gc->SetBrush(wxBrush(GetBackgroundColour()));
      gc->DrawRectangle(0, 0, widgetSize.x, widgetSize.y);
      gc->DrawBitmap(
         *bitmap, Padding, (widgetSize.y - bitmapSize.y) / 2.0, bitmapSize.x,
         bitmapSize.y);
 
      const auto text = GetText();
 
      if (text.empty())
         return;
 
      gc->SetFont(GetFont(), GetForegroundColour());
      gc->DrawText(text, Padding + bitmapSize.x + 2 * Padding, 0);
 
      if (mOwner.mState != State::Uploading)
         return;
 
      gc->SetAntialiasMode(wxANTIALIAS_NONE);
 
      const auto progress = std::clamp(mOwner.mProgress, 0, 100);
 
      const auto progressFilledPen =
         gc->CreatePen(wxGraphicsPenInfo {}
                          .Colour(wxColour(0xc3c3c3))
                          .Width(ProgressBarBorderSize));
 
      const auto progressEmptyPen =
         gc->CreatePen(wxGraphicsPenInfo {}
                          .Colour(wxColour(0xc3c3c3))
                          .Width(ProgressBarBorderSize));
      const auto zeroPen = gc->CreatePen(
         wxGraphicsPenInfo {}.Width(0).Style(wxPENSTYLE_TRANSPARENT));
 
      const auto progressFilledBrush = gc->CreateBrush(wxColour(0x3cf03c));
      const auto progressEmptyBrush  = gc->CreateBrush(wxColour(0xffffff));
 
      const auto progressBarBorderLeft =
         Padding + bitmapSize.x + 2 * Padding + mCloudSyncProgressMessageWidth;
 
      const auto progressBarBorderRight =
         progressBarBorderLeft + ProgressBarWidth;
 
      const auto progressBarBorderTop =
         (widgetSize.y - ProgressBarHeight) / 2.0;
 
      const auto progressBarBorderBottom =
         progressBarBorderTop + ProgressBarHeight;
 
      const auto filledWidth =
         (ProgressBarWidth - ProgressBarBorderSize * 2) * progress / 100;
 
      const auto progressBarFillLeft =
         progressBarBorderLeft + ProgressBarBorderSize;
      const auto progressBarFillRight = progressBarFillLeft + filledWidth;
 
      const auto progressBarEmptyLeft =
         progressBarFillRight + (progress > 0 ? 1 : 0);
      const auto progressBarEmptyRight =
         progressBarBorderRight - ProgressBarBorderSize;
 
      const auto filledHeight = ProgressBarHeight - ProgressBarBorderSize;
 
      // Draw border
      if (progress == 0)
         gc->SetPen(progressEmptyPen);
      else
         gc->SetPen(progressFilledPen);
 
      gc->StrokeLine(
         progressBarBorderLeft, progressBarBorderTop, progressBarBorderLeft,
         progressBarBorderBottom);
 
      if (progress > 0)
      {
         gc->StrokeLine(
            progressBarFillLeft, progressBarBorderTop, progressBarFillRight,
            progressBarBorderTop);
 
         gc->StrokeLine(
            progressBarFillLeft, progressBarBorderBottom, progressBarFillRight,
            progressBarBorderBottom);
 
         gc->SetPen(zeroPen);
         gc->SetBrush(progressFilledBrush);
 
         gc->DrawRectangle(
            progressBarFillLeft, progressBarBorderTop + ProgressBarBorderSize,
            progressBarFillRight - progressBarFillLeft + 1, filledHeight);
      }
 
      if (progress < 100)
      {
         gc->SetPen(progressEmptyPen);
 
         gc->StrokeLine(
            progressBarEmptyLeft, progressBarBorderTop, progressBarEmptyRight,
            progressBarBorderTop);
 
         gc->StrokeLine(
            progressBarEmptyLeft, progressBarBorderBottom,
            progressBarEmptyRight, progressBarBorderBottom);
 
         gc->SetPen(zeroPen);
         gc->SetBrush(progressEmptyBrush);
 
         gc->DrawRectangle(
            progressBarEmptyLeft, progressBarBorderTop + ProgressBarBorderSize,
            progressBarEmptyRight - progressBarEmptyLeft + 1, filledHeight);
      }
 
      if (progress == 100)
         gc->SetPen(progressFilledPen);
      else
         gc->SetPen(progressEmptyPen);
 
      gc->StrokeLine(
         progressBarBorderRight, progressBarBorderTop, progressBarBorderRight,
         progressBarBorderBottom);
   }

References GetBitmap(), GetText(), mCloudSyncProgressMessageWidth, mOwner, audacity::cloud::audiocom::sync::CloudSyncStatusField::mProgress, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::Padding, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::ProgressBarBorderSize, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::ProgressBarHeight, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::ProgressBarWidth, and audacity::cloud::audiocom::sync::CloudSyncStatusField::Uploading.

Referenced by StatusWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

SetRect()

void audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::SetRect ( const wxRect &  rect )

inline

Definition at line 137 of file CloudSyncStatusField.cpp.

   {
      SetSize(rect);
   }

UpdateName()

void audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::UpdateName ( )

inline

Definition at line 324 of file CloudSyncStatusField.cpp.

   {
      SetName(GetTranslatableText());
   }

References GetTranslatableText(), and wxPanelWrapper::SetName().

Here is the call graph for this function:

UpdatePrefs()

void audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::UpdatePrefs ( )

inlineoverridevirtual

Implements PrefsListener.

Definition at line 309 of file CloudSyncStatusField.cpp.

   {
      mSyncedBitmap   = &theTheme.Bitmap(bmpCloud);
      mProgressBitmap = &theTheme.Bitmap(bmpCloudProgress);
 
      mCloudSyncFailedMessageWidth =
         GetTextExtent(CloudSyncFailedMessage.Translation()).x;
 
      mCloudSyncProgressMessageWidth =
         GetTextExtent(TranslatableString { CloudSyncProgressMessage }
                          .Format(100)
                          .Translation())
            .x;
   }

References ThemeBase::Bitmap(), audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncFailedMessage, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::CloudSyncProgressMessage, mCloudSyncFailedMessageWidth, mCloudSyncProgressMessageWidth, mProgressBitmap, mSyncedBitmap, and theTheme.

Referenced by StatusWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCloudSyncFailedMessageWidth

int audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::mCloudSyncFailedMessageWidth {}

private

Definition at line 335 of file CloudSyncStatusField.cpp.

Referenced by GetPreferredWidth(), and UpdatePrefs().

mCloudSyncProgressMessageWidth

int audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::mCloudSyncProgressMessageWidth {}

private

Definition at line 336 of file CloudSyncStatusField.cpp.

Referenced by GetPreferredWidth(), OnPaint(), and UpdatePrefs().

mOwner

CloudSyncStatusField& audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::mOwner

private

Definition at line 330 of file CloudSyncStatusField.cpp.

Referenced by GetBitmap(), GetTranslatableText(), and OnPaint().

mProgressBitmap

const wxBitmap* audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::mProgressBitmap {}

private

Definition at line 333 of file CloudSyncStatusField.cpp.

Referenced by GetBitmap(), GetPreferredWidth(), and UpdatePrefs().

mSyncedBitmap

const wxBitmap* audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget::mSyncedBitmap {}

private

Definition at line 332 of file CloudSyncStatusField.cpp.

Referenced by GetBitmap(), GetPreferredWidth(), and UpdatePrefs().

---

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

• CloudSyncStatusField.cpp