summaryrefslogtreecommitdiff
path: root/support/dktools/DkWxFrame.cpt
blob: 329f2d28e302cb773fcb30de7fc0bbfc5c36d218 (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
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2011-xxxx
license		=	bsd


%%	header

#include <dk3all.h>

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


#include "DkWxAppHelper.h"
#include "DkWxHelpController.h"



/**	Base class for top-level frames. This class keeps pointers to an
	application helper for file search and localization and a
	pointer to a help controller object managing online help
	for both *.chm and *.htb based help.

	Derive your applications frames from this class.
*/
class DkWxFrame : public wxFrame
{
  private:
  
    /**	Number of windows currently open.
    */
    static int		iInstances;
    
    /**	Keywords to save and retrieve size and position data.
    */
    static wxChar const * const	kwSizePos[];

    /**	Preference keys whether or not to restore maxizmed and iconized.
    */
    static dkChar const * const	kwRestoreFeatures[];
    
  protected:
  
    /**	Helper object for file search and internationalization.
    */
    DkWxAppHelper	*pHelper;

    /**	Help controller for chm and htb based help files.
    */
    DkWxHelpController		*helpController;

    /**	Save current position.
    */
    void savePosition();
    
  public:
  
    /**	Constructor.
    	@param	applicationName		Application name.
    	@param	applicationHelper	Helper object.
	@param	applicationHelp		Help controller.
    	@param	wxid			Window ID.
    */
    DkWxFrame(
      wxChar const		*applicationName,
      DkWxAppHelper		*applicationHelper,
      DkWxHelpController	*applicationHelp,
      int		 	wxid
    );

    /**	Restore previous position or center on screen.
    */
    void restorePosition();
    
    /**	Handler for close event.
    	@param	event	Event to process.
    */
    void OnClose(wxCloseEvent & event);
    
    /**	Check whether we can close the frame.
    	@param	isLast	Flag: Last frame instance of application.
	@return	Permission to close.
    */
    virtual bool	canClose(bool isLast);

    /**	Open help system if help controller available.
    */
    void		openHelp();

    /**	Open help section specified by name.
    	@param	name	Section name.
    */
    void
    openHelpSectionByName(wxString const & name);

    /**	Open help section specified by section number.
    	@param	number	Section number (context ID).
    */
    void
    openHelpSectionByNumber(int number);
};



%%	module

/**	@file	DkWxFrame.cpp	Implementation of DkWxFrame.
*/

#include "DkWxFrame.h"


$!trace-include



int DkWxFrame::iInstances = 0;



wxChar const * const	DkWxFrame::kwSizePos[] = {
/* 0 */ wxT("window.x"),
/* 1 */ wxT("window.y"),
/* 2 */ wxT("window.w"),
/* 3 */ wxT("window.h"),
/* 4 */ wxT("window.maximized"),
/* 5 */ wxT("window.iconized"),
NULL
};



dkChar const * const	DkWxFrame::kwRestoreFeatures[] = {
/* 0 */ dkT("/window/restore-maximized"),
/* 1 */ dkT("/window/restore-iconized"),
/* 2 */ dkT("/window/restore-size"),
NULL
};



DkWxFrame::DkWxFrame(
  wxChar const		*applicationName,
  DkWxAppHelper		*applicationHelper,
  DkWxHelpController	*applicationHelp,
  int		 	wxid
) : wxFrame(NULL, wxid, applicationName)
{
  $? "+ DkWxFrame::DkWxFrame"
  /*
  	Initialize elements.
  */
  pHelper = NULL;
  helpController = applicationHelp;
  /*
  	Set elements.
  */
  pHelper = applicationHelper;
  iInstances++;
  Connect(wxid, wxEVT_CLOSE_WINDOW, wxCloseEventHandler(DkWxFrame::OnClose));
  $? "- DkWxFrame::DkWxFrame"
}



void DkWxFrame::OnClose(wxCloseEvent & event)
{
  bool		doClose = true;
  $? "+ DkWxFrame::OnClose"
  if(event.CanVeto()) {
    doClose = canClose(iInstances == 1);
  } else {
    canClose(iInstances == 1);
  }
  if(doClose) {		$? ". close window"
    /*
    	For last instance save position.
    */
    if(iInstances-- == 1) {	$? ". save position"
      savePosition();
    }
    /*
    	Process close event.
    */
    event.Skip();
  } else {		$? ". veto event"
    /*
    	Do not close the window.
    */
    event.Veto();
  } $? "- DkWxFrame::OnClose"
}



void
DkWxFrame::restorePosition()
{
  int		p[6];	/* Values retrieved from application helper */
  wxSize	scsz;	/* Screen size */
  int		x;	/* X position */
  int		y;	/* Y position */
  int		w;	/* Width */
  int		h;	/* Height */
  int		rs;	/* Flag: Attempt to restore size */
  p[0] = p[1] = -1;
  p[2] = p[3] = p[4] = w = h = 0;
  pHelper->retrieveMultipleInts(kwSizePos, p);
  if ((0 > p[0]) || (0 > p[1])) {
    CentreOnScreen();
  } else {
    scsz = wxGetDisplaySize();
    x = p[0];
    y = p[1];
    GetSize(&w, &h);
#if wxCHECK_VERSION(3,0,0)
    rs = 0;
#else
    rs = 1;
#endif
    rs = dk3app_get_pref_bool(pHelper->getApp(), kwRestoreFeatures[2], rs);
    if (0 != rs) {
      if (p[2] > w) { w = p[2]; }
      if (p[3] > h) { h = p[3]; }
    }
    if ((x + w) >= scsz.GetWidth())  { x = scsz.GetWidth() - w; }
    if ((y + h) >= scsz.GetHeight()) { y = scsz.GetHeight() - h; }
    if (0 > x) { x = 0; }
    if (0 > y) { y = 0; }
    if (0 != rs) {
      SetSize(x, y, w, h);
    } else {
      SetPosition(wxPoint(x, y));
    }
    if (0 != dk3app_get_pref_bool(pHelper->getApp(), kwRestoreFeatures[0], 0))
    {
      if (0 != p[4]) {
        Maximize(true);
      }
    }
    if (0 != dk3app_get_pref_bool(pHelper->getApp(), kwRestoreFeatures[1], 0))
    {
      if (0 != p[5]) {
        Iconize(true);
      }
    }
  }
}



#if VERSION_BEFORE_20160902
void
DkWxFrame::restorePosition()
{
#if 1
  int		p[6];
  size_t	num;
  int		w, h;
  int		restoreFeature;
  $? "+ DkWxFrame::restorePosition"
  p[0] = p[1] = p[2] = p[3] p[4] = p[5] = w = h = 0;
  if((num = pHelper->retrieveMultipleInts(kwSizePos, p)) >= 4) {
    $? ". saved coordinates"
    $? ". x = %d", p[0]
    $? ". y = %d", p[1]
    $? ". w = %d", p[2]
    $? ". h = %d", p[3]
    $? ". m = %d", p[4]
    $? ". i = %d", p[5]
    wxSize scsz = wxGetDisplaySize();
    GetSize(&w, &h);
    $? ". current coordinates"
    $? ". w = %d", w
    $? ". h = %d", h
    if(w > p[2]) { p[2] = w; }
    if(h > p[3]) { p[3] = h; }
    $? ". screen width  = %d %d", scsz.GetWidth(), scsz.x
    $? ". screen height = %d %d", scsz.GetHeight(), scsz.y
#if wxCHECK_VERSION(3,0,0)
    {
      wxSize	minSize = GetMinSize();
      if (p[2] < minSize.x) { p[2] = minSize.x; }
      if (p[3] < minSize.y) { p[3] = minSize.y; }
    }
#endif
    if((p[0] + p[2]) > scsz.GetWidth()) { p[0] = scsz.GetWidth() - p[2]; }
    if((p[1] + p[3]) > scsz.GetHeight()) { p[1] = scsz.GetHeight() - p[3]; }
    if(p[0] < 0) { p[0] = 0; }
    if(p[1] < 0) { p[1] = 0; }
    $? ". new coordinates"
    $? ". x = %d", p[0]
    $? ". y = %d", p[1]
    $? ". w = %d", p[2]
    $? ". h = %d", p[3]
    /*	This variant allows to decrease the frame below the minimum size.
    */
#if wxCHECK_VERSION(3,0,0)
    SetPosition(wxPoint(p[0], p[1]));
#else
    SetSize(p[0], p[1], p[2], p[3]);
#endif
    restoreFeature = dk3app_get_pref_bool(
      pHelper->getApp(),
      kwRestoreFeatures[0],
      0
    );
    if((restoreFeature) && (4 < num)) {
      if(0 != p[4]) {
        Maximize(true);
      }
    }
    restoreFeature = dk3app_get_pref_bool(
      pHelper->getApp(),
      kwRestoreFeatures[1],
      0
    );
    if((restoreFeature) && (5 < num)) {
      if(0 != p[5]) {
        Iconize(true);
      }
    }
  } else {
    CentreOnScreen();
  } $? "- DkWxFrame::restorePosition"
#else
  int	x = 0;
  int	y = 0;
  int	w = 0;
  int	h = 0;
  wxSize scsz = wxGetDisplaySize();
  GetPosition(&x, &y);
  GetSize(&w, &h);
#endif
}
#endif
/* VERSION_BEFORE_20160902 */



void
DkWxFrame::savePosition()
{
  int p[6];
  $? "+ DkWxFrame::savePosition"
  p[4] = 0;
  p[5] = 0;
  if(IsIconized()) {
    p[5] = 1;
    Iconize(false);
  }
  if(IsMaximized()) {
    p[4] = 1;
    Maximize(false);
  }
  GetPosition(&(p[0]), &(p[1]));
  GetSize(&(p[2]), &(p[3]));
  if(pHelper) {
    $? ". x = %d", p[0]
    $? ". y = %d", p[1]
    $? ". w = %d", p[2]
    $? ". h = %d", p[3]
    pHelper->saveMultipleInts(kwSizePos, p);
  } $? "- DkWxFrame::savePosition"
}



bool
DkWxFrame::canClose(bool isLast)
{
  $? "= DkWxFrame::canClose 1"
  return true;
}



void
DkWxFrame::openHelp()
{
  $? "+ DkWxFrame::openHelp"
  if(helpController) {
    helpController->openHelp((wxFrame *)this);
  } $? "- DkWxFrame::openHelp"
}



void
DkWxFrame::openHelpSectionByName(wxString const & name)
{
  $? "+ DkWxFrame::openHelpSectionByName"
  if (helpController) {
    helpController->openHelpSectionByName((wxFrame *)this, name);
  }
  $? "- DkWxFrame::openHelpSectionByName"
}



void
DkWxFrame::openHelpSectionByNumber(int number)
{
  $? "+ DkWxFrame::openHelpSectionByNumber"
  if (helpController) {
    helpController->openHelpSectionByNumber((wxFrame *)this, number);
  }
  $? "- DkWxFrame::openHelpSectionByNumber"
}