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