applied Otto Wyss' patch to extend wxHelpController::KeywordSearch with mode argument...
[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 if (mode == wxHELP_SEARCH_ALL)
744 {
745 it = (wxHtmlContentsItem*) m_SearchList->GetClientData(0);
746 }
747 else if (mode == wxHELP_SEARCH_INDEX)
748 {
749 it = (wxHtmlContentsItem*) m_IndexList->GetClientData(0);
750 }
751 if (it)
752 {
753 m_HtmlWin->LoadPage(it->GetFullPath());
754 NotifyPageChanged();
755 }
756 }
757 return (foundcnt > 0);
758 }
759
760 void wxHtmlHelpFrame::CreateContents()
761 {
762 if (! m_ContentsBox)
763 return ;
764
765 if (m_PagesHash)
766 {
767 WX_CLEAR_HASH_TABLE(*m_PagesHash);
768 delete m_PagesHash;
769 }
770 m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * m_Data->GetContentsCnt());
771
772 int cnt = m_Data->GetContentsCnt();
773 int i;
774
775 wxHtmlContentsItem *it;
776
777 const int MAX_ROOTS = 64;
778 wxTreeItemId roots[MAX_ROOTS];
779 // VS: this array holds information about whether we've set item icon at
780 // given level. This is neccessary because m_Data has flat structure
781 // and there's no way of recognizing if some item has subitems or not.
782 // We set the icon later: when we find an item with level=n, we know
783 // that the last item with level=n-1 was folder with subitems, so we
784 // set its icon accordingly
785 bool imaged[MAX_ROOTS];
786 m_ContentsBox->DeleteAllItems();
787
788 roots[0] = m_ContentsBox->AddRoot(_("(Help)"));
789 imaged[0] = TRUE;
790
791 for (it = m_Data->GetContents(), i = 0; i < cnt; i++, it++)
792 {
793 // Handle books:
794 if (it->m_Level == 0)
795 {
796 if (m_hfStyle & wxHF_MERGE_BOOKS)
797 // VS: we don't want book nodes, books' content should
798 // appear under tree's root. This line will create "fake"
799 // record about book node so that the rest of this look
800 // will believe there really _is_ book node and will
801 // behave correctly.
802 roots[1] = roots[0];
803 else
804 {
805 roots[1] = m_ContentsBox->AppendItem(roots[0],
806 it->m_Name, IMG_Book, -1,
807 new wxHtmlHelpTreeItemData(i));
808 m_ContentsBox->SetItemBold(roots[1], TRUE);
809 }
810 imaged[1] = TRUE;
811 }
812 // ...and their contents:
813 else
814 {
815 roots[it->m_Level + 1] = m_ContentsBox->AppendItem(
816 roots[it->m_Level], it->m_Name, IMG_Page,
817 -1, new wxHtmlHelpTreeItemData(i));
818 imaged[it->m_Level + 1] = FALSE;
819 }
820
821 m_PagesHash->Put(it->GetFullPath(),
822 new wxHtmlHelpHashData(i, roots[it->m_Level + 1]));
823
824 // Set the icon for the node one level up in the hiearachy,
825 // unless already done (see comment above imaged[] declaration)
826 if (!imaged[it->m_Level])
827 {
828 int image = IMG_Folder;
829 if (m_hfStyle & wxHF_ICONS_BOOK)
830 image = IMG_Book;
831 else if (m_hfStyle & wxHF_ICONS_BOOK_CHAPTER)
832 image = (it->m_Level == 1) ? IMG_Book : IMG_Folder;
833 m_ContentsBox->SetItemImage(roots[it->m_Level], image);
834 m_ContentsBox->SetItemImage(roots[it->m_Level], image,
835 wxTreeItemIcon_Selected);
836 imaged[it->m_Level] = TRUE;
837 }
838 }
839 }
840
841
842 void wxHtmlHelpFrame::CreateIndex()
843 {
844 if (! m_IndexList)
845 return ;
846
847 m_IndexList->Clear();
848
849 int cnt = m_Data->GetIndexCnt();
850
851 wxString cnttext;
852 if (cnt > INDEX_IS_SMALL) cnttext.Printf(_("%i of %i"), 0, cnt);
853 else cnttext.Printf(_("%i of %i"), cnt, cnt);
854 m_IndexCountInfo->SetLabel(cnttext);
855 if (cnt > INDEX_IS_SMALL) return;
856
857 wxHtmlContentsItem* index = m_Data->GetIndex();
858
859 for (int i = 0; i < cnt; i++)
860 m_IndexList->Append(index[i].m_Name, (char*)(index + i));
861 }
862
863 void wxHtmlHelpFrame::CreateSearch()
864 {
865 if (! (m_SearchList && m_SearchChoice))
866 return ;
867 m_SearchList->Clear();
868 m_SearchChoice->Clear();
869 m_SearchChoice->Append(_("Search in all books"));
870 const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray();
871 int i, cnt = bookrec.GetCount();
872 for (i = 0; i < cnt; i++)
873 m_SearchChoice->Append(bookrec[i].GetTitle());
874 m_SearchChoice->SetSelection(0);
875 }
876
877
878 void wxHtmlHelpFrame::RefreshLists()
879 {
880 CreateContents();
881 CreateIndex();
882 CreateSearch();
883 }
884
885 void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path)
886 {
887 wxString oldpath;
888 wxString tmp;
889
890 if (path != wxEmptyString)
891 {
892 oldpath = cfg->GetPath();
893 cfg->SetPath(_T("/") + path);
894 }
895
896 m_Cfg.navig_on = cfg->Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0;
897 m_Cfg.sashpos = cfg->Read(wxT("hcSashPos"), m_Cfg.sashpos);
898 m_Cfg.x = cfg->Read(wxT("hcX"), m_Cfg.x);
899 m_Cfg.y = cfg->Read(wxT("hcY"), m_Cfg.y);
900 m_Cfg.w = cfg->Read(wxT("hcW"), m_Cfg.w);
901 m_Cfg.h = cfg->Read(wxT("hcH"), m_Cfg.h);
902
903 m_FixedFace = cfg->Read(wxT("hcFixedFace"), m_FixedFace);
904 m_NormalFace = cfg->Read(wxT("hcNormalFace"), m_NormalFace);
905 m_FontSize = cfg->Read(wxT("hcBaseFontSize"), m_FontSize);
906
907 {
908 int i;
909 int cnt;
910 wxString val, s;
911
912 cnt = cfg->Read(wxT("hcBookmarksCnt"), 0L);
913 if (cnt != 0)
914 {
915 m_BookmarksNames.Clear();
916 m_BookmarksPages.Clear();
917 if (m_Bookmarks)
918 {
919 m_Bookmarks->Clear();
920 m_Bookmarks->Append(_("(bookmarks)"));
921 }
922
923 for (i = 0; i < cnt; i++)
924 {
925 val.Printf(wxT("hcBookmark_%i"), i);
926 s = cfg->Read(val);
927 m_BookmarksNames.Add(s);
928 if (m_Bookmarks) m_Bookmarks->Append(s);
929 val.Printf(wxT("hcBookmark_%i_url"), i);
930 s = cfg->Read(val);
931 m_BookmarksPages.Add(s);
932 }
933 }
934 }
935
936 if (m_HtmlWin)
937 m_HtmlWin->ReadCustomization(cfg);
938
939 if (path != wxEmptyString)
940 cfg->SetPath(oldpath);
941 }
942
943 void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path)
944 {
945 wxString oldpath;
946 wxString tmp;
947
948 if (path != wxEmptyString)
949 {
950 oldpath = cfg->GetPath();
951 cfg->SetPath(_T("/") + path);
952 }
953
954 cfg->Write(wxT("hcNavigPanel"), m_Cfg.navig_on);
955 cfg->Write(wxT("hcSashPos"), (long)m_Cfg.sashpos);
956 if ( !IsIconized() )
957 {
958 // Don't write if iconized as this would make the window
959 // disappear next time it is shown!
960 cfg->Write(wxT("hcX"), (long)m_Cfg.x);
961 cfg->Write(wxT("hcY"), (long)m_Cfg.y);
962 cfg->Write(wxT("hcW"), (long)m_Cfg.w);
963 cfg->Write(wxT("hcH"), (long)m_Cfg.h);
964 }
965 cfg->Write(wxT("hcFixedFace"), m_FixedFace);
966 cfg->Write(wxT("hcNormalFace"), m_NormalFace);
967 cfg->Write(wxT("hcBaseFontSize"), (long)m_FontSize);
968
969 if (m_Bookmarks)
970 {
971 int i;
972 int cnt = m_BookmarksNames.GetCount();
973 wxString val;
974
975 cfg->Write(wxT("hcBookmarksCnt"), (long)cnt);
976 for (i = 0; i < cnt; i++)
977 {
978 val.Printf(wxT("hcBookmark_%i"), i);
979 cfg->Write(val, m_BookmarksNames[i]);
980 val.Printf(wxT("hcBookmark_%i_url"), i);
981 cfg->Write(val, m_BookmarksPages[i]);
982 }
983 }
984
985 if (m_HtmlWin)
986 m_HtmlWin->WriteCustomization(cfg);
987
988 if (path != wxEmptyString)
989 cfg->SetPath(oldpath);
990 }
991
992
993
994
995
996 static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, wxString fixf, int size)
997 {
998 int f_sizes[7];
999 f_sizes[0] = int(size * 0.6);
1000 f_sizes[1] = int(size * 0.8);
1001 f_sizes[2] = size;
1002 f_sizes[3] = int(size * 1.2);
1003 f_sizes[4] = int(size * 1.4);
1004 f_sizes[5] = int(size * 1.6);
1005 f_sizes[6] = int(size * 1.8);
1006
1007 win->SetFonts(scalf, fixf, f_sizes);
1008 }
1009
1010
1011 class wxHtmlHelpFrameOptionsDialog : public wxDialog
1012 {
1013 public:
1014 wxComboBox *NormalFont, *FixedFont;
1015 wxSpinCtrl *FontSize;
1016 wxHtmlWindow *TestWin;
1017
1018 wxHtmlHelpFrameOptionsDialog(wxWindow *parent)
1019 : wxDialog(parent, -1, wxString(_("Help Browser Options")))
1020 {
1021 wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
1022 wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 3, 2, 5);
1023
1024 sizer->Add(new wxStaticText(this, -1, _("Normal font:")));
1025 sizer->Add(new wxStaticText(this, -1, _("Fixed font:")));
1026 sizer->Add(new wxStaticText(this, -1, _("Font size:")));
1027
1028 sizer->Add(NormalFont = new wxComboBox(this, -1, wxEmptyString, wxDefaultPosition,
1029 wxSize(200, 200),
1030 0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
1031
1032 sizer->Add(FixedFont = new wxComboBox(this, -1, wxEmptyString, wxDefaultPosition,
1033 wxSize(200, 200),
1034 0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
1035
1036 sizer->Add(FontSize = new wxSpinCtrl(this, -1));
1037 FontSize->SetRange(2, 100);
1038
1039 topsizer->Add(sizer, 0, wxLEFT|wxRIGHT|wxTOP, 10);
1040
1041 topsizer->Add(new wxStaticText(this, -1, _("Preview:")),
1042 0, wxLEFT | wxTOP, 10);
1043 topsizer->Add(TestWin = new wxHtmlWindow(this, -1, wxDefaultPosition, wxSize(20, 150),
1044 wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER),
1045 1, wxEXPAND | wxLEFT|wxTOP|wxRIGHT, 10);
1046
1047 wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL);
1048 wxButton *ok;
1049 sizer2->Add(ok = new wxButton(this, wxID_OK, _("OK")), 0, wxALL, 10);
1050 ok->SetDefault();
1051 sizer2->Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10);
1052 topsizer->Add(sizer2, 0, wxALIGN_RIGHT);
1053
1054 SetAutoLayout(TRUE);
1055 SetSizer(topsizer);
1056 topsizer->Fit(this);
1057 Centre(wxBOTH);
1058 }
1059
1060
1061 void UpdateTestWin()
1062 {
1063 wxBusyCursor bcur;
1064 SetFontsToHtmlWin(TestWin,
1065 NormalFont->GetStringSelection(),
1066 FixedFont->GetStringSelection(),
1067 FontSize->GetValue());
1068 TestWin->SetPage(_(
1069 "<html><body>\
1070 <table><tr><td>\
1071 Normal face<br>(and <u>underlined</u>. <i>Italic face.</i> \
1072 <b>Bold face.</b> <b><i>Bold italic face.</i></b><br>\
1073 <font size=-2>font size -2</font><br>\
1074 <font size=-1>font size -1</font><br>\
1075 <font size=+0>font size +0</font><br>\
1076 <font size=+1>font size +1</font><br>\
1077 <font size=+2>font size +2</font><br>\
1078 <font size=+3>font size +3</font><br>\
1079 <font size=+4>font size +4</font><br>\
1080 <td>\
1081 <p><tt>Fixed size face.<br> <b>bold</b> <i>italic</i> \
1082 <b><i>bold italic <u>underlined</u></i></b><br>\
1083 <font size=-2>font size -2</font><br>\
1084 <font size=-1>font size -1</font><br>\
1085 <font size=+0>font size +0</font><br>\
1086 <font size=+1>font size +1</font><br>\
1087 <font size=+2>font size +2</font><br>\
1088 <font size=+3>font size +3</font><br>\
1089 <font size=+4>font size +4</font></tt>\
1090 </table></body></html>"
1091 ));
1092 }
1093
1094 void OnUpdate(wxCommandEvent& WXUNUSED(event))
1095 {
1096 UpdateTestWin();
1097 }
1098 void OnUpdateSpin(wxSpinEvent& WXUNUSED(event))
1099 {
1100 UpdateTestWin();
1101 }
1102
1103 DECLARE_EVENT_TABLE()
1104 DECLARE_NO_COPY_CLASS(wxHtmlHelpFrameOptionsDialog)
1105 };
1106
1107 BEGIN_EVENT_TABLE(wxHtmlHelpFrameOptionsDialog, wxDialog)
1108 EVT_COMBOBOX(-1, wxHtmlHelpFrameOptionsDialog::OnUpdate)
1109 EVT_SPINCTRL(-1, wxHtmlHelpFrameOptionsDialog::OnUpdateSpin)
1110 END_EVENT_TABLE()
1111
1112 void wxHtmlHelpFrame::OptionsDialog()
1113 {
1114 wxHtmlHelpFrameOptionsDialog dlg(this);
1115 unsigned i;
1116
1117 if (m_NormalFonts == NULL)
1118 {
1119 wxFontEnumerator enu;
1120 enu.EnumerateFacenames();
1121 m_NormalFonts = new wxArrayString;
1122 *m_NormalFonts = *enu.GetFacenames();
1123 m_NormalFonts->Sort(wxStringSortAscending);
1124 }
1125 if (m_FixedFonts == NULL)
1126 {
1127 wxFontEnumerator enu;
1128 enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, TRUE);
1129 m_FixedFonts = new wxArrayString;
1130 *m_FixedFonts = *enu.GetFacenames();
1131 m_FixedFonts->Sort(wxStringSortAscending);
1132 }
1133
1134 // VS: We want to show the font that is actually used by wxHtmlWindow.
1135 // If customization dialog wasn't used yet, facenames are empty and
1136 // wxHtmlWindow uses default fonts -- let's find out what they
1137 // are so that we can pass them to the dialog:
1138 if (m_NormalFace.empty())
1139 {
1140 wxFont fnt(m_FontSize, wxSWISS, wxNORMAL, wxNORMAL, FALSE);
1141 m_NormalFace = fnt.GetFaceName();
1142 }
1143 if (m_FixedFace.empty())
1144 {
1145 wxFont fnt(m_FontSize, wxMODERN, wxNORMAL, wxNORMAL, FALSE);
1146 m_FixedFace = fnt.GetFaceName();
1147 }
1148
1149 for (i = 0; i < m_NormalFonts->GetCount(); i++)
1150 dlg.NormalFont->Append((*m_NormalFonts)[i]);
1151 for (i = 0; i < m_FixedFonts->GetCount(); i++)
1152 dlg.FixedFont->Append((*m_FixedFonts)[i]);
1153 if (!m_NormalFace.empty())
1154 dlg.NormalFont->SetStringSelection(m_NormalFace);
1155 else
1156 dlg.NormalFont->SetSelection(0);
1157 if (!m_FixedFace.empty())
1158 dlg.FixedFont->SetStringSelection(m_FixedFace);
1159 else
1160 dlg.FixedFont->SetSelection(0);
1161 dlg.FontSize->SetValue(m_FontSize);
1162 dlg.UpdateTestWin();
1163
1164 if (dlg.ShowModal() == wxID_OK)
1165 {
1166 m_NormalFace = dlg.NormalFont->GetStringSelection();
1167 m_FixedFace = dlg.FixedFont->GetStringSelection();
1168 m_FontSize = dlg.FontSize->GetValue();
1169 SetFontsToHtmlWin(m_HtmlWin, m_NormalFace, m_FixedFace, m_FontSize);
1170 }
1171 }
1172
1173
1174
1175 void wxHtmlHelpFrame::NotifyPageChanged()
1176 {
1177 if (m_UpdateContents && m_PagesHash)
1178 {
1179 wxString an = m_HtmlWin->GetOpenedAnchor();
1180 wxHtmlHelpHashData *ha;
1181 if (an.IsEmpty())
1182 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1183 else
1184 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1185 if (ha)
1186 {
1187 bool olduc = m_UpdateContents;
1188 m_UpdateContents = FALSE;
1189 m_ContentsBox->SelectItem(ha->m_Id);
1190 m_ContentsBox->EnsureVisible(ha->m_Id);
1191 m_UpdateContents = olduc;
1192 }
1193 }
1194 }
1195
1196
1197
1198 /*
1199 EVENT HANDLING :
1200 */
1201
1202
1203 void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event)
1204 {
1205 // This saves one mouse click when using the
1206 // wxHTML for context sensitive help systems
1207 #ifndef __WXGTK__
1208 // NB: wxActivateEvent is a bit broken in wxGTK
1209 // and is sometimes sent when it should not be
1210 if (event.GetActive() && m_HtmlWin)
1211 m_HtmlWin->SetFocus();
1212 #endif
1213
1214 event.Skip();
1215 }
1216
1217 void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event)
1218 {
1219 switch (event.GetId())
1220 {
1221 case wxID_HTML_BACK :
1222 m_HtmlWin->HistoryBack();
1223 NotifyPageChanged();
1224 break;
1225
1226 case wxID_HTML_FORWARD :
1227 m_HtmlWin->HistoryForward();
1228 NotifyPageChanged();
1229 break;
1230
1231 case wxID_HTML_UP :
1232 if (m_PagesHash)
1233 {
1234 wxString an = m_HtmlWin->GetOpenedAnchor();
1235 wxHtmlHelpHashData *ha;
1236 if (an.IsEmpty())
1237 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1238 else
1239 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1240 if (ha && ha->m_Index > 0)
1241 {
1242 wxHtmlContentsItem *it = m_Data->GetContents() + (ha->m_Index - 1);
1243 if (it->m_Page[0] != 0)
1244 {
1245 m_HtmlWin->LoadPage(it->GetFullPath());
1246 NotifyPageChanged();
1247 }
1248 }
1249 }
1250 break;
1251
1252 case wxID_HTML_UPNODE :
1253 if (m_PagesHash)
1254 {
1255 wxString an = m_HtmlWin->GetOpenedAnchor();
1256 wxHtmlHelpHashData *ha;
1257 if (an.IsEmpty())
1258 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
1259 else
1260 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
1261 if (ha && ha->m_Index > 0)
1262 {
1263 int level = m_Data->GetContents()[ha->m_Index].m_Level - 1;
1264 wxHtmlContentsItem *it;
1265 int ind = ha->m_Index - 1;
1266
1267 it = m_Data->GetContents() + ind;
1268 while (ind >= 0 && it->m_Level != level) ind--, it--;
1269 if (ind >= 0)
1270 {
1271 if (it->m_Page[0] != 0)
1272 {
1273 m_HtmlWin->LoadPage(it->GetFullPath());
1274 NotifyPageChanged();
1275 }
1276 }
1277 }
1278 }
1279 break;
1280
1281 case wxID_HTML_DOWN :
1282 if (m_PagesHash)
1283 {
1284 wxString an = m_HtmlWin->GetOpenedAnchor();
1285 wxString adr;
1286 wxHtmlHelpHashData *ha;
1287
1288 if (an.IsEmpty()) adr = m_HtmlWin->GetOpenedPage();
1289 else adr = m_HtmlWin->GetOpenedPage() + wxT("#") + an;
1290
1291 ha = (wxHtmlHelpHashData*) m_PagesHash->Get(adr);
1292
1293 if (ha && ha->m_Index < m_Data->GetContentsCnt() - 1)
1294 {
1295 wxHtmlContentsItem *it = m_Data->GetContents() + (ha->m_Index + 1);
1296
1297 while (it->GetFullPath() == adr) it++;
1298
1299 if (it->m_Page[0] != 0)
1300 {
1301 m_HtmlWin->LoadPage(it->GetFullPath());
1302 NotifyPageChanged();
1303 }
1304 }
1305 }
1306 break;
1307
1308 case wxID_HTML_PANEL :
1309 {
1310 if (! (m_Splitter && m_NavigPan))
1311 return ;
1312 if (m_Splitter->IsSplit())
1313 {
1314 m_Cfg.sashpos = m_Splitter->GetSashPosition();
1315 m_Splitter->Unsplit(m_NavigPan);
1316 m_Cfg.navig_on = FALSE;
1317 }
1318 else
1319 {
1320 m_NavigPan->Show(TRUE);
1321 m_HtmlWin->Show(TRUE);
1322 m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
1323 m_Cfg.navig_on = TRUE;
1324 }
1325 }
1326 break;
1327
1328 case wxID_HTML_OPTIONS :
1329 OptionsDialog();
1330 break;
1331
1332 case wxID_HTML_BOOKMARKSADD :
1333 {
1334 wxString item;
1335 wxString url;
1336
1337 item = m_HtmlWin->GetOpenedPageTitle();
1338 url = m_HtmlWin->GetOpenedPage();
1339 if (item == wxEmptyString)
1340 item = url.AfterLast(wxT('/'));
1341 if (m_BookmarksPages.Index(url) == wxNOT_FOUND)
1342 {
1343 m_Bookmarks->Append(item);
1344 m_BookmarksNames.Add(item);
1345 m_BookmarksPages.Add(url);
1346 }
1347 }
1348 break;
1349
1350 case wxID_HTML_BOOKMARKSREMOVE :
1351 {
1352 wxString item;
1353 int pos;
1354
1355 item = m_Bookmarks->GetStringSelection();
1356 pos = m_BookmarksNames.Index(item);
1357 if (pos != wxNOT_FOUND)
1358 {
1359 m_BookmarksNames.RemoveAt(pos);
1360 m_BookmarksPages.RemoveAt(pos);
1361 m_Bookmarks->Delete(m_Bookmarks->GetSelection());
1362 }
1363 }
1364 break;
1365
1366 #if wxUSE_PRINTING_ARCHITECTURE
1367 case wxID_HTML_PRINT :
1368 {
1369 if (m_Printer == NULL)
1370 m_Printer = new wxHtmlEasyPrinting(_("Help Printing"), this);
1371 if (!m_HtmlWin->GetOpenedPage())
1372 wxLogWarning(_("Cannot print empty page."));
1373 else
1374 m_Printer->PrintFile(m_HtmlWin->GetOpenedPage());
1375 }
1376 break;
1377 #endif
1378
1379 case wxID_HTML_OPENFILE :
1380 {
1381 wxString s = wxFileSelector(_("Open HTML document"),
1382 wxEmptyString,
1383 wxEmptyString,
1384 wxEmptyString,
1385 _(
1386 "HTML files (*.htm)|*.htm|HTML files (*.html)|*.html|\
1387 Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|\
1388 HTML Help Project (*.hhp)|*.hhp|\
1389 All files (*.*)|*"
1390 ),
1391 wxOPEN | wxFILE_MUST_EXIST,
1392 this);
1393 if (!s.IsEmpty())
1394 {
1395 wxString ext = s.Right(4).Lower();
1396 if (ext == _T(".zip") || ext == _T(".htb") || ext == _T(".hhp"))
1397 {
1398 wxBusyCursor bcur;
1399 m_Data->AddBook(s);
1400 RefreshLists();
1401 }
1402 else
1403 m_HtmlWin->LoadPage(s);
1404 }
1405 }
1406 break;
1407 }
1408 }
1409
1410
1411
1412 void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event)
1413 {
1414 wxHtmlHelpTreeItemData *pg;
1415 wxHtmlContentsItem *it;
1416
1417 pg = (wxHtmlHelpTreeItemData*) m_ContentsBox->GetItemData(event.GetItem());
1418
1419 if (pg && m_UpdateContents)
1420 {
1421 it = m_Data->GetContents() + (pg->m_Id);
1422 m_UpdateContents = FALSE;
1423 if (it->m_Page[0] != 0)
1424 m_HtmlWin->LoadPage(it->GetFullPath());
1425 m_UpdateContents = TRUE;
1426 }
1427 }
1428
1429
1430
1431 void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent& WXUNUSED(event))
1432 {
1433 wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_IndexList->GetClientData(m_IndexList->GetSelection());
1434 if (it->m_Page[0] != 0)
1435 m_HtmlWin->LoadPage(it->GetFullPath());
1436 NotifyPageChanged();
1437 }
1438
1439
1440 void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event)
1441 {
1442 wxString sr = m_IndexText->GetLineText(0);
1443 sr.MakeLower();
1444 if (sr == wxEmptyString)
1445 {
1446 OnIndexAll(event);
1447 }
1448 else
1449 {
1450 wxBusyCursor bcur;
1451 const wxChar *cstr = sr.c_str();
1452 wxChar mybuff[512];
1453 wxChar *ptr;
1454 bool first = TRUE;
1455
1456 m_IndexList->Clear();
1457 int cnt = m_Data->GetIndexCnt();
1458 wxHtmlContentsItem* index = m_Data->GetIndex();
1459
1460 int displ = 0;
1461 for (int i = 0; i < cnt; i++)
1462 {
1463 wxStrncpy(mybuff, index[i].m_Name, 512);
1464 mybuff[511] = _T('\0');
1465 for (ptr = mybuff; *ptr != 0; ptr++)
1466 if (*ptr >= _T('A') && *ptr <= _T('Z'))
1467 *ptr -= (wxChar)(_T('A') - _T('a'));
1468 if (wxStrstr(mybuff, cstr) != NULL)
1469 {
1470 m_IndexList->Append(index[i].m_Name, (char*)(index + i));
1471 displ++;
1472 if (first)
1473 {
1474 if (index[i].m_Page[0] != 0)
1475 m_HtmlWin->LoadPage(index[i].GetFullPath());
1476 NotifyPageChanged();
1477 first = FALSE;
1478 }
1479 }
1480 }
1481
1482 wxString cnttext;
1483 cnttext.Printf(_("%i of %i"), displ, cnt);
1484 m_IndexCountInfo->SetLabel(cnttext);
1485
1486 m_IndexText->SetSelection(0, sr.Length());
1487 m_IndexText->SetFocus();
1488 }
1489 }
1490
1491 void wxHtmlHelpFrame::OnIndexAll(wxCommandEvent& WXUNUSED(event))
1492 {
1493 wxBusyCursor bcur;
1494
1495 m_IndexList->Clear();
1496 int cnt = m_Data->GetIndexCnt();
1497 bool first = TRUE;
1498 wxHtmlContentsItem* index = m_Data->GetIndex();
1499
1500 for (int i = 0; i < cnt; i++)
1501 {
1502 m_IndexList->Append(index[i].m_Name, (char*)(index + i));
1503 if (first)
1504 {
1505 if (index[i].m_Page[0] != 0)
1506 m_HtmlWin->LoadPage(index[i].GetFullPath());
1507 NotifyPageChanged();
1508 first = FALSE;
1509 }
1510 }
1511
1512 wxString cnttext;
1513 cnttext.Printf(_("%i of %i"), cnt, cnt);
1514 m_IndexCountInfo->SetLabel(cnttext);
1515 }
1516
1517
1518 void wxHtmlHelpFrame::OnSearchSel(wxCommandEvent& WXUNUSED(event))
1519 {
1520 wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_SearchList->GetClientData(m_SearchList->GetSelection());
1521 if (it)
1522 {
1523 if (it->m_Page[0] != 0)
1524 m_HtmlWin->LoadPage(it->GetFullPath());
1525 NotifyPageChanged();
1526 }
1527 }
1528
1529 void wxHtmlHelpFrame::OnSearch(wxCommandEvent& WXUNUSED(event))
1530 {
1531 wxString sr = m_SearchText->GetLineText(0);
1532
1533 if (!sr.empty())
1534 KeywordSearch(sr, wxHELP_SEARCH_ALL);
1535 }
1536
1537 void wxHtmlHelpFrame::OnBookmarksSel(wxCommandEvent& WXUNUSED(event))
1538 {
1539 wxString sr = m_Bookmarks->GetStringSelection();
1540
1541 if (sr != wxEmptyString && sr != _("(bookmarks)"))
1542 {
1543 m_HtmlWin->LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]);
1544 NotifyPageChanged();
1545 }
1546 }
1547
1548 void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt)
1549 {
1550 GetSize(&m_Cfg.w, &m_Cfg.h);
1551 GetPosition(&m_Cfg.x, &m_Cfg.y);
1552
1553 #ifdef __WXGTK__
1554 if (IsGrabbed())
1555 {
1556 RemoveGrab();
1557 }
1558 #endif
1559
1560 if (m_Splitter && m_Cfg.navig_on) m_Cfg.sashpos = m_Splitter->GetSashPosition();
1561
1562 if (m_Config)
1563 WriteCustomization(m_Config, m_ConfigRoot);
1564
1565 if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController)))
1566 {
1567 ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt);
1568 }
1569
1570 evt.Skip();
1571 }
1572
1573 #ifdef __WXMAC__
1574 void wxHtmlHelpFrame::OnClose(wxCommandEvent& event)
1575 {
1576 Close(TRUE);
1577 }
1578
1579 void wxHtmlHelpFrame::OnAbout(wxCommandEvent& event)
1580 {
1581 wxMessageBox(wxT("wxWindows HTML Help Viewer (c) 1998-2003, Vaclav Slavik et al"), wxT("HelpView"),
1582 wxICON_INFORMATION|wxOK, this);
1583 }
1584 #endif
1585
1586 BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame)
1587 EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate)
1588 EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_OPTIONS, wxHtmlHelpFrame::OnToolbar)
1589 EVT_BUTTON(wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpFrame::OnToolbar)
1590 EVT_BUTTON(wxID_HTML_BOOKMARKSADD, wxHtmlHelpFrame::OnToolbar)
1591 EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL, wxHtmlHelpFrame::OnContentsSel)
1592 EVT_LISTBOX(wxID_HTML_INDEXLIST, wxHtmlHelpFrame::OnIndexSel)
1593 EVT_LISTBOX(wxID_HTML_SEARCHLIST, wxHtmlHelpFrame::OnSearchSel)
1594 EVT_BUTTON(wxID_HTML_SEARCHBUTTON, wxHtmlHelpFrame::OnSearch)
1595 EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT, wxHtmlHelpFrame::OnSearch)
1596 EVT_BUTTON(wxID_HTML_INDEXBUTTON, wxHtmlHelpFrame::OnIndexFind)
1597 EVT_TEXT_ENTER(wxID_HTML_INDEXTEXT, wxHtmlHelpFrame::OnIndexFind)
1598 EVT_BUTTON(wxID_HTML_INDEXBUTTONALL, wxHtmlHelpFrame::OnIndexAll)
1599 EVT_COMBOBOX(wxID_HTML_BOOKMARKSLIST, wxHtmlHelpFrame::OnBookmarksSel)
1600 EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow)
1601 #ifdef __WXMAC__
1602 EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose)
1603 EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout)
1604 #endif
1605
1606 END_EVENT_TABLE()
1607
1608 #endif // wxUSE_WXHTML_HELP
1609