summaryrefslogtreecommitdiffstats
path: root/src/kvilib/tal/kvi_tal_wizard.h
blob: f84e35555ab13375f4cee3cf14b0c072629930bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
#ifndef _KVI_TAL_WIZARD_H_
#define _KVI_TAL_WIZARD_H_

//=============================================================================
//
//   File : kvi_tal_wizard.h
//   Creation date : Tue Feb 06 2007 14:35:08 by Szymon Stefanek
//
//   This file is part of the KVirc irc client distribution
//   Copyright (C) 2007 Szymon Stefanek (pragma at kvirc dot net)
//
//   This program is FREE software. You can redistribute it and/or
//   modify it under the terms of the GNU General Public License
//   as published by the Free Software Foundation; either version 2
//   of the License, or (at your opinion) any later version.
//
//   This program is distributed in the HOPE that it will be USEFUL,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc. ,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================

#include "kvi_settings.h"

#ifdef COMPILE_USE_QT4
	#include <QDialog>
#else
	#include <qdialog.h>
#endif

class QShowEvent;
class QPushButton;
class KviTalWizardPrivate;
class KviTalWizardPageData;

///
/// \class KviTalWizard
///
/// \brief Provides a wizard-style dialog with steps
///
class KVILIB_API KviTalWizard : public QDialog
{
	Q_OBJECT
public:
	KviTalWizard(QWidget * pParent);
	~KviTalWizard();
protected:
	KviTalWizardPrivate * m_p;
public:
	///
	/// 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.
	///
	void addPage(QWidget * pWidget,const QString &szTitle);
	///
	/// 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.
	///
	void insertPage(QWidget * pWidget,const QString &szTitle,int iIndex);
	///
	/// 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.
	///
	bool setPageEnabled(QWidget * pWidget,bool bEnabled);
	///
	/// 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.
	///
	bool setPageTitle(QWidget * pWidget,const QString &szTitle);
	///
	/// 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.
	///
	bool setCurrentPage(QWidget * pWidget);
	///
	/// Returns a pointer to the current page
	///
	QWidget * currentPage();
	///
	/// Enables or disables the help button for the specified page.
	/// By default the help button is always disabled.
	///
	void setHelpEnabled(QWidget * pWidget,bool bEnabled);
	///
	/// Enables or disables the cancel button for the specified page.
	/// By default the cancel button is always enabled.
	///
	void setCancelEnabled(QWidget * pWidget,bool bEnabled);
	///
	/// Enables or disables the finish button for the specified page.
	/// By default the finish button is always disabled.
	///
	void setFinishEnabled(QWidget * pWidget,bool bEnabled);
	///
	/// Enables or disables the next button for the specified page.
	/// By default the next button is always enabled.
	///
	void setNextEnabled(QWidget * pWidget,bool bEnabled);
	///
	/// Enables or disables the prev button for the specified page.
	/// By default the prev button is always enabled.
	///
	void setBackEnabled(QWidget * pWidget,bool bEnabled);
	///
	/// Returns a pointer to the cancel button displayed in the dialog.
	///
	QPushButton * cancelButton();
	///
	/// Returns a pointer to the help button displayed in the dialog.
	///
	QPushButton * helpButton();
	///
	/// Returns a pointer to the finish button displayed in the dialog.
	///
	QPushButton * finishButton();
	///
	/// Returns a pointer to the next button displayed in the dialog.
	///
	QPushButton * nextButton();
	///
	/// Returns a pointer to the back button displayed in the dialog.
	///
	QPushButton * backButton();
signals:
	///
	/// Emitted when the help button is clicked.
	///
	void helpClicked();
protected:
	///
	/// Displays the first page if no other page is shown yet.
	///
	virtual void showEvent(QShowEvent * e);
	///
	/// Handles redirects the close button to the "cancel" operation.
	///
	virtual void closeEvent(QCloseEvent * e);
protected:
	void setCurrentPage(KviTalWizardPageData * pData);
protected slots:
	void backButtonClicked();
	void nextButtonClicked();
	void helpButtonClicked();
	void cancelButtonClicked();
	void finishButtonClicked();
};


#endif // _KVI_TAL_WIZARD_H_