Warning.cpp File Reference

#include "Warning.h"
#include "ShuttleGui.h"
#include <wx/artprov.h>
#include <wx/checkbox.h>
#include <wx/sizer.h>
#include <wx/stattext.h>
#include "wxPanelWrapper.h"

Include dependency graph for Warning.cpp:

Go to the source code of this file.

Classes
class	WarningDialog
	Gives a warning message, that can be dismissed, with crucially the ability to not see similar warnings again for this session. More...

Functions
const TranslatableString &	DefaultWarningFooter ()
int	ShowWarningDialog (wxWindow *parent, const wxString &internalDialogName, const TranslatableString &message, bool showCancelButton, const TranslatableString &footer)

Function Documentation

DefaultWarningFooter()

const TranslatableString & DefaultWarningFooter

(

)

Definition at line 51 of file Warning.cpp.

{
   static auto result = XXO("Don't show this warning again");
   return result;
}

References XXO().

Here is the call graph for this function:

ShowWarningDialog()

int ShowWarningDialog	(	wxWindow *	parent,
		const wxString &	internalDialogName,
		const TranslatableString &	message,
		bool	showCancelButton = false,
		const TranslatableString &	footer = DefaultWarningFooter()
	)

Displays a warning dialog with a check box. If the user checks the box, the internalDialogName is noted in the preferences. The internalDialogName is never seen by the user; it should be unique to each message.

Definition at line 90 of file Warning.cpp.

{
   auto key = WarningDialogKey(internalDialogName);
   if (!gPrefs->Read(key, (long) true)) {
      return wxID_OK;
   }
 
   WarningDialog dlog(parent, message, footer, showCancelButton);
 
   int retCode = dlog.ShowModal();
   if (retCode == wxID_CANCEL)
      return retCode;
 
   gPrefs->Write(key, (retCode == wxID_YES));
   gPrefs->Flush();
   return wxID_OK;
}

References audacity::BasicSettings::Flush(), gPrefs, key, audacity::BasicSettings::Read(), WarningDialogKey(), and audacity::BasicSettings::Write().

Referenced by anonymous_namespace{DropoutDetector.cpp}::DropoutSubscription::DropoutSubscription().

Here is the call graph for this function:

Here is the caller graph for this function: