summaryrefslogtreecommitdiff
path: root/support/dktools/DkWxFrame.h
blob: 8007a5457c203a65cb5f6e501c4859d61d2dfa32 (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
/*
Copyright (C) 2011-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: DkWxFrame.cpt
*/

/**	@file DkWxFrame.h Header file for the DkWxFrame module.
*/

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


#line 9 "DkWxFrame.cpt"

#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);
};




#endif