HistoryDialog Class Reference

Works with UndoManager to allow user to see descriptions of and undo previous commands. Also allows you to selectively clear the undo memory so as to free up space. More...

#include <HistoryWindow.h>

Inheritance diagram for HistoryDialog:

Collaboration diagram for HistoryDialog:

Public Member Functions
	HistoryDialog (AudacityProject *parent, UndoManager *manager)
void	UpdateDisplayForClipboard (struct ClipboardChangeMessage)
void	UpdateDisplay (struct UndoRedoMessage)
void	DoUpdateDisplay ()
bool	Show (bool show=true) 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
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Private Member Functions
void	Populate (ShuttleGui &S)
void	OnAudioIO (AudioIOEvent)
void	DoUpdate ()
void	UpdateLevels ()
void	OnShow (wxShowEvent &event)
void	OnSize (wxSizeEvent &event)
void	OnCloseWindow (wxCloseEvent &event)
void	OnListKeyDown (wxKeyEvent &event)
void	OnItemSelected (wxListEvent &event)
void	OnDiscard (wxCommandEvent &event)
void	OnDiscardClipboard (wxCommandEvent &event)
void	OnCompact (wxCommandEvent &event)
void	OnGetURL (wxCommandEvent &event)
void	UpdatePrefs () override

Private Attributes
Observer::Subscription	mAudioIOSubscription
Observer::Subscription	mUndoSubscription
Observer::Subscription	mClipboardSubscription
AudacityProject *	mProject
UndoManager *	mManager
wxListCtrl *	mList
wxTextCtrl *	mTotal
wxTextCtrl *	mClipboard
wxTextCtrl *	mAvail
wxSpinCtrl *	mLevels
wxButton *	mDiscard
wxButton *	mCompact
int	mSelected
bool	mAudioIOBusy

Additional Inherited Members
Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Detailed Description

Works with UndoManager to allow user to see descriptions of and undo previous commands. Also allows you to selectively clear the undo memory so as to free up space.

Definition at line 28 of file HistoryWindow.h.

Constructor & Destructor Documentation

HistoryDialog()

HistoryDialog::HistoryDialog	(	AudacityProject *	parent,
		UndoManager *	manager
	)

Definition at line 136 of file HistoryWindow.cpp.

                                                                         :
   wxDialogWrapper(FindProjectFrame( parent ), wxID_ANY, HistoryTitle,
      wxDefaultPosition, wxDefaultSize,
      wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER )
{
   SetName();
 
   mManager = manager;
   mProject = parent;
   mSelected = 0;
   mAudioIOBusy = false;
 
   //------------------------- Main section --------------------
   // Construct the GUI.
   ShuttleGui S(this, eIsCreating);
   Populate(S);
 
   mAudioIOSubscription = AudioIO::Get()->Subscribe(*this, &HistoryDialog::OnAudioIO);
 
   mClipboardSubscription = Clipboard::Get()
      .Subscribe(*this, &HistoryDialog::UpdateDisplayForClipboard);
 
   if (parent)
      mUndoSubscription = UndoManager::Get(*parent)
         .Subscribe(*this, &HistoryDialog::UpdateDisplay);
}

References eIsCreating, AudioIO::Get(), Clipboard::Get(), UndoManager::Get(), manager, mAudioIOBusy, mAudioIOSubscription, mClipboardSubscription, mManager, mProject, mSelected, mUndoSubscription, OnAudioIO(), Populate(), S, wxDialogWrapper::SetName(), Observer::Publisher< Message, NotifyAll >::Subscribe(), UpdateDisplay(), and UpdateDisplayForClipboard().

Here is the call graph for this function:

Member Function Documentation

DoUpdate()

void HistoryDialog::DoUpdate ( )

private

Definition at line 284 of file HistoryWindow.cpp.

