1 /////////////////////////////////////////////////////////////////////////////
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
8 // Copyright: (c) Harm van der Heijden and Vaclav Slavik
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
13 #pragma implementation
16 // For compilers that support precompilation, includes "wx.h"
18 #include "wx/wxprec.h"
31 #include "wx/html/helpfrm.h"
32 #include "wx/notebook.h"
33 #include "wx/imaglist.h"
34 #include "wx/treectrl.h"
35 #include "wx/tokenzr.h"
36 #include "wx/wfstream.h"
37 #include "wx/html/htmlwin.h"
38 #include "wx/busyinfo.h"
39 #include "wx/progdlg.h"
40 #include "wx/toolbar.h"
45 #include "bitmaps/panel.xpm"
46 #include "bitmaps/back.xpm"
47 #include "bitmaps/forward.xpm"
48 #include "bitmaps/book.xpm"
49 #include "bitmaps/folder.xpm"
50 #include "bitmaps/page.xpm"
51 #include "bitmaps/help.xpm"
54 #include "wx/stream.h"
56 // number of times that the contents/index creation progress dialog
58 #define PROGRESS_STEP 40
60 //--------------------------------------------------------------------------
61 // wxHtmlHelpTreeItemData
62 //--------------------------------------------------------------------------
64 class wxHtmlHelpTreeItemData
: public wxTreeItemData
70 wxHtmlHelpTreeItemData(wxHtmlContentsItem
*it
) : wxTreeItemData()
72 m_Page
= it
-> m_Book
-> GetBasePath() + it
-> m_Page
;
74 const wxString
& GetPage() { return m_Page
; }
77 //---------------------------------------------------------------------------
79 //---------------------------------------------------------------------------
81 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame
, wxFrame
)
83 wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow
* parent
, wxWindowID id
, const wxString
& title
,
84 int style
, wxHtmlHelpData
* data
)
87 Create(parent
, id
, title
, style
);
90 void wxHtmlHelpFrame::Init(wxHtmlHelpData
* data
)
94 m_DataCreated
= FALSE
;
96 m_Data
= new wxHtmlHelpData();
100 m_ContentsImageList
= new wxImageList(16, 16);
101 m_ContentsImageList
-> Add(wxICON(book
));
102 m_ContentsImageList
-> Add(wxICON(folder
));
103 m_ContentsImageList
-> Add(wxICON(page
));
105 m_ContentsBox
= NULL
;
108 m_SearchButton
= NULL
;
110 m_SearchChoice
= NULL
;
115 m_ConfigRoot
= wxEmptyString
;
117 m_Cfg
.x
= m_Cfg
.y
= 0;
121 m_Cfg
.navig_on
= TRUE
;
124 // Create: builds the GUI components.
125 // with the style flag it's possible to toggle the toolbar, contents, index and search
127 // m_HtmlWin will *always* be created, but it's important to realize that
128 // m_ContentsBox, m_IndexBox, m_SearchList, m_SearchButton, m_SearchText and
129 // m_SearchButton may be NULL.
130 // moreover, if no contents, index or searchpage is needed, m_Splitter and
131 // m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame)
133 bool wxHtmlHelpFrame::Create(wxWindow
* parent
, wxWindowID id
, const wxString
& title
,
136 // Do the config in two steps. We read the HtmlWindow customization after we
137 // create the window.
139 ReadCustomization(m_Config
, m_ConfigRoot
);
141 wxFrame::Create(parent
, id
, _("Help"), wxPoint(m_Cfg
.x
, m_Cfg
.y
), wxSize(m_Cfg
.w
, m_Cfg
.h
));
144 wxIcon
frameIcon("wxhelp", wxBITMAP_TYPE_ICO_RESOURCE
, 32, 32);
146 wxIcon
frameIcon(help_xpm
);
151 int notebook_page
= 0;
156 if (style
& wxHF_TOOLBAR
) {
157 wxToolBar
*toolBar
= CreateToolBar(wxNO_BORDER
| wxTB_HORIZONTAL
| /*wxTB_FLAT | */
159 toolBar
-> SetMargins(2, 2);
160 wxBitmap
* toolBarBitmaps
[3];
163 toolBarBitmaps
[0] = new wxBitmap("panel");
164 toolBarBitmaps
[1] = new wxBitmap("back");
165 toolBarBitmaps
[2] = new wxBitmap("forward");
168 toolBarBitmaps
[0] = new wxBitmap(panel_xpm
);
169 toolBarBitmaps
[1] = new wxBitmap(back_xpm
);
170 toolBarBitmaps
[2] = new wxBitmap(forward_xpm
);
176 toolBar
-> AddTool(wxID_HTML_PANEL
, *(toolBarBitmaps
[0]), wxNullBitmap
,
177 FALSE
, currentX
, -1, (wxObject
*) NULL
,
178 _("Show/hide navigation panel"));
179 currentX
+= width
+ 5;
180 toolBar
-> AddSeparator();
181 toolBar
-> AddTool(wxID_HTML_BACK
, *(toolBarBitmaps
[1]), wxNullBitmap
,
182 FALSE
, currentX
, -1, (wxObject
*) NULL
,
183 _("Go back to the previous HTML page"));
184 currentX
+= width
+ 5;
185 toolBar
-> AddTool(wxID_HTML_FORWARD
, *(toolBarBitmaps
[2]), wxNullBitmap
,
186 FALSE
, currentX
, -1, (wxObject
*) NULL
,
187 _("Go forward to the next HTML page"));
188 currentX
+= width
+ 5;
190 toolBar
-> Realize();
192 // Can delete the bitmaps since they're reference counted
193 for (int i
= 0; i
< 3; i
++)
194 delete toolBarBitmaps
[i
];
197 if (style
& (wxHF_CONTENTS
| wxHF_INDEX
| wxHF_SEARCH
)) {
198 // traditional help controller; splitter window with html page on the
199 // right and a notebook containing various pages on the left
200 m_Splitter
= new wxSplitterWindow(this);
202 m_HtmlWin
= new wxHtmlWindow(m_Splitter
);
203 m_NavigPan
= new wxNotebook(m_Splitter
, wxID_HTML_NOTEBOOK
,
204 wxDefaultPosition
, wxDefaultSize
);
205 } else { // only html window, no notebook with index,contents etc
206 m_HtmlWin
= new wxHtmlWindow(this);
209 m_HtmlWin
-> SetRelatedFrame(this, m_TitleFormat
);
210 m_HtmlWin
-> SetRelatedStatusBar(0);
212 m_HtmlWin
-> ReadCustomization(m_Config
, m_ConfigRoot
);
214 // contents tree panel?
215 if (style
& wxHF_CONTENTS
) {
216 m_ContentsBox
= new wxTreeCtrl(m_NavigPan
, wxID_HTML_TREECTRL
,
217 wxDefaultPosition
, wxDefaultSize
,
218 wxTR_HAS_BUTTONS
| wxSUNKEN_BORDER
);
219 m_ContentsBox
-> SetImageList(m_ContentsImageList
);
220 m_NavigPan
-> AddPage(m_ContentsBox
, _("Contents"));
221 m_ContentsPage
= notebook_page
++;
224 // index listbox panel?
225 if (style
& wxHF_INDEX
) {
226 wxWindow
*dummy
= new wxPanel(m_NavigPan
, wxID_HTML_INDEXPAGE
);
227 wxLayoutConstraints
*b1
= new wxLayoutConstraints
;
228 b1
-> top
.SameAs (dummy
, wxTop
, 0);
229 b1
-> left
.SameAs (dummy
, wxLeft
, 0);
230 b1
-> width
.PercentOf (dummy
, wxWidth
, 100);
231 b1
-> bottom
.SameAs (dummy
, wxBottom
, 0);
232 m_IndexBox
= new wxListBox(dummy
, wxID_HTML_INDEXLIST
, wxDefaultPosition
,
233 wxDefaultSize
, 0, NULL
, wxLB_SINGLE
| wxLB_ALWAYS_SB
);
234 m_IndexBox
-> SetConstraints(b1
);
235 dummy
-> SetAutoLayout(TRUE
);
236 m_NavigPan
-> AddPage(dummy
, _("Index"));
237 m_IndexPage
= notebook_page
++;
240 // search list panel?
241 if (style
& wxHF_SEARCH
) {
242 wxWindow
*dummy
= new wxPanel(m_NavigPan
, wxID_HTML_SEARCHPAGE
);
244 wxLayoutConstraints
*b1
= new wxLayoutConstraints
;
245 m_SearchText
= new wxTextCtrl(dummy
, wxID_HTML_SEARCHTEXT
);
246 b1
-> top
.SameAs (dummy
, wxTop
, 10);
247 b1
-> left
.SameAs (dummy
, wxLeft
, 10);
248 b1
-> right
.SameAs (dummy
, wxRight
, 10);
250 m_SearchText
-> SetConstraints(b1
);
252 wxLayoutConstraints
*b2
= new wxLayoutConstraints
;
253 m_SearchButton
= new wxButton(dummy
, wxID_HTML_SEARCHBUTTON
, _("Search"));
254 b2
-> top
.Below (m_SearchText
, 10);
255 b2
-> left
.SameAs (dummy
, wxLeft
, 10);
258 m_SearchButton
-> SetConstraints(b2
);
260 wxLayoutConstraints
*b3
= new wxLayoutConstraints
;
261 m_SearchList
= new wxListBox(dummy
, wxID_HTML_SEARCHLIST
, wxDefaultPosition
, wxDefaultSize
, 0);
262 b3
-> top
.Below (m_SearchButton
, 10);
263 b3
-> left
.SameAs (dummy
, wxLeft
, 0);
264 b3
-> right
.SameAs (dummy
, wxRight
, 0);
265 b3
-> bottom
.SameAs (dummy
, wxBottom
, 0);
266 m_SearchList
-> SetConstraints(b3
);
268 wxLayoutConstraints
*b4
= new wxLayoutConstraints
;
269 m_SearchChoice
= new wxChoice(dummy
, wxID_HTML_SEARCHCHOICE
, wxDefaultPosition
,
271 b4
-> top
.Below (m_SearchText
, 10);
272 b4
-> left
.SameAs (m_SearchButton
, wxRight
, 10);
273 b4
-> right
.SameAs (dummy
, wxRight
, 10);
275 m_SearchChoice
-> SetConstraints(b4
);
277 dummy
-> SetAutoLayout(TRUE
);
279 m_NavigPan
-> AddPage(dummy
, _("Search"));
280 m_SearchPage
= notebook_page
++;
282 m_HtmlWin
-> Show(TRUE
);
287 if (m_NavigPan
&& m_Splitter
) {
288 m_Splitter
-> SetMinimumPaneSize(20);
289 if (m_Cfg
.navig_on
) {
290 m_NavigPan
-> Show(TRUE
);
291 m_Splitter
-> SplitVertically(m_NavigPan
, m_HtmlWin
, m_Cfg
.sashpos
);
294 m_NavigPan
-> Show(FALSE
);
295 m_Splitter
-> Initialize(m_HtmlWin
);
301 wxHtmlHelpFrame::~wxHtmlHelpFrame()
303 delete m_ContentsImageList
;
308 bool wxHtmlHelpFrame::Display(const wxString
& x
)
310 wxString url
= m_Data
->FindPageByName(x
);
311 if (! url
.IsEmpty()) {
312 m_HtmlWin
->LoadPage(url
);
318 bool wxHtmlHelpFrame::Display(const int id
)
320 wxString url
= m_Data
->FindPageById(id
);
321 if (! url
.IsEmpty()) {
322 m_HtmlWin
->LoadPage(url
);
330 bool wxHtmlHelpFrame::DisplayContents()
334 if (!m_Splitter
-> IsSplit()) {
335 m_NavigPan
-> Show(TRUE
);
336 m_HtmlWin
-> Show(TRUE
);
337 m_Splitter
-> SplitVertically(m_NavigPan
, m_HtmlWin
, m_Cfg
.sashpos
);
338 m_Cfg
.navig_on
= TRUE
;
340 m_NavigPan
-> SetSelection(0);
346 bool wxHtmlHelpFrame::DisplayIndex()
350 if (!m_Splitter
-> IsSplit()) {
351 m_NavigPan
-> Show(TRUE
);
352 m_HtmlWin
-> Show(TRUE
);
353 m_Splitter
-> SplitVertically(m_NavigPan
, m_HtmlWin
, m_Cfg
.sashpos
);
355 m_NavigPan
-> SetSelection(1);
359 bool wxHtmlHelpFrame::KeywordSearch(const wxString
& keyword
)
361 if (! (m_SearchList
&& m_SearchButton
&& m_SearchText
&& m_SearchChoice
))
366 wxString book
= wxEmptyString
;
368 if (!m_Splitter
-> IsSplit()) {
369 m_NavigPan
-> Show(TRUE
);
370 m_HtmlWin
-> Show(TRUE
);
371 m_Splitter
-> SplitVertically(m_NavigPan
, m_HtmlWin
, m_Cfg
.sashpos
);
373 m_NavigPan
-> SetSelection(m_SearchPage
);
374 m_SearchList
-> Clear();
375 m_SearchText
-> SetValue(keyword
);
376 m_SearchButton
-> Enable(FALSE
);
378 if (m_SearchChoice
->GetSelection() != 0)
379 book
= m_SearchChoice
->GetStringSelection();
381 wxHtmlSearchStatus
status(m_Data
, keyword
, book
);
383 wxProgressDialog
progress(_("Searching..."), _("No matching page found yet"),
384 status
.GetMaxIndex(), this,
385 wxPD_APP_MODAL
| wxPD_CAN_ABORT
| wxPD_AUTO_HIDE
);
387 while (status
.IsActive()) {
388 if (progress
.Update(status
.GetCurIndex()) == FALSE
)
390 if (status
.Search()) {
391 foundstr
.Printf(_("Found %i matches"), ++foundcnt
);
392 progress
.Update(status
.GetCurIndex(), foundstr
);
393 m_SearchList
-> Append(status
.GetName(), status
.GetContentsItem());
398 m_SearchButton
-> Enable(TRUE
);
399 m_SearchText
-> SetSelection(0, keyword
.Length());
400 m_SearchText
-> SetFocus();
402 wxHtmlContentsItem
*it
= (wxHtmlContentsItem
*) m_SearchList
-> GetClientData(0);
403 if (it
) m_HtmlWin
-> LoadPage(it
-> m_Book
-> GetBasePath() + it
-> m_Page
);
405 return (foundcnt
> 0);
410 void wxHtmlHelpFrame::CreateContents(bool show_progress
)
415 wxProgressDialog
*progress
;
418 m_ContentsBox
->Clear();
420 int cnt
= m_Data
->GetContentsCnt();
421 int div
= (cnt
/ PROGRESS_STEP
) + 1;
424 wxHtmlContentsItem
*it
= m_Data
->GetContents();
427 progress
= new wxProgressDialog(_("Building contents tree..."), wxEmptyString
,
428 cnt
, this, wxPD_APP_MODAL
| wxPD_CAN_ABORT
|
431 wxTreeItemId roots
[MAX_ROOTS
];
432 bool imaged
[MAX_ROOTS
];
434 m_ContentsBox
-> DeleteAllItems();
435 roots
[0] = m_ContentsBox
-> AddRoot(_("(Help)"));
438 for (i
= 0; i
< cnt
; i
++, it
++) {
439 if (show_progress
&& ((i
% div
) == 0)) {
440 proginfo
.Printf(_("Added %d/%d items"), i
, cnt
);
441 if (! progress
->Update(i
, proginfo
))
445 roots
[it
-> m_Level
+ 1] = m_ContentsBox
-> AppendItem(
446 roots
[it
-> m_Level
], it
-> m_Name
, IMG_Page
, -1,
447 new wxHtmlHelpTreeItemData(it
));
449 if (it
-> m_Level
== 0) {
450 m_ContentsBox
-> SetItemBold(roots
[1], TRUE
);
451 m_ContentsBox
-> SetItemImage(roots
[1], IMG_Book
);
452 m_ContentsBox
-> SetItemSelectedImage(roots
[1], IMG_Book
);
454 } else imaged
[it
-> m_Level
+ 1] = FALSE
;
456 if (!imaged
[it
-> m_Level
]) {
457 m_ContentsBox
-> SetItemImage(roots
[it
-> m_Level
], IMG_Folder
);
458 m_ContentsBox
-> SetItemSelectedImage(roots
[it
-> m_Level
], IMG_Folder
);
459 imaged
[it
-> m_Level
] = TRUE
;
464 m_ContentsBox
-> Expand(roots
[0]);
468 void wxHtmlHelpFrame::CreateIndex(bool show_progress
)
473 wxProgressDialog
*progress
;
478 int cnt
= m_Data
->GetIndexCnt();
479 int div
= (cnt
/ PROGRESS_STEP
) + 1;
481 wxHtmlContentsItem
* index
= m_Data
->GetIndex();
484 progress
= new wxProgressDialog(_("Building index list..."), wxEmptyString
,
485 cnt
, this, wxPD_APP_MODAL
| wxPD_CAN_ABORT
|
487 for (int i
= 0; i
< cnt
; i
++) {
488 if (show_progress
&& ((i
% div
) == 0)) {
489 proginfo
.Printf(_("Added %d/%d items"), i
, cnt
);
490 if (! progress
->Update(i
, proginfo
))
494 m_IndexBox
-> Append(index
[i
].m_Name
, (char*)(index
+ i
));
501 void wxHtmlHelpFrame::CreateSearch()
503 if (! (m_SearchList
&& m_SearchChoice
))
505 m_SearchList
-> Clear();
506 m_SearchChoice
-> Clear();
507 m_SearchChoice
-> Append(_("all books"));
508 const wxHtmlBookRecArray
& bookrec
= m_Data
->GetBookRecArray();
509 int i
, cnt
= bookrec
.GetCount();
510 for (i
= 0; i
< cnt
; i
++)
511 m_SearchChoice
->Append(bookrec
[i
].GetTitle());
512 m_SearchChoice
->SetSelection(0);
516 void wxHtmlHelpFrame::RefreshLists(bool show_progress
)
518 CreateContents(show_progress
);
519 CreateIndex(show_progress
);
523 void wxHtmlHelpFrame::ReadCustomization(wxConfigBase
*cfg
, const wxString
& path
)
528 if (path
!= wxEmptyString
) {
529 oldpath
= cfg
-> GetPath();
530 cfg
-> SetPath(path
);
533 m_Cfg
.navig_on
= cfg
-> Read("hcNavigPanel", m_Cfg
.navig_on
) != 0;
534 m_Cfg
.sashpos
= cfg
-> Read("hcSashPos", m_Cfg
.sashpos
);
535 m_Cfg
.x
= cfg
-> Read("hcX", m_Cfg
.x
);
536 m_Cfg
.y
= cfg
-> Read("hcY", m_Cfg
.y
);
537 m_Cfg
.w
= cfg
-> Read("hcW", m_Cfg
.w
);
538 m_Cfg
.h
= cfg
-> Read("hcH", m_Cfg
.h
);
541 m_HtmlWin
->ReadCustomization(cfg
, path
);
543 if (path
!= wxEmptyString
)
544 cfg
-> SetPath(oldpath
);
547 void wxHtmlHelpFrame::WriteCustomization(wxConfigBase
*cfg
, const wxString
& path
)
552 if (path
!= wxEmptyString
) {
553 oldpath
= cfg
-> GetPath();
554 cfg
-> SetPath(path
);
557 cfg
-> Write("hcNavigPanel", m_Cfg
.navig_on
);
558 cfg
-> Write("hcSashPos", (long)m_Cfg
.sashpos
);
559 cfg
-> Write("hcX", (long)m_Cfg
.x
);
560 cfg
-> Write("hcY", (long)m_Cfg
.y
);
561 cfg
-> Write("hcW", (long)m_Cfg
.w
);
562 cfg
-> Write("hcH", (long)m_Cfg
.h
);
565 m_HtmlWin
->WriteCustomization(cfg
, path
);
567 if (path
!= wxEmptyString
)
568 cfg
-> SetPath(oldpath
);
577 void wxHtmlHelpFrame::OnToolbar(wxCommandEvent
& event
)
579 switch (event
.GetId()) {
580 case wxID_HTML_BACK
:
581 m_HtmlWin
-> HistoryBack();
583 case wxID_HTML_FORWARD
:
584 m_HtmlWin
-> HistoryForward();
586 case wxID_HTML_PANEL
:
587 if (! (m_Splitter
&& m_NavigPan
))
589 if (m_Splitter
-> IsSplit()) {
590 m_Cfg
.sashpos
= m_Splitter
-> GetSashPosition();
591 m_Splitter
-> Unsplit(m_NavigPan
);
592 m_Cfg
.navig_on
= FALSE
;
594 m_NavigPan
-> Show(TRUE
);
595 m_HtmlWin
-> Show(TRUE
);
596 m_Splitter
-> SplitVertically(m_NavigPan
, m_HtmlWin
, m_Cfg
.sashpos
);
597 m_Cfg
.navig_on
= TRUE
;
605 void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent
& event
)
607 wxHtmlHelpTreeItemData
*pg
;
609 pg
= (wxHtmlHelpTreeItemData
*) m_ContentsBox
-> GetItemData(event
.GetItem());
610 if (pg
) m_HtmlWin
-> LoadPage(pg
-> GetPage());
615 void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent
& WXUNUSED(event
))
617 wxHtmlContentsItem
*it
= (wxHtmlContentsItem
*) m_IndexBox
-> GetClientData(m_IndexBox
-> GetSelection());
618 m_HtmlWin
-> LoadPage(it
-> m_Book
-> GetBasePath() + it
-> m_Page
);
623 void wxHtmlHelpFrame::OnSearchSel(wxCommandEvent
& WXUNUSED(event
))
625 wxHtmlContentsItem
*it
= (wxHtmlContentsItem
*) m_SearchList
-> GetClientData(m_SearchList
-> GetSelection());
626 if (it
) m_HtmlWin
-> LoadPage(it
-> m_Book
-> GetBasePath() + it
-> m_Page
);
629 void wxHtmlHelpFrame::OnSearch(wxCommandEvent
& WXUNUSED(event
))
631 wxString sr
= m_SearchText
-> GetLineText(0);
633 if (sr
!= wxEmptyString
) KeywordSearch(sr
);
636 void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent
& evt
)
638 GetSize(&m_Cfg
.w
, &m_Cfg
.h
);
639 GetPosition(&m_Cfg
.x
, &m_Cfg
.y
);
640 if (m_Splitter
&& m_Cfg
.navig_on
) m_Cfg
.sashpos
= m_Splitter
-> GetSashPosition();
643 WriteCustomization(m_Config
, m_ConfigRoot
);
648 BEGIN_EVENT_TABLE(wxHtmlHelpFrame
, wxFrame
)
649 EVT_TOOL_RANGE(wxID_HTML_PANEL
, wxID_HTML_FORWARD
, wxHtmlHelpFrame::OnToolbar
)
650 EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL
, wxHtmlHelpFrame::OnContentsSel
)
651 EVT_LISTBOX(wxID_HTML_INDEXLIST
, wxHtmlHelpFrame::OnIndexSel
)
652 EVT_LISTBOX(wxID_HTML_SEARCHLIST
, wxHtmlHelpFrame::OnSearchSel
)
653 EVT_BUTTON(wxID_HTML_SEARCHBUTTON
, wxHtmlHelpFrame::OnSearch
)
654 EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT
, wxHtmlHelpFrame::OnSearch
)
655 EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow
)