summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4WxFrame.h
blob: 1c68b6f8824f6521a42ac2d31ec2c7a7e6829c16 (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
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	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: Dk4WxFrame.cpt
*/

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


#line 9 "Dk4WxFrame.cpt"

/**	@file	Dk4WxFrame.h	Base class for top level frames.
*/

#ifndef DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#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
#if DK4_BUILDING_DKTOOLS4
#include "Dk4WxApplicationHelper.h"
#else
#include <dktools-4/Dk4WxApplicationHelper.h>
#endif
#endif

#ifndef	DK4WXHELPCONTROLLER_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "Dk4WxHelpController.h"
#else
#include <dktools-4/Dk4WxHelpController.h>
#endif
#endif



/**	Frame (top level window).
*/
class Dk4WxFrame : public wxFrame
{
  protected:

    /**	Application helper.
    */
    Dk4WxApplicationHelper	*pAppHelp;

    /**	Help controller for online help.
    */
    Dk4WxHelpController		*pHelp;

    /**	Application name.
    */
    wxString			 sAppName;


    /**	Synchronize access to iInstances.
    */
    static wxCriticalSection	 csInstances;

    /**	Number of instances.
    */
    static int			 iInstances;

  public:

    /**	Constructor.
	@param	appName		Application name.
	@param	appHelper	Application helper.
	@param	helpController	Help controller.
	@param	wxid		Window ID.
    */
    Dk4WxFrame(
      const wxString	&	 appName,
      Dk4WxApplicationHelper	*appHelper,
      Dk4WxHelpController	*helpController,
      int			 wxid
    );

    /**	Restore previously saved window position.
    */
    void
    RestorePosition(void);

    /**	Handler for close event.
	@param	event	Event to process.
    */
    void
    OnClose(wxCloseEvent & event);

    /**	Decide whether we can close the frame.
	@param	isFinal	Flag: Final frame.
	@return	True to close the frame, false to keep it.
    */
    virtual
    bool
    CanClose(bool isFinal);


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

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

    /**	Find data file and launch default application
    	or web browser on it.
	@param	fn		File name to search for and use.
	@param	bIsHelp		Flag: File is a help file.
	@param	bVerbose	Flag: Show diagnostics on errors.
	@return	Success indicator.
    */
    bool
    FindFileAndLaunch(
    	dkChar const	*fn,
	bool		 bIsHelp	= false,
	bool		 bVerbose	= false
    );

  protected:

    /**	Save current window position.
    */
    void
    SavePosition(void);

};




#endif