]> git.saurik.com Git - wxWidgets.git/blob - src/html/helpfrm.cpp
projects / wxWidgets.git / blob
? search:


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