anonymous_namespace{HelpMenus.cpp}::QuickFixDialog Class Reference

Class which makes a dialog for displaying quick fixes to common issues. More...

Inheritance diagram for anonymous_namespace{HelpMenus.cpp}::QuickFixDialog:

Collaboration diagram for anonymous_namespace{HelpMenus.cpp}::QuickFixDialog:

Public Types
using	PrefSetter = std::function< void() >

Public Member Functions
	QuickFixDialog (wxWindow *pParent, AudacityProject &project)
void	Populate ()
void	PopulateOrExchange (ShuttleGui &S)
void	AddStuck (ShuttleGui &S, bool &bBool, const PrefSetter &prefSetter, const TranslatableString &Prompt, const ManualPageID &Help)
void	OnOk (wxCommandEvent &event)
void	OnCancel (wxCommandEvent &event)
void	OnHelp (const ManualPageID &Str)
void	OnFix (const PrefSetter &setter, wxWindowID id)
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

Public Attributes
AudacityProject &	mProject
int	mItem
bool	mbSyncLocked
bool	mbInSnapTo
bool	mbSoundActivated

Detailed Description

Class which makes a dialog for displaying quick fixes to common issues.

This class originated with the 'Stuck in a mode' problem, where far too many users get into a mode without realising, and don't know how to get out. It is a band-aid, and we should do more towards a full and proper solution where there are fewer special modes, and they don't persist.

Definition at line 47 of file HelpMenus.cpp.

Member Typedef Documentation

PrefSetter

using anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PrefSetter = std::function< void() >

Definition at line 50 of file HelpMenus.cpp.

Constructor & Destructor Documentation

QuickFixDialog()

anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::QuickFixDialog	(	wxWindow *	pParent,
		AudacityProject &	project
	)

Definition at line 82 of file HelpMenus.cpp.

                                                                           :
      wxDialogWrapper(pParent, wxID_ANY, XO("Do you have these problems?"),
            wxDefaultPosition, wxDefaultSize,
            wxDEFAULT_DIALOG_STYLE )
      , mProject{ project }
{
   mbSyncLocked = SyncLockTracks.Read();
   mbInSnapTo = ProjectSnap(project).GetSnapMode() != SnapMode::SNAP_OFF; gPrefs->Read(wxT("/SnapTo"));
   mbSoundActivated = SoundActivatedRecord.Read();
 
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
 
   Fit();
   auto sz = GetSize();
   SetMinSize( sz );
   SetMaxSize( sz );
 
   // The close button has the cancel id and acts exactly the same as cancel.
   wxButton * pWin = (wxButton*)FindWindowById( wxID_CANCEL );
   if( pWin )
      pWin->SetFocus( );
   Center();
}

References project.

Member Function Documentation

AddStuck()

void anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::AddStuck	(	ShuttleGui &	S,
		bool &	bBool,
		const PrefSetter &	prefSetter,
		const TranslatableString &	Prompt,
		const ManualPageID &	Help
	)

Definition at line 107 of file HelpMenus.cpp.

{
   mItem++;
   wxWindowID id = FixButtonID + mItem;
   if( !bBool)
      return;
 
   S
      .AddFixedText( Prompt );
 
   S
      .Id( id )
      .AddButton( XXO("Fix") )
         ->Bind( wxEVT_BUTTON, [this, prefSetter, id](wxCommandEvent&){
            OnFix( prefSetter, id );
         } );
 
   {
     // Replace standard Help button with smaller icon button.
      // bs->AddButton(safenew wxButton(parent, wxID_HELP));
      auto b = safenew wxBitmapButton(S.GetParent(), HelpButtonID+mItem, theTheme.Bitmap( bmpHelpIcon ));
      b->SetToolTip( _("Help") );
      b->SetLabel(_("Help"));       // for screen readers
      b->Bind( wxEVT_BUTTON, [this, Help](const wxCommandEvent&){
         OnHelp( Help );
      } );
      S.AddWindow( b );
   }
}

References _, ThemeBase::Bitmap(), FixButtonID, HelpButtonID, S, safenew, theTheme, and XXO().

Here is the call graph for this function:

OnCancel()

void anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::OnCancel

(

wxCommandEvent &

event

)

Definition at line 213 of file HelpMenus.cpp.

{
   (void)event;// Compiler food
   EndModal(wxID_CANCEL);
}

OnFix()

void anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::OnFix	(	const PrefSetter &	setter,
		wxWindowID	id
	)

