BrowserDialog Class Reference

Adds some event handling to an HtmlWindow. More...

#include <HelpSystem.h>

Inheritance diagram for BrowserDialog:

Collaboration diagram for BrowserDialog:

Public Types
enum	{ ID = 0 }

Public Member Functions
	BrowserDialog (wxWindow *pParent, const TranslatableString &title)
void	OnForward (wxCommandEvent &event)
void	OnBackward (wxCommandEvent &event)
void	OnClose (wxCommandEvent &event)
void	OnKeyDown (wxKeyEvent &event)
void	UpdateButtons ()
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
HtmlWindow *	mpHtml
bool	mDismissed {}

Detailed Description

Adds some event handling to an HtmlWindow.

Definition at line 139 of file HelpSystem.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
ID

Definition at line 142 of file HelpSystem.h.

{ ID = 0 };

Constructor & Destructor Documentation

BrowserDialog()

BrowserDialog::BrowserDialog	(	wxWindow *	pParent,
		const TranslatableString &	title
	)

Definition at line 428 of file HelpSystem.cpp.

   : wxDialogWrapper{ pParent, ID, title, wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER /*| wxMAXIMIZE_BOX */  }
{
   int width, height;
   const int minWidth = 400;
   const int minHeight = 250;
 
   gPrefs->Read(wxT("/GUI/BrowserWidth"), &width, minWidth);
   gPrefs->Read(wxT("/GUI/BrowserHeight"), &height, minHeight);
 
   if (width < minWidth || width > wxSystemSettings::GetMetric(wxSYS_SCREEN_X))
      width = minWidth;
   if (height < minHeight || height > wxSystemSettings::GetMetric(wxSYS_SCREEN_Y))
      height = minHeight;
 
   SetMinSize(wxSize(minWidth, minHeight));
   SetSize(wxDefaultPosition.x, wxDefaultPosition.y, width, height, wxSIZE_AUTO);
}

References title.

Member Function Documentation

OnBackward()

void BrowserDialog::OnBackward

(

wxCommandEvent &

event

)

Definition at line 453 of file HelpSystem.cpp.

{
   mpHtml->HistoryBack();
   UpdateButtons();
}

References mpHtml, and UpdateButtons().

Here is the call graph for this function:

OnClose()

void BrowserDialog::OnClose

(

wxCommandEvent &

event

)

Definition at line 459 of file HelpSystem.cpp.

{
   if (IsModal() && !mDismissed)
   {
      mDismissed = true;
      EndModal(wxID_CANCEL);
   }
   auto parent = GetParent();
 
   gPrefs->Write(wxT("/GUI/BrowserWidth"), GetSize().GetX());
   gPrefs->Write(wxT("/GUI/BrowserHeight"), GetSize().GetY());
   gPrefs->Flush();
 
#ifdef __WXMAC__
   auto grandparent = GetParent()->GetParent();
#endif
 
   parent->Destroy();
 
#ifdef __WXMAC__
   if(grandparent && grandparent->IsShown()) {
      grandparent->Raise();
   }
#endif
}

References audacity::BasicSettings::Flush(), gPrefs, mDismissed, audacity::BasicSettings::Write(), and wxT().

Here is the call graph for this function:

OnForward()

void BrowserDialog::OnForward

(

wxCommandEvent &

event

)

Definition at line 447 of file HelpSystem.cpp.

{
   mpHtml->HistoryForward();
   UpdateButtons();
}

References mpHtml, and UpdateButtons().

Here is the call graph for this function:

OnKeyDown()

void BrowserDialog::OnKeyDown

(

wxKeyEvent &

event

)

Definition at line 485 of file HelpSystem.cpp.

{
   bool bSkip = true;
   if (event.GetKeyCode() == WXK_ESCAPE)
   {
      bSkip = false;
      Close(false);
   }
   event.Skip(bSkip);
}

UpdateButtons()

void BrowserDialog::UpdateButtons

(

)

Definition at line 497 of file HelpSystem.cpp.

{
   wxWindow * pWnd;
   if( (pWnd = FindWindowById( wxID_BACKWARD, this )) != NULL )
   {
      pWnd->Enable(mpHtml->HistoryCanBack());
   }
   if( (pWnd = FindWindowById( wxID_FORWARD, this )) != NULL )
   {
      pWnd->Enable(mpHtml->HistoryCanForward());
   }
}

References mpHtml.

Referenced by OnBackward(), OnForward(), and LinkingHtmlWindow::OnLinkClicked().

Here is the caller graph for this function:

Member Data Documentation

mDismissed

bool BrowserDialog::mDismissed {}

Definition at line 155 of file HelpSystem.h.

Referenced by OnClose().

mpHtml

HtmlWindow* BrowserDialog::mpHtml

Definition at line 154 of file HelpSystem.h.

Referenced by OnBackward(), OnForward(), HelpSystem::ShowHtmlText(), and UpdateButtons().

---

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

• HelpSystem.h
• HelpSystem.cpp