{
   int i = 0;
 
   SpaceUsageCalculator calculator;
   calculator.Calculate( *mManager );
 
   // point to size for oldest state
   auto iter = calculator.space.rbegin();
 
   mList->DeleteAllItems();
 
   wxLongLong_t total = 0;
   mSelected = mManager->GetCurrentState();
   mManager->VisitStates(
      [&]( const UndoStackElem &elem ){
         const auto space = *iter++;
         total += space;
         const auto size = Internat::FormatSize(space);
         const auto &desc = elem.description;
         mList->InsertItem(i, desc.Translation(), i == mSelected ? 1 : 0);
         mList->SetItem(i, 1, size.Translation());
         ++i;
      },
      false // oldest state first
   );
 
   mTotal->SetValue(Internat::FormatSize(total).Translation());
 
   auto clipboardUsage = calculator.clipboardSpaceUsage;
   mClipboard->SetValue(Internat::FormatSize(clipboardUsage).Translation());
#if defined(ALLOW_DISCARD)
   FindWindowById(ID_DISCARD_CLIPBOARD)->Enable(clipboardUsage > 0);
#endif
 
   mList->EnsureVisible(mSelected);
 
   mList->SetItemState(mSelected,
                       wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED,
                       wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED);
 
   UpdateLevels();
}

References anonymous_namespace{ExportPCM.cpp}::desc, UndoStackElem::description, Internat::FormatSize(), UndoManager::GetCurrentState(), ID_DISCARD_CLIPBOARD, mClipboard, mList, mManager, mSelected, mTotal, size, TranslatableString::Translation(), UpdateLevels(), and UndoManager::VisitStates().

Referenced by DoUpdateDisplay(), OnDiscard(), and Show().

Here is the call graph for this function:

Here is the caller graph for this function:

DoUpdateDisplay()

void HistoryDialog::DoUpdateDisplay

(

)

Definition at line 271 of file HistoryWindow.cpp.

{
   if(IsShown())
      DoUpdate();
}

References DoUpdate().

Referenced by UpdateDisplay(), and UpdateDisplayForClipboard().

Here is the call graph for this function:

Here is the caller graph for this function:

OnAudioIO()

void HistoryDialog::OnAudioIO ( AudioIOEvent  evt )

private

Definition at line 239 of file HistoryWindow.cpp.

{
   if (evt.type == AudioIOEvent::MONITOR)
      return;
   mAudioIOBusy = evt.on;
 
#if defined(ALLOW_DISCARD)
   mDiscard->Enable(!mAudioIOBusy);
   mCompact->Enable(!mAudioIOBusy);
#endif
}

References mAudioIOBusy, mCompact, mDiscard, AudioIOEvent::MONITOR, AudioIOEvent::on, and AudioIOEvent::type.

Referenced by HistoryDialog().

Here is the caller graph for this function:

OnCloseWindow()

void HistoryDialog::OnCloseWindow ( wxCloseEvent &  event )

private

Definition at line 449 of file HistoryWindow.cpp.

{
   this->Show(false);
}

References Show().

Here is the call graph for this function:

OnCompact()

void HistoryDialog::OnCompact ( wxCommandEvent &  event )

private

Definition at line 376 of file HistoryWindow.cpp.

{
   auto &projectFileIO = ProjectFileIO::Get(*mProject);
 
   projectFileIO.ReopenProject();
 
   auto baseFile = wxFileName(projectFileIO.GetFileName());
   auto walFile = wxFileName(projectFileIO.GetFileName() + wxT("-wal"));
   auto before = baseFile.GetSize() + walFile.GetSize();
 
   projectFileIO.Compact({}, true);
 
   auto after = baseFile.GetSize() + walFile.GetSize();
 
   AudacityMessageBox(
      XO("Compacting actually freed %s of disk space.")
      .Format(Internat::FormatSize((before - after).GetValue())),
      XO("History"));
}

References AudacityMessageBox(), Internat::FormatSize(), ProjectFileIO::Get(), mProject, wxT(), and XO().

Here is the call graph for this function:

OnDiscard()

void HistoryDialog::OnDiscard ( wxCommandEvent &  event )

private

Definition at line 357 of file HistoryWindow.cpp.

{
   int i = mLevels->GetValue();
 
   mSelected -= i;
   mManager->RemoveStates(0, i);
   ProjectHistory::Get( *mProject ).SetStateTo(mSelected);
 
   while(--i >= 0)
      mList->DeleteItem(i);
 
   DoUpdate();
}

References DoUpdate(), ProjectHistory::Get(), mLevels, mList, mManager, mSelected, UndoManager::RemoveStates(), and ProjectHistory::SetStateTo().

