SplashDialog Class Reference

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

#include <SplashDialog.h>

Inheritance 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 wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const wxString &name=_("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const wxString &name=_("Dialog"))
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	Show2 (wxWindow *pParent)

Private Member Functions
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 26 of file SplashDialog.h.

Constructor & Destructor Documentation

SplashDialog::SplashDialog

(

wxWindow *

parent

)

Definition at line 67 of file SplashDialog.cpp.

References eIsCreating.

Referenced by Show2().

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

SplashDialog::~SplashDialog ( )

virtual

Definition at line 144 of file SplashDialog.cpp.

{
}

Member Function Documentation

void SplashDialog::OnDontShow ( wxCommandEvent &  Evt )

private

Definition at line 148 of file SplashDialog.cpp.

References gPrefs.

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

void SplashDialog::OnOK

(

wxCommandEvent &

event

)

Definition at line 155 of file SplashDialog.cpp.

{
   Show( false );

}

void SplashDialog::Populate ( ShuttleGui &  S )

private

Definition at line 83 of file SplashDialog.cpp.

References _(), ShuttleGuiBase::AddCheckBox(), ShuttleGuiBase::AddWindow(), DontShowID, ShuttleGuiBase::EndVerticalLay(), ShuttleGuiBase::GetParent(), gPrefs, HelpText(), ShuttleGui::Id(), LOGOWITHNAME_HEIGHT, LOGOWITHNAME_WIDTH, m_pLogo, mpHtml, ShuttleGui::Prop(), safenew, ShuttleGuiBase::SetBorder(), ShuttleGuiBase::SetStretchyCol(), ShuttleGuiBase::StartMultiColumn(), and ShuttleGuiBase::StartVerticalLay().

{
   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).AddWindow( icon );

#if  (0)
   icon->Bind(wxEVT_LEFT_DOWN,
              [this]( wxMouseEvent const & event ) ->void {
                 if ( event.ShiftDown() && event.ControlDown())
                    wxLaunchDefaultBrowser("https://www.audacityteam.org");
              }
         );
#endif

   mpHtml = safenew LinkingHtmlWindow(S.GetParent(), -1,
                                         wxDefaultPosition,
                                         wxSize(506, 280),
                                         wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER );
   mpHtml->SetPage(HelpText( wxT("welcome") ));
   S.Prop(1).AddWindow( mpHtml, wxEXPAND );
   S.Prop(0).StartMultiColumn(2, wxEXPAND);
   S.SetStretchyCol( 1 );// Column 1 is stretchy...
   {
      S.SetBorder( 5 );
      S.Id( DontShowID).AddCheckBox( _("Don't show this again at start up"), bShow ? wxT("false") : wxT("true") );
      wxButton *ok = safenew wxButton(S.GetParent(), wxID_OK);
      ok->SetDefault();
      S.SetBorder( 5 );
      S.Prop(0).AddWindow( ok, wxALIGN_RIGHT| wxALL );
   }
   S.EndVerticalLay();
}

void SplashDialog::Show2 ( wxWindow *  pParent )

static

Definition at line 161 of file SplashDialog.cpp.

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

Referenced by AudacityProject::OnHelpWelcome().

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

Member Data Documentation

std::unique_ptr<wxBitmap> SplashDialog::m_pLogo

private

Definition at line 42 of file SplashDialog.h.

Referenced by Populate().

HtmlWindow* SplashDialog::mpHtml

private

Definition at line 41 of file SplashDialog.h.

Referenced by Populate(), and Show2().

SplashDialog * SplashDialog::pSelf =NULL

staticprivate

Definition at line 43 of file SplashDialog.h.

Referenced by Show2().

---

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

• SplashDialog.h
• SplashDialog.cpp