KiCad PCB EDA Suite
Loading...
Searching...
No Matches
STARTWIZARD_PROVIDER Class Referenceabstract

#include <startwizard_provider.h>

Inheritance diagram for STARTWIZARD_PROVIDER:
STARTWIZARD_PROVIDER_LIBRARIES STARTWIZARD_PROVIDER_PRIVACY STARTWIZARD_PROVIDER_SETTINGS

Public Member Functions

 STARTWIZARD_PROVIDER (const wxString &aPageName)
 
virtual ~STARTWIZARD_PROVIDER ()=default
 
virtual wxString Name () const =0
 
virtual bool NeedsUserInput () const
 
virtual wxPanel * GetWizardPanel (wxWindow *aParent, STARTWIZARD *aWizard)
 
const wxString & GetPageName () const
 
bool WasShown () const
 
void SetWasShown (bool aShown)
 
virtual void Finish ()
 
virtual void ApplyDefaults ()
 Apply whatever actions and settings should happen if the user cancels the startup wizard.
 

Private Attributes

wxString m_pageName
 
bool m_wasShown
 

Detailed Description

Definition at line 31 of file startwizard_provider.h.

Constructor & Destructor Documentation

◆ STARTWIZARD_PROVIDER()

STARTWIZARD_PROVIDER::STARTWIZARD_PROVIDER ( const wxString & aPageName)
inline

◆ ~STARTWIZARD_PROVIDER()

virtual STARTWIZARD_PROVIDER::~STARTWIZARD_PROVIDER ( )
virtualdefault

Member Function Documentation

◆ ApplyDefaults()

virtual void STARTWIZARD_PROVIDER::ApplyDefaults ( )
inlinevirtual

Apply whatever actions and settings should happen if the user cancels the startup wizard.

Reimplemented in STARTWIZARD_PROVIDER_LIBRARIES, STARTWIZARD_PROVIDER_PRIVACY, and STARTWIZARD_PROVIDER_SETTINGS.

Definition at line 55 of file startwizard_provider.h.

◆ Finish()

virtual void STARTWIZARD_PROVIDER::Finish ( )
inlinevirtual

◆ GetPageName()

const wxString & STARTWIZARD_PROVIDER::GetPageName ( ) const
inline

Definition at line 47 of file startwizard_provider.h.

References m_pageName.

◆ GetWizardPanel()

virtual wxPanel * STARTWIZARD_PROVIDER::GetWizardPanel ( wxWindow * aParent,
STARTWIZARD * aWizard )
inlinevirtual

◆ Name()

virtual wxString STARTWIZARD_PROVIDER::Name ( ) const
pure virtual

◆ NeedsUserInput()

virtual bool STARTWIZARD_PROVIDER::NeedsUserInput ( ) const
inlinevirtual

◆ SetWasShown()

void STARTWIZARD_PROVIDER::SetWasShown ( bool aShown)
inline

Definition at line 50 of file startwizard_provider.h.

References m_wasShown.

◆ WasShown()

bool STARTWIZARD_PROVIDER::WasShown ( ) const
inline

Definition at line 49 of file startwizard_provider.h.

References m_wasShown.

Member Data Documentation

◆ m_pageName

wxString STARTWIZARD_PROVIDER::m_pageName
private

Definition at line 58 of file startwizard_provider.h.

Referenced by GetPageName(), and STARTWIZARD_PROVIDER().

◆ m_wasShown

bool STARTWIZARD_PROVIDER::m_wasShown
private

Definition at line 59 of file startwizard_provider.h.

Referenced by SetWasShown(), STARTWIZARD_PROVIDER(), and WasShown().


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