Show dialog window with update information for the user. More...

#include <UpdatePopupDialog.h>

Inheritance diagram for UpdatePopupDialog:

Collaboration diagram for UpdatePopupDialog:

Public Member Functions
	UpdatePopupDialog (wxWindow *parent, const VersionPatch &versionPatch, bool configurableNotification)

virtual	~UpdatePopupDialog ()

void	OnUpdate (wxCommandEvent &event)

void	OnSkip (wxCommandEvent &event)

void	OnDontShow (wxCommandEvent &event)

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
HtmlWindow *	AddHtmlContent (wxWindow *parent)

Private Attributes
const VersionPatch &	mVersionPatch

Detailed Description

Show dialog window with update information for the user.

Definition at line 21 of file UpdatePopupDialog.h.

Constructor & Destructor Documentation

◆ UpdatePopupDialog()

UpdatePopupDialog::UpdatePopupDialog	(	wxWindow *	parent,
		const VersionPatch &	versionPatch,
		bool	configurableNotification
	)

explicit

Definition at line 31 of file UpdatePopupDialog.cpp.

    : wxDialogWrapper (parent, -1, XC("Update Audacity", "update dialog"),
        wxDefaultPosition, wxDefaultSize,
        wxCAPTION),
      mVersionPatch(versionPatch)
{
    ShuttleGui S (this, eIsCreating);
    S.SetBorder (5);
    S.StartVerticalLay (wxEXPAND, 1);
    {
        S.AddWindow (AddHtmlContent (S.GetParent()));
 
        S.StartHorizontalLay (wxEXPAND, 0);
        {
            S.SetBorder (5);
 
            if (configurableNotification)
            {
                S.Id(DontShowID).AddCheckBox(
                    XO("Don't show this again at start up"),
                    !DefaultUpdatesCheckingFlag->Read());
            }
 
            S.Prop(1).AddSpace(1, 0, 1);
 
            S.Id (wxID_NO).AddButton (XC ("&Skip", "update dialog"));
            S.Id (wxID_YES).AddButton (XC("&Install update", "update dialog"));
 
            S.SetBorder (5);
        }
        S.EndHorizontalLay();
    }
    S.EndVerticalLay();
 
    Layout();
    Fit();
    Center();
 
    wxSize sz = GetSize();
    const auto maxHeight = std::max(1, wxDisplay().GetGeometry().GetHeight() - 100);
    const auto minHeight = std::min({ sz.y, 600, maxHeight });
    SetSizeHints(sz.x, minHeight, wxDefaultCoord, maxHeight);
}

References DefaultUpdatesCheckingFlag, DontShowID, eIsCreating, min(), S, XC, and XO().

Here is the call graph for this function:

◆ ~UpdatePopupDialog()

UpdatePopupDialog::~UpdatePopupDialog ( )

virtual

Definition at line 75 of file UpdatePopupDialog.cpp.

{
    ;
}

Member Function Documentation

◆ AddHtmlContent()

HtmlWindow * UpdatePopupDialog::AddHtmlContent ( wxWindow * parent )

private

Definition at line 95 of file UpdatePopupDialog.cpp.

{
    wxStringOutputStream o;
    wxTextOutputStream informationStr (o);
 
#if AUDACITY_BUILD_LEVEL == 0
    const auto versionPostfix = " Alpha";
#elif AUDACITY_BUILD_LEVEL == 1
    const auto versionPostfix = " Beta";
#else
    const auto versionPostfix = "";
#endif
 
    informationStr
        << wxT("<html><body><h3>")
        // i18n-hint Substitution of version number for %s.
                   << XC("Audacity %s is available!", "update dialog")
                         .Format(
                            mVersionPatch.version.GetString() + versionPostfix)
                         .Translation()
        << wxT("</h3><h5>")
        << XC("Changelog", "update dialog")
        << wxT("</h5><p>");
 
    informationStr << wxT("<ul>");
    for (auto& logLine : mVersionPatch.changelog)
    {
        informationStr << wxT("<li>");
        // We won't to translate downloaded text.
        informationStr << logLine;
        informationStr << wxT("</li>");
    }
    informationStr << wxT("</ul></p>");
 
    informationStr << wxT("<p>");
    informationStr << wxT("<a href = \"https://github.com/audacity/audacity/releases\">");
    informationStr << XC("Read more on GitHub", "update dialog");
    informationStr << wxT("</a>");
    informationStr << wxT("</p>");
 
    informationStr << wxT("</body></html>");
 
    HtmlWindow* html = safenew LinkingHtmlWindow (parent, -1,
        wxDefaultPosition,
        wxSize (500, -1),
        wxHW_SCROLLBAR_AUTO );
 
    html->SetBorders (20);
    html->SetPage (o.GetString());
 
    wxHtmlContainerCell* cell = html->GetInternalRepresentation();
 
    cell->Layout (500);
 
    const wxSize size = wxSize (500, cell->GetHeight());
 
    html->SetMinSize (size);
    html->SetMaxSize (size);
    html->SetSize (size);
 
    return html;
}

References VersionPatch::changelog, VersionId::GetString(), mVersionPatch, safenew, size, VersionPatch::version, wxT(), and XC.

Here is the call graph for this function:

◆ OnDontShow()

void UpdatePopupDialog::OnDontShow ( wxCommandEvent & event )

Definition at line 90 of file UpdatePopupDialog.cpp.

{
    DefaultUpdatesCheckingFlag->Write(!event.IsChecked());
}

References DefaultUpdatesCheckingFlag.

◆ OnSkip()

void UpdatePopupDialog::OnSkip ( wxCommandEvent & event )

Definition at line 85 of file UpdatePopupDialog.cpp.

{
    EndModal (wxID_NO);
}

◆ OnUpdate()

void UpdatePopupDialog::OnUpdate ( wxCommandEvent & event )

Definition at line 80 of file UpdatePopupDialog.cpp.

{
    EndModal (wxID_YES);
}

Member Data Documentation

◆ mVersionPatch

const VersionPatch& UpdatePopupDialog::mVersionPatch

private

Definition at line 37 of file UpdatePopupDialog.h.

Referenced by AddHtmlContent().

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

Public Member Functions

Private Member Functions

Private Attributes