KVIrc 5.2.6
Developer APIs
KviTalWizard Class Reference

Provides a wizard-style dialog with steps. More...

#include <KviTalWizard.h>

+ Inheritance diagram for KviTalWizard:

Signals

void helpClicked ()
 
void pageChanged (QString title)
 

Public Member Functions

void addPage (QWidget *pWidget, const QString &szTitle)
 
QPushButton * backButton ()
 
QPushButton * cancelButton ()
 
QWidget * currentPage ()
 
QPushButton * finishButton ()
 
QPushButton * helpButton ()
 
void insertPage (QWidget *pWidget, const QString &szTitle, int iIndex)
 
 KviTalWizard (QWidget *pParent)
 
QPushButton * nextButton ()
 
void setBackEnabled (QWidget *pWidget, bool bEnabled)
 
void setCancelEnabled (QWidget *pWidget, bool bEnabled)
 
bool setCurrentPage (QWidget *pWidget)
 
void setFinishEnabled (QWidget *pWidget, bool bEnabled)
 
void setHelpEnabled (QWidget *pWidget, bool bEnabled)
 
void setNextEnabled (QWidget *pWidget, bool bEnabled)
 
bool setPageEnabled (QWidget *pWidget, bool bEnabled)
 
bool setPageTitle (QWidget *pWidget, const QString &szTitle)
 
 ~KviTalWizard ()
 

Protected Slots

void backButtonClicked ()
 
void cancelButtonClicked ()
 
void finishButtonClicked ()
 
void helpButtonClicked ()
 
void nextButtonClicked ()
 

Protected Member Functions

void closeEvent (QCloseEvent *e) override
 
void setCurrentPage (KviTalWizardPageData *pData)
 
void showEvent (QShowEvent *e) override
 

Protected Attributes

KviTalWizardPrivatem_p
 

Detailed Description

Provides a wizard-style dialog with steps.

Constructor & Destructor Documentation

◆ KviTalWizard()

◆ ~KviTalWizard()

KviTalWizard::~KviTalWizard ( )

References m_p.

Member Function Documentation

◆ addPage()

void KviTalWizard::addPage ( QWidget * pWidget,
const QString & szTitle )

Adds a page to the wizard with the specified title. The pages are displayed in order they're added. Adding a page a second time is equivalent to calling setPageTitle() and enabling the page.

References insertPage().

Referenced by KviRemoteMircServerImportWizard::KviRemoteMircServerImportWizard(), RegistrationWizard::RegistrationWizard(), SaveThemeDialog::SaveThemeDialog(), and SetupWizard::SetupWizard().

◆ backButton()

QPushButton * KviTalWizard::backButton ( )

Returns a pointer to the back button displayed in the dialog.

References m_p.

Referenced by KviKvsMdmWizard::KviKvsMdmWizard().

◆ backButtonClicked

void KviTalWizard::backButtonClicked ( )
protectedslot

References m_p, pageChanged(), and setCurrentPage().

Referenced by KviTalWizard(), and pageChanged().

◆ cancelButton()

QPushButton * KviTalWizard::cancelButton ( )

Returns a pointer to the cancel button displayed in the dialog.

References m_p.

Referenced by KviRemoteMircServerImportWizard::getListTerminated().

◆ cancelButtonClicked

void KviTalWizard::cancelButtonClicked ( )
protectedslot

◆ closeEvent()

void KviTalWizard::closeEvent ( QCloseEvent * e)
overrideprotected

Handles redirects the close button to the "cancel" operation.

References cancelButtonClicked(), and e.

Referenced by pageChanged().

◆ currentPage()

QWidget * KviTalWizard::currentPage ( )

Returns a pointer to the current page

References m_p.

◆ finishButton()

QPushButton * KviTalWizard::finishButton ( )

Returns a pointer to the finish button displayed in the dialog.

References m_p.

Referenced by KviRemoteMircServerImportWizard::getListTerminated(), and KviRemoteMircServerImportWizard::start().

◆ finishButtonClicked

void KviTalWizard::finishButtonClicked ( )
protectedslot

Referenced by KviTalWizard(), and pageChanged().

◆ helpButton()

QPushButton * KviTalWizard::helpButton ( )

Returns a pointer to the help button displayed in the dialog.

References m_p.

◆ helpButtonClicked

void KviTalWizard::helpButtonClicked ( )
protectedslot

References helpClicked().

Referenced by KviTalWizard(), and pageChanged().

◆ helpClicked

void KviTalWizard::helpClicked ( )
signal

Emitted when the help button is clicked.

