File: Help.cpp

package info (click to toggle)
audacity 0.98-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 2,896 kB
  • ctags: 4,089
  • sloc: cpp: 26,099; ansic: 4,961; sh: 2,465; makefile: 156; perl: 23
file content (192 lines) | stat: -rw-r--r-- 4,495 bytes parent folder | download
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
/**********************************************************************

  Audacity: A Digital Audio Editor

  Help.cpp

  Dominic Mazzoni

  Audacity uses the wxWindows HTML help controller and gets the
  HTML files from a zip archive with a "htb" extension, which
  is supposed to stand for "HTML Book".  It expects the help
  file to be called "audacity-help.htb".

  If you want to edit the help file, unzip audacity-help.htb
  (rename it to audacity-help.zip first if you have to), edit
  the files, and then zip them again.  Audacity asks the user
  for the location of the help file the first time and then
  remembers it from then on.

**********************************************************************/

#ifdef foo___WXMAC__

void InitHelp(wxWindow * parent)
{
}

void ShowHelp(wxWindow * parent)
{
}

void ShowHelpIndex(wxWindow * parent)
{
}

void ShowHelp(wxWindow * parent, wxString topic)
{
}

void SearchHelp(wxWindow * parent)
{
}

void QuitHelp()
{
}


#else

#include <wx/filedlg.h>
#include <wx/msgdlg.h>
#include <wx/textdlg.h>
#include <wx/html/helpctrl.h>

#include "Help.h"
#include "Prefs.h"

wxHtmlHelpController *gHelp = NULL;

void SetHelpFile(wxWindow * parent)
{
   if (gHelp) {
      delete gHelp;
      gHelp = NULL;
   }

   wxString helpFilePath = gPrefs->Read("/Help/HelpFilePath", "");
   wxString searchPath;
   if (::wxFileExists(helpFilePath))
      searchPath = ::wxPathOnly(helpFilePath);

   helpFilePath = wxFileSelector("Where is audacity-help.htb?",
                                 searchPath,
                                 "audacity-help.htb",  // Name
                                 "",                   // Extension
                                 "HTML Help Books (*.htb)|*.htb",
                                 wxOPEN, parent);
   if (helpFilePath == "")
      return;

   gHelp = new wxHtmlHelpController();
   if (!gHelp->AddBook(helpFilePath)) {
      wxMessageBox("Couldn't open the Audacity Help file.");
      delete gHelp;
      gHelp = NULL;
      return;
   }
   
   gPrefs->Write("/Help/HelpFilePath", helpFilePath);   

   wxMessageBox("Help file loaded successfully.");
}

void InitHelp(wxWindow * parent)
{
   if (!gHelp) {
      wxArrayString paths;
      wxString helpFilePath = "";

      wxString storedPath =
         gPrefs->Read("/Help/HelpFilePath", "");
      if (storedPath != "")
         paths.Add(storedPath);

      paths.Add(wxGetCwd() + wxFILE_SEP_PATH + "audacity-help.htb");

      #ifdef __WXGTK__
      paths.Add("/usr/local/share/doc/audacity/audacity-help.htb");
      paths.Add("/usr/share/doc/audacity/audacity-help.htb");
      paths.Add("/usr/share/audacity/audacity-help.htb"); // for debian
      #endif

      #ifdef __WXMSW__
      paths.Add("C:\\Program Files\\Audacity\\audacity-help.htb");
      #endif

      for(int i=0; i<paths.GetCount() && helpFilePath==""; i++) {
         if (::wxFileExists(paths[i]))
            helpFilePath = paths[i];
      }

      if (helpFilePath == "") {
         helpFilePath = wxFileSelector("Where is audacity-help.htb?",
                                       NULL,
                                       "audacity-help.htb",  // Name
                                       "",                   // Extension
                                       "HTML Help Books (*.htb)|*.htb",
                                       wxOPEN, parent);
         if (helpFilePath == "")
            return;
      }

      gHelp = new wxHtmlHelpController();
      if (!gHelp->AddBook(helpFilePath)) {
         wxMessageBox("Couldn't open the Audacity Help file.");
         delete gHelp;
         gHelp = NULL;
      }

      gPrefs->Write("/Help/HelpFilePath", helpFilePath);
   }
}

void ShowHelp(wxWindow * parent)
{
   InitHelp(parent);

   if (gHelp)
      gHelp->Display("Main");
}

void ShowHelpIndex(wxWindow * parent)
{
   InitHelp(parent);

   if (gHelp)
      gHelp->DisplayIndex();
}

void ShowHelp(wxWindow * parent, wxString topic)
{
   InitHelp(parent);

   if (gHelp)
      gHelp->KeywordSearch(topic);
}

void SearchHelp(wxWindow * parent)
{
   InitHelp(parent);

   if (gHelp) {
      wxString key = wxGetTextFromUser("Search for?",
                                       "Search help for keyword",
                                       "",
                                       parent);

      if (!key.IsEmpty())
         gHelp->KeywordSearch(key);
   }
}

void QuitHelp()
{
   if (gHelp) {
      delete gHelp;
      gHelp = NULL;
   }
}

#endif