#include <UserPanel.h>

Inheritance diagram for audacity::cloud::audiocom::UserPanel:

Collaboration diagram for audacity::cloud::audiocom::UserPanel:

Public Types
enum class	LinkMode { Link , SignIn }

Public Types inherited from Observer::Publisher< UserPanelStateChangedMessage >
using	message_type = UserPanelStateChangedMessage

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const UserPanelStateChangedMessage &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	UserPanel (const ServiceConfig &serviceConfig, OAuthService &authService, UserService &userService, LinkMode linkMode, AudiocomTrace, wxWindow *parent=nullptr, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)

	~UserPanel () override

bool	IsAuthorized () const

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 Observer::Publisher< UserPanelStateChangedMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Member Functions
void	OnStateChanged (bool isAuthorized)

void	UpdateUserData ()

void	OnLinkButtonPressed ()

void	SetAnonymousState ()

Private Attributes
const ServiceConfig &	mServiceConfig

OAuthService &	mAuthService

UserService &	mUserService

const AudiocomTrace	mAudiocomTrace

UserImage *	mUserImage {}

wxStaticText *	mUserName {}

wxButton *	mLinkButton {}

Observer::Subscription	mUserDataChangedSubscription

bool	mIsAuthorized { false }

const LinkMode	mLinkMode

Additional Inherited Members
Static Public Attributes inherited from Observer::Publisher< UserPanelStateChangedMessage >
static constexpr bool	notifies_all

