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