Referenced by helpButtonClicked().

◆ insertPage()

void KviTalWizard::insertPage ( QWidget * pWidget,
const QString & szTitle,
int iIndex )

Adds a page to the wizard with the specified title and in the specified position. Adding a page a second time is equivalent to calling setPageTitle() and enabling the page.

References KviTalWizardPageData::bEnabled, KviTalWizardPageData::EnableBack, KviTalWizardPageData::EnableCancel, KviTalWizardPageData::EnableNext, KviTalWizardPageData::iEnableFlags, KviTalWizardPageData::iVisibleIndex, m_p, KviTalWizardPageData::pWidget, and KviTalWizardPageData::szTitle.

Referenced by addPage().

◆ nextButton()

QPushButton * KviTalWizard::nextButton ( )

Returns a pointer to the next button displayed in the dialog.

References m_p.

Referenced by KviKvsMdmWizard::KviKvsMdmWizard().

◆ nextButtonClicked

void KviTalWizard::nextButtonClicked ( )
protectedslot

References m_p, pageChanged(), and setCurrentPage().

Referenced by KviTalWizard(), and pageChanged().

◆ pageChanged

◆ setBackEnabled()

void KviTalWizard::setBackEnabled ( QWidget * pWidget,
bool bEnabled )

Enables or disables the prev button for the specified page. By default the prev button is always enabled.

References KviTalWizardPageData::EnableBack, KviTalWizardPageData::iEnableFlags, m_p, and setCurrentPage().

Referenced by KviRemoteMircServerImportWizard::KviRemoteMircServerImportWizard(), SaveThemeDialog::SaveThemeDialog(), and SetupWizard::SetupWizard().

◆ setCancelEnabled()

void KviTalWizard::setCancelEnabled ( QWidget * pWidget,
bool bEnabled )

Enables or disables the cancel button for the specified page. By default the cancel button is always enabled.

References KviTalWizardPageData::EnableCancel, KviTalWizardPageData::iEnableFlags, m_p, and setCurrentPage().

◆ setCurrentPage() [1/2]

◆ setCurrentPage() [2/2]

bool KviTalWizard::setCurrentPage ( QWidget * pWidget)

Switches the wizard to the specified page. Please note that this class handles page switching automatically so you usually don't need to call this function.

Returns true on success or false if the pWidget does not identify a page that has been added to this wizard.

References m_p, and setCurrentPage().

Referenced by SetupWizard::accept(), backButtonClicked(), nextButtonClicked(), pageChanged(), SaveThemeDialog::saveTheme(), setBackEnabled(), setCancelEnabled(), setCurrentPage(), setFinishEnabled(), setHelpEnabled(), setNextEnabled(), setPageEnabled(), and showEvent().

◆ setFinishEnabled()

void KviTalWizard::setFinishEnabled ( QWidget * pWidget,
bool bEnabled )

◆ setHelpEnabled()

void KviTalWizard::setHelpEnabled ( QWidget * pWidget,
bool bEnabled )

Enables or disables the help button for the specified page. By default the help button is always disabled.

References KviTalWizardPageData::EnableHelp, KviTalWizardPageData::iEnableFlags, m_p, and setCurrentPage().

Referenced by SaveThemeDialog::SaveThemeDialog(), and SetupWizard::SetupWizard().

◆ setNextEnabled()

◆ setPageEnabled()

bool KviTalWizard::setPageEnabled ( QWidget * pWidget,
bool bEnabled )

Enables or disables a page. A disabled page is skipped when the user presses "Next" in the previous page or "Back" in the page after. Disabling the current page has no effect.

Returns true on success or false if the pWidget does not identify a page that has been added to this wizard.

References KviTalWizardPageData::bEnabled, m_p, and setCurrentPage().

Referenced by SetupWizard::newDirClicked(), SetupWizard::oldDirClicked(), SetupWizard::portableClicked(), and SetupWizard::SetupWizard().

◆ setPageTitle()

bool KviTalWizard::setPageTitle ( QWidget * pWidget,
const QString & szTitle )

Changes a page title.

Returns true on success or false if the pWidget does not identify a page that has been added to this wizard.

References m_p, and KviTalWizardPageData::szTitle.

◆ showEvent()

void KviTalWizard::showEvent ( QShowEvent * e)
overrideprotected

Displays the first page if no other page is shown yet.

References e, m_p, pageChanged(), KviTalWizardPageData::pWidget, and setCurrentPage().

Referenced by pageChanged(), RegistrationWizard::showEvent(), and SetupWizard::showEvent().

Member Data Documentation

◆ m_p


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