summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4WxAutostartController.h
blob: edcc68791b7ab5f6f491cbdb7e9a39395627dacd (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
/*
	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: Dk4WxAutostartController.cpt
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

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


#line 9 "Dk4WxAutostartController.cpt"

/**	@file	Dk4WxAutostartController.h	Autostart controller.
*/

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

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

#ifndef DK4CONST_H_INCLUDED
#include "dk4const.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef DK4TIME_H_INCLUDED
#include "dk4time.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 WX_THREAD_H_INCLUDED
#include <wx/thread.h>
#define	WX_THREAD_H_INCLUDED 1
#endif


/**	Reactions on idle events.
*/
enum {

					/**	Ignore the event, we are done.
					*/
  DK4WX_AUTOSTART_REACTION_IGNORE	= 0 ,

					/**	Start autorun.
					*/
  DK4WX_AUTOSTART_REACTION_START ,

					/**	Request more idle events.
					*/
  DK4WX_AUTOSTART_REACTION_MORE ,

					/**	Exit the application.
					*/
  DK4WX_AUTOSTART_REACTION_EXIT
};


/**	Controller to check whether or not to start an autostart run
	on idle events.
*/
class Dk4WxAutostartController
{
  protected:

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

    /**	Time for automatic exit.
    */
    dk4_time_t		iExitTime;

    /**	Current controller state.
    */
    int			iState;

    /**	Flag: Start automatically.
    */
    bool		bAutostart;

    /**	Flag: Exit after successfull processing via autostart.
    */
    bool		bAutoexit;

  public:

    /**	Default controller.
    */
    Dk4WxAutostartController();

    /**	Enable auto start.
	Call this function from the frames constructor.
	@param	fl	Flag to enable/disable auto start.
    */
    void
    SetAutoStart(bool fl);

    /**	Enable auto exit.
	An application can exit automatically if no feedback is required
	after an automatic one-time processing resulting in success.
	Example: A program to schedule a file to a print queue invoked
	via the file managers context menu. The program should immediately
	transfer the file to the print queue, so you enable auto start.
	After completing successfully you want the program to exit immediately.
	Call this function from the frames constructor.
	@param	fl	Flag to enable/disable auto exit.
    */
    void
    SetAutoExit(bool fl);

    /**	Get reaction for one idle event.
	This function is typically called from the frames idle event
	handler to decide what to do.
	@return One from:
	- DK4WX_AUTOSTART_REACTION_IGNORE<br>
	  to ignore the idle event,
	- DK4WX_AUTOSTART_REACTION_START<br>
	  to start an automatic run,
	- DK4WX_AUTOSTART_REACTION_MORE<br>
	  to request more idle events, or
	- DK4WX_AUTOSTART_REACTION_EXIT<br>
	  to exit the application.
    */
    int
    GetReaction(void);

    /**	Indicate to the controller that processing was started.
	Call this function to indicate start of processing.
	Should be called for both auto start runs and manually started runs.
    */
    void
    StartProcessing(void);

    /**	Indicate end of processing.
        Should be called for both auto start runs and manually started runs.
	@param	success	Result from processing.
    */
    void
    EndProcessing(bool success = true);

};





#endif