summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4WxProgressDialog.h
blob: 8906e768ab82676100bb2b43a267560fef3907aa (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: Dk4WxProgressDialog.wxc
*/

#ifndef DK4WXPROGRESSDIALOG_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4WXPROGRESSDIALOG_H_INCLUDED 1


#line 54 "Dk4WxProgressDialog.wxc"

/**	@file	Dk4WxProgressDialog.h	Progress dialog.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef WX_WXPREC_H_INCLUDED
#include <wx/wxprec.h>
#define	WX_WXPREC_H_INCLUDED 1
#endif
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#ifndef WX_PRECOMP
#ifndef WX_WX_H_INCLUDED
#include <wx/wx.h>
#define	WX_WX_H_INCLUDED 1
#endif
#endif

#ifndef DK4WXAPPLICATIONHELPER_H_INCLUDED
#include "Dk4WxApplicationHelper.h"
#endif

#ifndef	DK4WXPROGRESSCONTROLLERBASE_H_INCLUDED
#include "Dk4WxProgressControllerBase.h"
#endif



#line 90 "Dk4WxProgressDialog.wxc"

/**	Progress dialog (progress bar and cancel button).
*/
class Dk4WxProgressDialog :
  public wxDialog,
  public Dk4WxProgressControllerWorkerBase,
  Dk4WxProgressControllerOwnerBase
{
  private:

    /**	Event table.
    */
    DECLARE_EVENT_TABLE()

  protected:

    /**	Synchronize access from multiple threads.
    */
    wxCriticalSection	csProtect;

    /**	Text for dialog title.
    */
    wxString		 sDialogTitle;

    /**	Text for dialog box.
    */
    wxString		 sDialogText;

    /**	Three text strings shown in the dialog.
    */
    const wxChar	*sText[3];

    /**	Current gauge value.
    */
    int			iOld;

    /**	New gauge value, set by worker thread.
    */
    int			iNew;

    /**	Dialog box style.
    */
    int			iDialogStyle;

    /**	Flag: Aborted via Cancel button.
    */
    bool		bAborted;

    /**	Worker thread finished.
    */
    bool		bFinished;

    /**	Success indicator from worker thread.
    */
    bool		bSuccess;

    /**	Flag: Still active, not yet closed.
    */
    bool		bActive;

    /**	Flag: Data to show a message box is available.
    */
    bool		bHaveDialog;

  public:

    /**	Constructor.
    */
    Dk4WxProgressDialog(
      wxFrame			*parent,
      Dk4WxApplicationHelper	*pAppHelp
    );

    /**	Handler for idle events.
	@param	event	Event to process.
    */
    void
    OnIdle(wxIdleEvent & event);

    /**	Handler for cancel button.
	@param	event	Event to process.
    */
    void
    OnCancel(wxCommandEvent & WXUNUSED(event));

    /**	Set new gauge value, called from worker thread.
    */
    void
    SetGauge(int value);

    /**	Indicate that a dialog box should be shown by the main thread
	after the worker thread has finished.
	@param	title	Message box title.
	@param	msg	Message box text.
	@param	st	Message box style.
    */
    void
    SetDialogData(
      const wxString &	title,
      const wxString &	msg,
      int		st = wxID_OK
    );

    /**	Start processing. Does nothing, just implement the
	Dk4WxProgressControllerBase interface.
    */
    void
    StartProcessing(void);

    /**	Indicate end of processing, called from worker thread.
	@param	success	Flag: Successful processing.
    */
    void
    EndProcessing(bool success = true);

    /**	Check whether we can continue.
    */
    bool
    CanContinue(void);

    /**	Check whether the worker thread is finished.
	@return	True if the worker thread is finished, false while running.
    */
    bool
    IsFinished(void);

    /**	Retrieve gauge value.
	@return	Current value for progress gauge.
    */
    int
    GetGauge(void);

    /**	Abort processing. Called from the progress dialogs Cancel button.
    */
    void
    AbortProcessing(void);

    /** Check whether the worker thread finished successfully.
	@return	True to indicate success, false otherwise.
    */
    bool
    GetSuccess(void);

    /**	Check whether a dialog should be shown.
	@param	title	Result variable for message box title.
	@param	msg	Result variable for message text.
	@param	style	Result variable for dialog box style.
	@return	True to show a dialog, false otherwise.
    */
    bool
    GetDialogData(wxString & title, wxString & msg, int & style);

    /**	Flag: GUI ok.
    */
    bool dkctGUILayoutOK;

    /**	GUI element sDialog.
    */
#line 9 "Dk4WxProgressDialog.wxc"
    wxBoxSizer *sDialog;

    /**	GUI element verticalSizer.
    */
#line 17 "Dk4WxProgressDialog.wxc"
    wxBoxSizer *verticalSizer;

    /**	GUI element sttInProgress.
    */
#line 37 "Dk4WxProgressDialog.wxc"
    wxStaticText *sttInProgress;

    /**	GUI element gaugeProgress.
    */
#line 31 "Dk4WxProgressDialog.wxc"
    wxGauge *gaugeProgress;

    /**	GUI element sttWait.
    */
#line 41 "Dk4WxProgressDialog.wxc"
    wxStaticText *sttWait;

    /**	GUI element bCancel.
    */
#line 47 "Dk4WxProgressDialog.wxc"
    wxButton *bCancel;


#line 243 "Dk4WxProgressDialog.wxc"
};


#line 246 "Dk4WxProgressDialog.wxc"



#endif