SplashDialog Class Reference

The SplashDialog shows help information for Audacity when Audacity starts up. More...

#include <SplashDialog.h>

Inheritance diagram for SplashDialog:

Collaboration diagram for SplashDialog:

Public Member Functions
	SplashDialog (wxWindow *parent)
virtual	~SplashDialog ()
void	OnOK (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

Static Public Member Functions
static void	DoHelpWelcome (AudacityProject &project)
static void	Show2 (wxWindow *pParent)

Private Member Functions
void	OnChar (wxMouseEvent &event)
void	Populate (ShuttleGui &S)
void	OnDontShow (wxCommandEvent &Evt)

Private Attributes
HtmlWindow *	mpHtml
std::unique_ptr< wxBitmap >	m_pLogo

Static Private Attributes
static SplashDialog *	pSelf =NULL

Detailed Description

The SplashDialog shows help information for Audacity when Audacity starts up.

It was written for the benefit of NEW users who do not want to read the manual. The text of the dialog is kept short to increase the chance of it being read. The content is designed to reduce the most commonly asked questions about Audacity.

Definition at line 21 of file SplashDialog.h.

Constructor & Destructor Documentation

SplashDialog()

SplashDialog::SplashDialog

(

wxWindow *

parent

)

Definition at line 102 of file SplashDialog.cpp.

   :  wxDialogWrapper(parent, -1, XO("Welcome to Audacity!"),
      wxPoint( -1, 60 ), // default x position, y position 60 pixels from top of screen.
      wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
{
   SetName();
   m_pLogo = NULL; //v
   ShuttleGui S( this, eIsCreating );
   Populate( S );
   Fit();
   this->Centre();
   int x,y;
   GetPosition( &x, &y );
   Move( x, 60 );
}

References eIsCreating, m_pLogo, Populate(), S, and wxDialogWrapper::SetName().

Referenced by Show2().

Here is the call graph for this function:

Here is the caller graph for this function:

~SplashDialog()

SplashDialog::~SplashDialog ( )

virtual

Definition at line 182 of file SplashDialog.cpp.

{
}

Member Function Documentation

DoHelpWelcome()

void SplashDialog::DoHelpWelcome ( AudacityProject &  project )

static

Definition at line 97 of file SplashDialog.cpp.

{
   Show2( &GetProjectFrame( project ) );
}

References GetProjectFrame().

Referenced by AudacityApp::InitPart2().

Here is the call graph for this function:

Here is the caller graph for this function:

OnChar()

void SplashDialog::OnChar ( wxMouseEvent &  event )

private

Definition at line 118 of file SplashDialog.cpp.

{
   if ( event.ShiftDown() && event.ControlDown() )
      wxLaunchDefaultBrowser("https://www.audacityteam.org");
}

Referenced by Populate().

Here is the caller graph for this function:

OnDontShow()

void SplashDialog::OnDontShow ( wxCommandEvent &  Evt )

private

Definition at line 186 of file SplashDialog.cpp.

{
   bool bShow = !Evt.IsChecked();
   gPrefs->Write(wxT("/GUI/ShowSplashScreen"), bShow );
   gPrefs->Flush();
}

References FileConfig::Flush(), gPrefs, and wxT().

Here is the call graph for this function:

OnOK()

void SplashDialog::OnOK

(

wxCommandEvent &

event

)

Definition at line 193 of file SplashDialog.cpp.

{
   Show( false );
 
}

Populate()

void SplashDialog::Populate ( ShuttleGui &  S )

private

Definition at line 124 of file SplashDialog.cpp.

{
   bool bShow;
   gPrefs->Read(wxT("/GUI/ShowSplashScreen"), &bShow, true );
   S.StartVerticalLay(1);
 
   //v For now, change to AudacityLogoWithName via old-fashioned ways, not Theme.
   m_pLogo = std::make_unique<wxBitmap>((const char **) AudacityLogoWithName_xpm); //v
 
 
   // JKC: Resize to 50% of size.  Later we may use a smaller xpm as
   // our source, but this allows us to tweak the size - if we want to.
   // It also makes it easier to revert to full size if we decide to.
   const float fScale=0.5f;// smaller size.
   wxImage RescaledImage( m_pLogo->ConvertToImage() );
   wxColour MainColour( 
      RescaledImage.GetRed(1,1), 
      RescaledImage.GetGreen(1,1), 
      RescaledImage.GetBlue(1,1));
   this->SetBackgroundColour(MainColour);
 
   // wxIMAGE_QUALITY_HIGH not supported by wxWidgets 2.6.1, or we would use it here.
   RescaledImage.Rescale( (int)(LOGOWITHNAME_WIDTH * fScale), (int)(LOGOWITHNAME_HEIGHT *fScale) );
   wxBitmap RescaledBitmap( RescaledImage );
   wxStaticBitmap *const icon =
       safenew wxStaticBitmap(S.GetParent(), -1,
                          //*m_pLogo, //v theTheme.Bitmap(bmpAudacityLogoWithName),
                          RescaledBitmap,
                          wxDefaultPosition,
                          wxSize((int)(LOGOWITHNAME_WIDTH*fScale), (int)(LOGOWITHNAME_HEIGHT*fScale)));
 
   S.Prop(0)
#if  (0)
      .ConnectRoot( wxEVT_LEFT_DOWN, &SplashDialog::OnChar)
#endif
      .AddWindow( icon );
 
   mpHtml = safenew LinkingHtmlWindow(S.GetParent(), -1,
                                         wxDefaultPosition, wxSize(506, HTMLWindowHeight),
                                         wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER );
   mpHtml->SetPage(HelpText( wxT("welcome") ));
   S.Prop(1)
      .Position( wxEXPAND )
      .AddWindow( mpHtml );
   S.Prop(0).StartMultiColumn(2, wxEXPAND);
   S.SetStretchyCol( 1 );// Column 1 is stretchy...
   {
      S.SetBorder( 5 );
      S.Id( DontShowID).AddCheckBox( XXO("Don't show this again at start up"), !bShow );
      S.SetBorder( 5 );
 
      S.Id(wxID_OK)
         .Prop(0)
         .AddButton(XXO("OK"), wxALIGN_RIGHT| wxALL, true);
   }
   S.EndVerticalLay();
}

References DontShowID, gPrefs, HelpText(), HTMLWindowHeight, LOGOWITHNAME_HEIGHT, LOGOWITHNAME_WIDTH, m_pLogo, mpHtml, OnChar(), S, safenew, wxImage(), wxT(), and XXO().

Referenced by SplashDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

Show2()

void SplashDialog::Show2 ( wxWindow *  pParent )

static

Definition at line 199 of file SplashDialog.cpp.

{
#ifdef HAS_WHATS_NEW
   FSHelper helper;
#endif // HAS_WHATS_NEW
 
   if( pSelf == NULL )
   {
      // pParent owns it
      wxASSERT(pParent);
      pSelf = safenew SplashDialog( pParent );
   }
   pSelf->mpHtml->SetPage(HelpText( wxT("welcome") ));
   pSelf->Show( true );
}

References HelpText(), mpHtml, pSelf, safenew, SplashDialog(), and wxT().

Here is the call graph for this function:

Member Data Documentation

m_pLogo

std::unique_ptr<wxBitmap> SplashDialog::m_pLogo

private

Definition at line 41 of file SplashDialog.h.

Referenced by Populate(), and SplashDialog().

mpHtml

HtmlWindow* SplashDialog::mpHtml

private

Definition at line 40 of file SplashDialog.h.

Referenced by Populate(), and Show2().

pSelf

SplashDialog * SplashDialog::pSelf =NULL

staticprivate

Definition at line 42 of file SplashDialog.h.

Referenced by Show2().

---

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

• SplashDialog.h
• SplashDialog.cpp