TimeDialog Class Reference

Dialog used to request a time value. More...

#include <TimeDialog.h>

Inheritance diagram for TimeDialog:

Collaboration diagram for TimeDialog:

Public Member Functions
	TimeDialog (wxWindow *parent, const TranslatableString &title, const NumericFormatID &format, const AudacityProject &project, double time, const TranslatableString &prompt=XO("Duration"))
void	SetFormatString (const NumericFormatID &formatString)
void	SetTimeValue (double newTime)
const double	GetTimeValue ()
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
void	PopulateOrExchange (ShuttleGui &S)
bool	TransferDataToWindow () override
bool	TransferDataFromWindow () override
void	OnUpdate (wxCommandEvent &event)

Private Attributes
TranslatableString	mPrompt
NumericFormatID	mFormat
const AudacityProject &	mProject
double	mTime
NumericTextCtrl *	mTimeCtrl

Detailed Description

Dialog used to request a time value.

Definition at line 24 of file TimeDialog.h.

Constructor & Destructor Documentation

TimeDialog()

TimeDialog::TimeDialog	(	wxWindow *	parent,
		const TranslatableString &	title,
		const NumericFormatID &	format,
		const AudacityProject &	project,
		double	time,
		const TranslatableString &	prompt = XO("Duration")
	)

Definition at line 29 of file TimeDialog.cpp.

:  wxDialogWrapper(parent, wxID_ANY, title),
   mPrompt(prompt),
   mFormat(format),
   mProject(project),
   mTime(time),
   mTimeCtrl(NULL)
{
   SetName();
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References eIsCreating, and S.

Member Function Documentation

GetTimeValue()

const double TimeDialog::GetTimeValue

(

)

Definition at line 94 of file TimeDialog.cpp.

{
   return mTime;
}

References mTime.

Referenced by SelectUtilities::OnSetRegion().

Here is the caller graph for this function:

OnUpdate()

void TimeDialog::OnUpdate ( wxCommandEvent &  event )

private

Definition at line 112 of file TimeDialog.cpp.

{
   Layout();
   Refresh();
 
   event.Skip(false);
}

PopulateOrExchange()

void TimeDialog::PopulateOrExchange ( ShuttleGui &  S )

private

Definition at line 47 of file TimeDialog.cpp.

{
   S.SetBorder(5);
   S.StartVerticalLay(true);
   {
      S.StartStatic(mPrompt, true);
      {
         mTimeCtrl = safenew
            NumericTextCtrl(
                         FormatterContext::ProjectContext(mProject),
                         S.GetParent(), wxID_ANY,
                         NumericConverterType_TIME(),
                         mFormat,
                         mTime,
                         NumericTextCtrl::Options{}
                            .AutoPos(true));
         S.AddWindow(mTimeCtrl);
      }
      S.EndStatic();
   }
   S.EndVerticalLay();
   S.AddStandardButtons();
 
   TransferDataToWindow();
 
   Layout();
   Fit();
   SetMinSize(GetSize());
   Center();
}

References NumericTextCtrl::Options::AutoPos(), mFormat, mProject, mPrompt, mTime, mTimeCtrl, NumericConverterType_TIME(), FormatterContext::ProjectContext(), S, safenew, and TransferDataToWindow().

Here is the call graph for this function:

SetFormatString()

void TimeDialog::SetFormatString

(

const NumericFormatID &

formatString

)

Definition at line 99 of file TimeDialog.cpp.

{
   mFormat = formatString;
   TransferDataToWindow();
}

References mFormat, and TransferDataToWindow().

Here is the call graph for this function:

SetTimeValue()

void TimeDialog::SetTimeValue

(

double

newTime

)

Definition at line 106 of file TimeDialog.cpp.

{
   mTime = newTime;
   TransferDataToWindow();
}

References mTime, and TransferDataToWindow().

Here is the call graph for this function:

TransferDataFromWindow()

bool TimeDialog::TransferDataFromWindow ( )

overrideprivate

Definition at line 87 of file TimeDialog.cpp.

{
   mTime = mTimeCtrl->GetValue();
 
   return true;
}

References NumericConverter::GetValue(), mTime, and mTimeCtrl.

Here is the call graph for this function:

TransferDataToWindow()

bool TimeDialog::TransferDataToWindow ( )

overrideprivate

Definition at line 78 of file TimeDialog.cpp.

{
   mTimeCtrl->SetFormatName(mFormat);
   mTimeCtrl->SetValue(mTime);
   mTimeCtrl->SetFocus();
 
   return true;
}

References mFormat, mTime, mTimeCtrl, NumericTextCtrl::SetFormatName(), and NumericTextCtrl::SetValue().

Referenced by PopulateOrExchange(), SetFormatString(), and SetTimeValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mFormat

NumericFormatID TimeDialog::mFormat

private

Definition at line 50 of file TimeDialog.h.

Referenced by PopulateOrExchange(), SetFormatString(), and TransferDataToWindow().

mProject

const AudacityProject& TimeDialog::mProject

private

Definition at line 51 of file TimeDialog.h.

Referenced by PopulateOrExchange().

mPrompt

TranslatableString TimeDialog::mPrompt

private

Definition at line 49 of file TimeDialog.h.

Referenced by PopulateOrExchange().

mTime

double TimeDialog::mTime

private

Definition at line 52 of file TimeDialog.h.

Referenced by GetTimeValue(), PopulateOrExchange(), SetTimeValue(), TransferDataFromWindow(), and TransferDataToWindow().

mTimeCtrl

NumericTextCtrl* TimeDialog::mTimeCtrl

private

Definition at line 54 of file TimeDialog.h.

Referenced by PopulateOrExchange(), TransferDataFromWindow(), and TransferDataToWindow().

---

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

• TimeDialog.h
• TimeDialog.cpp