X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/658fb8e6c5952b13e22da0c720573be7a01724f1..10a59880771fae005b31e003916a028267b54427:/src/html/helpfrm.cpp diff --git a/src/html/helpfrm.cpp b/src/html/helpfrm.cpp index 5464a318fc..51d1bba8e9 100644 --- a/src/html/helpfrm.cpp +++ b/src/html/helpfrm.cpp @@ -9,8 +9,8 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) +#pragma implementation "helpfrm.h" #endif // For compilers that support precompilation, includes "wx.h" @@ -21,14 +21,28 @@ #pragma hdrstop #endif -#include "wx/defs.h" +#if wxUSE_WXHTML_HELP -#if wxUSE_HTML #ifndef WXPRECOMP -#include "wx/wx.h" + #include "wx/intl.h" + #include "wx/log.h" + + #include "wx/object.h" + #include "wx/sizer.h" + + #include "wx/bmpbuttn.h" + #include "wx/statbox.h" + #include "wx/radiobox.h" +#endif // WXPRECOMP + +#ifdef __WXMAC__ + #include "wx/menu.h" + #include "wx/msgdlg.h" #endif #include "wx/html/helpfrm.h" +#include "wx/html/helpctrl.h" +#include "wx/textctrl.h" #include "wx/notebook.h" #include "wx/imaglist.h" #include "wx/treectrl.h" @@ -41,32 +55,18 @@ #include "wx/fontenum.h" #include "wx/stream.h" #include "wx/filedlg.h" - -// Bitmaps: - -#ifndef __WXMSW__ -#include "bitmaps/wpanel.xpm" -#include "bitmaps/wback.xpm" -#include "bitmaps/wforward.xpm" -#include "bitmaps/wbook.xpm" -#include "bitmaps/woptions.xpm" -#include "bitmaps/wfolder.xpm" -#include "bitmaps/wpage.xpm" -#include "bitmaps/whelp.xpm" -#include "bitmaps/whlproot.xpm" -#include "bitmaps/wbkadd.xpm" -#include "bitmaps/wbkdel.xpm" -#include "bitmaps/wup.xpm" -#include "bitmaps/wupnode.xpm" -#include "bitmaps/wdown.xpm" -#include "bitmaps/wopen.xpm" -#include "bitmaps/wprint.xpm" -#endif - +#include "wx/artprov.h" +#include "wx/spinctrl.h" +#include "wx/dynarray.h" +#include "wx/choicdlg.h" // what is considered "small index"? #define INDEX_IS_SMALL 100 +/* Motif defines this as a macro */ +#ifdef Below +#undef Below +#endif //-------------------------------------------------------------------------- // wxHtmlHelpTreeItemData (private) @@ -75,6 +75,11 @@ class wxHtmlHelpTreeItemData : public wxTreeItemData { public: +#if defined(__VISAGECPP__) +// VA needs a default ctor for some reason.... + wxHtmlHelpTreeItemData() : wxTreeItemData() + { m_Id = 0; } +#endif wxHtmlHelpTreeItemData(int id) : wxTreeItemData() { m_Id = id;} @@ -91,7 +96,8 @@ class wxHtmlHelpHashData : public wxObject public: wxHtmlHelpHashData(int index, wxTreeItemId id) : wxObject() { m_Index = index; m_Id = id;} - + ~wxHtmlHelpHashData() {} + int m_Index; wxTreeItemId m_Id; }; @@ -109,19 +115,107 @@ class wxHtmlHelpHtmlWindow : public wxHtmlWindow virtual void OnLinkClicked(const wxHtmlLinkInfo& link) { wxHtmlWindow::OnLinkClicked(link); - m_Frame -> NotifyPageChanged(); + const wxMouseEvent *e = link.GetEvent(); + if (e == NULL || e->LeftUp()) + m_Frame->NotifyPageChanged(); } - private: + private: wxHtmlHelpFrame *m_Frame; + + DECLARE_NO_COPY_CLASS(wxHtmlHelpHtmlWindow) }; +//--------------------------------------------------------------------------- +// wxHtmlHelpFrame::m_mergedIndex +//--------------------------------------------------------------------------- + +WX_DEFINE_ARRAY_PTR(const wxHtmlHelpDataItem*, wxHtmlHelpDataItemPtrArray); + +struct wxHtmlHelpMergedIndexItem +{ + wxHtmlHelpMergedIndexItem *parent; + wxString name; + wxHtmlHelpDataItemPtrArray items; +}; + +WX_DECLARE_OBJARRAY(wxHtmlHelpMergedIndexItem, wxHtmlHelpMergedIndex); +#include "wx/arrimpl.cpp" +WX_DEFINE_OBJARRAY(wxHtmlHelpMergedIndex) + +void wxHtmlHelpFrame::UpdateMergedIndex() +{ + delete m_mergedIndex; + m_mergedIndex = new wxHtmlHelpMergedIndex; + wxHtmlHelpMergedIndex& merged = *m_mergedIndex; + + const wxHtmlHelpDataItems& items = m_Data->GetIndexArray(); + size_t len = items.size(); + + wxHtmlHelpMergedIndexItem *history[128] = {NULL}; + + for (size_t i = 0; i < len; i++) + { + const wxHtmlHelpDataItem& item = items[i]; + wxASSERT_MSG( item.level < 128, _T("nested index entries too deep") ); + + if (history[item.level] && + history[item.level]->items[0]->name == item.name) + { + // same index entry as previous one, update list of items + history[item.level]->items.Add(&item); + } + else + { + // new index entry + wxHtmlHelpMergedIndexItem *mi = new wxHtmlHelpMergedIndexItem(); + mi->name = item.GetIndentedName(); + mi->items.Add(&item); + mi->parent = (item.level == 0) ? NULL : history[item.level - 1]; + history[item.level] = mi; + merged.Add(mi); + } + } +} + //--------------------------------------------------------------------------- // wxHtmlHelpFrame //--------------------------------------------------------------------------- +// Command IDs : +enum +{ + //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1, + wxID_HTML_PANEL = wxID_HIGHEST + 2, + wxID_HTML_BACK, + wxID_HTML_FORWARD, + wxID_HTML_UPNODE, + wxID_HTML_UP, + wxID_HTML_DOWN, + wxID_HTML_PRINT, + wxID_HTML_OPENFILE, + wxID_HTML_OPTIONS, + wxID_HTML_BOOKMARKSLIST, + wxID_HTML_BOOKMARKSADD, + wxID_HTML_BOOKMARKSREMOVE, + wxID_HTML_TREECTRL, + wxID_HTML_INDEXPAGE, + wxID_HTML_INDEXLIST, + wxID_HTML_INDEXTEXT, + wxID_HTML_INDEXBUTTON, + wxID_HTML_INDEXBUTTONALL, + wxID_HTML_NOTEBOOK, + wxID_HTML_SEARCHPAGE, + wxID_HTML_SEARCHTEXT, + wxID_HTML_SEARCHLIST, + wxID_HTML_SEARCHBUTTON, + wxID_HTML_SEARCHCHOICE, + wxID_HTML_COUNTINFO +}; + + IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame) wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString& title, @@ -133,20 +227,16 @@ wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) { - if (data) { + if (data) + { m_Data = data; - m_DataCreated = FALSE; - } else { + m_DataCreated = false; + } else + { m_Data = new wxHtmlHelpData(); - m_DataCreated = TRUE; + m_DataCreated = true; } - m_ContentsImageList = new wxImageList(16, 16); - m_ContentsImageList -> Add(wxICON(wbook)); - m_ContentsImageList -> Add(wxICON(wfolder)); - m_ContentsImageList -> Add(wxICON(wpage)); - m_ContentsImageList -> Add(wxICON(whlproot)); - m_ContentsBox = NULL; m_IndexList = NULL; m_IndexButton = NULL; @@ -159,11 +249,14 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) m_IndexCountInfo = NULL; m_Splitter = NULL; m_NavigPan = NULL; + m_NavigNotebook = NULL; m_HtmlWin = NULL; m_Bookmarks = NULL; m_SearchCaseSensitive = NULL; m_SearchWholeWords = NULL; + m_mergedIndex = NULL; + m_Config = NULL; m_ConfigRoot = wxEmptyString; @@ -171,18 +264,23 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) m_Cfg.w = 700; m_Cfg.h = 480; m_Cfg.sashpos = 240; - m_Cfg.navig_on = TRUE; + m_Cfg.navig_on = true; m_NormalFonts = m_FixedFonts = NULL; m_NormalFace = m_FixedFace = wxEmptyString; - m_FontSize = 1; - +#ifdef __WXMSW__ + m_FontSize = 10; +#else + m_FontSize = 14; +#endif + #if wxUSE_PRINTING_ARCHITECTURE m_Printer = NULL; #endif m_PagesHash = NULL; - m_UpdateContents = TRUE; + m_UpdateContents = true; + m_helpController = (wxHelpControllerBase*) NULL; } // Create: builds the GUI components. @@ -194,323 +292,363 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) // moreover, if no contents, index or searchpage is needed, m_Splitter and // m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame) -bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& title, - int style) +bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, + const wxString& WXUNUSED(title), int style) { + m_hfStyle = style; + + wxImageList *ContentsImageList = new wxImageList(16, 16); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, wxART_HELP_BROWSER)); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, wxART_HELP_BROWSER)); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, wxART_HELP_BROWSER)); + // Do the config in two steps. We read the HtmlWindow customization after we // create the window. if (m_Config) ReadCustomization(m_Config, m_ConfigRoot); - wxFrame::Create(parent, id, _("Help"), wxPoint(m_Cfg.x, m_Cfg.y), wxSize(m_Cfg.w, m_Cfg.h), wxDEFAULT_FRAME_STYLE, "wxHtmlHelp"); + wxFrame::Create(parent, id, _("Help"), + wxPoint(m_Cfg.x, m_Cfg.y), wxSize(m_Cfg.w, m_Cfg.h), + wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp")); GetPosition(&m_Cfg.x, &m_Cfg.y); - SetIcon(wxICON(whelp)); + SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER)); + + // On the Mac, each modeless frame must have a menubar. + // TODO: add more menu items, and perhaps add a style to show + // the menubar: compulsory on the Mac, optional elsewhere. +#ifdef __WXMAC__ + wxMenuBar* menuBar = new wxMenuBar; + + wxMenu* fileMenu = new wxMenu; + fileMenu->Append(wxID_HTML_OPENFILE, _("&Open...")); + fileMenu->AppendSeparator(); + fileMenu->Append(wxID_CLOSE, _("&Close")); + + wxMenu* helpMenu = new wxMenu; + helpMenu->Append(wxID_ABOUT, _("&About...")); + // Ensures we don't get an empty help menu + helpMenu->Append(wxID_HELP_CONTENTS, _("&About...")); + + menuBar->Append(fileMenu,_("&File")); + menuBar->Append(helpMenu,_("&Help")); + SetMenuBar(menuBar); +#endif int notebook_page = 0; +#if wxUSE_STATUSBAR CreateStatusBar(); +#endif // wxUSE_STATUSBAR +#if wxUSE_TOOLBAR // toolbar? - if (style & wxHF_TOOLBAR) { - wxToolBar *toolBar = CreateToolBar(wxNO_BORDER | wxTB_HORIZONTAL | wxTB_DOCKABLE); + if (style & (wxHF_TOOLBAR | wxHF_FLAT_TOOLBAR)) + { + wxToolBar *toolBar = CreateToolBar(wxNO_BORDER | wxTB_HORIZONTAL | + wxTB_DOCKABLE | + (style & wxHF_FLAT_TOOLBAR ? wxTB_FLAT : 0)); toolBar->SetMargins( 2, 2 ); AddToolbarButtons(toolBar, style); - toolBar -> Realize(); + toolBar->Realize(); } +#endif //wxUSE_TOOLBAR + + wxSizer *navigSizer = NULL; - if (style & (wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH)) { + if (style & (wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH)) + { // traditional help controller; splitter window with html page on the // right and a notebook containing various pages on the left m_Splitter = new wxSplitterWindow(this); m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter); - m_NavigPan = new wxNotebook(m_Splitter, wxID_HTML_NOTEBOOK, - wxDefaultPosition, wxDefaultSize); - } else { // only html window, no notebook with index,contents etc + m_NavigPan = new wxPanel(m_Splitter, wxID_ANY); + m_NavigNotebook = new wxNotebook(m_NavigPan, wxID_HTML_NOTEBOOK, + wxDefaultPosition, wxDefaultSize); + + navigSizer = new wxBoxSizer(wxVERTICAL); + navigSizer->Add(m_NavigNotebook, 1, wxEXPAND); + + m_NavigPan->SetSizer(navigSizer); + } + else + { // only html window, no notebook with index,contents etc m_HtmlWin = new wxHtmlWindow(this); } - m_HtmlWin -> SetRelatedFrame(this, m_TitleFormat); - m_HtmlWin -> SetRelatedStatusBar(0); - if (m_Config) - m_HtmlWin -> ReadCustomization(m_Config, m_ConfigRoot); + m_HtmlWin->SetRelatedFrame(this, m_TitleFormat); +#if wxUSE_STATUSBAR + m_HtmlWin->SetRelatedStatusBar(0); +#endif // wxUSE_STATUSBAR + if ( m_Config ) + m_HtmlWin->ReadCustomization(m_Config, m_ConfigRoot); // contents tree panel? - if (style & wxHF_CONTENTS) { - wxWindow *dummy = new wxPanel(m_NavigPan, wxID_HTML_INDEXPAGE); - - if (style & wxHF_BOOKMARKS) { - wxLayoutConstraints *b1 = new wxLayoutConstraints; - wxBitmapButton *bmpbt = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE, wxBITMAP(wbkdel), wxDefaultPosition, wxSize(20,20)); - - b1 -> top.SameAs (dummy, wxTop, 10); - b1 -> right.SameAs (dummy, wxRight, 10); - b1 -> height.AsIs(); - b1 -> width.AsIs(); - bmpbt -> SetConstraints(b1); + if ( style & wxHF_CONTENTS ) + { + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); - wxLayoutConstraints *b2 = new wxLayoutConstraints; - wxBitmapButton *bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD, wxBITMAP(wbkadd), wxDefaultPosition, wxSize(20,20)); + topsizer->Add(0, 10); - b2 -> top.SameAs (dummy, wxTop, 10); - b2 -> right.LeftOf (bmpbt, 2); - b2 -> height.AsIs(); - b2 -> width.AsIs(); - bmpbt2 -> SetConstraints(b2); + dummy->SetSizer(topsizer); -#if wxUSE_TOOLTIPS - bmpbt -> SetToolTip(_("Remove current page from bookmarks")); - bmpbt2 -> SetToolTip(_("Add current page to bookmarks")); -#endif //wxUSE_TOOLTIPS - - wxLayoutConstraints *b3 = new wxLayoutConstraints; - m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST, wxEmptyString, - wxDefaultPosition, wxDefaultSize, 0, NULL, wxCB_READONLY | wxCB_SORT); - m_Bookmarks -> Append(_("(bookmarks)")); + if ( style & wxHF_BOOKMARKS ) + { + m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST, + wxEmptyString, + wxDefaultPosition, wxDefaultSize, + 0, NULL, wxCB_READONLY | wxCB_SORT); + m_Bookmarks->Append(_("(bookmarks)")); for (unsigned i = 0; i < m_BookmarksNames.GetCount(); i++) - m_Bookmarks -> Append(m_BookmarksNames[i]); - m_Bookmarks -> SetSelection(0); - - b3 -> centreY.SameAs (bmpbt2, wxCentreY); - b3 -> left.SameAs (dummy, wxLeft, 10); - b3 -> right.LeftOf (bmpbt2, 5); - b3 -> height.AsIs(); - m_Bookmarks -> SetConstraints(b3); + m_Bookmarks->Append(m_BookmarksNames[i]); + m_Bookmarks->SetSelection(0); + + wxBitmapButton *bmpbt1, *bmpbt2; + bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD, + wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK, + wxART_HELP_BROWSER)); + bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE, + wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK, + wxART_HELP_BROWSER)); +#if wxUSE_TOOLTIPS + bmpbt1->SetToolTip(_("Add current page to bookmarks")); + bmpbt2->SetToolTip(_("Remove current page from bookmarks")); +#endif // wxUSE_TOOLTIPS + wxSizer *sizer = new wxBoxSizer(wxHORIZONTAL); - wxLayoutConstraints *b4 = new wxLayoutConstraints; - m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL, - wxDefaultPosition, wxDefaultSize, - wxTR_HAS_BUTTONS | wxSUNKEN_BORDER); - m_ContentsBox -> SetImageList(m_ContentsImageList); + sizer->Add(m_Bookmarks, 1, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 5); + sizer->Add(bmpbt1, 0, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 2); + sizer->Add(bmpbt2, 0, wxALIGN_CENTRE_VERTICAL, 0); - b4 -> top.Below (m_Bookmarks, 10); - b4 -> left.SameAs (dummy, wxLeft, 0); - b4 -> right.SameAs (dummy, wxRight, 0); - b4 -> bottom.SameAs (dummy, wxBottom, 0); - m_ContentsBox -> SetConstraints(b4); + topsizer->Add(sizer, 0, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 10); + } - dummy -> SetAutoLayout(TRUE); - dummy -> Layout(); + m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL, + wxDefaultPosition, wxDefaultSize, + wxSUNKEN_BORDER | + wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | + wxTR_LINES_AT_ROOT); - m_NavigPan -> AddPage(dummy, _("Contents")); - } + m_ContentsBox->AssignImageList(ContentsImageList); - else - { - m_ContentsBox = new wxTreeCtrl(m_NavigPan, wxID_HTML_TREECTRL, - wxDefaultPosition, wxDefaultSize, - wxTR_HAS_BUTTONS | wxSUNKEN_BORDER); - m_ContentsBox -> SetImageList(m_ContentsImageList); - m_NavigPan -> AddPage(m_ContentsBox, _("Contents")); - } + topsizer->Add(m_ContentsBox, 1, + wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, + 2); + m_NavigNotebook->AddPage(dummy, _("Contents")); m_ContentsPage = notebook_page++; } // index listbox panel? - if (style & wxHF_INDEX) { - wxWindow *dummy = new wxPanel(m_NavigPan, wxID_HTML_INDEXPAGE); - - wxLayoutConstraints *b1 = new wxLayoutConstraints; - m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER); - b1 -> top.SameAs (dummy, wxTop, 10); - b1 -> left.SameAs (dummy, wxLeft, 10); - b1 -> right.SameAs (dummy, wxRight, 10); - b1 -> height.AsIs(); - m_IndexText -> SetConstraints(b1); - - wxLayoutConstraints *b4 = new wxLayoutConstraints; - m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL, _("Show all")); - - b4 -> top.Below (m_IndexText, 10); - b4 -> right.SameAs (dummy, wxRight, 10); - b4 -> width.AsIs(); - b4 -> height.AsIs(); - m_IndexButtonAll -> SetConstraints(b4); - - wxLayoutConstraints *b2 = new wxLayoutConstraints; + if ( style & wxHF_INDEX ) + { + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); + + dummy->SetSizer(topsizer); + + m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString, + wxDefaultPosition, wxDefaultSize, + wxTE_PROCESS_ENTER); m_IndexButton = new wxButton(dummy, wxID_HTML_INDEXBUTTON, _("Find")); - b2 -> top.Below (m_IndexText, 10); - b2 -> right.LeftOf (m_IndexButtonAll, 10); - b2 -> width.AsIs(); - b2 -> height.AsIs(); - m_IndexButton -> SetConstraints(b2); - - wxLayoutConstraints *b5 = new wxLayoutConstraints; - m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxALIGN_RIGHT | wxST_NO_AUTORESIZE); - - b5 -> top.Below (m_IndexButton, 5); - b5 -> right.SameAs (dummy, wxRight, 10); - b5 -> left.SameAs (dummy, wxLeft, 10); - b5 -> height.AsIs(); - m_IndexCountInfo -> SetConstraints(b5); - - wxLayoutConstraints *b3 = new wxLayoutConstraints; - m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST, wxDefaultPosition, wxDefaultSize, 0, NULL, wxLB_SINGLE); - b3 -> top.Below (m_IndexCountInfo, 5); - b3 -> left.SameAs (dummy, wxLeft, 0); - b3 -> right.SameAs (dummy, wxRight, 0); - b3 -> bottom.SameAs (dummy, wxBottom, 0); - m_IndexList -> SetConstraints(b3); + m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL, + _("Show all")); + m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO, + wxEmptyString, wxDefaultPosition, + wxDefaultSize, + wxALIGN_RIGHT | wxST_NO_AUTORESIZE); + m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST, + wxDefaultPosition, wxDefaultSize, + 0, NULL, wxLB_SINGLE); #if wxUSE_TOOLTIPS - m_IndexButtonAll -> SetToolTip(_("Show all items in index")); - m_IndexButton -> SetToolTip(_("Display all index items that contain given substring. Search is case insensitive.")); + m_IndexButton->SetToolTip(_("Display all index items that contain given substring. Search is case insensitive.")); + m_IndexButtonAll->SetToolTip(_("Show all items in index")); #endif //wxUSE_TOOLTIPS - dummy -> SetAutoLayout(TRUE); - dummy -> Layout(); + topsizer->Add(m_IndexText, 0, wxEXPAND | wxALL, 10); + wxSizer *btsizer = new wxBoxSizer(wxHORIZONTAL); + btsizer->Add(m_IndexButton, 0, wxRIGHT, 2); + btsizer->Add(m_IndexButtonAll); + topsizer->Add(btsizer, 0, + wxALIGN_RIGHT | wxLEFT | wxRIGHT | wxBOTTOM, 10); + topsizer->Add(m_IndexCountInfo, 0, wxEXPAND | wxLEFT | wxRIGHT, 2); + topsizer->Add(m_IndexList, 1, wxEXPAND | wxALL, 2); - m_NavigPan -> AddPage(dummy, _("Index")); + m_NavigNotebook->AddPage(dummy, _("Index")); m_IndexPage = notebook_page++; } // search list panel? - if (style & wxHF_SEARCH) { - wxWindow *dummy = new wxPanel(m_NavigPan, wxID_HTML_SEARCHPAGE); - - wxLayoutConstraints *b1 = new wxLayoutConstraints; - m_SearchText = new wxTextCtrl(dummy, wxID_HTML_SEARCHTEXT, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER); - b1 -> top.SameAs (dummy, wxTop, 10); - b1 -> left.SameAs (dummy, wxLeft, 10); - b1 -> right.SameAs (dummy, wxRight, 10); - b1 -> height.AsIs(); - m_SearchText -> SetConstraints(b1); - - wxLayoutConstraints *b4 = new wxLayoutConstraints; - m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE, wxDefaultPosition, - wxDefaultSize); - b4 -> top.Below (m_SearchText, 10); - b4 -> left.SameAs (dummy, wxLeft, 10); - b4 -> right.SameAs (dummy, wxRight, 10); - b4 -> height.AsIs(); - m_SearchChoice -> SetConstraints(b4); - - wxLayoutConstraints *b5 = new wxLayoutConstraints; - m_SearchCaseSensitive = new wxCheckBox(dummy, -1, _("Case sensitive")); - b5 -> top.Below (m_SearchChoice, 10); - b5 -> left.SameAs (dummy, wxLeft, 10); - b5 -> width.AsIs(); - b5 -> height.AsIs (); - m_SearchCaseSensitive -> SetConstraints(b5); - - wxLayoutConstraints *b6 = new wxLayoutConstraints; - m_SearchWholeWords = new wxCheckBox(dummy, -1, _("Whole words only")); - b6 -> top.Below (m_SearchCaseSensitive, 0); - b6 -> left.SameAs (dummy, wxLeft, 10); - b6 -> width.AsIs(); - b6 -> height.AsIs (); - m_SearchWholeWords -> SetConstraints(b6); - - wxLayoutConstraints *b2 = new wxLayoutConstraints; + if ( style & wxHF_SEARCH ) + { + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxSizer *sizer = new wxBoxSizer(wxVERTICAL); + + dummy->SetSizer(sizer); + + m_SearchText = new wxTextCtrl(dummy, wxID_HTML_SEARCHTEXT, + wxEmptyString, + wxDefaultPosition, wxDefaultSize, + wxTE_PROCESS_ENTER); + m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE, + wxDefaultPosition, wxDefaultSize); + m_SearchCaseSensitive = new wxCheckBox(dummy, wxID_ANY, _("Case sensitive")); + m_SearchWholeWords = new wxCheckBox(dummy, wxID_ANY, _("Whole words only")); m_SearchButton = new wxButton(dummy, wxID_HTML_SEARCHBUTTON, _("Search")); #if wxUSE_TOOLTIPS - m_SearchButton -> SetToolTip(_("Search contents of help book(s) for all occurences of the text you typed above")); + m_SearchButton->SetToolTip(_("Search contents of help book(s) for all occurences of the text you typed above")); #endif //wxUSE_TOOLTIPS - b2 -> top.Below (m_SearchWholeWords, 0); - b2 -> right.SameAs (dummy, wxRight, 10); - b2 -> width.AsIs(); - b2 -> height.AsIs(); - m_SearchButton -> SetConstraints(b2); - - wxLayoutConstraints *b3 = new wxLayoutConstraints; - m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST, wxDefaultPosition, wxDefaultSize, 0, NULL, wxLB_SINGLE); - b3 -> top.Below (m_SearchButton, 10); - b3 -> left.SameAs (dummy, wxLeft, 0); - b3 -> right.SameAs (dummy, wxRight, 0); - b3 -> bottom.SameAs (dummy, wxBottom, 0); - m_SearchList -> SetConstraints(b3); - - dummy -> SetAutoLayout(TRUE); - dummy -> Layout(); - m_NavigPan -> AddPage(dummy, _("Search")); - m_SearchPage = notebook_page++; + m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST, + wxDefaultPosition, wxDefaultSize, + 0, NULL, wxLB_SINGLE); + + sizer->Add(m_SearchText, 0, wxEXPAND | wxALL, 10); + sizer->Add(m_SearchChoice, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 10); + sizer->Add(m_SearchCaseSensitive, 0, wxLEFT | wxRIGHT, 10); + sizer->Add(m_SearchWholeWords, 0, wxLEFT | wxRIGHT, 10); + sizer->Add(m_SearchButton, 0, wxALL | wxALIGN_RIGHT, 8); + sizer->Add(m_SearchList, 1, wxALL | wxEXPAND, 2); + + m_NavigNotebook->AddPage(dummy, _("Search")); + m_SearchPage = notebook_page; } - m_HtmlWin -> Show(TRUE); - + + m_HtmlWin->Show(); + RefreshLists(); + if ( navigSizer ) + { + navigSizer->SetSizeHints(m_NavigPan); + m_NavigPan->Layout(); + } + // showtime - if (m_NavigPan && m_Splitter) { - m_Splitter -> SetMinimumPaneSize(20); - if (m_Cfg.navig_on) - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - else { - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - m_Splitter -> Unsplit(); - } - if (m_Cfg.navig_on) { - m_NavigPan -> Show(TRUE); - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + if ( m_NavigPan && m_Splitter ) + { + m_Splitter->SetMinimumPaneSize(20); + if ( m_Cfg.navig_on ) + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + + if ( m_Cfg.navig_on ) + { + m_NavigPan->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); } - else { - m_NavigPan -> Show(FALSE); - m_Splitter -> Initialize(m_HtmlWin); + else + { + m_NavigPan->Show(false); + m_Splitter->Initialize(m_HtmlWin); } } - return TRUE; + + // Reduce flicker by updating the splitter pane sizes before the + // frame is shown + wxSizeEvent sizeEvent(GetSize(), GetId()); + ProcessEvent(sizeEvent); + + m_Splitter->UpdateSize(); + + return true; } wxHtmlHelpFrame::~wxHtmlHelpFrame() { - PopEventHandler(); // wxhtmlhelpcontroller - delete m_ContentsImageList; + // PopEventHandler(); // wxhtmlhelpcontroller (not any more!) if (m_DataCreated) delete m_Data; if (m_NormalFonts) delete m_NormalFonts; if (m_FixedFonts) delete m_FixedFonts; - if (m_PagesHash) delete m_PagesHash; + if (m_PagesHash) + { + WX_CLEAR_HASH_TABLE(*m_PagesHash); + delete m_PagesHash; + } +#if wxUSE_PRINTING_ARCHITECTURE + if (m_Printer) delete m_Printer; +#endif } +#if wxUSE_TOOLBAR void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style) { - toolBar -> AddTool(wxID_HTML_PANEL, wxBITMAP(wpanel), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + wxBitmap wpanelBitmap = + wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_HELP_BROWSER); + wxBitmap wbackBitmap = + wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_HELP_BROWSER); + wxBitmap wforwardBitmap = + wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_HELP_BROWSER); + wxBitmap wupnodeBitmap = + wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_HELP_BROWSER); + wxBitmap wupBitmap = + wxArtProvider::GetBitmap(wxART_GO_UP, wxART_HELP_BROWSER); + wxBitmap wdownBitmap = + wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_HELP_BROWSER); + wxBitmap wopenBitmap = + wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_HELP_BROWSER); + wxBitmap wprintBitmap = + wxArtProvider::GetBitmap(wxART_PRINT, wxART_HELP_BROWSER); + wxBitmap woptionsBitmap = + wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_HELP_BROWSER); + + wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() && + wforwardBitmap.Ok() && wupnodeBitmap.Ok() && + wupBitmap.Ok() && wdownBitmap.Ok() && + wopenBitmap.Ok() && wprintBitmap.Ok() && + woptionsBitmap.Ok()), + wxT("One or more HTML help frame toolbar bitmap could not be loaded.")) ; + + + toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Show/hide navigation panel")); - toolBar -> AddSeparator(); - toolBar -> AddTool(wxID_HTML_BACK, wxBITMAP(wback), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + toolBar->AddSeparator(); + toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Go back")); - toolBar -> AddTool(wxID_HTML_FORWARD, wxBITMAP(wforward), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Go forward")); - toolBar -> AddSeparator(); + toolBar->AddSeparator(); - toolBar -> AddTool(wxID_HTML_UPNODE, wxBITMAP(wupnode), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Go one level up in document hierarchy")); - toolBar -> AddTool(wxID_HTML_UP, wxBITMAP(wup), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Previous page")); - toolBar -> AddTool(wxID_HTML_DOWN, wxBITMAP(wdown), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Next page")); - if ((style & wxHF_PRINT) || (style & wxHF_OPENFILES)) - toolBar -> AddSeparator(); - - if (style & wxHF_OPENFILES) - toolBar -> AddTool(wxID_HTML_OPENFILE, wxBITMAP(wopen), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES)) + toolBar->AddSeparator(); + + if (style & wxHF_OPEN_FILES) + toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Open HTML document")); #if wxUSE_PRINTING_ARCHITECTURE if (style & wxHF_PRINT) - toolBar -> AddTool(wxID_HTML_PRINT, wxBITMAP(wprint), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Print this page")); #endif - toolBar -> AddSeparator(); - toolBar -> AddTool(wxID_HTML_OPTIONS, wxBITMAP(woptions), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + toolBar->AddSeparator(); + toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, _("Display options dialog")); } +#endif //wxUSE_TOOLBAR void wxHtmlHelpFrame::SetTitleFormat(const wxString& format) @@ -524,23 +662,27 @@ void wxHtmlHelpFrame::SetTitleFormat(const wxString& format) bool wxHtmlHelpFrame::Display(const wxString& x) { wxString url = m_Data->FindPageByName(x); - if (! url.IsEmpty()) { + if (!url.IsEmpty()) + { m_HtmlWin->LoadPage(url); NotifyPageChanged(); - return TRUE; + return true; } - return FALSE; + + return false; } bool wxHtmlHelpFrame::Display(const int id) { wxString url = m_Data->FindPageById(id); - if (! url.IsEmpty()) { + if (!url.IsEmpty()) + { m_HtmlWin->LoadPage(url); NotifyPageChanged(); - return TRUE; + return true; } - return FALSE; + + return false; } @@ -548,15 +690,26 @@ bool wxHtmlHelpFrame::Display(const int id) bool wxHtmlHelpFrame::DisplayContents() { if (! m_ContentsBox) - return FALSE; - if (!m_Splitter -> IsSplit()) { - m_NavigPan -> Show(TRUE); - m_HtmlWin -> Show(TRUE); - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - m_Cfg.navig_on = TRUE; + return false; + + if (!m_Splitter->IsSplit()) + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + m_Cfg.navig_on = true; } - m_NavigPan -> SetSelection(0); - return TRUE; + + m_NavigNotebook->SetSelection(0); + + if (m_Data->GetBookRecArray().GetCount() > 0) + { + wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; + if (!book.GetStart().IsEmpty()) + m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); + } + + return true; } @@ -564,121 +717,278 @@ bool wxHtmlHelpFrame::DisplayContents() bool wxHtmlHelpFrame::DisplayIndex() { if (! m_IndexList) - return FALSE; - if (!m_Splitter -> IsSplit()) { - m_NavigPan -> Show(TRUE); - m_HtmlWin -> Show(TRUE); - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + return false; + + if (!m_Splitter->IsSplit()) + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + } + + m_NavigNotebook->SetSelection(1); + + if (m_Data->GetBookRecArray().GetCount() > 0) + { + wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; + if (!book.GetStart().IsEmpty()) + m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); } - m_NavigPan -> SetSelection(1); - return TRUE; + + return true; } +void wxHtmlHelpFrame::DisplayIndexItem(const wxHtmlHelpMergedIndexItem *it) +{ + if (it->items.size() == 1) + { + if (!it->items[0]->page.empty()) + { + m_HtmlWin->LoadPage(it->items[0]->GetFullPath()); + NotifyPageChanged(); + } + } + else + { + wxBusyCursor busy_cursor; + + // more pages associated with this index item -- let the user choose + // which one she/he wants from a list: + wxArrayString arr; + size_t len = it->items.size(); + for (size_t i = 0; i < len; i++) + { + wxString page = it->items[i]->page; + // try to find page's title in contents: + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + size_t clen = contents.size(); + for (size_t j = 0; j < clen; j++) + { + if (contents[j].page == page) + { + page = contents[j].name; + break; + } + } + arr.push_back(page); + } + + wxSingleChoiceDialog dlg(this, + _("Please choose the page to display:"), + _("Help Topics"), + arr, NULL, wxCHOICEDLG_STYLE & ~wxCENTRE); + if (dlg.ShowModal() == wxID_OK) + { + m_HtmlWin->LoadPage(it->items[dlg.GetSelection()]->GetFullPath()); + NotifyPageChanged(); + } + } +} -bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword) +bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword, + wxHelpSearchMode mode) { - if (! (m_SearchList && m_SearchButton && m_SearchText && m_SearchChoice)) - return FALSE; + if (mode == wxHELP_SEARCH_ALL) + { + if ( !(m_SearchList && + m_SearchButton && m_SearchText && m_SearchChoice) ) + return false; + } + else if (mode == wxHELP_SEARCH_INDEX) + { + if ( !(m_IndexList && + m_IndexButton && m_IndexButtonAll && m_IndexText) ) + return false; + } - int foundcnt = 0, curi; + int foundcnt = 0; wxString foundstr; wxString book = wxEmptyString; - if (!m_Splitter -> IsSplit()) { - m_NavigPan -> Show(TRUE); - m_HtmlWin -> Show(TRUE); - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + if (!m_Splitter->IsSplit()) + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); } - m_NavigPan -> SetSelection(m_SearchPage); - m_SearchList -> Clear(); - m_SearchText -> SetValue(keyword); - m_SearchButton -> Enable(FALSE); - if (m_SearchChoice->GetSelection() != 0) - book = m_SearchChoice->GetStringSelection(); - - wxHtmlSearchStatus status(m_Data, keyword, - m_SearchCaseSensitive -> GetValue(), m_SearchWholeWords -> GetValue(), - book); - - wxProgressDialog progress(_("Searching..."), _("No matching page found yet"), - status.GetMaxIndex(), this, - wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE | wxGA_SMOOTH); + if (mode == wxHELP_SEARCH_ALL) + { + m_NavigNotebook->SetSelection(m_SearchPage); + m_SearchList->Clear(); + m_SearchText->SetValue(keyword); + m_SearchButton->Disable(); + + if (m_SearchChoice->GetSelection() != 0) + book = m_SearchChoice->GetStringSelection(); + + wxHtmlSearchStatus status(m_Data, keyword, + m_SearchCaseSensitive->GetValue(), + m_SearchWholeWords->GetValue(), + book); + +#if wxUSE_PROGRESSDLG + wxProgressDialog progress(_("Searching..."), + _("No matching page found yet"), + status.GetMaxIndex(), this, + wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE); +#endif - while (status.IsActive()) { - curi = status.GetCurIndex(); - if (curi % 32 == 0 && progress.Update(curi) == FALSE) - break; - if (status.Search()) { - foundstr.Printf(_("Found %i matches"), ++foundcnt); - progress.Update(status.GetCurIndex(), foundstr); - m_SearchList -> Append(status.GetName(), status.GetContentsItem()); + int curi; + while (status.IsActive()) + { + curi = status.GetCurIndex(); + if (curi % 32 == 0 +#if wxUSE_PROGRESSDLG + && !progress.Update(curi) +#endif + ) + break; + if (status.Search()) + { + foundstr.Printf(_("Found %i matches"), ++foundcnt); +#if wxUSE_PROGRESSDLG + progress.Update(status.GetCurIndex(), foundstr); +#endif + m_SearchList->Append(status.GetName(), (void*)status.GetCurItem()); + } } + + m_SearchButton->Enable(); + m_SearchText->SetSelection(0, keyword.Length()); + m_SearchText->SetFocus(); + } + else if (mode == wxHELP_SEARCH_INDEX) + { + m_NavigNotebook->SetSelection(m_IndexPage); + m_IndexList->Clear(); + m_IndexButton->Disable(); + m_IndexButtonAll->Disable(); + m_IndexText->SetValue(keyword); + + wxCommandEvent dummy; + OnIndexFind(dummy); // what a hack... + m_IndexButton->Enable(); + m_IndexButtonAll->Enable(); + foundcnt = m_IndexList->GetCount(); } - m_SearchButton -> Enable(TRUE); - m_SearchText -> SetSelection(0, keyword.Length()); - m_SearchText -> SetFocus(); - if (foundcnt) { - wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_SearchList -> GetClientData(0); - if (it) + if (foundcnt) + { + switch ( mode ) { - m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); - NotifyPageChanged(); + default: + wxFAIL_MSG( _T("unknown help search mode") ); + // fall back + + case wxHELP_SEARCH_ALL: + { + wxHtmlHelpDataItem *it = + (wxHtmlHelpDataItem*) m_SearchList->GetClientData(0); + if (it) + { + m_HtmlWin->LoadPage(it->GetFullPath()); + NotifyPageChanged(); + } + break; + } + + case wxHELP_SEARCH_INDEX: + { + wxHtmlHelpMergedIndexItem* it = + (wxHtmlHelpMergedIndexItem*) m_IndexList->GetClientData(0); + if (it) + DisplayIndexItem(it); + break; + } } + } - return (foundcnt > 0); -} -#define MAX_ROOTS 64 + return foundcnt > 0; +} void wxHtmlHelpFrame::CreateContents() { if (! m_ContentsBox) return ; - m_ContentsBox->Clear(); + if (m_PagesHash) + { + WX_CLEAR_HASH_TABLE(*m_PagesHash); + delete m_PagesHash; + } - if (m_PagesHash) delete m_PagesHash; - m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * m_Data -> GetContentsCnt()); - m_PagesHash -> DeleteContents(TRUE); - - int cnt = m_Data->GetContentsCnt(); - int i; + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + + size_t cnt = contents.size(); - wxHtmlContentsItem *it; + m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * cnt); + const int MAX_ROOTS = 64; wxTreeItemId roots[MAX_ROOTS]; + // VS: this array holds information about whether we've set item icon at + // given level. This is neccessary because m_Data has flat structure + // and there's no way of recognizing if some item has subitems or not. + // We set the icon later: when we find an item with level=n, we know + // that the last item with level=n-1 was folder with subitems, so we + // set its icon accordingly bool imaged[MAX_ROOTS]; + m_ContentsBox->DeleteAllItems(); + + roots[0] = m_ContentsBox->AddRoot(_("(Help)")); + imaged[0] = true; - m_ContentsBox -> DeleteAllItems(); - roots[0] = m_ContentsBox -> AddRoot(_("(Help)")); - m_ContentsBox -> SetItemImage(roots[0], IMG_RootFolder); - m_ContentsBox -> SetItemSelectedImage(roots[0], IMG_RootFolder); - imaged[0] = TRUE; - - for (it = m_Data->GetContents(), i = 0; i < cnt; i++, it++) { - roots[it -> m_Level + 1] = m_ContentsBox -> AppendItem( - roots[it -> m_Level], it -> m_Name, IMG_Page, -1, - new wxHtmlHelpTreeItemData(i)); - m_PagesHash -> Put(it -> m_Book -> GetBasePath() + it -> m_Page, - new wxHtmlHelpHashData(i, roots[it -> m_Level + 1])); - - if (it -> m_Level == 0) { - m_ContentsBox -> SetItemBold(roots[1], TRUE); - m_ContentsBox -> SetItemImage(roots[1], IMG_Book); - m_ContentsBox -> SetItemSelectedImage(roots[1], IMG_Book); - imaged[1] = TRUE; - } else imaged[it -> m_Level + 1] = FALSE; - - if (!imaged[it -> m_Level]) { - m_ContentsBox -> SetItemImage(roots[it -> m_Level], IMG_Folder); - m_ContentsBox -> SetItemSelectedImage(roots[it -> m_Level], IMG_Folder); - imaged[it -> m_Level] = TRUE; + for (size_t i = 0; i < cnt; i++) + { + wxHtmlHelpDataItem *it = &contents[i]; + // Handle books: + if (it->level == 0) + { + if (m_hfStyle & wxHF_MERGE_BOOKS) + // VS: we don't want book nodes, books' content should + // appear under tree's root. This line will create "fake" + // record about book node so that the rest of this look + // will believe there really _is_ book node and will + // behave correctly. + roots[1] = roots[0]; + else + { + roots[1] = m_ContentsBox->AppendItem(roots[0], + it->name, IMG_Book, -1, + new wxHtmlHelpTreeItemData(i)); + m_ContentsBox->SetItemBold(roots[1], true); + } + imaged[1] = true; + } + // ...and their contents: + else + { + roots[it->level + 1] = m_ContentsBox->AppendItem( + roots[it->level], it->name, IMG_Page, + -1, new wxHtmlHelpTreeItemData(i)); + imaged[it->level + 1] = false; + } + + m_PagesHash->Put(it->GetFullPath(), + new wxHtmlHelpHashData(i, roots[it->level + 1])); + + // Set the icon for the node one level up in the hiearachy, + // unless already done (see comment above imaged[] declaration) + if (!imaged[it->level]) + { + int image = IMG_Folder; + if (m_hfStyle & wxHF_ICONS_BOOK) + image = IMG_Book; + else if (m_hfStyle & wxHF_ICONS_BOOK_CHAPTER) + image = (it->level == 1) ? IMG_Book : IMG_Folder; + m_ContentsBox->SetItemImage(roots[it->level], image); + m_ContentsBox->SetItemImage(roots[it->level], image, + wxTreeItemIcon_Selected); + imaged[it->level] = true; } } - m_ContentsBox -> Expand(roots[0]); } @@ -689,27 +999,29 @@ void wxHtmlHelpFrame::CreateIndex() m_IndexList->Clear(); - int cnt = m_Data->GetIndexCnt(); - - wxString cnttext; - if (cnt > INDEX_IS_SMALL) cnttext.Printf(_("%i of %i"), 0, cnt); - else cnttext.Printf(_("%i of %i"), cnt, cnt); - m_IndexCountInfo -> SetLabel(cnttext); - if (cnt > INDEX_IS_SMALL) return; - - wxHtmlContentsItem* index = m_Data->GetIndex(); + size_t cnt = m_mergedIndex->size(); - for (int i = 0; i < cnt; i++) - m_IndexList -> Append(index[i].m_Name, (char*)(index + i)); + wxString cnttext; + if (cnt > INDEX_IS_SMALL) + cnttext.Printf(_("%i of %i"), 0, cnt); + else + cnttext.Printf(_("%i of %i"), cnt, cnt); + m_IndexCountInfo->SetLabel(cnttext); + if (cnt > INDEX_IS_SMALL) + return; + + for (size_t i = 0; i < cnt; i++) + m_IndexList->Append((*m_mergedIndex)[i].name, + (char*)(&(*m_mergedIndex)[i])); } void wxHtmlHelpFrame::CreateSearch() { if (! (m_SearchList && m_SearchChoice)) return ; - m_SearchList -> Clear(); - m_SearchChoice -> Clear(); - m_SearchChoice -> Append(_("Search in all books")); + m_SearchList->Clear(); + m_SearchChoice->Clear(); + m_SearchChoice->Append(_("Search in all books")); const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray(); int i, cnt = bookrec.GetCount(); for (i = 0; i < cnt; i++) @@ -720,6 +1032,9 @@ void wxHtmlHelpFrame::CreateSearch() void wxHtmlHelpFrame::RefreshLists() { + // Update m_mergedIndex: + UpdateMergedIndex(); + // Update the controls CreateContents(); CreateIndex(); CreateSearch(); @@ -730,43 +1045,47 @@ void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path) wxString oldpath; wxString tmp; - if (path != wxEmptyString) { - oldpath = cfg -> GetPath(); - cfg -> SetPath(_T("/") + path); + if (path != wxEmptyString) + { + oldpath = cfg->GetPath(); + cfg->SetPath(_T("/") + path); } - m_Cfg.navig_on = cfg -> Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0; - m_Cfg.sashpos = cfg -> Read(wxT("hcSashPos"), m_Cfg.sashpos); - m_Cfg.x = cfg -> Read(wxT("hcX"), m_Cfg.x); - m_Cfg.y = cfg -> Read(wxT("hcY"), m_Cfg.y); - m_Cfg.w = cfg -> Read(wxT("hcW"), m_Cfg.w); - m_Cfg.h = cfg -> Read(wxT("hcH"), m_Cfg.h); + m_Cfg.navig_on = cfg->Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0; + m_Cfg.sashpos = cfg->Read(wxT("hcSashPos"), m_Cfg.sashpos); + m_Cfg.x = cfg->Read(wxT("hcX"), m_Cfg.x); + m_Cfg.y = cfg->Read(wxT("hcY"), m_Cfg.y); + m_Cfg.w = cfg->Read(wxT("hcW"), m_Cfg.w); + m_Cfg.h = cfg->Read(wxT("hcH"), m_Cfg.h); - m_FixedFace = cfg -> Read(wxT("hcFixedFace"), m_FixedFace); - m_NormalFace = cfg -> Read(wxT("hcNormalFace"), m_NormalFace); - m_FontSize = cfg -> Read(wxT("hcFontSize"), m_FontSize); + m_FixedFace = cfg->Read(wxT("hcFixedFace"), m_FixedFace); + m_NormalFace = cfg->Read(wxT("hcNormalFace"), m_NormalFace); + m_FontSize = cfg->Read(wxT("hcBaseFontSize"), m_FontSize); { int i; int cnt; wxString val, s; - - cnt = cfg -> Read(wxT("hcBookmarksCnt"), 0L); - if (cnt != 0) { + + cnt = cfg->Read(wxT("hcBookmarksCnt"), 0L); + if (cnt != 0) + { m_BookmarksNames.Clear(); m_BookmarksPages.Clear(); - if (m_Bookmarks) { - m_Bookmarks -> Clear(); - m_Bookmarks -> Append(_("(bookmarks)")); + if (m_Bookmarks) + { + m_Bookmarks->Clear(); + m_Bookmarks->Append(_("(bookmarks)")); } - - for (i = 0; i < cnt; i++) { + + for (i = 0; i < cnt; i++) + { val.Printf(wxT("hcBookmark_%i"), i); - s = cfg -> Read(val); + s = cfg->Read(val); m_BookmarksNames.Add(s); - if (m_Bookmarks) m_Bookmarks -> Append(s); + if (m_Bookmarks) m_Bookmarks->Append(s); val.Printf(wxT("hcBookmark_%i_url"), i); - s = cfg -> Read(val); + s = cfg->Read(val); m_BookmarksPages.Add(s); } } @@ -776,7 +1095,7 @@ void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path) m_HtmlWin->ReadCustomization(cfg); if (path != wxEmptyString) - cfg -> SetPath(oldpath); + cfg->SetPath(oldpath); } void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path) @@ -784,32 +1103,40 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path wxString oldpath; wxString tmp; - if (path != wxEmptyString) { - oldpath = cfg -> GetPath(); - cfg -> SetPath(_T("/") + path); + if (path != wxEmptyString) + { + oldpath = cfg->GetPath(); + cfg->SetPath(_T("/") + path); } - cfg -> Write(wxT("hcNavigPanel"), m_Cfg.navig_on); - cfg -> Write(wxT("hcSashPos"), (long)m_Cfg.sashpos); - cfg -> Write(wxT("hcX"), (long)m_Cfg.x); - cfg -> Write(wxT("hcY"), (long)m_Cfg.y); - cfg -> Write(wxT("hcW"), (long)m_Cfg.w); - cfg -> Write(wxT("hcH"), (long)m_Cfg.h); - cfg -> Write(wxT("hcFixedFace"), m_FixedFace); - cfg -> Write(wxT("hcNormalFace"), m_NormalFace); - cfg -> Write(wxT("hcFontSize"), (long)m_FontSize); - - if (m_Bookmarks) { + cfg->Write(wxT("hcNavigPanel"), m_Cfg.navig_on); + cfg->Write(wxT("hcSashPos"), (long)m_Cfg.sashpos); + if ( !IsIconized() ) + { + // Don't write if iconized as this would make the window + // disappear next time it is shown! + cfg->Write(wxT("hcX"), (long)m_Cfg.x); + cfg->Write(wxT("hcY"), (long)m_Cfg.y); + cfg->Write(wxT("hcW"), (long)m_Cfg.w); + cfg->Write(wxT("hcH"), (long)m_Cfg.h); + } + cfg->Write(wxT("hcFixedFace"), m_FixedFace); + cfg->Write(wxT("hcNormalFace"), m_NormalFace); + cfg->Write(wxT("hcBaseFontSize"), (long)m_FontSize); + + if (m_Bookmarks) + { int i; int cnt = m_BookmarksNames.GetCount(); wxString val; - - cfg -> Write(wxT("hcBookmarksCnt"), (long)cnt); - for (i = 0; i < cnt; i++) { + + cfg->Write(wxT("hcBookmarksCnt"), (long)cnt); + for (i = 0; i < cnt; i++) + { val.Printf(wxT("hcBookmark_%i"), i); - cfg -> Write(val, m_BookmarksNames[i]); + cfg->Write(val, m_BookmarksNames[i]); val.Printf(wxT("hcBookmark_%i_url"), i); - cfg -> Write(val, m_BookmarksPages[i]); + cfg->Write(val, m_BookmarksPages[i]); } } @@ -817,7 +1144,7 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path m_HtmlWin->WriteCustomization(cfg); if (path != wxEmptyString) - cfg -> SetPath(oldpath); + cfg->SetPath(oldpath); } @@ -826,153 +1153,176 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, wxString fixf, int size) { - static int f_sizes[5][7] = - { - { 6, 7, 9, 12, 14, 16, 19}, - { 8, 9, 12, 14, 16, 19, 22}, - {10, 12, 14, 16, 19, 24, 32}, - {14, 16, 18, 24, 32, 38, 45}, - {16, 20, 24, 32, 38, 45, 50} - }; - - win -> SetFonts(scalf, fixf, f_sizes[size]); + int f_sizes[7]; + f_sizes[0] = int(size * 0.6); + f_sizes[1] = int(size * 0.8); + f_sizes[2] = size; + f_sizes[3] = int(size * 1.2); + f_sizes[4] = int(size * 1.4); + f_sizes[5] = int(size * 1.6); + f_sizes[6] = int(size * 1.8); + + win->SetFonts(scalf, fixf, f_sizes); } class wxHtmlHelpFrameOptionsDialog : public wxDialog { - public: - wxComboBox *NormalFont, *FixedFont; - wxRadioBox *RadioBox; - wxHtmlWindow *TestWin; - - wxHtmlHelpFrameOptionsDialog(wxWindow *parent) : wxDialog(parent, -1, wxString(_("Help Browser Options"))) - { - wxString choices[5] = {_("very small"), _("small"), _("medium"), _("large"), _("very large")}; - wxBoxSizer *topsizer, *sizer, *sizer2; - - topsizer = new wxBoxSizer(wxVERTICAL); - - sizer = new wxBoxSizer(wxHORIZONTAL); - - sizer2 = new wxStaticBoxSizer( new wxStaticBox(this, -1, _("Normal font:")), wxVERTICAL); - sizer2 -> Add(NormalFont = new wxComboBox(this, -1, wxEmptyString, wxDefaultPosition, - wxSize(200, 200), - 0, NULL, wxCB_DROPDOWN | wxCB_READONLY), - 1, wxEXPAND | wxLEFT | wxRIGHT, 10); - - sizer -> Add(sizer2, 0, wxEXPAND | wxLEFT|wxRIGHT|wxTOP, 10); - - sizer2 = new wxStaticBoxSizer( new wxStaticBox(this, -1, _("Fixed font:")), wxVERTICAL); - sizer2 -> Add(FixedFont = new wxComboBox(this, -1, wxEmptyString, wxDefaultPosition, - wxSize(200, 200), - 0, NULL, wxCB_DROPDOWN | wxCB_READONLY), - 1, wxEXPAND | wxLEFT | wxRIGHT, 10); - - sizer -> Add(sizer2, 0, wxEXPAND | wxLEFT|wxRIGHT|wxTOP, 10); - - topsizer -> Add(sizer); +public: + wxComboBox *NormalFont, *FixedFont; + wxSpinCtrl *FontSize; + wxHtmlWindow *TestWin; - topsizer -> Add(RadioBox = new wxRadioBox(this, -1, _("Font size:"), - wxDefaultPosition, wxDefaultSize, 5, choices, 5), - 0, wxEXPAND | wxLEFT|wxRIGHT|wxTOP, 10); - - topsizer -> Add(new wxStaticText(this, -1, _("Preview:")), - 0, wxLEFT | wxTOP, 10); - topsizer -> Add(TestWin = new wxHtmlWindow(this, -1, wxDefaultPosition, wxSize(-1, 150)), - 1, wxEXPAND | wxLEFT|wxTOP|wxRIGHT, 10); + wxHtmlHelpFrameOptionsDialog(wxWindow *parent) + : wxDialog(parent, wxID_ANY, wxString(_("Help Browser Options"))) + { + wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL); + wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 3, 2, 5); + + sizer->Add(new wxStaticText(this, wxID_ANY, _("Normal font:"))); + sizer->Add(new wxStaticText(this, wxID_ANY, _("Fixed font:"))); + sizer->Add(new wxStaticText(this, wxID_ANY, _("Font size:"))); + + sizer->Add(NormalFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, + wxSize(200, -1), + 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); + + sizer->Add(FixedFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, + wxSize(200, -1), + 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); + + sizer->Add(FontSize = new wxSpinCtrl(this, wxID_ANY)); + FontSize->SetRange(2, 100); + + topsizer->Add(sizer, 0, wxLEFT|wxRIGHT|wxTOP, 10); + + topsizer->Add(new wxStaticText(this, wxID_ANY, _("Preview:")), + 0, wxLEFT | wxTOP, 10); + topsizer->Add(TestWin = new wxHtmlWindow(this, wxID_ANY, wxDefaultPosition, wxSize(20, 150), + wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER), + 1, wxEXPAND | wxLEFT|wxTOP|wxRIGHT, 10); + + wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL); + wxButton *ok; + sizer2->Add(ok = new wxButton(this, wxID_OK, _("OK")), 0, wxALL, 10); + ok->SetDefault(); + sizer2->Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10); + topsizer->Add(sizer2, 0, wxALIGN_RIGHT); + + SetSizer(topsizer); + topsizer->Fit(this); + Centre(wxBOTH); + } - sizer = new wxBoxSizer(wxHORIZONTAL); - sizer -> Add(new wxButton(this, wxID_OK, _("OK")), 0, wxALL, 10); - sizer -> Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10); - topsizer -> Add(sizer, 0, wxALIGN_RIGHT); - SetAutoLayout(TRUE); - SetSizer(topsizer); - topsizer -> Fit(this); - Centre(wxBOTH); - } - - - void UpdateTestWin() - { - wxBusyCursor bcur; - SetFontsToHtmlWin(TestWin, - NormalFont -> GetStringSelection(), - FixedFont -> GetStringSelection(), - RadioBox -> GetSelection()); - TestWin -> SetPage(_("" - "Normal face
(and underlined. Italic face. " - "Bold face. Bold italic face.
" - "font size -2
" - "font size -1
" - "font size +0
" - "font size +1
" - "font size +2
" - "font size +3
" - "font size +4
" - - "

Fixed size face.
bold italic " - "bold italic underlined
" - "font size -2
" - "font size -1
" - "font size +0
" - "font size +1
" - "font size +2
" - "font size +3
" - "font size +4" - "")); - } + void UpdateTestWin() + { + wxBusyCursor bcur; + SetFontsToHtmlWin(TestWin, + NormalFont->GetStringSelection(), + FixedFont->GetStringSelection(), + FontSize->GetValue()); + + wxString content(_("font size")); + + content = _T("") + content + _T(" -2
") + _T("") + content + _T(" -1
") + _T("") + content + _T(" +0
") + _T("") + content + _T(" +1
") + _T("") + content + _T(" +2
") + _T("") + content + _T(" +3
") + _T("") + content + _T(" +4
") ; + + content = wxString( _T("
") ) + + _("Normal face
and underlined. ") + + _("Italic face. ") + + _("Bold face. ") + + _("Bold italic face.
") + + content + + wxString( _T("		") ) + + _("Fixed size face.
bold italic ") + + _("bold italic underlined
") + + content + + _T("
"); + + TestWin->SetPage( content ); + } - void OnUpdate(wxCommandEvent& event) - { - UpdateTestWin(); - } + void OnUpdate(wxCommandEvent& WXUNUSED(event)) + { + UpdateTestWin(); + } + void OnUpdateSpin(wxSpinEvent& WXUNUSED(event)) + { + UpdateTestWin(); + } - DECLARE_EVENT_TABLE() + DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxHtmlHelpFrameOptionsDialog) }; BEGIN_EVENT_TABLE(wxHtmlHelpFrameOptionsDialog, wxDialog) - EVT_COMBOBOX(-1, wxHtmlHelpFrameOptionsDialog::OnUpdate) - EVT_RADIOBOX(-1, wxHtmlHelpFrameOptionsDialog::OnUpdate) + EVT_COMBOBOX(wxID_ANY, wxHtmlHelpFrameOptionsDialog::OnUpdate) + EVT_SPINCTRL(wxID_ANY, wxHtmlHelpFrameOptionsDialog::OnUpdateSpin) END_EVENT_TABLE() - void wxHtmlHelpFrame::OptionsDialog() { wxHtmlHelpFrameOptionsDialog dlg(this); unsigned i; - - if (m_NormalFonts == NULL) { + + if (m_NormalFonts == NULL) + { wxFontEnumerator enu; enu.EnumerateFacenames(); m_NormalFonts = new wxArrayString; *m_NormalFonts = *enu.GetFacenames(); - m_NormalFonts -> Sort(); + m_NormalFonts->Sort(); // ascending sort } - if (m_FixedFonts == NULL) { + if (m_FixedFonts == NULL) + { wxFontEnumerator enu; - enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, TRUE); + enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, true /*enum fixed width only*/); m_FixedFonts = new wxArrayString; *m_FixedFonts = *enu.GetFacenames(); - m_FixedFonts -> Sort(); + m_FixedFonts->Sort(); // ascending sort } - - for (i = 0; i < m_NormalFonts -> GetCount(); i++) - dlg.NormalFont -> Append((*m_NormalFonts)[i]); - for (i = 0; i < m_FixedFonts -> GetCount(); i++) - dlg.FixedFont -> Append((*m_FixedFonts)[i]); - if (!m_NormalFace.IsEmpty()) dlg.NormalFont -> SetStringSelection(m_NormalFace); - else dlg.NormalFont -> SetSelection(0); - if (!m_FixedFace.IsEmpty()) dlg.FixedFont -> SetStringSelection(m_FixedFace); - else dlg.FixedFont -> SetSelection(0); - dlg.RadioBox -> SetSelection(m_FontSize); + + // VS: We want to show the font that is actually used by wxHtmlWindow. + // If customization dialog wasn't used yet, facenames are empty and + // wxHtmlWindow uses default fonts -- let's find out what they + // are so that we can pass them to the dialog: + if (m_NormalFace.empty()) + { + wxFont fnt(m_FontSize, wxSWISS, wxNORMAL, wxNORMAL, false); + m_NormalFace = fnt.GetFaceName(); + } + if (m_FixedFace.empty()) + { + wxFont fnt(m_FontSize, wxMODERN, wxNORMAL, wxNORMAL, false); + m_FixedFace = fnt.GetFaceName(); + } + + for (i = 0; i < m_NormalFonts->GetCount(); i++) + dlg.NormalFont->Append((*m_NormalFonts)[i]); + for (i = 0; i < m_FixedFonts->GetCount(); i++) + dlg.FixedFont->Append((*m_FixedFonts)[i]); + if (!m_NormalFace.empty()) + dlg.NormalFont->SetStringSelection(m_NormalFace); + else + dlg.NormalFont->SetSelection(0); + if (!m_FixedFace.empty()) + dlg.FixedFont->SetStringSelection(m_FixedFace); + else + dlg.FixedFont->SetSelection(0); + dlg.FontSize->SetValue(m_FontSize); dlg.UpdateTestWin(); - - if (dlg.ShowModal() == wxID_OK) { - m_NormalFace = dlg.NormalFont -> GetStringSelection(); - m_FixedFace = dlg.FixedFont -> GetStringSelection(); - m_FontSize = dlg.RadioBox -> GetSelection(); + + if (dlg.ShowModal() == wxID_OK) + { + m_NormalFace = dlg.NormalFont->GetStringSelection(); + m_FixedFace = dlg.FixedFont->GetStringSelection(); + m_FontSize = dlg.FontSize->GetValue(); SetFontsToHtmlWin(m_HtmlWin, m_NormalFace, m_FixedFace, m_FontSize); } } @@ -983,18 +1333,18 @@ void wxHtmlHelpFrame::NotifyPageChanged() { if (m_UpdateContents && m_PagesHash) { - wxString an = m_HtmlWin -> GetOpenedAnchor(); + wxString an = m_HtmlWin->GetOpenedAnchor(); wxHtmlHelpHashData *ha; if (an.IsEmpty()) - ha = (wxHtmlHelpHashData*) m_PagesHash -> Get(m_HtmlWin -> GetOpenedPage()); + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage()); else - ha = (wxHtmlHelpHashData*) m_PagesHash -> Get(m_HtmlWin -> GetOpenedPage() + wxT("#") + an); + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an); if (ha) { bool olduc = m_UpdateContents; - m_UpdateContents = FALSE; - m_ContentsBox -> SelectItem(ha -> m_Id); - m_ContentsBox -> EnsureVisible(ha -> m_Id); + m_UpdateContents = false; + m_ContentsBox->SelectItem(ha->m_Id); + m_ContentsBox->EnsureVisible(ha->m_Id); m_UpdateContents = olduc; } } @@ -1007,83 +1357,113 @@ EVENT HANDLING : */ -void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event) +void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event) { - switch (event.GetId()) { + // This saves one mouse click when using the + // wxHTML for context sensitive help systems +#ifndef __WXGTK__ + // NB: wxActivateEvent is a bit broken in wxGTK + // and is sometimes sent when it should not be + if (event.GetActive() && m_HtmlWin) + m_HtmlWin->SetFocus(); +#endif + + event.Skip(); +} +void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event) +{ + switch (event.GetId()) + { case wxID_HTML_BACK : - m_HtmlWin -> HistoryBack(); + m_HtmlWin->HistoryBack(); NotifyPageChanged(); break; case wxID_HTML_FORWARD : - m_HtmlWin -> HistoryForward(); + m_HtmlWin->HistoryForward(); NotifyPageChanged(); break; - - case wxID_HTML_UP : - if (m_PagesHash) + + case wxID_HTML_UP : + if (m_PagesHash) { - wxString an = m_HtmlWin -> GetOpenedAnchor(); + wxString an = m_HtmlWin->GetOpenedAnchor(); wxHtmlHelpHashData *ha; if (an.IsEmpty()) - ha = (wxHtmlHelpHashData*) m_PagesHash -> Get(m_HtmlWin -> GetOpenedPage()); + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage()); else - ha = (wxHtmlHelpHashData*) m_PagesHash -> Get(m_HtmlWin -> GetOpenedPage() + wxT("#") + an); - if (ha && ha -> m_Index > 0) + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an); + if (ha && ha->m_Index > 0) { - wxHtmlContentsItem *it = m_Data -> GetContents() + (ha -> m_Index - 1); - m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); - NotifyPageChanged(); + const wxHtmlHelpDataItem& it = m_Data->GetContentsArray()[ha->m_Index - 1]; + if (!it.page.empty()) + { + m_HtmlWin->LoadPage(it.GetFullPath()); + NotifyPageChanged(); + } } } break; - case wxID_HTML_UPNODE : - if (m_PagesHash) + case wxID_HTML_UPNODE : + if (m_PagesHash) { - wxString an = m_HtmlWin -> GetOpenedAnchor(); + wxString an = m_HtmlWin->GetOpenedAnchor(); wxHtmlHelpHashData *ha; if (an.IsEmpty()) - ha = (wxHtmlHelpHashData*) m_PagesHash -> Get(m_HtmlWin -> GetOpenedPage()); + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage()); else - ha = (wxHtmlHelpHashData*) m_PagesHash -> Get(m_HtmlWin -> GetOpenedPage() + wxT("#") + an); - if (ha && ha -> m_Index > 0) + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an); + if (ha && ha->m_Index > 0) { - int level = m_Data -> GetContents()[ha -> m_Index].m_Level - 1; - wxHtmlContentsItem *it; - int ind = ha -> m_Index - 1; - - it = m_Data -> GetContents() + ind; - while (ind >= 0 && it -> m_Level != level) ind--, it--; + int level = + m_Data->GetContentsArray()[ha->m_Index].level - 1; + int ind = ha->m_Index - 1; + + const wxHtmlHelpDataItem *it = + &m_Data->GetContentsArray()[ind]; + while (ind >= 0 && it->level != level) + { + ind--; + it = &m_Data->GetContentsArray()[ind]; + } if (ind >= 0) { - m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); - NotifyPageChanged(); + if (!it->page.empty()) + { + m_HtmlWin->LoadPage(it->GetFullPath()); + NotifyPageChanged(); + } } } } break; - case wxID_HTML_DOWN : - if (m_PagesHash) + case wxID_HTML_DOWN : + if (m_PagesHash) { - wxString an = m_HtmlWin -> GetOpenedAnchor(); + wxString an = m_HtmlWin->GetOpenedAnchor(); wxString adr; wxHtmlHelpHashData *ha; - - if (an.IsEmpty()) adr = m_HtmlWin -> GetOpenedPage(); - else adr = m_HtmlWin -> GetOpenedPage() + wxT("#") + an; - ha = (wxHtmlHelpHashData*) m_PagesHash -> Get(adr); + if (an.IsEmpty()) adr = m_HtmlWin->GetOpenedPage(); + else adr = m_HtmlWin->GetOpenedPage() + wxT("#") + an; - if (ha && ha -> m_Index < m_Data -> GetContentsCnt() - 1) + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(adr); + + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + if (ha && ha->m_Index < (int)contents.size() - 1) { - wxHtmlContentsItem *it = m_Data -> GetContents() + (ha -> m_Index + 1); - - while (it -> m_Book -> GetBasePath() + it -> m_Page == adr) it++; - m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); - NotifyPageChanged(); + size_t idx = ha->m_Index + 1; + + while (contents[idx].GetFullPath() == adr) idx++; + + if (!contents[idx].page.empty()) + { + m_HtmlWin->LoadPage(contents[idx].GetFullPath()); + NotifyPageChanged(); + } } } break; @@ -1092,15 +1472,18 @@ void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event) { if (! (m_Splitter && m_NavigPan)) return ; - if (m_Splitter -> IsSplit()) { - m_Cfg.sashpos = m_Splitter -> GetSashPosition(); - m_Splitter -> Unsplit(m_NavigPan); - m_Cfg.navig_on = FALSE; - } else { - m_NavigPan -> Show(TRUE); - m_HtmlWin -> Show(TRUE); - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - m_Cfg.navig_on = TRUE; + if (m_Splitter->IsSplit()) + { + m_Cfg.sashpos = m_Splitter->GetSashPosition(); + m_Splitter->Unsplit(m_NavigPan); + m_Cfg.navig_on = false; + } + else + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + m_Cfg.navig_on = true; } } break; @@ -1108,34 +1491,37 @@ void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event) case wxID_HTML_OPTIONS : OptionsDialog(); break; - - case wxID_HTML_BOOKMARKSADD : + + case wxID_HTML_BOOKMARKSADD : { wxString item; wxString url; - - item = m_HtmlWin -> GetOpenedPageTitle(); - url = m_HtmlWin -> GetOpenedPage(); - if (item == wxEmptyString) item = url.AfterLast(wxT('/')); - if (m_BookmarksPages.Index(url) == wxNOT_FOUND) { - m_Bookmarks -> Append(item); + + item = m_HtmlWin->GetOpenedPageTitle(); + url = m_HtmlWin->GetOpenedPage(); + if (item == wxEmptyString) + item = url.AfterLast(wxT('/')); + if (m_BookmarksPages.Index(url) == wxNOT_FOUND) + { + m_Bookmarks->Append(item); m_BookmarksNames.Add(item); m_BookmarksPages.Add(url); } } break; - - case wxID_HTML_BOOKMARKSREMOVE : + + case wxID_HTML_BOOKMARKSREMOVE : { wxString item; int pos; - - item = m_Bookmarks -> GetStringSelection(); + + item = m_Bookmarks->GetStringSelection(); pos = m_BookmarksNames.Index(item); - if (pos != wxNOT_FOUND) { - m_BookmarksNames.Remove(pos); - m_BookmarksPages.Remove(pos); - m_Bookmarks -> Delete(m_Bookmarks -> GetSelection()); + if (pos != wxNOT_FOUND) + { + m_BookmarksNames.RemoveAt(pos); + m_BookmarksPages.RemoveAt(pos); + m_Bookmarks->Delete(m_Bookmarks->GetSelection()); } } break; @@ -1143,32 +1529,48 @@ void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event) #if wxUSE_PRINTING_ARCHITECTURE case wxID_HTML_PRINT : { - if (m_Printer == NULL) + if (m_Printer == NULL) m_Printer = new wxHtmlEasyPrinting(_("Help Printing"), this); - m_Printer -> PrintFile(m_HtmlWin -> GetOpenedPage()); + if (!m_HtmlWin->GetOpenedPage()) + wxLogWarning(_("Cannot print empty page.")); + else + m_Printer->PrintFile(m_HtmlWin->GetOpenedPage()); } break; #endif case wxID_HTML_OPENFILE : { - wxString s = wxFileSelector(_("Open HTML document"), wxEmptyString, wxEmptyString, wxEmptyString, - wxT("HTML files (*.htm)|*.htm|HTML files (*.html)|*.html|" - "Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|" - "HTML Help Project (*.hhp)|*.hhp|" - "All files (*.*)|*"), - wxOPEN | wxFILE_MUST_EXIST, this); + wxString filemask = wxString( + _("HTML files (*.html;*.htm)|*.html;*.htm|")) + + _("Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|") + + _("HTML Help Project (*.hhp)|*.hhp|") + +#if wxUSE_LIBMSPACK + _("Compressed HTML Help file (*.chm)|*.chm|") + +#endif + _("All files (*.*)|*"); + wxString s = wxFileSelector(_("Open HTML document"), + wxEmptyString, + wxEmptyString, + wxEmptyString, + filemask, + wxOPEN | wxFILE_MUST_EXIST, + this); if (!s.IsEmpty()) { wxString ext = s.Right(4).Lower(); - if (ext == _T(".zip") || ext == _T(".htb") || ext == _T(".hhp")) + if (ext == _T(".zip") || ext == _T(".htb") || +#if wxUSE_LIBMSPACK + ext == _T(".chm") || +#endif + ext == _T(".hhp")) { wxBusyCursor bcur; - m_Data -> AddBook(s); + m_Data->AddBook(s); RefreshLists(); } else - m_HtmlWin -> LoadPage(s); + m_HtmlWin->LoadPage(s); } } break; @@ -1180,16 +1582,16 @@ void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event) void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event) { wxHtmlHelpTreeItemData *pg; - wxHtmlContentsItem *it; - pg = (wxHtmlHelpTreeItemData*) m_ContentsBox -> GetItemData(event.GetItem()); - - if (pg && m_UpdateContents) + pg = (wxHtmlHelpTreeItemData*) m_ContentsBox->GetItemData(event.GetItem()); + + if (pg && m_UpdateContents) { - it = m_Data -> GetContents() + (pg -> m_Id); - m_UpdateContents = FALSE; - m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); - m_UpdateContents = TRUE; + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + m_UpdateContents = false; + if (!contents[pg->m_Id].page.empty()) + m_HtmlWin->LoadPage(contents[pg->m_Id].GetFullPath()); + m_UpdateContents = true; } } @@ -1197,104 +1599,131 @@ void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event) void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent& WXUNUSED(event)) { - wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_IndexList -> GetClientData(m_IndexList -> GetSelection()); - m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); - NotifyPageChanged(); + wxHtmlHelpMergedIndexItem *it = (wxHtmlHelpMergedIndexItem*) + m_IndexList->GetClientData(m_IndexList->GetSelection()); + if (it) + DisplayIndexItem(it); } void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event) { - wxString sr = m_IndexText -> GetLineText(0); + wxString sr = m_IndexText->GetLineText(0); sr.MakeLower(); - if (sr == wxEmptyString) + if (sr == wxEmptyString) + { OnIndexAll(event); - - else { + } + else + { wxBusyCursor bcur; - const wxChar *cstr = sr.c_str(); - wxChar mybuff[512], *ptr; - bool first = TRUE; - + m_IndexList->Clear(); - int cnt = m_Data->GetIndexCnt(); - wxHtmlContentsItem* index = m_Data->GetIndex(); + const wxHtmlHelpMergedIndex& index = *m_mergedIndex; + size_t cnt = index.size(); int displ = 0; - for (int i = 0; i < cnt; i++) + for (size_t i = 0; i < cnt; i++) { - wxStrncpy(mybuff, index[i].m_Name, 512); - mybuff[511] = 0; - for (ptr = mybuff; *ptr != 0; ptr++) - if (*ptr >= 'A' && *ptr <= 'Z') *ptr -= 'A' - 'a'; - if (wxStrstr(mybuff, cstr) != NULL) { - m_IndexList -> Append(index[i].m_Name, (char*)(index + i)); - displ++; - if (first) { - m_HtmlWin -> LoadPage(index[i].m_Book -> GetBasePath() + index[i].m_Page); - NotifyPageChanged(); - first = FALSE; + if (index[i].name.Lower().find(sr) != wxString::npos) + { + int pos = m_IndexList->Append(index[i].name, + (char*)(&index[i])); + + if (displ++ == 0) + { + // don't automatically show topic selector if this + // item points to multiple pages: + if (index[i].items.size() == 1) + { + m_IndexList->SetSelection(0); + DisplayIndexItem(&index[i]); + } + } + + // if this is nested item of the index, show its parent(s) + // as well, otherwise it would not be clear what entry is + // shown: + wxHtmlHelpMergedIndexItem *parent = index[i].parent; + while (parent) + { + if (pos == 0 || + (index.Index(*(wxHtmlHelpMergedIndexItem*)m_IndexList->GetClientData(pos-1))) < index.Index(*parent)) + { + m_IndexList->Insert(parent->name, + pos, (char*)parent); + parent = parent->parent; + } + else break; } } } wxString cnttext; cnttext.Printf(_("%i of %i"), displ, cnt); - m_IndexCountInfo -> SetLabel(cnttext); + m_IndexCountInfo->SetLabel(cnttext); - m_IndexText -> SetSelection(0, sr.Length()); - m_IndexText -> SetFocus(); + m_IndexText->SetSelection(0, sr.Length()); + m_IndexText->SetFocus(); } } void wxHtmlHelpFrame::OnIndexAll(wxCommandEvent& WXUNUSED(event)) { wxBusyCursor bcur; - + m_IndexList->Clear(); - int cnt = m_Data->GetIndexCnt(); - bool first = TRUE; - wxHtmlContentsItem* index = m_Data->GetIndex(); - - for (int i = 0; i < cnt; i++) { - m_IndexList -> Append(index[i].m_Name, (char*)(index + i)); - if (first) { - m_HtmlWin -> LoadPage(index[i].m_Book -> GetBasePath() + index[i].m_Page); - NotifyPageChanged(); - first = FALSE; + const wxHtmlHelpMergedIndex& index = *m_mergedIndex; + size_t cnt = index.size(); + bool first = true; + + for (size_t i = 0; i < cnt; i++) + { + m_IndexList->Append(index[i].name, (char*)(&index[i])); + if (first) + { + // don't automatically show topic selector if this + // item points to multiple pages: + if (index[i].items.size() == 1) + { + DisplayIndexItem(&index[i]); + } + first = false; } } wxString cnttext; cnttext.Printf(_("%i of %i"), cnt, cnt); - m_IndexCountInfo -> SetLabel(cnttext); + m_IndexCountInfo->SetLabel(cnttext); } void wxHtmlHelpFrame::OnSearchSel(wxCommandEvent& WXUNUSED(event)) { - wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_SearchList -> GetClientData(m_SearchList -> GetSelection()); - if (it) + wxHtmlHelpDataItem *it = (wxHtmlHelpDataItem*) m_SearchList->GetClientData(m_SearchList->GetSelection()); + if (it) { - m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); + if (!it->page.empty()) + m_HtmlWin->LoadPage(it->GetFullPath()); NotifyPageChanged(); } } void wxHtmlHelpFrame::OnSearch(wxCommandEvent& WXUNUSED(event)) { - wxString sr = m_SearchText -> GetLineText(0); + wxString sr = m_SearchText->GetLineText(0); - if (sr != wxEmptyString) KeywordSearch(sr); + if (!sr.empty()) + KeywordSearch(sr, wxHELP_SEARCH_ALL); } void wxHtmlHelpFrame::OnBookmarksSel(wxCommandEvent& WXUNUSED(event)) { - wxString sr = m_Bookmarks -> GetStringSelection(); + wxString sr = m_Bookmarks->GetStringSelection(); if (sr != wxEmptyString && sr != _("(bookmarks)")) { - m_HtmlWin -> LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]); + m_HtmlWin->LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]); NotifyPageChanged(); } } @@ -1304,15 +1733,41 @@ void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt) GetSize(&m_Cfg.w, &m_Cfg.h); GetPosition(&m_Cfg.x, &m_Cfg.y); - if (m_Splitter && m_Cfg.navig_on) m_Cfg.sashpos = m_Splitter -> GetSashPosition(); +#ifdef __WXGTK__ + if (IsGrabbed()) + { + RemoveGrab(); + } +#endif + + if (m_Splitter && m_Cfg.navig_on) m_Cfg.sashpos = m_Splitter->GetSashPosition(); if (m_Config) WriteCustomization(m_Config, m_ConfigRoot); + if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController))) + { + ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt); + } + evt.Skip(); } +#ifdef __WXMAC__ +void wxHtmlHelpFrame::OnClose(wxCommandEvent& event) +{ + Close(true); +} + +void wxHtmlHelpFrame::OnAbout(wxCommandEvent& event) +{ + wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2004, Vaclav Slavik et al"), wxT("HelpView"), + wxICON_INFORMATION|wxOK, this); +} +#endif + BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame) + EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate) EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_OPTIONS, wxHtmlHelpFrame::OnToolbar) EVT_BUTTON(wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpFrame::OnToolbar) EVT_BUTTON(wxID_HTML_BOOKMARKSADD, wxHtmlHelpFrame::OnToolbar) @@ -1325,7 +1780,14 @@ BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame) EVT_TEXT_ENTER(wxID_HTML_INDEXTEXT, wxHtmlHelpFrame::OnIndexFind) EVT_BUTTON(wxID_HTML_INDEXBUTTONALL, wxHtmlHelpFrame::OnIndexAll) EVT_COMBOBOX(wxID_HTML_BOOKMARKSLIST, wxHtmlHelpFrame::OnBookmarksSel) - EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow) + EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow) +#ifdef __WXMAC__ + EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose) + EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout) + EVT_MENU(wxID_HELP_CONTENTS, wxHtmlHelpFrame::OnAbout) +#endif + END_EVENT_TABLE() -#endif +#endif // wxUSE_WXHTML_HELP +