Definition at line 224 of file HelpMenus.cpp.

{
   if ( setter )
      setter();
   
   // Change the label after doing the fix, as the fix may take a second or two.
   auto pBtn = FindWindow(id);
   if( pBtn )
      pBtn->SetLabel( _("Fixed") );
 
   // The close button has the cancel id and acts exactly the same as cancel.
   wxButton * pWin = (wxButton*)FindWindowById( wxID_CANCEL );
   if( pWin )
      pWin->SetFocus( );
}

References _.

OnHelp()

void anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::OnHelp

(

const ManualPageID &

Str

)

Definition at line 219 of file HelpMenus.cpp.

{
   HelpSystem::ShowHelp(this, Str, true);
}

References HelpSystem::ShowHelp().

Here is the call graph for this function:

OnOk()

void anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::OnOk

(

wxCommandEvent &

event

)

Definition at line 207 of file HelpMenus.cpp.

{
   (void)event;// Compiler food
   EndModal(wxID_OK);
}

Populate()

void anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::Populate

(

)

PopulateOrExchange()

void anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 139 of file HelpMenus.cpp.

{
 
   S.StartVerticalLay(1);
   S.StartStatic( XO("Quick Fixes"));
 
   // These aren't all possible modes one can be stuck in, but they are some of them.
   bool bStuckInMode = mbSyncLocked || mbInSnapTo || mbSoundActivated;
 
   if( !bStuckInMode ){
      SetLabel(XO("Nothing to do"));
      S.AddFixedText(XO("No quick, easily fixed problems were found"));
   }
   else {
      S.StartMultiColumn(3, wxALIGN_CENTER);
      {
         mItem = -1;
 
         auto defaultAction =
         [](AudacityProject *pProject, BoolSetting &setting){ return
            [pProject, &setting]{
               setting.Reset();
               gPrefs->Flush();
               // This is overkill (aka slow), as all preferences are
               // reloaded and all
               // toolbars recreated.
               // Overkill probably doesn't matter, as this command is
               // infrequently used.
               DoReloadPreferences( *pProject );
            };
         };
 
         // Use # in the URLs to ensure we go to the online version of help.
         // Local help may well not be installed.
         auto pProject = &mProject;
         AddStuck( S, mbSyncLocked,
            defaultAction( pProject, SyncLockTracks ),
            XO("Clocks on the Tracks"), "Quick_Fix#sync_lock" );
         AddStuck( S, mbInSnapTo,
            [pProject] {
               // Sadly SnapTo has to be handled specially,
               // as it is not part of the standard
               // preference dialogs.
               ProjectSnap::Get( *pProject ).SetSnapMode( SnapMode::SNAP_OFF );
            },
            XO("Can't select precisely"), "Quick_Fix#snap_to" );
         AddStuck( S, mbSoundActivated,
            defaultAction( pProject, SoundActivatedRecord ),
            XO("Recording stops and starts"),
            "Quick_Fix#sound_activated_recording" );
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartHorizontalLay(wxALIGN_CENTER_HORIZONTAL, 0);
      S.AddStandardButtons(eCloseButton + (bStuckInMode ? 0 : eHelpButton));
   S.EndHorizontalLay();
 
   S.EndVerticalLay();
 
   wxButton * pBtn = (wxButton*)FindWindowById( wxID_HELP );
   if( pBtn )
      pBtn->Bind( wxEVT_BUTTON, [this]( const wxCommandEvent & ){
         OnHelp( "Quick_Fix#" );
      } );
}

References DoReloadPreferences(), eCloseButton, eHelpButton, audacity::BasicSettings::Flush(), ProjectSnap::Get(), gPrefs, S, ProjectSnap::SetSnapMode(), SNAP_OFF, SoundActivatedRecord, SyncLockTracks, and XO().

Here is the call graph for this function:

Member Data Documentation

mbInSnapTo

bool anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::mbInSnapTo

Definition at line 68 of file HelpMenus.cpp.

mbSoundActivated

bool anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::mbSoundActivated

Definition at line 69 of file HelpMenus.cpp.

mbSyncLocked

bool anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::mbSyncLocked

Definition at line 67 of file HelpMenus.cpp.

mItem

int anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::mItem

Definition at line 66 of file HelpMenus.cpp.

mProject

AudacityProject& anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::mProject

Definition at line 64 of file HelpMenus.cpp.

---

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

• HelpMenus.cpp