CWizardDlg Class Reference

Search Toolkit Book for CWizardDlg

#include <gui/widgets/wx/wizard_dlg.hpp>

Inheritance diagram for CWizardDlg:

Collaboration diagram for CWizardDlg:

Public Types
enum	{ eCmdUpdateButtons = 15000 , eCmdUpdateTitle }
enum	{ ID_CWIZARDDLG = 10115 , ID_HELP_LINK = 10116 , ID_BUTTON_OPTIONS = 10010 }
	Control identifiers. More...

Public Member Functions
	CWizardDlg ()
	CWizardDlg (wxWindow *parent, wxWindowID id=ID_CWIZARDDLG, const wxString &caption=_("WizardDlg"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxTAB_TRAVERSAL)
bool	Create (wxWindow *parent, wxWindowID id=ID_CWIZARDDLG, const wxString &caption=_("WizardDlg"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxTAB_TRAVERSAL)
	~CWizardDlg ()
void	Init ()
void	CreateControls ()
virtual void	CreatePages ()
void	SetCurrentPage (IWizardPage *page)
void	UpdateButtons ()
void	OnButtonOptionsClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BUTTON_OPTIONS More...
void	OnBackwardClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for wxID_BACKWARD More...
void	OnForwardClick (wxCommandEvent &event)
	wxEVT_COMMAND_BUTTON_CLICKED event handler for wxID_FORWARD More...
void	OnUpdateButtons (wxCommandEvent &)
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources. More...
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources. More...
void	SetHelpUrl (const wxString &url)
Public Member Functions inherited from CDialog
	CDialog ()
virtual void	InitDialog ()
virtual void	EndModal (int retCode)
virtual void	SetRegistryPath (const string &path)
virtual void	LoadSettings ()
virtual void	SaveSettings () const

Static Public Member Functions
static bool	ShowToolTips ()

Public Attributes
wxBoxSizer *	m_ButtonsSizer
wxButton *	m_OptionsBtn
wxButton *	m_BackBtn
wxButton *	m_NextBtn
wxHyperlinkCtrl *	m_Help

Protected Attributes
IWizardPage *	m_CurrentPage
Protected Attributes inherited from CDialog
string	m_RegPath

Additional Inherited Members
Protected Member Functions inherited from CDialog
virtual void	x_LoadSettings (const CRegistryReadView &)
	override these functions in derived classes More...
virtual void	x_SaveSettings (CRegistryWriteView) const
void	x_CorrectDisplay (wxRect &rc)
	move to the parent display More...

Detailed Description

CWizardDlg class declaration

Definition at line 78 of file wizard_dlg.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
eCmdUpdateButtons
eCmdUpdateTitle

Definition at line 84 of file wizard_dlg.hpp.

anonymous enum

anonymous enum

Control identifiers.

Enumerator
ID_CWIZARDDLG
ID_HELP_LINK
ID_BUTTON_OPTIONS

Definition at line 142 of file wizard_dlg.hpp.

Constructor & Destructor Documentation

CWizardDlg() [1/2]

CWizardDlg::CWizardDlg

(

)

Definition at line 64 of file wizard_dlg.cpp.

References Init().

CWizardDlg() [2/2]

CWizardDlg::CWizardDlg	(	wxWindow *	parent,
		wxWindowID	id = ID_CWIZARDDLG,
		const wxString &	caption = _("WizardDlg"),
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxSize(400, 300),
		long	style = wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxTAB_TRAVERSAL
	)

Definition at line 70 of file wizard_dlg.cpp.

References Create(), Init(), and ncbi::grid::netcache::search::fields::size.

~CWizardDlg()

CWizardDlg::~CWizardDlg

(

)

Definition at line 93 of file wizard_dlg.cpp.

Member Function Documentation

Create()

bool CWizardDlg::Create	(	wxWindow *	parent,
		wxWindowID	id = ID_CWIZARDDLG,
		const wxString &	caption = _("WizardDlg"),
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxSize(400, 300),
		long	style = wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxTAB_TRAVERSAL
	)

Definition at line 77 of file wizard_dlg.cpp.

References CreateControls(), and ncbi::grid::netcache::search::fields::size.

Referenced by COpenObjectsDlg::Create(), COpenDataSourceObjectDlg::Create(), and CWizardDlg().

CreateControls()

void CWizardDlg::CreateControls

(

)

Definition at line 110 of file wizard_dlg.cpp.

References _, CreatePages(), ID_BUTTON_OPTIONS, ID_HELP_LINK, m_BackBtn, m_ButtonsSizer, m_Help, m_NextBtn, m_OptionsBtn, and UpdateButtons().

Referenced by Create().

CreatePages()

virtual void CWizardDlg::CreatePages ( )

inlinevirtual

Reimplemented in COpenDataSourceObjectDlg, and COpenObjectsDlg.

Definition at line 101 of file wizard_dlg.hpp.

Referenced by CreateControls().

GetBitmapResource()

wxBitmap CWizardDlg::GetBitmapResource

(

const wxString &

name

)

Retrieves bitmap resources.

Definition at line 212 of file wizard_dlg.cpp.

GetIconResource()

wxIcon CWizardDlg::GetIconResource

(

const wxString &

name

)

Retrieves icon resources.

Definition at line 220 of file wizard_dlg.cpp.

Init()

void CWizardDlg::Init

(

void

)

Definition at line 99 of file wizard_dlg.cpp.

References m_BackBtn, m_ButtonsSizer, m_Help, m_NextBtn, m_OptionsBtn, and NULL.

Referenced by CWizardDlg().

OnBackwardClick()

void CWizardDlg::OnBackwardClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for wxID_BACKWARD

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BACKWARD

Definition at line 234 of file wizard_dlg.cpp.

References IWizardPage::CanLeavePage(), IWizardPage::GetPrevPage(), m_CurrentPage, prev(), and SetCurrentPage().

OnButtonOptionsClick()

void CWizardDlg::OnButtonOptionsClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BUTTON_OPTIONS

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BUTTON_OPTIONS

Definition at line 265 of file wizard_dlg.cpp.

References IWizardPage::CanLeavePage(), IWizardPage::GetOptionsPage(), m_CurrentPage, next(), and SetCurrentPage().

OnForwardClick()

void CWizardDlg::OnForwardClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_BUTTON_CLICKED event handler for wxID_FORWARD

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_FORWARD

Definition at line 248 of file wizard_dlg.cpp.

References IWizardPage::CanLeavePage(), CDialog::EndModal(), IWizardPage::GetNextPage(), m_CurrentPage, next(), and SetCurrentPage().

OnUpdateButtons()

void CWizardDlg::OnUpdateButtons ( wxCommandEvent &  )

inline

Definition at line 119 of file wizard_dlg.hpp.

References UpdateButtons().

SetCurrentPage()

void CWizardDlg::SetCurrentPage

(

IWizardPage *

page

)

Definition at line 161 of file wizard_dlg.cpp.

References IWizardPage::GetPanel(), m_CurrentPage, and UpdateButtons().

Referenced by COpenDataSourceObjectDlg::Create(), OnBackwardClick(), OnButtonOptionsClick(), OnForwardClick(), and COpenObjectsDlg::SetManagers().

SetHelpUrl()

void CWizardDlg::SetHelpUrl

(

const wxString &

url

)

Definition at line 154 of file wizard_dlg.cpp.

References m_Help.

Referenced by CImportFeatTable::x_DoImportFeaturesFromFile().

ShowToolTips()

bool CWizardDlg::ShowToolTips ( )

static

Definition at line 208 of file wizard_dlg.cpp.

UpdateButtons()

void CWizardDlg::UpdateButtons

(

)

Definition at line 193 of file wizard_dlg.cpp.

References IWizardPage::GetNextPage(), IWizardPage::GetOptionsPage(), IWizardPage::GetPrevPage(), m_BackBtn, m_ButtonsSizer, m_CurrentPage, m_NextBtn, m_OptionsBtn, next(), prev(), and wxT.

Referenced by CreateControls(), OnUpdateButtons(), and SetCurrentPage().

Member Data Documentation

m_BackBtn

wxButton* CWizardDlg::m_BackBtn

Definition at line 137 of file wizard_dlg.hpp.

Referenced by CreateControls(), Init(), and UpdateButtons().

m_ButtonsSizer

wxBoxSizer* CWizardDlg::m_ButtonsSizer

Definition at line 135 of file wizard_dlg.hpp.

Referenced by CreateControls(), Init(), and UpdateButtons().

m_CurrentPage

IWizardPage* CWizardDlg::m_CurrentPage

protected

Definition at line 150 of file wizard_dlg.hpp.

Referenced by OnBackwardClick(), OnButtonOptionsClick(), OnForwardClick(), SetCurrentPage(), and UpdateButtons().

m_Help

wxHyperlinkCtrl* CWizardDlg::m_Help

Definition at line 139 of file wizard_dlg.hpp.

Referenced by CreateControls(), Init(), and SetHelpUrl().

m_NextBtn

wxButton* CWizardDlg::m_NextBtn

Definition at line 138 of file wizard_dlg.hpp.

Referenced by CreateControls(), Init(), and UpdateButtons().

m_OptionsBtn

wxButton* CWizardDlg::m_OptionsBtn

Definition at line 136 of file wizard_dlg.hpp.

Referenced by CreateControls(), Init(), and UpdateButtons().

---

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

• include/gui/widgets/wx/wizard_dlg.hpp
• src/gui/widgets/wx/wizard_dlg.cpp