summaryrefslogtreecommitdiff
path: root/support/dktools/DkWxHelpController.cpt
blob: 9a3954ef6bd5ef39ddb63a400a204a92d07ef1fb (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
%%	options

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



%%	header

#include <dk3conf.h>
#include <dk3types.h>

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

#include <DkWxAppHelper.h>



/**	Help controller covering both chm and htb help files.
*/
class DkWxHelpController
{
  private:

    /**	Application helper, used to find the help files.
    */
    DkWxAppHelper		*appHelper;

    /**	Flag: Help file was found.
    */
    bool			bFileFound;

#ifdef __WXMSW__
    /**	Use CHM help controller on Windows systems.
    */
    wxCHMHelpController		hc;
#else
    /**	Use HTML help controller on all other systems.
    */
    wxHtmlHelpController	hc;
#endif

  public:
    /**	Constructor.
    	@param	ah	Application helper.
	@param	chmName	Short file name of chm file, without leading directory.
	@param	htbName	Short file name of htb file, without leading directory.
    */
    DkWxHelpController(
      DkWxAppHelper *ah,
      wxChar const *chmName,
      wxChar const *htbName
    );

    /**	Open help system.
    	@param	wxf	Parent frame.
    */
    void
    openHelp(wxFrame *wxf);

    /**	Open a help section specified by name.
    	@param	wxf	Parent frame.
	@param	name	Section name.
    */
    void
    openHelpSectionByName(wxFrame *wxf, wxString const & name);

    /**	Open a help section specified by number.
    	@param	wxf	Parent frame.
	@param	number	Section number (context ID).
    */
    void
    openHelpSectionByNumber(wxFrame *wxf, int number);

};



%%	module

#include "dk3all.h"

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

#include "dk3wxs.h"


$!trace-include




DkWxHelpController::DkWxHelpController(
  DkWxAppHelper	*ah,
  wxChar const	*chmName,
  wxChar const	*htbName
)
#ifdef __WXMSW__
#else
  : hc(wxHF_DEFAULT_STYLE | wxHF_MERGE_BOOKS)
#endif
{
  wxChar		fnb[DK3_MAX_PATH];

  appHelper = ah;
  bFileFound = false;
  $? "+ DkWxHelpController::DkWxHelpController"
#ifdef __WXMSW__
  $? ". Windows variant"
  if((appHelper) && (chmName)) {
    if(appHelper->findDataFile(chmName, fnb, DK3_SIZEOF(fnb,wxChar))) {
      hc.Initialize(fnb);
      bFileFound = true;
    }
  }
#else
  wxZipFSHandler	*zfsh;
  $? ". UNIX variant"
  if((ah) && (htbName)) {
    if(appHelper->findDataFile(htbName, fnb, DK3_SIZEOF(fnb,wxChar))) {
      zfsh = new wxZipFSHandler();
      if(zfsh) {
        wxFileSystem::AddHandler(zfsh);
	hc.AddBook(fnb);
	bFileFound = true;
      }
    }
  }
#endif
  $? "- DkWxHelpController::DkWxHelpController"
}



void
DkWxHelpController::openHelp(wxFrame *wxf)
{
  wxChar const	*titleString;
  wxChar const	*msgString;
  $? "+ DkWxHelpController::openHelp"
  if(bFileFound) {
    hc.DisplayContents();
  } else {
    if(appHelper) {
      titleString = appHelper->getBasicString(3);
      msgString = appHelper->getBasicString(10);
      wxMessageBox(msgString, titleString, wxOK, wxf);
    }
  } $? "- DkWxHelpController::openHelp"
}



void
DkWxHelpController::openHelpSectionByName(wxFrame *wxf, wxString const & name)
{
  wxChar const	*titleString;
  wxChar const	*msgString;
  $? "+ DkWxHelpController::openHelpSectionByName"
  if (bFileFound) {
    hc.DisplaySection(name);
  } else {
    if (appHelper) {
      titleString = appHelper->getBasicString(3);
      msgString = appHelper->getBasicString(10);
      wxMessageBox(msgString, titleString, wxOK, wxf);
    }
  }
  $? "- DkWxHelpController::openHelpSectionByName"
}



void
DkWxHelpController::openHelpSectionByNumber(wxFrame *wxf, int number)
{
  wxChar const	*titleString;
  wxChar const	*msgString;
  $? "+ DkWxHelpController::openHelpSectionByNumber"
  if (bFileFound) {
    hc.DisplaySection(number);
  } else {
    titleString = appHelper->getBasicString(3);
    msgString = appHelper->getBasicString(10);
    wxMessageBox(msgString, titleString, wxOK, wxf);
  }
  $? "- DkWxHelpController::openHelpSectionByNumber"
}