Protected Member Functions inherited from Observer::Publisher< UserPanelStateChangedMessage >
CallbackReturn	Publish (const UserPanelStateChangedMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 33 of file UserPanel.h.

Member Enumeration Documentation

◆ LinkMode

enum class audacity::cloud::audiocom::UserPanel::LinkMode

strong

Enumerator
Link
SignIn

Definition at line 41 of file UserPanel.h.

                       {
      Link,
      SignIn,
   };

Constructor & Destructor Documentation

◆ UserPanel()

audacity::cloud::audiocom::UserPanel::UserPanel	(	const ServiceConfig &	serviceConfig,
		OAuthService &	authService,
		UserService &	userService,
		LinkMode	linkMode,
		AudiocomTrace	trace,
		wxWindow *	parent = `nullptr`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`
	)

Definition at line 52 of file UserPanel.cpp.

    : wxPanelWrapper { parent, wxID_ANY, pos, size }
    , mServiceConfig { serviceConfig }
    , mAuthService { authService }
    , mUserService { userService }
    , mAudiocomTrace { trace }
    , mUserDataChangedSubscription { userService.Subscribe(
         [this](const auto&) { UpdateUserData(); }) }
    , mLinkMode { linkMode }
{
   mUserImage = safenew UserImage(this, avatarSize);
   mUserImage->SetLabel( mLinkMode == LinkMode::Link ? 
                         notLinkedText : anonymousText );      // for screen readers
   mUserName = safenew wxStaticText(
      this,
      wxID_ANY,
      ( mLinkMode == LinkMode::Link ? 
        notLinkedText : anonymousText).Translation() );
 
   mLinkButton =
      safenew wxButton(this, wxID_ANY, XXO("&Link Account").Translation());
   mLinkButton->Bind(wxEVT_BUTTON, [this](auto) { OnLinkButtonPressed(); });
   
   mLinkButton->Show(mLinkMode == LinkMode::Link);
 
   auto sizer = safenew wxBoxSizer { wxHORIZONTAL };
 
   sizer->Add(mUserImage, 0, wxALIGN_CENTER_VERTICAL);
   sizer->AddSpacer(8);
   sizer->Add(mUserName, 0, wxALIGN_CENTER_VERTICAL);
   sizer->AddStretchSpacer();
   sizer->Add(mLinkButton, 0, wxALIGN_CENTER_VERTICAL);
 
   SetSizerAndFit(sizer);
   UpdateUserData();
}

References UpdateUserData().

Here is the call graph for this function:

◆ ~UserPanel()

audacity::cloud::audiocom::UserPanel::~UserPanel ( )

overridedefault

Member Function Documentation

◆ IsAuthorized()

bool audacity::cloud::audiocom::UserPanel::IsAuthorized ( ) const

Definition at line 94 of file UserPanel.cpp.

{
   return mIsAuthorized;
}

Referenced by audacity::cloud::audiocom::sync::CloudProjectPropertiesDialog::OnSubmit().

Here is the caller graph for this function:

◆ OnLinkButtonPressed()

void audacity::cloud::audiocom::UserPanel::OnLinkButtonPressed ( )

private

Definition at line 169 of file UserPanel.cpp.

{
   auto& oauthService = GetOAuthService();
 
   if (oauthService.HasAccessToken())
      oauthService.UnlinkAccount(mAudiocomTrace);
   else
   {
      OpenInDefaultBrowser({ audacity::ToWXString(
         mServiceConfig.GetOAuthLoginPage(mAudiocomTrace)) });
 
#ifdef HAS_CUSTOM_URL_HANDLING
      if (!URLSchemesRegistry::Get().IsURLHandlingSupported())
#endif
      {
         LinkWithTokenDialog dlg(mAudiocomTrace, this);
         dlg.ShowModal();
      }
   }
}

References URLSchemesRegistry::Get(), audacity::cloud::audiocom::GetOAuthService(), URLSchemesRegistry::IsURLHandlingSupported(), BasicUI::OpenInDefaultBrowser(), and audacity::ToWXString().

Here is the call graph for this function:

◆ OnStateChanged()

void audacity::cloud::audiocom::UserPanel::OnStateChanged ( bool isAuthorized )

private

Definition at line 99 of file UserPanel.cpp.

{
   if (mIsAuthorized == isAuthorized)
      return;
 
   mIsAuthorized = isAuthorized;
   Publish(UserPanelStateChangedMessage { isAuthorized });
}

◆ SetAnonymousState()

void audacity::cloud::audiocom::UserPanel::SetAnonymousState ( )

private

Definition at line 190 of file UserPanel.cpp.

{
   mUserName->SetLabel(anonymousText.Translation());
   mUserImage->SetBitmap(theTheme.Bitmap(bmpAnonymousUser));
   mUserImage->SetLabel(anonymousText);   // for screen readers
   mLinkButton->SetLabel(XXO("&Link Account").Translation());
   mLinkButton->Show(mLinkMode == LinkMode::Link);
 
   OnStateChanged(false);
}

References audacity::cloud::audiocom::anonymous_namespace{UserPanel.cpp}::anonymousText, ThemeBase::Bitmap(), wxDialogWrapper::SetLabel(), theTheme, and XXO().

Here is the call graph for this function:

◆ UpdateUserData()

void audacity::cloud::audiocom::UserPanel::UpdateUserData ( )

private

Definition at line 108 of file UserPanel.cpp.

{
   Freeze();
 
   auto layoutUpdater = finally(
      [this]()
      {
         mLinkButton->Fit();
 
         Layout();
         Thaw();
 
         auto parent = GetParent();
 
         if (parent != nullptr)
            parent->Refresh();
         else
            Refresh();
      });
 
   auto& oauthService = GetOAuthService();
 
   if (!oauthService.HasRefreshToken())
   {
      SetAnonymousState();
      return;
   }
 
   if (!oauthService.HasAccessToken())
      oauthService.ValidateAuth({}, mAudiocomTrace, true);
 
   auto& userService = GetUserService();
 
   if (userService.GetUserSlug().empty())
   {
      SetAnonymousState();
      return;
   }
 
   const auto displayName = userService.GetDisplayName();
 
   if (!displayName.empty()) {
      mUserName->SetLabel(displayName);
      mUserImage->wxPanel::SetLabel(displayName);  // for screen readers
   }
 
   const auto avatarPath = userService.GetAvatarPath();
 
   if (!avatarPath.empty())
      mUserImage->SetBitmap(avatarPath);
   else
      mUserImage->SetBitmap(theTheme.Bitmap(bmpAnonymousUser));
 
   mLinkButton->SetLabel(( mLinkMode == LinkMode::Link ? 
     XXO("&Unlink Account") :
     XXO("&Sign Out") ).Translation());
   mLinkButton->Show();
 
   OnStateChanged(true);
}

References ThemeBase::Bitmap(), audacity::cloud::audiocom::anonymous_namespace{UserService.cpp}::displayName, audacity::cloud::audiocom::GetOAuthService(), audacity::cloud::audiocom::GetUserService(), theTheme, and XXO().

Referenced by UserPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mAudiocomTrace

const AudiocomTrace audacity::cloud::audiocom::UserPanel::mAudiocomTrace

private

Definition at line 65 of file UserPanel.h.

◆ mAuthService

OAuthService& audacity::cloud::audiocom::UserPanel::mAuthService

private

Definition at line 63 of file UserPanel.h.

◆ mIsAuthorized

bool audacity::cloud::audiocom::UserPanel::mIsAuthorized { false }

private

Definition at line 73 of file UserPanel.h.

◆ mLinkButton

wxButton* audacity::cloud::audiocom::UserPanel::mLinkButton {}

private

Definition at line 69 of file UserPanel.h.

◆ mLinkMode

const LinkMode audacity::cloud::audiocom::UserPanel::mLinkMode

private

Definition at line 74 of file UserPanel.h.

◆ mServiceConfig

const ServiceConfig& audacity::cloud::audiocom::UserPanel::mServiceConfig

private

Definition at line 62 of file UserPanel.h.

◆ mUserDataChangedSubscription

Observer::Subscription audacity::cloud::audiocom::UserPanel::mUserDataChangedSubscription

private

Definition at line 71 of file UserPanel.h.

◆ mUserImage

UserImage* audacity::cloud::audiocom::UserPanel::mUserImage {}

private

Definition at line 67 of file UserPanel.h.

◆ mUserName

wxStaticText* audacity::cloud::audiocom::UserPanel::mUserName {}

private

Definition at line 68 of file UserPanel.h.

◆ mUserService

UserService& audacity::cloud::audiocom::UserPanel::mUserService

private

Definition at line 64 of file UserPanel.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LinkMode

Constructor & Destructor Documentation

◆ UserPanel()

◆ ~UserPanel()

Member Function Documentation

◆ IsAuthorized()

◆ OnLinkButtonPressed()

◆ OnStateChanged()

◆ SetAnonymousState()

◆ UpdateUserData()

Member Data Documentation

◆ mAudiocomTrace

◆ mAuthService

◆ mIsAuthorized

◆ mLinkButton

◆ mLinkMode

◆ mServiceConfig

◆ mUserDataChangedSubscription

◆ mUserImage

◆ mUserName

◆ mUserService