WhatsNewDialog Class Reference

#include <WhatsNewDialog.h>

Inheritance diagram for WhatsNewDialog:

Collaboration diagram for WhatsNewDialog:

Public Member Functions
	WhatsNewDialog (wxWindow *parent, wxWindowID id)
	~WhatsNewDialog () 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

Static Public Member Functions
static void	Show (AudacityProject &project)

Private Member Functions
void	Populate (ShuttleGui &S)
void	OnOK (wxCommandEvent &)

Private Attributes
wxCheckBox *	mDontShowAgain {}

Detailed Description

Definition at line 20 of file WhatsNewDialog.h.

Constructor & Destructor Documentation

WhatsNewDialog()

WhatsNewDialog::WhatsNewDialog	(	wxWindow *	parent,
		wxWindowID	id
	)

Definition at line 163 of file WhatsNewDialog.cpp.

   : wxDialogWrapper(parent, id, XO("Welcome to Audacity!"))
{
 
   SetSize(FromDIP(wxSize(WindowWidth, WindowHeight)));
 
#if defined(__WXMSW__)
   //On Windows UI controls doesn't use same theme preference
   //as per application, we should use the latter one to get 
   //match with LinkingHtmlWindow's theme
   SetBackgroundColour(theTheme.Colour(clrMedium));
#endif
   SetName();
   ShuttleGui S( this, eIsCreating );
   Populate( S );
   Centre();
}

References ThemeBase::Colour(), eIsCreating, S, theTheme, anonymous_namespace{WhatsNewDialog.cpp}::WindowHeight, and anonymous_namespace{WhatsNewDialog.cpp}::WindowWidth.

Here is the call graph for this function:

~WhatsNewDialog()

WhatsNewDialog::~WhatsNewDialog ( )

overridedefault

Member Function Documentation

OnOK()

void WhatsNewDialog::OnOK ( wxCommandEvent &  evt )

private

Definition at line 281 of file WhatsNewDialog.cpp.

{
   gPrefs->Write(wxT("/GUI/ShowSplashScreen"), !mDontShowAgain->IsChecked() );
   gPrefs->Flush();
   wxDialogWrapper::Show(false);
}

References audacity::BasicSettings::Flush(), gPrefs, mDontShowAgain, ExportProgressUI::Show(), audacity::BasicSettings::Write(), and wxT().

Here is the call graph for this function:

Populate()

void WhatsNewDialog::Populate ( ShuttleGui &  S )

private

Definition at line 191 of file WhatsNewDialog.cpp.

{
   bool showSplashScreen;
   gPrefs->Read(wxT("/GUI/ShowSplashScreen"), &showSplashScreen, true );
 
   FSHelper helper;
 
   S.StartHorizontalLay(wxEXPAND);
   {
      S.SetBorder(20);
      const auto whatsnew = safenew LinkingHtmlWindow(S.GetParent());
      whatsnew->SetPage(MakeWhatsNewText());
      whatsnew->SetBackgroundColour(S.GetParent()->GetBackgroundColour());
      S
         .Prop(1)
#if defined(SHOW_MUSEHUB)
         .Position(wxEXPAND | wxLEFT | wxTOP | wxBOTTOM)
#else
         .Position(wxEXPAND | wxALL)
#endif
         .AddWindow(whatsnew);
 
#if defined(SHOW_MUSEHUB)
      S.AddSpace(20);
 
      const auto getplugins = safenew LinkingHtmlWindow(S.GetParent());
      getplugins->SetPage(MakeGetPluginsText());
      getplugins->SetBackgroundColour(S.GetParent()->GetBackgroundColour());
      S
         .Prop(1)
         .Position(wxEXPAND | wxTOP | wxRIGHT | wxBOTTOM)
         .AddWindow(getplugins);
#endif
   }
   S.EndHorizontalLay();
 
   const auto line = safenew wxWindow(S.GetParent(), wxID_ANY);
   line->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_BTNSHADOW));
   line->SetSize(-1, 1);
 
   S
      .Prop(0)
      .Position(wxEXPAND)
      .AddWindow(line);
 
   S.StartHorizontalLay(wxALIGN_CENTRE, 0);
   {
      S.SetBorder(10);
      const auto tutorialsLink = safenew wxHyperlinkCtrl(
         S.GetParent(),
         wxID_ANY,
         _("View tutorials"),
         "https://support.audacityteam.org/");
      S
         .Position(wxTOP | wxBOTTOM)
         .AddWindow(tutorialsLink);
 
      S.AddSpace(25);
 
      const auto forumLink = safenew wxHyperlinkCtrl(
         S.GetParent(),
         wxID_ANY,
         _("Visit our forum"),
         "https://forum.audacityteam.org/");
      S
         .Position(wxTOP | wxBOTTOM)
         .AddWindow(forumLink);
   }
   S.EndHorizontalLay();
 
   S.Position(wxEXPAND).StartPanel(2);
   {
      S.StartHorizontalLay(wxEXPAND);
      {
         S.SetBorder(4);
         mDontShowAgain = S
            .Position(wxALL | wxALIGN_CENTRE)
            .AddCheckBox( XXO("Don't show this again at start up"), !showSplashScreen);
         
         S.AddSpace(1,1,1);
 
         S
            .Id(wxID_OK)
            .AddButton(XXO("OK"), wxALL, true);
      }
      S.EndHorizontalLay();
   }
   S.EndPanel();
}

References _, gPrefs, anonymous_namespace{WhatsNewDialog.cpp}::MakeGetPluginsText(), anonymous_namespace{WhatsNewDialog.cpp}::MakeWhatsNewText(), mDontShowAgain, audacity::BasicSettings::Read(), S, safenew, wxT(), and XXO().

Here is the call graph for this function:

Show()

void WhatsNewDialog::Show ( AudacityProject &  project )

static

Definition at line 183 of file WhatsNewDialog.cpp.

{
   auto dialog = &GetAttachedWindows(project)
      .Get<WhatsNewDialog>(sWhatsNewWindow);
   dialog->CenterOnParent();
   dialog->wxDialogWrapper::Show();
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), GetAttachedWindows(), project, and sWhatsNewWindow.

Referenced by AudacityApp::InitPart2().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mDontShowAgain

wxCheckBox* WhatsNewDialog::mDontShowAgain {}

private

Definition at line 22 of file WhatsNewDialog.h.

Referenced by OnOK(), and Populate().

---

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

• WhatsNewDialog.h
• WhatsNewDialog.cpp