Here is the call graph for this function:

OnDiscardClipboard()

void HistoryDialog::OnDiscardClipboard ( wxCommandEvent &  event )

private

Definition at line 371 of file HistoryWindow.cpp.

{
   Clipboard::Get().Clear();
}

References Clipboard::Clear(), and Clipboard::Get().

Here is the call graph for this function:

OnGetURL()

void HistoryDialog::OnGetURL ( wxCommandEvent &  event )

private

Definition at line 396 of file HistoryWindow.cpp.

{
   HelpSystem::ShowHelp(this, L"Undo,_Redo_and_History");
}

References HelpSystem::ShowHelp().

Here is the call graph for this function:

OnItemSelected()

void HistoryDialog::OnItemSelected ( wxListEvent &  event )

private

Definition at line 401 of file HistoryWindow.cpp.

{
   if (mAudioIOBusy) {
      mList->SetItemState(mSelected,
                       wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED,
                       wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED);
      return;
   }
 
   int selected = event.GetIndex();
   int i;
 
   for (i = 0; i < mList->GetItemCount(); i++) {
      mList->SetItemImage(i, 0);
      if (i > selected)
         mList->SetItemTextColour(i, *wxLIGHT_GREY);
      else
         mList->SetItemTextColour(i, mList->GetTextColour());
   }
   mList->SetItemImage(selected, 1);
 
   // Do not do a SetStateTo() if we're not actually changing the selected
   // entry.  Doing so can cause unnecessary delays upon initial load or while
   // clicking the same entry over and over.
   if (selected != mSelected) {
      ProjectHistory::Get( *mProject ).SetStateTo(selected);
   }
   mSelected = selected;
 
   UpdateLevels();
}

References ProjectHistory::Get(), mAudioIOBusy, mList, mSelected, ProjectHistory::SetStateTo(), and UpdateLevels().

Here is the call graph for this function:

OnListKeyDown()

void HistoryDialog::OnListKeyDown ( wxKeyEvent &  event )

private

Definition at line 433 of file HistoryWindow.cpp.

{
   switch (event.GetKeyCode())
   {
      case WXK_RETURN:
         // Don't know why wxListCtrls prevent default dialog action,
         // but they do, so handle it.
         EmulateButtonClickIfPresent(GetAffirmativeId());
      break;
 
      default:
         event.Skip();
      break;
   }
}

Referenced by Populate().

Here is the caller graph for this function:

OnShow()

void HistoryDialog::OnShow ( wxShowEvent &  event )

private

Definition at line 454 of file HistoryWindow.cpp.

{
   if (event.IsShown())
   {
      mList->SetFocus();
   }
}

References mList.

OnSize()

void HistoryDialog::OnSize ( wxSizeEvent &  event )

private

Definition at line 462 of file HistoryWindow.cpp.

{
   Layout();
   mList->SetColumnWidth(0, mList->GetClientSize().x - mList->GetColumnWidth(1));
   if (mList->GetItemCount() > 0)
      mList->EnsureVisible(mSelected);
}

References mList, and mSelected.

Populate()

void HistoryDialog::Populate ( ShuttleGui &  S )

private

Definition at line 163 of file HistoryWindow.cpp.

{
   auto imageList = std::make_unique<wxImageList>(9, 16);
   imageList->Add(wxIcon(empty9x16_xpm));
   imageList->Add(wxIcon(arrow_xpm));
 
   S.SetBorder(5);
   S.StartVerticalLay(true);
   {
      S.StartStatic(XO("&Manage History"), 1);
      {
         mList = S
            .MinSize()
            .ConnectRoot(wxEVT_KEY_DOWN, &HistoryDialog::OnListKeyDown)
            .AddListControlReportMode(
               { { XO("Action"), wxLIST_FORMAT_LEFT, 260 },
                 { XO("Used Space"), wxLIST_FORMAT_LEFT, 125 } },
               wxLC_SINGLE_SEL
            );
 
         //Assign rather than set the image list, so that it is deleted later.
         // AssignImageList takes ownership
         mList->AssignImageList(imageList.release(), wxIMAGE_LIST_SMALL);
 
         S.StartMultiColumn(3, wxCENTRE);
         {
            S.AddPrompt(XXO("&Total space used"));
            mTotal = S.Id(ID_TOTAL).Style(wxTE_READONLY).AddTextBox({}, wxT(""), 10);
            S.AddVariableText( {} )->Hide();
 
#if defined(ALLOW_DISCARD)
            S.AddPrompt(XXO("&Undo levels available"));
            mAvail = S.Id(ID_AVAIL).Style(wxTE_READONLY).AddTextBox({}, wxT(""), 10);
            S.AddVariableText( {} )->Hide();
 
            S.AddPrompt(XXO("&Levels to discard"));
            mLevels = safenew wxSpinCtrl(S.GetParent(),
                                     ID_LEVELS,
                                     wxT("1"),
                                     wxDefaultPosition,
                                     wxDefaultSize,
                                     wxSP_ARROW_KEYS,
                                     0,
                                     mManager->GetCurrentState(),
                                     0);
            S.AddWindow(mLevels);
            /* i18n-hint: (verb)*/
            mDiscard = S.Id(ID_DISCARD).AddButton(XXO("&Discard"));
#endif
            S.AddPrompt(XXO("Clip&board space used"));
            mClipboard = S.Style(wxTE_READONLY).AddTextBox({}, wxT(""), 10);
 
#if defined(ALLOW_DISCARD)
            S.Id(ID_DISCARD_CLIPBOARD).AddButton(XXO("D&iscard"));
#endif
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
#if defined(ALLOW_DISCARD)
      mCompact = safenew wxButton(this, ID_COMPACT, _("&Compact"));
      S.AddStandardButtons(eOkButton | eHelpButton, mCompact);
#else
      S.AddStandardButtons(eOkButton | eHelpButton);
#endif
   }
   S.EndVerticalLay();
   // ----------------------- End of main section --------------
 
   Layout();
   Fit();
   SetMinSize(GetSize());
   mList->SetColumnWidth(0, mList->GetClientSize().x - mList->GetColumnWidth(1));
   mList->SetTextColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT));
}

References _, eHelpButton, eOkButton, UndoManager::GetCurrentState(), ID_AVAIL, ID_COMPACT, ID_DISCARD, ID_DISCARD_CLIPBOARD, ID_LEVELS, ID_TOTAL, mAvail, mClipboard, mCompact, mDiscard, mLevels, mList, mManager, mTotal, OnListKeyDown(), S, safenew, wxT(), XO(), and XXO().

Referenced by HistoryDialog(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

Show()

bool HistoryDialog::Show ( bool  show = true )

override

Definition at line 277 of file HistoryWindow.cpp.

{
   if ( show && !IsShown())
      DoUpdate();
   return wxDialogWrapper::Show( show );
}

References DoUpdate(), and ExportProgressUI::Show().

Referenced by OnCloseWindow(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateDisplay()

void HistoryDialog::UpdateDisplay

(

struct UndoRedoMessage

message

)

Definition at line 256 of file HistoryWindow.cpp.

{
   switch (message.type) {
   case UndoRedoMessage::Pushed:
   case UndoRedoMessage::Modified:
   case UndoRedoMessage::UndoOrRedo:
   case UndoRedoMessage::Reset:
   case UndoRedoMessage::Purge:
      break;
   default:
      return;
   }
   DoUpdateDisplay();
}

References DoUpdateDisplay(), UndoRedoMessage::Modified, UndoRedoMessage::Purge, UndoRedoMessage::Pushed, UndoRedoMessage::Reset, UndoRedoMessage::type, and UndoRedoMessage::UndoOrRedo.

Referenced by HistoryDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateDisplayForClipboard()

void HistoryDialog::UpdateDisplayForClipboard

(

struct ClipboardChangeMessage

)

Definition at line 251 of file HistoryWindow.cpp.

{
   DoUpdateDisplay();
}

References DoUpdateDisplay().

Referenced by HistoryDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateLevels()

void HistoryDialog::UpdateLevels ( )

private

Definition at line 328 of file HistoryWindow.cpp.

{
#if defined(ALLOW_DISCARD)
   wxWindow *focus;
   int value = mLevels->GetValue();
 
   if (value > mSelected) {
      value = mSelected;
   }
 
   if (value == 0) {
      value = 1;
   }
 
   mLevels->SetValue(value);
   mLevels->SetRange(1, mSelected);
 
   mAvail->SetValue(wxString::Format(wxT("%d"), mSelected));
 
   focus = FindFocus();
   if ((focus == mDiscard || focus == mLevels) && mSelected == 0) {
      mList->SetFocus();
   }
 
   mLevels->Enable(mSelected > 0);
   mDiscard->Enable(!mAudioIOBusy && mSelected > 0);
#endif
}

References BasicUI::FindFocus(), mAudioIOBusy, mAvail, mDiscard, mLevels, mList, mSelected, and wxT().

Referenced by DoUpdate(), and OnItemSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdatePrefs()

void HistoryDialog::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 471 of file HistoryWindow.cpp.

{
   bool shown = IsShown();
   if (shown) {
      Show(false);
   }
 
   SetSizer(nullptr);
   DestroyChildren();
 
   SetTitle(HistoryTitle);
   ShuttleGui S(this, eIsCreating);
   Populate(S);
 
   if (shown) {
      Show(true);
   }
}

References eIsCreating, HistoryTitle, Populate(), S, wxDialogWrapper::SetTitle(), and Show().

Here is the call graph for this function:

Member Data Documentation

mAudioIOBusy

bool HistoryDialog::mAudioIOBusy

private

Definition at line 77 of file HistoryWindow.h.

Referenced by HistoryDialog(), OnAudioIO(), OnItemSelected(), and UpdateLevels().

mAudioIOSubscription

Observer::Subscription HistoryDialog::mAudioIOSubscription

private

Definition at line 61 of file HistoryWindow.h.

Referenced by HistoryDialog().

mAvail

wxTextCtrl* HistoryDialog::mAvail

private

Definition at line 71 of file HistoryWindow.h.

Referenced by Populate(), and UpdateLevels().

mClipboard

wxTextCtrl* HistoryDialog::mClipboard

private

Definition at line 70 of file HistoryWindow.h.

Referenced by DoUpdate(), and Populate().

mClipboardSubscription

Observer::Subscription HistoryDialog::mClipboardSubscription

private

Definition at line 63 of file HistoryWindow.h.

Referenced by HistoryDialog().

mCompact

wxButton* HistoryDialog::mCompact

private

Definition at line 74 of file HistoryWindow.h.

Referenced by OnAudioIO(), and Populate().

mDiscard

wxButton* HistoryDialog::mDiscard

private

Definition at line 73 of file HistoryWindow.h.

Referenced by OnAudioIO(), Populate(), and UpdateLevels().

mLevels

wxSpinCtrl* HistoryDialog::mLevels

private

Definition at line 72 of file HistoryWindow.h.

Referenced by OnDiscard(), Populate(), and UpdateLevels().

mList

wxListCtrl* HistoryDialog::mList

private

Definition at line 68 of file HistoryWindow.h.

Referenced by DoUpdate(), OnDiscard(), OnItemSelected(), OnShow(), OnSize(), Populate(), and UpdateLevels().

mManager

UndoManager* HistoryDialog::mManager

private

Definition at line 67 of file HistoryWindow.h.

Referenced by DoUpdate(), HistoryDialog(), OnDiscard(), and Populate().

mProject

AudacityProject* HistoryDialog::mProject

private

Definition at line 66 of file HistoryWindow.h.

Referenced by HistoryDialog(), and OnCompact().

mSelected

int HistoryDialog::mSelected

private

Definition at line 76 of file HistoryWindow.h.

Referenced by DoUpdate(), HistoryDialog(), OnDiscard(), OnItemSelected(), OnSize(), and UpdateLevels().

mTotal

wxTextCtrl* HistoryDialog::mTotal

private

Definition at line 69 of file HistoryWindow.h.

Referenced by DoUpdate(), and Populate().

mUndoSubscription

Observer::Subscription HistoryDialog::mUndoSubscription

private

Definition at line 62 of file HistoryWindow.h.

Referenced by HistoryDialog().

---

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

• HistoryWindow.h
• HistoryWindow.cpp