summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4WxProgressDialog.wxc
blob: 0e4173d14e620d86df76c0e80702f7945186e6e4 (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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
%%	options


%%	wx-gui

type		=	dialog
contents	=	sDialog

[wxBoxSizer	sDialog]
direction	=	horizontal
grow		=	yes
proportion	=	1
contents	=	$space(10)
contents	=	verticalSizer
contents	=	$space(10)

[wxBoxSizer	verticalSizer]
direction	=	vertical
grow		=	yes
proportion	=	1
contents	=	$space(10)
contents	=	sttInProgress
contents	=	$space(10)
contents	=	gaugeProgress	centered-x
contents	=	$space(10)
contents	=	sttWait		centered-x
contents	=	$space(10)
contents	=	bCancel		centered-x
contents	=	$space(10)

[wxGauge	gaugeProgress]
range		=	1000
value		=	0
grow		=	yes
proportion	=	1

[wxStaticText	sttInProgress]
text		=	labelText
text style	=	centered no-auto-resize

[wxStaticText	sttWait]
text		=	wxT("")
text style	=	centered no-auto-resize
grow		=	yes
proportion	=	1

[wxButton	bCancel]
text		=	sText[0]
tip		=	sText[1]
id		=	wxID_CANCEL


%%	header start

/**	@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


%%	class start

/**	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);

%%	class end
};

%%	header end


%%	module start

#include "Dk4WxProgressDialog.h"



$!trace-include



BEGIN_EVENT_TABLE(Dk4WxProgressDialog,wxDialog)
  EVT_IDLE(                     Dk4WxProgressDialog::OnIdle)
  EVT_BUTTON(wxID_CANCEL,       Dk4WxProgressDialog::OnCancel)
END_EVENT_TABLE()


static const wxChar *	dk4wx_progress_kw_wx[] = {
$!string-table	macro=wxT
#
#	0	Default title
#
Operation in progress
Cancel
Abort operation
Abortion scheduled, please wait.
$!end
};



/**	Integer preference names.
*/
static const wxChar * const	names[] = {
$!string-table	macro=wxT
progress.min-width
$!end
};


%%	constructor start
Dk4WxProgressDialog::Dk4WxProgressDialog(
  wxFrame			*parent,
  Dk4WxApplicationHelper	*pAppHelp
)
: wxDialog(
  parent, wxID_ANY,
  (
    (NULL != pAppHelp)
    ? (pAppHelp->GetBasicString(2))
    : (dk4wx_progress_kw_wx[0])
  ),
  wxDefaultPosition,
  wxDefaultSize,
  wxDEFAULT_DIALOG_STYLE
)
{
  const wxChar	*labelText = NULL;
  int		 minWidth = 300;
  
  labelText = dk4wx_progress_kw_wx[0];
  if (NULL != pAppHelp) {
    labelText = pAppHelp->GetBasicString(2);
    pAppHelp->GetMultiple(names, &minWidth, 1);
    if (0 > minWidth) { minWidth = 300; }
  }

  iOld = 0;
  iNew = 0;
  bActive = true;
  bAborted = false;
  bFinished = false;
  bSuccess = false;
  bHaveDialog = false;
  sDialogTitle = wxEmptyString;
  sDialogText = wxEmptyString;
  iDialogStyle = wxID_OK;
  if (NULL != pAppHelp) {
    sText[0] = pAppHelp->GetBasicString(3);	// Button label
    sText[1] = pAppHelp->GetBasicString(4);	// Button tooltip
    sText[2] = pAppHelp->GetBasicString(5);	// Text hint
  } else {
    sText[0] = dk4wx_progress_kw_wx[1];
    sText[1] = dk4wx_progress_kw_wx[2];
    sText[2] = dk4wx_progress_kw_wx[3];
  }
%%	constructor end
  if (dkctGUILayoutOK) {
    wxSize gaugeSize = gaugeProgress->GetMinSize();
    if (300 > gaugeSize.GetWidth()) {
      gaugeSize.SetWidth(300);
      gaugeProgress->SetMinSize(gaugeSize);
    }
    sDialog->Fit(this);
    sDialog->SetSizeHints(this);
  }
}

%%	module end



void
Dk4WxProgressDialog::OnIdle(wxIdleEvent & event)
{
  int	result;
  {
    wxCriticalSectionLocker	lock(csProtect);
    if (bActive) {
      if (bFinished) {
        bActive = false;
	result = wxID_OK;
	if ((bAborted) || (!(bSuccess))) { result = wxID_CANCEL; }
	if (IsModal()) {
	  EndModal(result);
	} else {
	  SetReturnCode((bSuccess) && (!(bAborted)));
	  Show(false);
	}
      } else {
        if (iNew != iOld) {
	  iOld = iNew;
	  gaugeProgress->SetValue(iNew);
	  Refresh();
	  Update();
	}
	event.RequestMore();
      }
    }
  }
  event.Skip();
}



void
Dk4WxProgressDialog::OnCancel(wxCommandEvent & WXUNUSED(event))
{
  bCancel->Enable(false);
  bCancel->SetToolTip(sText[2]);
  Refresh();
  Update();
  {
    wxCriticalSectionLocker	lock(csProtect);
    if (!(bFinished)) {
      bAborted = true;
    }
  }
}



void
Dk4WxProgressDialog::SetGauge(int value)
{
  wxCriticalSectionLocker	lock(csProtect);
  iNew = value;
}



void
Dk4WxProgressDialog::SetDialogData(
  const wxString &	title,
  const wxString &	msg,
  int	st
)
{
  wxCriticalSectionLocker	lock(csProtect);
  bHaveDialog = true;
  sDialogTitle = title;
  sDialogText = msg;
  iDialogStyle = st;
}



void
Dk4WxProgressDialog::StartProcessing(void)
{
  wxCriticalSectionLocker	lock(csProtect);
  bActive = true;
  sDialogTitle = wxEmptyString;
  sDialogText = wxEmptyString;
  iOld = 0;
  iNew = 0;
  bAborted = false;
  bFinished = false;
  bSuccess = true;
  bActive = true;
  bHaveDialog = false;
}



void
Dk4WxProgressDialog::EndProcessing(bool success)
{
  wxCriticalSectionLocker	lock(csProtect);
  bFinished = true;
  if (!(bAborted)) {
    bSuccess = success;
  }
}



bool
Dk4WxProgressDialog::CanContinue(void)
{
  bool		 back	= true;
  {
    wxCriticalSectionLocker	lock(csProtect);
    if ((bAborted) || (bFinished)) {
      back = false;
    }
  }
  return back;
}



bool
Dk4WxProgressDialog::IsFinished(void)
{
  bool		 back	= false;
  {
    wxCriticalSectionLocker	lock(csProtect);
    back = bFinished;
  }
  return back;
}



int
Dk4WxProgressDialog::GetGauge(void)
{
  int		 back	= 0;
  {
    wxCriticalSectionLocker	lock(csProtect);
    back = iNew;
  }
  return back;
}



void
Dk4WxProgressDialog::AbortProcessing(void)
{
  wxCriticalSectionLocker	lock(csProtect);
  if (!(bFinished)) {
    bAborted = true;
  }
}



bool
Dk4WxProgressDialog::GetSuccess(void)
{
  bool		back	= false;
  {
    wxCriticalSectionLocker	lock(csProtect);
    if (bFinished) {
      back = true;
      if ((bAborted) || (!(bSuccess))) { back = false; }
    }
  }
  return back;
}



bool
Dk4WxProgressDialog::GetDialogData(
  wxString &	title,
  wxString &	msg,
  int &		style
)
{
  bool		 back	= false;
  {
    wxCriticalSectionLocker	lock(csProtect);
    if (bHaveDialog) {
      title = sDialogTitle;
      msg = sDialogText;
      style = iDialogStyle;
      back = true;
    }
  }
  return back;
}