fixed a 'variable could be used uninitialized' warning
[wxWidgets.git] / src / html / helpfrm.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: helpfrm.cpp
3 // Purpose: wxHtmlHelpFrame
4 // Notes: Based on htmlhelp.cpp, implementing a monolithic
5 // HTML Help controller class, by Vaclav Slavik
6 // Author: Harm van der Heijden and Vaclav Slavik
7 // RCS-ID: $Id$
8 // Copyright: (c) Harm van der Heijden and Vaclav Slavik
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
13 #pragma implementation "helpfrm.h"
14 #endif
15
16 // For compilers that support precompilation, includes "wx.h"
17
18 #include "wx/wxprec.h"
19
20 #ifdef __BORLANDC__
21 #pragma hdrstop
22 #endif
23
24 #if wxUSE_WXHTML_HELP
25
26 #ifndef WXPRECOMP
27 #include "wx/intl.h"
28 #include "wx/log.h"
29
30 #include "wx/object.h"
31 #include "wx/sizer.h"
32
33 #include "wx/bmpbuttn.h"
34 #include "wx/statbox.h"
35 #include "wx/radiobox.h"
36 #endif // WXPRECOMP
37
38 #ifdef __WXMAC__
39 #include "wx/menu.h"
40 #include "wx/msgdlg.h"
41 #endif
42
43 #include "wx/html/helpfrm.h"
44 #include "wx/html/helpctrl.h"
45 #include "wx/textctrl.h"
46 #include "wx/notebook.h"
47 #include "wx/imaglist.h"
48 #include "wx/treectrl.h"
49 #include "wx/tokenzr.h"
50 #include "wx/wfstream.h"
51 #include "wx/html/htmlwin.h"
52 #include "wx/busyinfo.h"
53 #include "wx/progdlg.h"
54 #include "wx/toolbar.h"
55 #include "wx/fontenum.h"
56 #include "wx/stream.h"
57 #include "wx/filedlg.h"
58 #include "wx/artprov.h"
59 #include "wx/spinctrl.h"
60
61 // what is considered "small index"?
62 #define INDEX_IS_SMALL 100
63
64 /* Motif defines this as a macro */
65 #ifdef Below
66 #undef Below
67 #endif
68
69 //--------------------------------------------------------------------------
70 // wxHtmlHelpTreeItemData (private)
71 //--------------------------------------------------------------------------
72
73 class wxHtmlHelpTreeItemData : public wxTreeItemData
74 {
75 public:
76 #if defined(__VISAGECPP__)
77 // VA needs a default ctor for some reason....
78 wxHtmlHelpTreeItemData() : wxTreeItemData()
79 { m_Id = 0; }
80 #endif
81 wxHtmlHelpTreeItemData(int id) : wxTreeItemData()
82 { m_Id = id;}
83
84 int m_Id;
85 };
86
87
88 //--------------------------------------------------------------------------
89 // wxHtmlHelpHashData (private)
90 //--------------------------------------------------------------------------
91
92 class wxHtmlHelpHashData : public wxObject
93 {
94 public:
95 wxHtmlHelpHashData(int index, wxTreeItemId id) : wxObject()
96 { m_Index = index; m_Id = id;}
97 ~wxHtmlHelpHashData() {}
98
99 int m_Index;
100 wxTreeItemId m_Id;
101 };
102
103
104 //--------------------------------------------------------------------------
105 // wxHtmlHelpHtmlWindow (private)
106 //--------------------------------------------------------------------------
107
108 class wxHtmlHelpHtmlWindow : public wxHtmlWindow
109 {
110 public:
111 wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) : wxHtmlWindow(parent), m_Frame(fr) {}
112
113 virtual void OnLinkClicked(const wxHtmlLinkInfo& link)
114 {
115 wxHtmlWindow::OnLinkClicked(link);
116 const wxMouseEvent *e = link.GetEvent();
117 if (e == NULL || e->LeftUp())
118 m_Frame->NotifyPageChanged();
119 }
120
121 private:
122 wxHtmlHelpFrame *m_Frame;
123
124 DECLARE_NO_COPY_CLASS(wxHtmlHelpHtmlWindow)
125 };
126
127
128
129 //---------------------------------------------------------------------------
130 // wxHtmlHelpFrame
131 //---------------------------------------------------------------------------
132
133 // Command IDs :
134 enum
135 {
136 //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1,
137 wxID_HTML_PANEL = wxID_HIGHEST + 2,
138 wxID_HTML_BACK,
139 wxID_HTML_FORWARD,
140 wxID_HTML_UPNODE,
141 wxID_HTML_UP,
142 wxID_HTML_DOWN,
143 wxID_HTML_PRINT,
144 wxID_HTML_OPENFILE,
145 wxID_HTML_OPTIONS,
146 wxID_HTML_BOOKMARKSLIST,
147 wxID_HTML_BOOKMARKSADD,
148 wxID_HTML_BOOKMARKSREMOVE,
149 wxID_HTML_TREECTRL,
150 wxID_HTML_INDEXPAGE,
151 wxID_HTML_INDEXLIST,
152 wxID_HTML_INDEXTEXT,
153 wxID_HTML_INDEXBUTTON,
154 wxID_HTML_INDEXBUTTONALL,
155 wxID_HTML_NOTEBOOK,
156 wxID_HTML_SEARCHPAGE,
157 wxID_HTML_SEARCHTEXT,
158 wxID_HTML_SEARCHLIST,
159 wxID_HTML_SEARCHBUTTON,
160 wxID_HTML_SEARCHCHOICE,
161 wxID_HTML_COUNTINFO
162 };
163
164
165 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame)
166
167 wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString& title,
168 int style, wxHtmlHelpData* data)
169 {
170 Init(data);
171 Create(parent, id, title, style);
172 }
173
174 void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
175 {
176 if (data)
177 {
178 m_Data = data;
179 m_DataCreated = FALSE;
180 } else
181 {
182 m_Data = new wxHtmlHelpData();
183 m_DataCreated = TRUE;
184 }
185
186 m_ContentsBox = NULL;
187 m_IndexList = NULL;
188 m_IndexButton = NULL;
189 m_IndexButtonAll = NULL;
190 m_IndexText = NULL;
191 m_SearchList = NULL;
192 m_SearchButton = NULL;
193 m_SearchText = NULL;
194 m_SearchChoice = NULL;
195 m_IndexCountInfo = NULL;
196 m_Splitter = NULL;
197 m_NavigPan = NULL;
198 m_NavigNotebook = NULL;
199 m_HtmlWin = NULL;
200 m_Bookmarks = NULL;
201 m_SearchCaseSensitive = NULL;
202 m_SearchWholeWords = NULL;
203
204 m_Config = NULL;
205 m_ConfigRoot = wxEmptyString;
206
207 m_Cfg.x = m_Cfg.y = 0;
208 m_Cfg.w = 700;
209 m_Cfg.h = 480;
210 m_Cfg.sashpos = 240;
211 m_Cfg.navig_on = TRUE;
212
213 m_NormalFonts = m_FixedFonts = NULL;
214 m_NormalFace = m_FixedFace = wxEmptyString;
215 #ifdef __WXMSW__
216 m_FontSize = 10;
217 #else
218 m_FontSize = 14;
219 #endif
220
221 #if wxUSE_PRINTING_ARCHITECTURE
222 m_Printer = NULL;
223 #endif
224
225 m_PagesHash = NULL;
226 m_UpdateContents = TRUE;
227 m_helpController = (wxHelpControllerBase*) NULL;
228 }
229
230 // Create: builds the GUI components.
231 // with the style flag it's possible to toggle the toolbar, contents, index and search
232 // controls.
233 // m_HtmlWin will *always* be created, but it's important to realize that
234 // m_ContentsBox, m_IndexList, m_SearchList, m_SearchButton, m_SearchText and
235 // m_SearchButton may be NULL.
236 // moreover, if no contents, index or searchpage is needed, m_Splitter and
237 // m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame)
238
239 bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id,
240 const wxString& WXUNUSED(title), int style)
241 {
242 m_hfStyle = style;
243
244 wxImageList *ContentsImageList = new wxImageList(16, 16);
245 ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, wxART_HELP_BROWSER));
246 ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, wxART_HELP_BROWSER));
247 ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, wxART_HELP_BROWSER));
248
249 // Do the config in two steps. We read the HtmlWindow customization after we
250 // create the window.
251 if (m_Config)
252 ReadCustomization(m_Config, m_ConfigRoot);
253
254 wxFrame::Create(parent, id, _("Help"),
255 wxPoint(m_Cfg.x, m_Cfg.y), wxSize(m_Cfg.w, m_Cfg.h),
256 wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp"));
257
258 GetPosition(&m_Cfg.x, &m_Cfg.y);
259
260 SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER));
261
262 // On the Mac, each modeless frame must have a menubar.
263 // TODO: add more menu items, and perhaps add a style to show
264 // the menubar: compulsory on the Mac, optional elsewhere.
265 #ifdef __WXMAC__
266 wxMenuBar* menuBar = new wxMenuBar;
267
268 wxMenu* fileMenu = new wxMenu;
269 fileMenu->Append(wxID_HTML_OPENFILE, _("&Open..."));
270 fileMenu->AppendSeparator();
271 fileMenu->Append(wxID_CLOSE, _("&Close"));
272
273 wxMenu* helpMenu = new wxMenu;
274 helpMenu->Append(wxID_ABOUT, _("&About..."));
275
276 menuBar->Append(fileMenu,_("File"));
277 menuBar->Append(helpMenu,_("Help"));
278 SetMenuBar(menuBar);
279 #endif
280
281 int notebook_page = 0;
282
283 CreateStatusBar();
284
285 // toolbar?
286 if (style & (wxHF_TOOLBAR | wxHF_FLAT_TOOLBAR))
287 {
288 wxToolBar *toolBar = CreateToolBar(wxNO_BORDER | wxTB_HORIZONTAL |
289 wxTB_DOCKABLE |
290 (style & wxHF_FLAT_TOOLBAR ? wxTB_FLAT : 0));
291 toolBar->SetMargins( 2, 2 );
292 AddToolbarButtons(toolBar, style);
293 toolBar->Realize();
294 }
295
296 wxSizer *navigSizer = NULL;
297
298 if (style & (wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH))
299 {
300 // traditional help controller; splitter window with html page on the
301 // right and a notebook containing various pages on the left
302 m_Splitter = new wxSplitterWindow(this);
303
304 m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter);
305 m_NavigPan = new wxPanel(m_Splitter, -1);
306 m_NavigNotebook = new wxNotebook(m_NavigPan, wxID_HTML_NOTEBOOK,
307 wxDefaultPosition, wxDefaultSize);
308 wxNotebookSizer *nbs = new wxNotebookSizer(m_NavigNotebook);
309
310 navigSizer = new wxBoxSizer(wxVERTICAL);
311 navigSizer->Add(nbs, 1, wxEXPAND);
312
313 m_NavigPan->SetAutoLayout(TRUE);
314 m_NavigPan->SetSizer(navigSizer);
315 }
316 else
317 { // only html window, no notebook with index,contents etc
318 m_HtmlWin = new wxHtmlWindow(this);
319 }
320
321 m_HtmlWin->SetRelatedFrame(this, m_TitleFormat);
322 m_HtmlWin->SetRelatedStatusBar(0);
323 if ( m_Config )
324 m_HtmlWin->ReadCustomization(m_Config, m_ConfigRoot);
325
326 // contents tree panel?
327 if ( style & wxHF_CONTENTS )
328 {
329 wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
330 wxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
331
332 topsizer->Add(0, 10);
333
334 dummy->SetAutoLayout(TRUE);
335 dummy->SetSizer(topsizer);
336
337 if ( style & wxHF_BOOKMARKS )
338 {
339 m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST,
340 wxEmptyString,
341 wxDefaultPosition, wxDefaultSize,
342 0, NULL, wxCB_READONLY | wxCB_SORT);
343 m_Bookmarks->Append(_("(bookmarks)"));
344 for (unsigned i = 0; i < m_BookmarksNames.GetCount(); i++)
345 m_Bookmarks->Append(m_BookmarksNames[i]);
346 m_Bookmarks->SetSelection(0);
347
348 wxBitmapButton *bmpbt1, *bmpbt2;
349 bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD,
350 wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK,
351 wxART_HELP_BROWSER));
352 bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE,
353 wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK,
354 wxART_HELP_BROWSER));
355 #if wxUSE_TOOLTIPS
356 bmpbt1->SetToolTip(_("Add current page to bookmarks"));
357 bmpbt2->SetToolTip(_("Remove current page from bookmarks"));
358 #endif // wxUSE_TOOLTIPS
359
360 wxSizer *sizer = new wxBoxSizer(wxHORIZONTAL);
361
362 sizer->Add(m_Bookmarks, 1, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 5);
363 sizer->Add(bmpbt1, 0, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 2);
364 sizer->Add(bmpbt2, 0, wxALIGN_CENTRE_VERTICAL, 0);
365
366 topsizer->Add(sizer, 0, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 10);
367 }
368
369 m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL,
370 wxDefaultPosition, wxDefaultSize,
371 wxSUNKEN_BORDER |
372 wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT |
373 wxTR_LINES_AT_ROOT);
374
375 m_ContentsBox->AssignImageList(ContentsImageList);
376
377 topsizer->Add(m_ContentsBox, 1, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 2);
378
379 m_NavigNotebook->AddPage(dummy, _("Contents"));
380 m_ContentsPage = notebook_page++;
381 }
382
383 // index listbox panel?
384 if ( style & wxHF_INDEX )
385 {
386 wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
387 wxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
388
389 dummy->SetAutoLayout(TRUE);
390 dummy->SetSizer(topsizer);
391
392 m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString,
393 wxDefaultPosition, wxDefaultSize,
394 wxTE_PROCESS_ENTER);
395 m_IndexButton = new wxButton(dummy, wxID_HTML_INDEXBUTTON, _("Find"));
396 m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL,
397 _("Show all"));
398 m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO,
399 wxEmptyString, wxDefaultPosition,
400 wxDefaultSize,
401 wxALIGN_RIGHT | wxST_NO_AUTORESIZE);
402 m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST,
403 wxDefaultPosition, wxDefaultSize,
404 0, NULL, wxLB_SINGLE);
405
406 #if wxUSE_TOOLTIPS
407 m_IndexButton->SetToolTip(_("Display all index items that contain given substring. Search is case insensitive."));
408 m_IndexButtonAll->SetToolTip(_("Show all items in index"));
409 #endif //wxUSE_TOOLTIPS
410
411 topsizer->Add(m_IndexText, 0, wxEXPAND | wxALL, 10);
412 wxSizer *btsizer = new wxBoxSizer(wxHORIZONTAL);
413 btsizer->Add(m_IndexButton, 0, wxRIGHT, 2);
414 btsizer->Add(m_IndexButtonAll);
415 topsizer->Add(btsizer, 0,
416 wxALIGN_RIGHT | wxLEFT | wxRIGHT | wxBOTTOM, 10);
417 topsizer->Add(m_IndexCountInfo, 0, wxEXPAND | wxLEFT | wxRIGHT, 2);
418 topsizer->Add(m_IndexList, 1, wxEXPAND | wxALL, 2);
419
420 m_NavigNotebook->AddPage(dummy, _("Index"));
421 m_IndexPage = notebook_page++;
422 }
423
424 // search list panel?
425 if ( style & wxHF_SEARCH )
426 {
427 wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
428 wxSizer *sizer = new wxBoxSizer(wxVERTICAL);
429
430 dummy->SetAutoLayout(TRUE);
431 dummy->SetSizer(sizer);
432
433 m_SearchText = new wxTextCtrl(dummy, wxID_HTML_SEARCHTEXT,
434 wxEmptyString,
435 wxDefaultPosition, wxDefaultSize,
436 wxTE_PROCESS_ENTER);
437 m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE,
438 wxDefaultPosition, wxDefaultSize);
439 m_SearchCaseSensitive = new wxCheckBox(dummy, -1, _("Case sensitive"));
440 m_SearchWholeWords = new wxCheckBox(dummy, -1, _("Whole words only"));
441 m_SearchButton = new wxButton(dummy, wxID_HTML_SEARCHBUTTON, _("Search"));
442 #if wxUSE_TOOLTIPS
443 m_SearchButton->SetToolTip(_("Search contents of help book(s) for all occurences of the text you typed above"));
444 #endif //wxUSE_TOOLTIPS
445 m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST,
446 wxDefaultPosition, wxDefaultSize,
447 0, NULL, wxLB_SINGLE);
448
449 sizer->Add(m_SearchText, 0, wxEXPAND | wxALL, 10);
450 sizer->Add(m_SearchChoice, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 10);
451 sizer->Add(m_SearchCaseSensitive, 0, wxLEFT | wxRIGHT, 10);
452 sizer->Add(m_SearchWholeWords, 0, wxLEFT | wxRIGHT, 10);
453 sizer->Add(m_SearchButton, 0, wxALL | wxALIGN_RIGHT, 8);
454 sizer->Add(m_SearchList, 1, wxALL | wxEXPAND, 2);
455
456 m_NavigNotebook->AddPage(dummy, _("Search"));
457 m_SearchPage = notebook_page++;
458 }
459
460 m_HtmlWin->Show(TRUE);
461
462 RefreshLists();
463
464 if ( navigSizer )
465 {
466 navigSizer->SetSizeHints(m_NavigPan);
467 m_NavigPan->Layout();
468 }
469
470 // showtime
471 if ( m_NavigPan && m_Splitter )
472 {
473 m_Splitter->SetMinimumPaneSize(20);
474 if ( m_Cfg.navig_on )
475 m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
476
477 if ( m_Cfg.navig_on )
478 {
479 m_NavigPan->Show(TRUE);
480 m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
481 }
482 else
483 {
484 m_NavigPan->Show(FALSE);
485 m_Splitter->Initialize(m_HtmlWin);
486 }
487 }
488
489 return TRUE;
490 }
491
492 wxHtmlHelpFrame::~wxHtmlHelpFrame()
493 {
494 // PopEventHandler(); // wxhtmlhelpcontroller (not any more!)
495 if (m_DataCreated)
496 delete m_Data;
497 if (m_NormalFonts) delete m_NormalFonts;
498 if (m_FixedFonts) delete m_FixedFonts;
499 if (m_PagesHash)
500 {
501 WX_CLEAR_HASH_TABLE(*m_PagesHash);
502 delete m_PagesHash;
503 }
504 }
505
506
507 void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style)
508 {
509 wxBitmap wpanelBitmap =
510 wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_HELP_BROWSER);
511 wxBitmap wbackBitmap =
512 wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_HELP_BROWSER);
513 wxBitmap wforwardBitmap =
514 wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_HELP_BROWSER);
515 wxBitmap wupnodeBitmap =
516 wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_HELP_BROWSER);
517 wxBitmap wupBitmap =
518 wxArtProvider::GetBitmap(wxART_GO_UP, wxART_HELP_BROWSER);
519 wxBitmap wdownBitmap =
520 wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_HELP_BROWSER);
521 wxBitmap wopenBitmap =
522 wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_HELP_BROWSER);
523 wxBitmap wprintBitmap =
524 wxArtProvider::GetBitmap(wxART_PRINT, wxART_HELP_BROWSER);
525 wxBitmap woptionsBitmap =
526 wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_HELP_BROWSER);
527
528 wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() &&
529 wforwardBitmap.Ok() && wupnodeBitmap.Ok() &&
530 wupBitmap.Ok() && wdownBitmap.Ok() &&
531 wopenBitmap.Ok() && wprintBitmap.Ok() &&
532 woptionsBitmap.Ok()),
533 wxT("One or more HTML help frame toolbar bitmap could not be loaded.")) ;
534
535
536 toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap,
537 FALSE, -1, -1, (wxObject *) NULL,
538 _("Show/hide navigation panel"));
539
540 toolBar->AddSeparator();
541 toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap,
542 FALSE, -1, -1, (wxObject *) NULL,
543 _("Go back"));
544 toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap,
545 FALSE, -1, -1, (wxObject *) NULL,
546 _("Go forward"));
547 toolBar->AddSeparator();
548
549 toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap,
550 FALSE, -1, -1, (wxObject *) NULL,
551 _("Go one level up in document hierarchy"));
552 toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap,
553 FALSE, -1, -1, (wxObject *) NULL,
554 _("Previous page"));
555 toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap,
556 FALSE, -1, -1, (wxObject *) NULL,
557 _("Next page"));
558
559 if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES))
560 toolBar->AddSeparator();
561
562 if (style & wxHF_OPEN_FILES)
563 toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap,
564 FALSE, -1, -1, (wxObject *) NULL,
565 _("Open HTML document"));
566
567 #if wxUSE_PRINTING_ARCHITECTURE
568 if (style & wxHF_PRINT)
569 toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap,
570 FALSE, -1, -1, (wxObject *) NULL,
571 _("Print this page"));
572 #endif
573
574 toolBar->AddSeparator();
575 toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap,
576 FALSE, -1, -1, (wxObject *) NULL,
577 _("Display options dialog"));
578 }
579
580
581 void wxHtmlHelpFrame::SetTitleFormat(const wxString& format)
582 {
583 if (m_HtmlWin)
584 m_HtmlWin->SetRelatedFrame(this, format);
585 m_TitleFormat = format;
586 }
587
588
589 bool wxHtmlHelpFrame::Display(const wxString& x)
590 {
591 wxString url = m_Data->FindPageByName(x);
592 if (!url.IsEmpty())
593 {
594 m_HtmlWin->LoadPage(url);
595 NotifyPageChanged();
596 return TRUE;
597 }
598 return FALSE;
599 }
600
601 bool wxHtmlHelpFrame::Display(const int id)
602 {
603 wxString url = m_Data->FindPageById(id);
604 if (!url.IsEmpty())
605 {
606 m_HtmlWin->LoadPage(url);
607 NotifyPageChanged();
608 return TRUE;
609 }
610 return FALSE;
611 }
612
613
614
615 bool wxHtmlHelpFrame::DisplayContents()
616 {
617 if (! m_ContentsBox)
618 return FALSE;
619 if (!m_Splitter->IsSplit())
620 {
621 m_NavigPan->Show(TRUE);
622 m_HtmlWin->Show(TRUE);
623 m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
624 m_Cfg.navig_on = TRUE;
625 }
626 m_NavigNotebook->SetSelection(0);
627 if (m_Data->GetBookRecArray().GetCount() > 0)
628 {
629 wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
630 if (!book.GetStart().IsEmpty())
631 m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
632 }
633 return TRUE;
634 }
635
636
637
638 bool wxHtmlHelpFrame::DisplayIndex()
639 {
640 if (! m_IndexList)
641 return FALSE;
642 if (!m_Splitter->IsSplit())
643 {
644 m_NavigPan->Show(TRUE);
645 m_HtmlWin->Show(TRUE);
646 m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
647 }
648 m_NavigNotebook->SetSelection(1);
649 if (m_Data->GetBookRecArray().GetCount() > 0)
650 {
651 wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
652 if (!book.GetStart().IsEmpty())
653 m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
654 }
655 return TRUE;
656 }
657
658
659
660 bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword,
661 wxHelpSearchMode mode)
662 {
663 if (mode == wxHELP_SEARCH_ALL)
664 {
665 if ( !(m_SearchList &&
666 m_SearchButton && m_SearchText && m_SearchChoice) )
667 return false;
668 }
669 else if (mode == wxHELP_SEARCH_INDEX)
670 {
671 if ( !(m_IndexList &&
672 m_IndexButton && m_IndexButtonAll && m_IndexText) )
673 return false;
674 }
675
676 int foundcnt = 0;
677 wxString foundstr;
678 wxString book = wxEmptyString;
679
680 if (!m_Splitter->IsSplit())
681 {
682 m_NavigPan->Show(TRUE);
683 m_HtmlWin->Show(TRUE);
684 m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
685 }
686
687 if (mode == wxHELP_SEARCH_ALL)
688 {
689 m_NavigNotebook->SetSelection(m_SearchPage);
690 m_SearchList->Clear();
691 m_SearchText->SetValue(keyword);
692 m_SearchButton->Enable(false);
693
694 if (m_SearchChoice->GetSelection() != 0)
695 book = m_SearchChoice->GetStringSelection();
696
697 wxHtmlSearchStatus status(m_Data, keyword,
698 m_SearchCaseSensitive->GetValue(),
699 m_SearchWholeWords->GetValue(),
700 book);
701
702 wxProgressDialog progress(_("Searching..."),
703 _("No matching page found yet"),
704 status.GetMaxIndex(), this,
705 wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE);
706
707 int curi;
708 while (status.IsActive())
709 {
710 curi = status.GetCurIndex();
711 if (curi % 32 == 0 && progress.Update(curi) == FALSE)
712 break;
713 if (status.Search())
714 {
715 foundstr.Printf(_("Found %i matches"), ++foundcnt);
716 progress.Update(status.GetCurIndex(), foundstr);
717 m_SearchList->Append(status.GetName(), status.GetContentsItem());
718 }
719 }
720
721 m_SearchButton->Enable(TRUE);
722 m_SearchText->SetSelection(0, keyword.Length());
723 m_SearchText->SetFocus();
724 }
725 else if (mode == wxHELP_SEARCH_INDEX)
726 {
727 m_NavigNotebook->SetSelection(m_IndexPage);
728 m_IndexList->Clear();
729 m_IndexButton->Enable(false);
730 m_IndexButtonAll->Enable(false);
731 m_IndexText->SetValue(keyword);
732
733 wxCommandEvent dummy;
734 OnIndexFind(dummy); // what a hack...
735 m_IndexButton->Enable(true);
736 m_IndexButtonAll->Enable(true);
737 foundcnt = m_IndexList->GetCount();
738 }
739
740 if (foundcnt)
741 {
742 wxHtmlContentsItem *it;
743 switch ( mode )
744 {
745 default:
746 wxFAIL_MSG( _T("unknown help search mode") );
747 // fall back
748
749 case wxHELP_SEARCH_ALL:
750 it = (wxHtmlContentsItem*) m_SearchList->GetClientData(0);
751 break;
752
753 case wxHELP_SEARCH_INDEX:
754 it = (wxHtmlContentsItem*) m_IndexList->GetClientData(0);
755 break;
756 }
757
758 if (it)
759 {
760 m_HtmlWin->LoadPage(it->GetFullPath());
761 NotifyPageChanged();
762 }
763 }
764
765 return foundcnt > 0;
766 }
767
768 void wxHtmlHelpFrame::CreateContents()
769 {
770 if (! m_ContentsBox)
771 return ;
772
773 if (m_PagesHash)
774 {
775 WX_CLEAR_HASH_TABLE(*m_PagesHash);
776 delete m_PagesHash;
777 }
778 m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * m_Data->GetContentsCnt());
779
780 int cnt = m_Data->GetContentsCnt();
781 int i;
782
783 wxHtmlContentsItem *it;
784
785 const int MAX_ROOTS = 64;
786 wxTreeItemId roots[MAX_ROOTS];
787 // VS: this array holds information about whether we've set item icon at
788 // given level. This is neccessary because m_Data has flat structure
789 // and there's no way of recognizing if some item has subitems or not.
790 // We set the icon later: when we find an item with level=n, we know
791 // that the last item with level=n-1 was folder with subitems, so we
792 // set its icon accordingly
793 bool imaged[MAX_ROOTS];
794 m_ContentsBox->DeleteAllItems();
795
796 roots[0] = m_ContentsBox->AddRoot(_("(Help)"));
797 imaged[0] = TRUE;
798
799 for (it = m_Data->GetContents(), i = 0; i < cnt; i++, it++)
800 {
801 // Handle books:
802 if (it->m_Level == 0)
803 {
804 if (m_hfStyle & wxHF_MERGE_BOOKS)
805 // VS: we don't want book nodes, books' content should
806 // appear under tree's root. This line will create "fake"
807 // record about book node so that the rest of this look
808 // will believe there really _is_ book node and will
809 // behave correctly.
810 roots[1] = roots[0];
811 else
812 {
813 roots[1] = m_ContentsBox->AppendItem(roots[0],
814 it->m_Name, IMG_Book, -1,
815 new wxHtmlHelpTreeItemData(i));
816 m_ContentsBox->SetItemBold(roots[1], TRUE);
817 }
818 imaged[1] = TRUE;
819 }
820 // ...and their contents:
821 else
822 {
823 roots[it->m_Level + 1] = m_ContentsBox->AppendItem(
824 roots[it->m_Level], it->m_Name, IMG_Page,
825 -1, new wxHtmlHelpTreeItemData(i));
826 imaged[it->m_Level + 1] = FALSE;
827 }
828
829 m_PagesHash->Put(it->GetFullPath(),
830 new wxHtmlHelpHashData(i, roots[it->m_Level + 1]));
831
832 // Set the icon for the node one level up in the hiearachy,
833 // unless already done (see comment above imaged[] declaration)
834 if (!imaged[it->m_Level])
835 {
836 int image = IMG_Folder;
837 if (m_hfStyle & wxHF_ICONS_BOOK)
838 image = IMG_Book;
839 else if (m_hfStyle & wxHF_ICONS_BOOK_CHAPTER)
840 image = (it->m_Level == 1) ? IMG_Book : IMG_Folder;
841 m_ContentsBox->SetItemImage(roots[it->m_Level], image);
842 m_ContentsBox->SetItemImage(roots[it->m_Level], image,
843 wxTreeItemIcon_Selected);
844 imaged[it->m_Level] = TRUE;
845 }
846 }
847 }
848
849
850 void wxHtmlHelpFrame::CreateIndex()
851 {
852 if (! m_IndexList)
853 return ;
854
855 m_IndexList->Clear();
856
857 int cnt = m_Data->GetIndexCnt();
858
859 wxString cnttext;
860 if (cnt > INDEX_IS_SMALL) cnttext.Printf(_("%i of %i"), 0, cnt);
861 else cnttext.Printf(_("%i of %i"), cnt, cnt);
862 m_IndexCountInfo->SetLabel(cnttext);
863 if (cnt > INDEX_IS_SMALL) return;
864
865 wxHtmlContentsItem* index = m_Data->GetIndex();
866
867 for (int i = 0; i < cnt; i++)
868 m_IndexList->Append(index[i].m_Name, (char*)(index + i));
869 }
870
871 void wxHtmlHelpFrame::CreateSearch()
872 {
873 if (! (m_SearchList && m_SearchChoice))
874 return ;
875 m_SearchList->Clear();
876 m_SearchChoice->Clear();
877 m_SearchChoice->Append(_("Search in all books"));
878 const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray();
879 int i, cnt = bookrec.GetCount();
880 for (i = 0; i < cnt; i++)
881 m_SearchChoice->Append(bookrec[i].GetTitle());
882 m_SearchChoice->SetSelection(0);
883 }
884
885
886 void wxHtmlHelpFrame::RefreshLists()
887 {
888 CreateContents();
889 CreateIndex();
890 CreateSearch();
891 }
892
893 void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path)
894 {
895 wxString oldpath;
896 wxString tmp;
897
898 if (path != wxEmptyString)
899 {
900 oldpath = cfg->GetPath();
901 cfg->SetPath(_T("/") + path);
902 }
903
904 m_Cfg.navig_on = cfg->Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0;
905 m_Cfg.sashpos = cfg->Read(wxT("hcSashPos"), m_Cfg.sashpos);
906 m_Cfg.x = cfg->Read(wxT("hcX"), m_Cfg.x);
907 m_Cfg.y = cfg->Read(wxT("hcY"), m_Cfg.y);
908 m_Cfg.w = cfg->Read(wxT("hcW"), m_Cfg.w);
909 m_Cfg.h = cfg->Read(wxT("hcH"), m_Cfg.h);
910
911 m_FixedFace = cfg->Read(wxT("hcFixedFace"), m_FixedFace);
912 m_NormalFace = cfg->Read(wxT("hcNormalFace"), m_NormalFace);
913 m_FontSize = cfg->Read(wxT("hcBaseFontSize"), m_FontSize);
914
915 {
916 int i;
917 int cnt;
918 wxString val, s;
919
920 cnt = cfg->Read(wxT("hcBookmarksCnt"), 0L);
921 if (cnt != 0)
922 {
923 m_BookmarksNames.Clear();
924 m_BookmarksPages.Clear();
925 if (m_Bookmarks)
926 {
927 m_Bookmarks->Clear();
928 m_Bookmarks->Append(_("(bookmarks)"));
929 }
930
931 for (i = 0; i < cnt; i++)
932 {
933 val.Printf(wxT("hcBookmark_%i"), i);
934 s = cfg->Read(val);
935 m_BookmarksNames.Add(s);
936 if (m_Bookmarks) m_Bookmarks->Append(s);
937 val.Printf(wxT("hcBookmark_%i_url"), i);
938 s = cfg->Read(val);
939 m_BookmarksPages.Add(s);
940 }
941 }
942 }
943
944 if (m_HtmlWin)
945 m_HtmlWin->ReadCustomization(cfg);
946
947 if (path != wxEmptyString)
948 cfg->SetPath(oldpath);
949 }
950
951 void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path)
952 {
953 wxString oldpath;
954 wxString tmp;
955
956 if (path != wxEmptyString)
957 {
958 oldpath = cfg->GetPath();
959 cfg->SetPath(_T("/") + path);
960 }
961
962 cfg->Write(wxT("hcNavigPanel"), m_Cfg.navig_on);
963 cfg->Write(wxT("hcSashPos"), (long)m_Cfg.sashpos);
964 if ( !IsIconized() )
965 {
966 // Don't write if iconized as this would make the window
967 // disappear next time it is shown!
968 cfg->Write(wxT("hcX"), (long)m_Cfg.x);
969 cfg->Write(wxT("hcY"), (long)m_Cfg.y);
970 cfg->Write(wxT("hcW"), (long)m_Cfg.w);
971 cfg->Write(wxT("hcH"), (long)m_Cfg.h);
972 }
973 cfg->Write(wxT("hcFixedFace"), m_FixedFace);
974 cfg->Write(wxT("hcNormalFace"), m_NormalFace);
975 cfg->Write(wxT("hcBaseFontSize"), (long)m_FontSize);
976
977 if (m_Bookmarks)
978 {
979 int i;
980 int cnt = m_BookmarksNames.GetCount();
981 wxString val;
982
983 cfg->Write(wxT("hcBookmarksCnt"), (long)cnt);
984 for (i = 0; i < cnt; i++)
985 {
986 val.Printf(wxT("hcBookmark_%i"), i);
987 cfg->Write(val, m_BookmarksNames[i]);
988 val.Printf(wxT("hcBookmark_%i_url"), i);
989 cfg->Write(val, m_BookmarksPages[i]);
990 }
991 }
992
993 if (m_HtmlWin)
994 m_HtmlWin->WriteCustomization(cfg);
995
996 if (path != wxEmptyString)
997 cfg->SetPath(oldpath);
998 }
999
1000
1001
1002
1003
1004 static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, wxString fixf, int size)
1005 {
1006 int f_sizes[7];
1007 f_sizes[0] = int(size * 0.6);
1008 f_sizes[1] = int(size * 0.8);
1009 f_sizes[2] = size;
1010 f_sizes[3] = int(size * 1.2);
1011 f_sizes[4] = int(size * 1.4);
1012 f_sizes[5] = int(size * 1.6);
1013 f_sizes[6] = int(size * 1.8);
1014
1015 win->SetFonts(scalf, fixf, f_sizes);
1016 }
1017
1018
1019 class wxHtmlHelpFrameOptionsDialog : public wxDialog
1020 {
1021 public:
1022 wxComboBox *NormalFont, *FixedFont;
1023 wxSpinCtrl *FontSize;
1024 wxHtmlWindow *TestWin;
1025
1026 wxHtmlHelpFrameOptionsDialog(wxWindow *parent)
1027 : wxDialog(parent, -1, wxString(_("Help Browser Options")))
1028 {
1029 wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
1030 wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 3, 2, 5);
1031
1032 sizer->Add(new wxStaticText(this, -1, _("Normal font:")));
1033 sizer->Add(new wxStaticText(this, -1, _("Fixed font:")));
1034 sizer->Add(new wxStaticText(this, -1, _("Font size:")));
1035
1036 sizer->Add(NormalFont = new wxComboBox(this, -1, wxEmptyString, wxDefaultPosition,
1037 wxSize(200, 200),
1038 0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
1039
1040 sizer->Add(FixedFont = new wxComboBox(this, -1, wxEmptyString, wxDefaultPosition,
1041 wxSize(200, 200),
1042 0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
1043
1044 sizer->Add(FontSize = new wxSpinCtrl(this, -1));
1045 FontSize->SetRange(2, 100);
1046
1047 topsizer->Add(sizer, 0, wxLEFT|wxRIGHT|wxTOP, 10);
1048
1049 topsizer->Add(new wxStaticText(this, -1, _("Preview:")),
1050 0, wxLEFT | wxTOP, 10);
1051 topsizer->Add(TestWin = new wxHtmlWindow(this, -1, wxDefaultPosition, wxSize(20, 150),
1052 wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER),
1053 1, wxEXPAND | wxLEFT|wxTOP|wxRIGHT, 10);
1054
1055 wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL);
1056 wxButton *ok;
1057 sizer2->Add(ok = new wxButton(this, wxID_OK, _("OK")), 0, wxALL, 10);
1058 ok->SetDefault();
1059 sizer2->Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10);
1060 topsizer->Add(sizer2, 0, wxALIGN_RIGHT);
1061
1062 SetAutoLayout(TRUE);
1063 SetSizer(topsizer);
1064 topsizer->Fit(this);
1065 Centre(wxBOTH);
1066 }
1067
1068
1069 void UpdateTestWin()
1070 {
1071 wxBusyCursor bcur;
1072 SetFontsToHtmlWin(TestWin,
1073 NormalFont->GetStringSelection(),
1074 FixedFont->GetStringSelection(),
1075 FontSize->GetValue());
1076 TestWin->SetPage(_(
1077 "<html><body>\
1078 <table><tr><td>\
1079 Normal face<br>(and <u>underlined</u>. <i>Italic face.</i> \
1080 <b>Bold face.</b> <b><i>Bold italic face.</i></b><br>\
1081 <font size=-2>font size -2</font><br>\
1082 <font size=-1>font size -1</font><br>\
1083 <font size=+0>font size +0</font><br>\
1084 <font size=+1>font size +1</font><br>\
1085 <font size=+2>font size +2</font><br>\
1086 <font size=+3>font size +3</font><br>\
1087 <font size=+4>font size +4</font><br>\
1088 <td>\
1089 <p><tt>Fixed size face.<br> <b>bold</b> <i>italic</i> \
1090 <b><i>bold italic <u>underlined</u></i></b><br>\
1091 <font size=-2>font size -2</font><br>\
1092 <font size=-1>font size -1</font><br>\
1093 <font size=+0>font size +0</font><br>\
1094 <font size=+1>font size +1</font><br>\
1095 <font size=+2>font size +2</font><br>\
1096 <font size=+3>font size +3</font><br>\
1097 <font size=+4>font size +4</font></tt>\
1098 </table></body></html>"
1099 ));
1100 }
1101
1102 void OnUpdate(wxCommandEvent& WXUNUSED(event))
1103 {
1104 UpdateTestWin();
1105 }
1106 void OnUpdateSpin(wxSpinEvent& WXUNUSED(event))
1107 {
1108 UpdateTestWin();
1109 }
1110
1111 DECLARE_EVENT_TABLE()
1112 DECLARE_NO_COPY_CLASS(wxHtmlHelpFrameOptionsDialog)
1113 };
1114
1115 BEGIN_EVENT_TABLE(wxHtmlHelpFrameOptionsDialog, wxDialog)
1116 EVT_COMBOBOX(-1, wxHtmlHelpFrameOptionsDialog::OnUpdate)
1117 EVT_SPINCTRL(-1, wxHtmlHelpFrameOptionsDialog::OnUpdateSpin)
1118 END_EVENT_TABLE()
1119
1120 void wxHtmlHelpFrame::OptionsDialog()
1121 {
1122 wxHtmlHelpFrameOptionsDialog dlg(this);
1123 unsigned i;
1124
1125 if (m_NormalFonts == NULL)
1126 {
1127 wxFontEnumerator enu;
1128 enu.EnumerateFacenames();
1129 m_NormalFonts = new wxArrayString;
1130 *m_NormalFonts = *enu.GetFacenames();
1131 m_NormalFonts->Sort(wxStringSortAscending);
1132 }
1133 if (m_FixedFonts == NULL)
1134 {
1135 wxFontEnumerator enu;
1136 enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, TRUE);
1137 m_FixedFonts = new wxArrayString;
1138 *m_FixedFonts = *enu.GetFacenames();
1139 m_FixedFonts->Sort(wxStringSortAscending);
1140 }
1141
1142 // VS: We want to show the font that is actually used by wxHtmlWindow.
1143 // If customization dialog wasn't used yet, facenames are empty and
1144 // wxHtmlWindow uses default fonts -- let's find out what they
1145 // are so that we can pass them to the dialog:
1146 if (m_NormalFace.empty())
1147 {
1148 wxFont fnt(m_FontSize, wxSWISS, wxNORMAL, wxNORMAL, FALSE);
1149 m_NormalFace = fnt.GetFaceName();
1150 }
1151 if (m_FixedFace.empty())
1152 {
1153 wxFont fnt(m_FontSize, wxMODERN, wxNORMAL, wxNORMAL, FALSE);
1154 m_FixedFace = fnt.GetFaceName();
1155 }
1156
1157 for (i = 0; i < m_NormalFonts->GetCount(); i++)
1158 dlg.NormalFont->Append((*m_NormalFonts)[i]);
1159 for (i = 0; i < m_FixedFonts->GetCount(); i++)
1160 dlg.FixedFont->Append((*m_FixedFonts)[i]);
1161 if (!m_NormalFace.empty())
1162 dlg.NormalFont->SetStringSelection(m_NormalFace);
1163 else
1164 dlg.NormalFont->SetSelection(0);
1165 if (!m_FixedFace.empty())
1166 dlg.FixedFont->SetStringSelection(m_FixedFace);
1167 else
1168 dlg.FixedFont->SetSelection(0);
1169 dlg.FontSize->SetValue(m_FontSize);
1170 dlg.UpdateTestWin();
1171
1172 if (dlg.ShowModal() == wxID_OK)
1173 {
1174 m_NormalFace = dlg.NormalFont->GetStringSelection();
1175 m_FixedFace = dlg.FixedFont->GetStringSelection();
1176 m_FontSize = dlg.FontSize->GetValue();
1177 SetFontsToHtmlWin(m_HtmlWin, m_NormalFace, m_FixedFace, m_FontSize);
1178 }
1179 }
1180
1181
1182
1183 void wxHtmlHelpFrame::NotifyPageChanged()
1184 {
1185 if (m_UpdateContents && m_PagesHash)
1186 {
1187 wxString an = m_HtmlWin->GetOpenedAnchor();
1188 wxHtmlHelpHashData *ha;
1189 if (an.IsEmpty())
1190 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1191 else
1192 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1193 if (ha)
1194 {
1195 bool olduc = m_UpdateContents;
1196 m_UpdateContents = FALSE;
1197 m_ContentsBox->SelectItem(ha->m_Id);
1198 m_ContentsBox->EnsureVisible(ha->m_Id);
1199 m_UpdateContents = olduc;
1200 }
1201 }
1202 }
1203
1204
1205
1206 /*
1207 EVENT HANDLING :
1208 */
1209
1210
1211 void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event)
1212 {
1213 // This saves one mouse click when using the
1214 // wxHTML for context sensitive help systems
1215 #ifndef __WXGTK__
1216 // NB: wxActivateEvent is a bit broken in wxGTK
1217 // and is sometimes sent when it should not be
1218 if (event.GetActive() && m_HtmlWin)
1219 m_HtmlWin->SetFocus();
1220 #endif
1221
1222 event.Skip();
1223 }
1224
1225 void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event)
1226 {
1227 switch (event.GetId())
1228 {
1229 case wxID_HTML_BACK :
1230 m_HtmlWin->HistoryBack();
1231 NotifyPageChanged();
1232 break;
1233
1234 case wxID_HTML_FORWARD :
1235 m_HtmlWin->HistoryForward();
1236 NotifyPageChanged();
1237 break;
1238
1239 case wxID_HTML_UP :
1240 if (m_PagesHash)
1241 {
1242 wxString an = m_HtmlWin->GetOpenedAnchor();
1243 wxHtmlHelpHashData *ha;
1244 if (an.IsEmpty())
1245 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1246 else
1247 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1248 if (ha && ha->m_Index > 0)
1249 {
1250 wxHtmlContentsItem *it = m_Data->GetContents() + (ha->m_Index - 1);
1251 if (it->m_Page[0] != 0)
1252 {
1253 m_HtmlWin->LoadPage(it->GetFullPath());
1254 NotifyPageChanged();
1255 }
1256 }
1257 }
1258 break;
1259
1260 case wxID_HTML_UPNODE :
1261 if (m_PagesHash)
1262 {
1263 wxString an = m_HtmlWin->GetOpenedAnchor();
1264 wxHtmlHelpHashData *ha;
1265 if (an.IsEmpty())
1266 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1267 else
1268 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1269 if (ha && ha->m_Index > 0)
1270 {
1271 int level = m_Data->GetContents()[ha->m_Index].m_Level - 1;
1272 wxHtmlContentsItem *it;
1273 int ind = ha->m_Index - 1;
1274
1275 it = m_Data->GetContents() + ind;
1276 while (ind >= 0 && it->m_Level != level) ind--, it--;
1277 if (ind >= 0)
1278 {
1279 if (it->m_Page[0] != 0)
1280 {
1281 m_HtmlWin->LoadPage(it->GetFullPath());
1282 NotifyPageChanged();
1283 }
1284 }
1285 }
1286 }
1287 break;
1288
1289 case wxID_HTML_DOWN :
1290 if (m_PagesHash)
1291 {
1292 wxString an = m_HtmlWin->GetOpenedAnchor();
1293 wxString adr;
1294 wxHtmlHelpHashData *ha;
1295
1296 if (an.IsEmpty()) adr = m_HtmlWin->GetOpenedPage();
1297 else adr = m_HtmlWin->GetOpenedPage() + wxT("#") + an;
1298
1299 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(adr);
1300
1301 if (ha && ha->m_Index < m_Data->GetContentsCnt() - 1)
1302 {
1303 wxHtmlContentsItem *it = m_Data->GetContents() + (ha->m_Index + 1);
1304
1305 while (it->GetFullPath() == adr) it++;
1306
1307 if (it->m_Page[0] != 0)
1308 {
1309 m_HtmlWin->LoadPage(it->GetFullPath());
1310 NotifyPageChanged();
1311 }
1312 }
1313 }
1314 break;
1315
1316 case wxID_HTML_PANEL :
1317 {
1318 if (! (m_Splitter && m_NavigPan))
1319 return ;
1320 if (m_Splitter->IsSplit())
1321 {
1322 m_Cfg.sashpos = m_Splitter->GetSashPosition();
1323 m_Splitter->Unsplit(m_NavigPan);
1324 m_Cfg.navig_on = FALSE;
1325 }
1326 else
1327 {
1328 m_NavigPan->Show(TRUE);
1329 m_HtmlWin->Show(TRUE);
1330 m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
1331 m_Cfg.navig_on = TRUE;
1332 }
1333 }
1334 break;
1335
1336 case wxID_HTML_OPTIONS :
1337 OptionsDialog();
1338 break;
1339
1340 case wxID_HTML_BOOKMARKSADD :
1341 {
1342 wxString item;
1343 wxString url;
1344
1345 item = m_HtmlWin->GetOpenedPageTitle();
1346 url = m_HtmlWin->GetOpenedPage();
1347 if (item == wxEmptyString)
1348 item = url.AfterLast(wxT('/'));
1349 if (m_BookmarksPages.Index(url) == wxNOT_FOUND)
1350 {
1351 m_Bookmarks->Append(item);
1352 m_BookmarksNames.Add(item);
1353 m_BookmarksPages.Add(url);
1354 }
1355 }
1356 break;
1357
1358 case wxID_HTML_BOOKMARKSREMOVE :
1359 {
1360 wxString item;
1361 int pos;
1362
1363 item = m_Bookmarks->GetStringSelection();
1364 pos = m_BookmarksNames.Index(item);
1365 if (pos != wxNOT_FOUND)
1366 {
1367 m_BookmarksNames.RemoveAt(pos);
1368 m_BookmarksPages.RemoveAt(pos);
1369 m_Bookmarks->Delete(m_Bookmarks->GetSelection());
1370 }
1371 }
1372 break;
1373
1374 #if wxUSE_PRINTING_ARCHITECTURE
1375 case wxID_HTML_PRINT :
1376 {
1377 if (m_Printer == NULL)
1378 m_Printer = new wxHtmlEasyPrinting(_("Help Printing"), this);
1379 if (!m_HtmlWin->GetOpenedPage())
1380 wxLogWarning(_("Cannot print empty page."));
1381 else
1382 m_Printer->PrintFile(m_HtmlWin->GetOpenedPage());
1383 }
1384 break;
1385 #endif
1386
1387 case wxID_HTML_OPENFILE :
1388 {
1389 wxString s = wxFileSelector(_("Open HTML document"),
1390 wxEmptyString,
1391 wxEmptyString,
1392 wxEmptyString,
1393 _(
1394 "HTML files (*.htm)|*.htm|HTML files (*.html)|*.html|\
1395 Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|\
1396 HTML Help Project (*.hhp)|*.hhp|\
1397 All files (*.*)|*"
1398 ),
1399 wxOPEN | wxFILE_MUST_EXIST,
1400 this);
1401 if (!s.IsEmpty())
1402 {
1403 wxString ext = s.Right(4).Lower();
1404 if (ext == _T(".zip") || ext == _T(".htb") || ext == _T(".hhp"))
1405 {
1406 wxBusyCursor bcur;
1407 m_Data->AddBook(s);
1408 RefreshLists();
1409 }
1410 else
1411 m_HtmlWin->LoadPage(s);
1412 }
1413 }
1414 break;
1415 }
1416 }
1417
1418
1419
1420 void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event)
1421 {
1422 wxHtmlHelpTreeItemData *pg;
1423 wxHtmlContentsItem *it;
1424
1425 pg = (wxHtmlHelpTreeItemData*) m_ContentsBox->GetItemData(event.GetItem());
1426
1427 if (pg && m_UpdateContents)
1428 {
1429 it = m_Data->GetContents() + (pg->m_Id);
1430 m_UpdateContents = FALSE;
1431 if (it->m_Page[0] != 0)
1432 m_HtmlWin->LoadPage(it->GetFullPath());
1433 m_UpdateContents = TRUE;
1434 }
1435 }
1436
1437
1438
1439 void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent& WXUNUSED(event))
1440 {
1441 wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_IndexList->GetClientData(m_IndexList->GetSelection());
1442 if (it->m_Page[0] != 0)
1443 m_HtmlWin->LoadPage(it->GetFullPath());
1444 NotifyPageChanged();
1445 }
1446
1447
1448 void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event)
1449 {
1450 wxString sr = m_IndexText->GetLineText(0);
1451 sr.MakeLower();
1452 if (sr == wxEmptyString)
1453 {
1454 OnIndexAll(event);
1455 }
1456 else
1457 {
1458 wxBusyCursor bcur;
1459 const wxChar *cstr = sr.c_str();
1460 wxChar mybuff[512];
1461 wxChar *ptr;
1462 bool first = TRUE;
1463
1464 m_IndexList->Clear();
1465 int cnt = m_Data->GetIndexCnt();
1466 wxHtmlContentsItem* index = m_Data->GetIndex();
1467
1468 int displ = 0;
1469 for (int i = 0; i < cnt; i++)
1470 {
1471 wxStrncpy(mybuff, index[i].m_Name, 512);
1472 mybuff[511] = _T('\0');
1473 for (ptr = mybuff; *ptr != 0; ptr++)
1474 if (*ptr >= _T('A') && *ptr <= _T('Z'))
1475 *ptr -= (wxChar)(_T('A') - _T('a'));
1476 if (wxStrstr(mybuff, cstr) != NULL)
1477 {
1478 m_IndexList->Append(index[i].m_Name, (char*)(index + i));
1479 displ++;
1480 if (first)
1481 {
1482 if (index[i].m_Page[0] != 0)
1483 m_HtmlWin->LoadPage(index[i].GetFullPath());
1484 NotifyPageChanged();
1485 first = FALSE;
1486 }
1487 }
1488 }
1489
1490 wxString cnttext;
1491 cnttext.Printf(_("%i of %i"), displ, cnt);
1492 m_IndexCountInfo->SetLabel(cnttext);
1493
1494 m_IndexText->SetSelection(0, sr.Length());
1495 m_IndexText->SetFocus();
1496 }
1497 }
1498
1499 void wxHtmlHelpFrame::OnIndexAll(wxCommandEvent& WXUNUSED(event))
1500 {
1501 wxBusyCursor bcur;
1502
1503 m_IndexList->Clear();
1504 int cnt = m_Data->GetIndexCnt();
1505 bool first = TRUE;
1506 wxHtmlContentsItem* index = m_Data->GetIndex();
1507
1508 for (int i = 0; i < cnt; i++)
1509 {
1510 m_IndexList->Append(index[i].m_Name, (char*)(index + i));
1511 if (first)
1512 {
1513 if (index[i].m_Page[0] != 0)
1514 m_HtmlWin->LoadPage(index[i].GetFullPath());
1515 NotifyPageChanged();
1516 first = FALSE;
1517 }
1518 }
1519
1520 wxString cnttext;
1521 cnttext.Printf(_("%i of %i"), cnt, cnt);
1522 m_IndexCountInfo->SetLabel(cnttext);
1523 }
1524
1525
1526 void wxHtmlHelpFrame::OnSearchSel(wxCommandEvent& WXUNUSED(event))
1527 {
1528 wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_SearchList->GetClientData(m_SearchList->GetSelection());
1529 if (it)
1530 {
1531 if (it->m_Page[0] != 0)
1532 m_HtmlWin->LoadPage(it->GetFullPath());
1533 NotifyPageChanged();
1534 }
1535 }
1536
1537 void wxHtmlHelpFrame::OnSearch(wxCommandEvent& WXUNUSED(event))
1538 {
1539 wxString sr = m_SearchText->GetLineText(0);
1540
1541 if (!sr.empty())
1542 KeywordSearch(sr, wxHELP_SEARCH_ALL);
1543 }
1544
1545 void wxHtmlHelpFrame::OnBookmarksSel(wxCommandEvent& WXUNUSED(event))
1546 {
1547 wxString sr = m_Bookmarks->GetStringSelection();
1548
1549 if (sr != wxEmptyString && sr != _("(bookmarks)"))
1550 {
1551 m_HtmlWin->LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]);
1552 NotifyPageChanged();
1553 }
1554 }
1555
1556 void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt)
1557 {
1558 GetSize(&m_Cfg.w, &m_Cfg.h);
1559 GetPosition(&m_Cfg.x, &m_Cfg.y);
1560
1561 #ifdef __WXGTK__
1562 if (IsGrabbed())
1563 {
1564 RemoveGrab();
1565 }
1566 #endif
1567
1568 if (m_Splitter && m_Cfg.navig_on) m_Cfg.sashpos = m_Splitter->GetSashPosition();
1569
1570 if (m_Config)
1571 WriteCustomization(m_Config, m_ConfigRoot);
1572
1573 if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController)))
1574 {
1575 ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt);
1576 }
1577
1578 evt.Skip();
1579 }
1580
1581 #ifdef __WXMAC__
1582 void wxHtmlHelpFrame::OnClose(wxCommandEvent& event)
1583 {
1584 Close(TRUE);
1585 }
1586
1587 void wxHtmlHelpFrame::OnAbout(wxCommandEvent& event)
1588 {
1589 wxMessageBox(wxT("wxWindows HTML Help Viewer (c) 1998-2003, Vaclav Slavik et al"), wxT("HelpView"),
1590 wxICON_INFORMATION|wxOK, this);
1591 }
1592 #endif
1593
1594 BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame)
1595 EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate)
1596 EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_OPTIONS, wxHtmlHelpFrame::OnToolbar)
1597 EVT_BUTTON(wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpFrame::OnToolbar)
1598 EVT_BUTTON(wxID_HTML_BOOKMARKSADD, wxHtmlHelpFrame::OnToolbar)
1599 EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL, wxHtmlHelpFrame::OnContentsSel)
1600 EVT_LISTBOX(wxID_HTML_INDEXLIST, wxHtmlHelpFrame::OnIndexSel)
1601 EVT_LISTBOX(wxID_HTML_SEARCHLIST, wxHtmlHelpFrame::OnSearchSel)
1602 EVT_BUTTON(wxID_HTML_SEARCHBUTTON, wxHtmlHelpFrame::OnSearch)
1603 EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT, wxHtmlHelpFrame::OnSearch)
1604 EVT_BUTTON(wxID_HTML_INDEXBUTTON, wxHtmlHelpFrame::OnIndexFind)
1605 EVT_TEXT_ENTER(wxID_HTML_INDEXTEXT, wxHtmlHelpFrame::OnIndexFind)
1606 EVT_BUTTON(wxID_HTML_INDEXBUTTONALL, wxHtmlHelpFrame::OnIndexAll)
1607 EVT_COMBOBOX(wxID_HTML_BOOKMARKSLIST, wxHtmlHelpFrame::OnBookmarksSel)
1608 EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow)
1609 #ifdef __WXMAC__
1610 EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose)
1611 EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout)
1612 #endif
1613
1614 END_EVENT_TABLE()
1615
1616 #endif // wxUSE_WXHTML_HELP
1617