X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d9b21c9f47f59f36d73220270002b55a7babfdfc..a8cb1a4947bbbf5e18ce52448f4c3bb4cff4daee:/src/html/helpfrm.cpp diff --git a/src/html/helpfrm.cpp b/src/html/helpfrm.cpp index 332129b273..3f403439b6 100644 --- a/src/html/helpfrm.cpp +++ b/src/html/helpfrm.cpp @@ -9,10 +9,6 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "helpfrm.h" -#endif - // For compilers that support precompilation, includes "wx.h" #include "wx/wxprec.h" @@ -35,6 +31,11 @@ #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" @@ -52,6 +53,9 @@ #include "wx/filedlg.h" #include "wx/artprov.h" #include "wx/spinctrl.h" +#include "wx/dynarray.h" +#include "wx/choicdlg.h" +#include "wx/settings.h" // what is considered "small index"? #define INDEX_IS_SMALL 100 @@ -103,12 +107,34 @@ class wxHtmlHelpHashData : public wxObject class wxHtmlHelpHtmlWindow : public wxHtmlWindow { public: - wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) : wxHtmlWindow(parent), m_Frame(fr) {} + wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) + : wxHtmlWindow(parent), m_Frame(fr) + { + SetStandardFonts(); + } 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(); + } + + // Returns full location with anchor (helper) + static wxString GetOpenedPageWithAnchor(wxHtmlWindow *win) + { + if(!win) + return wxEmptyString; + + wxString an = win->GetOpenedAnchor(); + wxString pg = win->GetOpenedPage(); + if(!an.empty()) + { + pg << wxT("#"); + pg << an; + } + return pg; } private: @@ -118,6 +144,58 @@ class wxHtmlHelpHtmlWindow : public wxHtmlWindow }; +//--------------------------------------------------------------------------- +// 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 @@ -169,13 +247,17 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) if (data) { m_Data = data; - m_DataCreated = FALSE; + m_DataCreated = false; } else { m_Data = new wxHtmlHelpData(); - m_DataCreated = TRUE; + m_DataCreated = true; } + m_ContentsPage = 0; + m_IndexPage = 0; + m_SearchPage = 0; + m_ContentsBox = NULL; m_IndexList = NULL; m_IndexButton = NULL; @@ -194,14 +276,16 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) m_SearchCaseSensitive = NULL; m_SearchWholeWords = NULL; + m_mergedIndex = NULL; + m_Config = NULL; m_ConfigRoot = wxEmptyString; - m_Cfg.x = m_Cfg.y = 0; + m_Cfg.x = m_Cfg.y = wxDefaultCoord; 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; @@ -216,7 +300,7 @@ void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) #endif m_PagesHash = NULL; - m_UpdateContents = TRUE; + m_UpdateContents = true; m_helpController = (wxHelpControllerBase*) NULL; } @@ -235,17 +319,23 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, 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)); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, + wxART_HELP_BROWSER, + wxSize(16, 16))); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, + wxART_HELP_BROWSER, + wxSize(16, 16))); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, + wxART_HELP_BROWSER, + wxSize(16, 16))); // 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), + 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); @@ -260,21 +350,26 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, wxMenu* fileMenu = new wxMenu; fileMenu->Append(wxID_HTML_OPENFILE, _("&Open...")); - fileMenu->Append(wxID_ABOUT, _("&About...")); fileMenu->AppendSeparator(); fileMenu->Append(wxID_CLOSE, _("&Close")); -// wxMenu* helpMenu = new wxMenu; -// helpMenu->Append(wxID_ABOUT, _("&About...")); + 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); + 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 | wxHF_FLAT_TOOLBAR)) { @@ -285,6 +380,7 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, AddToolbarButtons(toolBar, style); toolBar->Realize(); } +#endif //wxUSE_TOOLBAR wxSizer *navigSizer = NULL; @@ -295,15 +391,13 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, m_Splitter = new wxSplitterWindow(this); m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter); - m_NavigPan = new wxPanel(m_Splitter, -1); + m_NavigPan = new wxPanel(m_Splitter, wxID_ANY); m_NavigNotebook = new wxNotebook(m_NavigPan, wxID_HTML_NOTEBOOK, wxDefaultPosition, wxDefaultSize); - wxNotebookSizer *nbs = new wxNotebookSizer(m_NavigNotebook); - + navigSizer = new wxBoxSizer(wxVERTICAL); - navigSizer->Add(nbs, 1, wxEXPAND); + navigSizer->Add(m_NavigNotebook, 1, wxEXPAND); - m_NavigPan->SetAutoLayout(TRUE); m_NavigPan->SetSizer(navigSizer); } else @@ -312,7 +406,9 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, } 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); @@ -321,17 +417,16 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, { wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); - + topsizer->Add(0, 10); - - dummy->SetAutoLayout(TRUE); + dummy->SetSizer(topsizer); if ( style & wxHF_BOOKMARKS ) { - m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST, + m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST, wxEmptyString, - wxDefaultPosition, wxDefaultSize, + wxDefaultPosition, wxDefaultSize, 0, NULL, wxCB_READONLY | wxCB_SORT); m_Bookmarks->Append(_("(bookmarks)")); for (unsigned i = 0; i < m_BookmarksNames.GetCount(); i++) @@ -339,35 +434,44 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, 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)); + bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD, + wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK, + wxART_BUTTON)); + bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE, + wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK, + wxART_BUTTON)); #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); - + 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); - + topsizer->Add(sizer, 0, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 10); } m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL, wxDefaultPosition, wxDefaultSize, - wxSUNKEN_BORDER | +#ifdef __WXGTK20__ + wxSUNKEN_BORDER | wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | - wxTR_LINES_AT_ROOT); + wxTR_NO_LINES +#else + wxSUNKEN_BORDER | + wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | + wxTR_LINES_AT_ROOT +#endif + ); m_ContentsBox->AssignImageList(ContentsImageList); - - topsizer->Add(m_ContentsBox, 1, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 2); + + topsizer->Add(m_ContentsBox, 1, + wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, + 2); m_NavigNotebook->AddPage(dummy, _("Contents")); m_ContentsPage = notebook_page++; @@ -376,24 +480,23 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, // index listbox panel? if ( style & wxHF_INDEX ) { - wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); - dummy->SetAutoLayout(TRUE); dummy->SetSizer(topsizer); - m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString, - wxDefaultPosition, wxDefaultSize, + m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString, + wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER); m_IndexButton = new wxButton(dummy, wxID_HTML_INDEXBUTTON, _("Find")); - m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL, + m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL, _("Show all")); - m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO, + m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO, wxEmptyString, wxDefaultPosition, - wxDefaultSize, + wxDefaultSize, wxALIGN_RIGHT | wxST_NO_AUTORESIZE); - m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST, - wxDefaultPosition, wxDefaultSize, + m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST, + wxDefaultPosition, wxDefaultSize, 0, NULL, wxLB_SINGLE); #if wxUSE_TOOLTIPS @@ -405,7 +508,7 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, wxSizer *btsizer = new wxBoxSizer(wxHORIZONTAL); btsizer->Add(m_IndexButton, 0, wxRIGHT, 2); btsizer->Add(m_IndexButtonAll); - topsizer->Add(btsizer, 0, + 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); @@ -417,28 +520,27 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, // search list panel? if ( style & wxHF_SEARCH ) { - wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); wxSizer *sizer = new wxBoxSizer(wxVERTICAL); - dummy->SetAutoLayout(TRUE); dummy->SetSizer(sizer); - m_SearchText = new wxTextCtrl(dummy, wxID_HTML_SEARCHTEXT, - wxEmptyString, - wxDefaultPosition, wxDefaultSize, + 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, -1, _("Case sensitive")); - m_SearchWholeWords = new wxCheckBox(dummy, -1, _("Whole words only")); + m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE, + wxDefaultPosition, wxSize(125,wxDefaultCoord)); + 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")); #endif //wxUSE_TOOLTIPS - m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST, - wxDefaultPosition, wxDefaultSize, + 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); @@ -447,10 +549,10 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, sizer->Add(m_SearchList, 1, wxALL | wxEXPAND, 2); m_NavigNotebook->AddPage(dummy, _("Search")); - m_SearchPage = notebook_page++; + m_SearchPage = notebook_page; } - m_HtmlWin->Show(TRUE); + m_HtmlWin->Show(); RefreshLists(); @@ -469,50 +571,67 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, if ( m_Cfg.navig_on ) { - m_NavigPan->Show(TRUE); + m_NavigPan->Show(); m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); } else { - m_NavigPan->Show(FALSE); + 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() { + delete m_mergedIndex; + // 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) { - 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); + wxBitmap wpanelBitmap = + wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_TOOLBAR); + wxBitmap wbackBitmap = + wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_TOOLBAR); + wxBitmap wforwardBitmap = + wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_TOOLBAR); + wxBitmap wupnodeBitmap = + wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_TOOLBAR); + wxBitmap wupBitmap = + wxArtProvider::GetBitmap(wxART_GO_UP, wxART_TOOLBAR); + wxBitmap wdownBitmap = + wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_TOOLBAR); + wxBitmap wopenBitmap = + wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_TOOLBAR); + wxBitmap wprintBitmap = + wxArtProvider::GetBitmap(wxART_PRINT, wxART_TOOLBAR); + wxBitmap woptionsBitmap = + wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_TOOLBAR); wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() && wforwardBitmap.Ok() && wupnodeBitmap.Ok() && @@ -523,26 +642,26 @@ void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style) toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Show/hide navigation panel")); toolBar->AddSeparator(); toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Go back")); toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Go forward")); toolBar->AddSeparator(); toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Go one level up in document hierarchy")); toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Previous page")); toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Next page")); if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES)) @@ -550,21 +669,22 @@ void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style) if (style & wxHF_OPEN_FILES) toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Open HTML document")); #if wxUSE_PRINTING_ARCHITECTURE if (style & wxHF_PRINT) toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Print this page")); #endif toolBar->AddSeparator(); toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, _("Display options dialog")); } +#endif //wxUSE_TOOLBAR void wxHtmlHelpFrame::SetTitleFormat(const wxString& format) @@ -578,25 +698,27 @@ void wxHtmlHelpFrame::SetTitleFormat(const wxString& format) bool wxHtmlHelpFrame::Display(const wxString& x) { wxString url = m_Data->FindPageByName(x); - if (!url.IsEmpty()) + if (!url.empty()) { 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.empty()) { m_HtmlWin->LoadPage(url); NotifyPageChanged(); - return TRUE; + return true; } - return FALSE; + + return false; } @@ -604,22 +726,26 @@ bool wxHtmlHelpFrame::Display(const int id) bool wxHtmlHelpFrame::DisplayContents() { if (! m_ContentsBox) - return FALSE; + return false; + if (!m_Splitter->IsSplit()) { - m_NavigPan->Show(TRUE); - m_HtmlWin->Show(TRUE); + m_NavigPan->Show(); + m_HtmlWin->Show(); m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - m_Cfg.navig_on = TRUE; + m_Cfg.navig_on = true; } - m_NavigNotebook->SetSelection(0); + + m_NavigNotebook->SetSelection(m_ContentsPage); + if (m_Data->GetBookRecArray().GetCount() > 0) { wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; - if (!book.GetStart().IsEmpty()) + if (!book.GetStart().empty()) m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); } - return TRUE; + + return true; } @@ -627,82 +753,196 @@ bool wxHtmlHelpFrame::DisplayContents() bool wxHtmlHelpFrame::DisplayIndex() { if (! m_IndexList) - return FALSE; + return false; + if (!m_Splitter->IsSplit()) { - m_NavigPan->Show(TRUE); - m_HtmlWin->Show(TRUE); + m_NavigPan->Show(); + m_HtmlWin->Show(); m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); } - m_NavigNotebook->SetSelection(1); + + m_NavigNotebook->SetSelection(m_IndexPage); + if (m_Data->GetBookRecArray().GetCount() > 0) { wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; - if (!book.GetStart().IsEmpty()) + if (!book.GetStart().empty()) m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); } - 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_NavigPan->Show(); + m_HtmlWin->Show(); m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); } - m_NavigNotebook->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); - - while (status.IsActive()) + if (mode == wxHELP_SEARCH_ALL) { - curi = status.GetCurIndex(); - if (curi % 32 == 0 && progress.Update(curi) == FALSE) - break; - if (status.Search()) + 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 + + int curi; + while (status.IsActive()) { - foundstr.Printf(_("Found %i matches"), ++foundcnt); - progress.Update(status.GetCurIndex(), foundstr); - m_SearchList->Append(status.GetName(), status.GetContentsItem()); + 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) + switch ( mode ) { - m_HtmlWin->LoadPage(it->GetFullPath()); - 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); + + return foundcnt > 0; } void wxHtmlHelpFrame::CreateContents() @@ -710,76 +950,79 @@ 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); + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); - int cnt = m_Data->GetContentsCnt(); - int i; + 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 + // given level. This is necessary because m_Data has a 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 + // that the last item with level=n-1 was afolder with subitems, so we // set its icon accordingly bool imaged[MAX_ROOTS]; m_ContentsBox->DeleteAllItems(); - + roots[0] = m_ContentsBox->AddRoot(_("(Help)")); - imaged[0] = TRUE; + imaged[0] = true; - for (it = m_Data->GetContents(), i = 0; i < cnt; i++, it++) + for (size_t i = 0; i < cnt; i++) { + wxHtmlHelpDataItem *it = &contents[i]; // Handle books: - if (it->m_Level == 0) + 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" + // appear under tree's root. This line will create a "fake" // record about book node so that the rest of this look - // will believe there really _is_ book node and will + // will believe there really _is_ a book node and will // behave correctly. roots[1] = roots[0]; else { roots[1] = m_ContentsBox->AppendItem(roots[0], - it->m_Name, IMG_Book, -1, + it->name, IMG_Book, -1, new wxHtmlHelpTreeItemData(i)); - m_ContentsBox->SetItemBold(roots[1], TRUE); + m_ContentsBox->SetItemBold(roots[1], true); } - imaged[1] = TRUE; + imaged[1] = true; } // ...and their contents: else { - roots[it->m_Level + 1] = m_ContentsBox->AppendItem( - roots[it->m_Level], it->m_Name, IMG_Page, + roots[it->level + 1] = m_ContentsBox->AppendItem( + roots[it->level], it->name, IMG_Page, -1, new wxHtmlHelpTreeItemData(i)); - imaged[it->m_Level + 1] = FALSE; + imaged[it->level + 1] = false; } m_PagesHash->Put(it->GetFullPath(), - new wxHtmlHelpHashData(i, roots[it->m_Level + 1])); + new wxHtmlHelpHashData(i, roots[it->level + 1])); - // Set the icon for the node one level up in the hiearachy, + // Set the icon for the node one level up in the hierarchy, // unless already done (see comment above imaged[] declaration) - if (!imaged[it->m_Level]) + 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->m_Level == 1) ? IMG_Book : IMG_Folder; - m_ContentsBox->SetItemImage(roots[it->m_Level], image); - m_ContentsBox->SetItemSelectedImage(roots[it->m_Level], image); - imaged[it->m_Level] = TRUE; + 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; } } } @@ -792,18 +1035,20 @@ void wxHtmlHelpFrame::CreateIndex() m_IndexList->Clear(); - int cnt = m_Data->GetIndexCnt(); + size_t cnt = m_mergedIndex->size(); wxString cnttext; - if (cnt > INDEX_IS_SMALL) cnttext.Printf(_("%i of %i"), 0, cnt); - else cnttext.Printf(_("%i of %i"), cnt, cnt); + 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(); + if (cnt > INDEX_IS_SMALL) + return; - for (int i = 0; i < cnt; i++) - m_IndexList->Append(index[i].m_Name, (char*)(index + i)); + for (size_t i = 0; i < cnt; i++) + m_IndexList->Append((*m_mergedIndex)[i].name, + (char*)(&(*m_mergedIndex)[i])); } void wxHtmlHelpFrame::CreateSearch() @@ -823,6 +1068,9 @@ void wxHtmlHelpFrame::CreateSearch() void wxHtmlHelpFrame::RefreshLists() { + // Update m_mergedIndex: + UpdateMergedIndex(); + // Update the controls CreateContents(); CreateIndex(); CreateSearch(); @@ -939,7 +1187,7 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path -static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, wxString fixf, int size) +static void SetFontsToHtmlWin(wxHtmlWindow *win, const wxString& scalf, const wxString& fixf, int size) { int f_sizes[7]; f_sizes[0] = int(size * 0.6); @@ -961,43 +1209,42 @@ public: wxSpinCtrl *FontSize; wxHtmlWindow *TestWin; - wxHtmlHelpFrameOptionsDialog(wxWindow *parent) - : wxDialog(parent, -1, wxString(_("Help Browser Options"))) + 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, -1, _("Normal font:"))); - sizer->Add(new wxStaticText(this, -1, _("Fixed font:"))); - sizer->Add(new wxStaticText(this, -1, _("Font size:"))); + 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, -1, wxEmptyString, wxDefaultPosition, - wxSize(200, 200), + sizer->Add(NormalFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, + wxSize(200, wxDefaultCoord), 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); - sizer->Add(FixedFont = new wxComboBox(this, -1, wxEmptyString, wxDefaultPosition, - wxSize(200, 200), + sizer->Add(FixedFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, + wxSize(200, wxDefaultCoord), 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); - sizer->Add(FontSize = new wxSpinCtrl(this, -1)); + 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, -1, _("Preview:")), + topsizer->Add(new wxStaticText(this, wxID_ANY, _("Preview:")), 0, wxLEFT | wxTOP, 10); - topsizer->Add(TestWin = new wxHtmlWindow(this, -1, wxDefaultPosition, wxSize(20, 150), + 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); + sizer2->Add(ok = new wxButton(this, wxID_OK), 0, wxALL, 10); ok->SetDefault(); - sizer2->Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10); + sizer2->Add(new wxButton(this, wxID_CANCEL), 0, wxALL, 10); topsizer->Add(sizer2, 0, wxALIGN_RIGHT); - SetAutoLayout(TRUE); SetSizer(topsizer); topsizer->Fit(this); Centre(wxBOTH); @@ -1011,30 +1258,30 @@ public: NormalFont->GetStringSelection(), FixedFont->GetStringSelection(), FontSize->GetValue()); - 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. |
") ) +
+ _("Normal face and underlined. ") + + _("Italic face. ") + + _("Bold face. ") + + _("Bold italic face. ") + + content + + wxString( _T(" | ") ) +
+ _("Fixed size face. bold italic ") + + _("bold italic underlined ") + + content + + _T(" |