X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/83efdf3393ca396e96d44892eae0a77cb772f6f2..a87bf37838e09fb4634a887cc8a6055104b49a01:/src/html/helpfrm.cpp?ds=sidebyside diff --git a/src/html/helpfrm.cpp b/src/html/helpfrm.cpp index 246f238678..0f48ca1d35 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" @@ -39,48 +53,169 @@ #include "wx/progdlg.h" #include "wx/toolbar.h" #include "wx/fontenum.h" +#include "wx/stream.h" +#include "wx/filedlg.h" +#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 -// 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" +//-------------------------------------------------------------------------- +// wxHtmlHelpTreeItemData (private) +//-------------------------------------------------------------------------- + +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;} -#include "wx/stream.h" + int m_Id; +}; -// number of times that the contents/index creation progress dialog -// is updated. -#define PROGRESS_STEP 40 //-------------------------------------------------------------------------- -// wxHtmlHelpTreeItemData +// wxHtmlHelpHashData (private) //-------------------------------------------------------------------------- -class wxHtmlHelpTreeItemData : public wxTreeItemData +class wxHtmlHelpHashData : public wxObject { - private: - wxString m_Page; + public: + wxHtmlHelpHashData(int index, wxTreeItemId id) : wxObject() + { m_Index = index; m_Id = id;} + ~wxHtmlHelpHashData() {} + + int m_Index; + wxTreeItemId m_Id; +}; + + +//-------------------------------------------------------------------------- +// wxHtmlHelpHtmlWindow (private) +//-------------------------------------------------------------------------- +class wxHtmlHelpHtmlWindow : public wxHtmlWindow +{ public: - wxHtmlHelpTreeItemData(wxHtmlContentsItem *it) : wxTreeItemData() + wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) : wxHtmlWindow(parent), m_Frame(fr) {} + + virtual void OnLinkClicked(const wxHtmlLinkInfo& link) { - m_Page = it -> m_Book -> GetBasePath() + it -> m_Page; + wxHtmlWindow::OnLinkClicked(link); + const wxMouseEvent *e = link.GetEvent(); + if (e == NULL || e->LeftUp()) + m_Frame->NotifyPageChanged(); } - const wxString& GetPage() { return m_Page; } + + 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, @@ -92,29 +227,36 @@ 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_IndexBox = NULL; + m_IndexList = NULL; + m_IndexButton = NULL; + m_IndexButtonAll = NULL; + m_IndexText = NULL; m_SearchList = NULL; m_SearchButton = NULL; m_SearchText = NULL; m_SearchChoice = NULL; + 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; @@ -122,202 +264,425 @@ 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_FontSize = 1; m_NormalFace = m_FixedFace = wxEmptyString; - m_NormalItalic = m_FixedItalic = wxSLANT; +#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_helpController = (wxHelpControllerBase*) NULL; } // Create: builds the GUI components. // with the style flag it's possible to toggle the toolbar, contents, index and search // controls. // m_HtmlWin will *always* be created, but it's important to realize that -// m_ContentsBox, m_IndexBox, m_SearchList, m_SearchButton, m_SearchText and +// m_ContentsBox, m_IndexList, m_SearchList, m_SearchButton, m_SearchText and // m_SearchButton may be NULL. // 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)); + 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); - toolBar -> SetMargins(2, 2); - - toolBar -> AddTool(wxID_HTML_PANEL, wxBITMAP(wpanel), 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, - _("Go back to the previous HTML page")); - toolBar -> AddTool(wxID_HTML_FORWARD, wxBITMAP(wforward), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, - _("Go forward to the next HTML page")); - - toolBar -> AddSeparator(); - toolBar -> AddTool(wxID_HTML_OPTIONS, wxBITMAP(woptions), wxNullBitmap, - FALSE, -1, -1, (wxObject *) NULL, - _("Display options dialog")); - - toolBar -> Realize(); - } - - if (style & (wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH)) { + 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(); + } +#endif //wxUSE_TOOLBAR + + wxSizer *navigSizer = NULL; + + 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 wxHtmlWindow(m_Splitter); - m_NavigPan = new wxNotebook(m_Splitter, wxID_HTML_NOTEBOOK, - wxDefaultPosition, wxDefaultSize); - } else { // only html window, no notebook with index,contents etc + m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter); + 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) { - m_ContentsBox = new wxTreeCtrl(m_NavigPan, wxID_HTML_TREECTRL, + if ( style & wxHF_CONTENTS ) + { + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); + + topsizer->Add(0, 10); + + dummy->SetSizer(topsizer); + + 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); + + 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); + + 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, - wxTR_HAS_BUTTONS | wxSUNKEN_BORDER); - m_ContentsBox -> SetImageList(m_ContentsImageList); - m_NavigPan -> AddPage(m_ContentsBox, _("Contents")); + wxSUNKEN_BORDER | + wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | + wxTR_LINES_AT_ROOT); + + m_ContentsBox->AssignImageList(ContentsImageList); + + 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; - b1 -> top.SameAs (dummy, wxTop, 0); - b1 -> left.SameAs (dummy, wxLeft, 0); - b1 -> width.PercentOf (dummy, wxWidth, 100); - b1 -> bottom.SameAs (dummy, wxBottom, 0); - m_IndexBox = new wxListBox(dummy, wxID_HTML_INDEXLIST, wxDefaultPosition, - wxDefaultSize, 0, NULL, wxLB_SINGLE | wxLB_ALWAYS_SB); - m_IndexBox -> SetConstraints(b1); - dummy -> SetAutoLayout(TRUE); - m_NavigPan -> AddPage(dummy, _("Index")); + 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")); + 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_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 + + 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_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); - 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 *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")); - b2 -> top.Below (m_SearchText, 10); - b2 -> left.SameAs (dummy, wxLeft, 10); - b2 -> width.AsIs(); - b2 -> height.AsIs(); - m_SearchButton -> SetConstraints(b2); - - wxLayoutConstraints *b4 = new wxLayoutConstraints; - m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE, wxDefaultPosition, - wxDefaultSize); - b4 -> top.Below (m_SearchText, 10); - b4 -> left.SameAs (m_SearchButton, wxRight, 10); - b4 -> right.SameAs (dummy, wxRight, 10); - b4 -> height.AsIs(); - m_SearchChoice -> SetConstraints(b4); - - wxLayoutConstraints *b3 = new wxLayoutConstraints; - m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST, wxDefaultPosition, wxDefaultSize, 0); - 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_HtmlWin -> Show(TRUE); - - //RefreshLists(); +#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, + 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(); + + 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() { - 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) + { + 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); + + 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, wbackBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, + _("Go back")); + toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, + _("Go forward")); + toolBar->AddSeparator(); + + toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, + _("Go one level up in document hierarchy")); + toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, + _("Previous page")); + toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, + _("Next page")); + + 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, wprintBitmap, wxNullBitmap, + false, -1, -1, (wxObject *) NULL, + _("Print this page")); +#endif + + 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) +{ + if (m_HtmlWin) + m_HtmlWin->SetRelatedFrame(this, format); + m_TitleFormat = format; } + bool wxHtmlHelpFrame::Display(const wxString& x) { wxString url = m_Data->FindPageByName(x); - if (! url.IsEmpty()) { + if (!url.IsEmpty()) + { m_HtmlWin->LoadPage(url); - return TRUE; + NotifyPageChanged(); + 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); - return TRUE; + NotifyPageChanged(); + return true; } - return FALSE; + + return false; } @@ -325,183 +690,338 @@ 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_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())); } - m_NavigPan -> SetSelection(0); - return TRUE; + + return true; } bool wxHtmlHelpFrame::DisplayIndex() { - if (! m_IndexBox) - return FALSE; - if (!m_Splitter -> IsSplit()) { - m_NavigPan -> Show(TRUE); - m_HtmlWin -> Show(TRUE); - m_Splitter -> SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + if (! m_IndexList) + 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())); + } + + 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(); + } } - m_NavigPan -> SetSelection(1); - return TRUE; } -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; 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(); + 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 + + 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(); + } - wxHtmlSearchStatus status(m_Data, keyword, book); + if (foundcnt) + { + switch ( mode ) + { + default: + wxFAIL_MSG( _T("unknown help search mode") ); + // fall back - wxProgressDialog progress(_("Searching..."), _("No matching page found yet"), - status.GetMaxIndex(), this, - wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE); + case wxHELP_SEARCH_ALL: + { + wxHtmlHelpDataItem *it = + (wxHtmlHelpDataItem*) m_SearchList->GetClientData(0); + if (it) + { + m_HtmlWin->LoadPage(it->GetFullPath()); + NotifyPageChanged(); + } + break; + } - while (status.IsActive()) { - if (progress.Update(status.GetCurIndex()) == FALSE) - break; - if (status.Search()) { - foundstr.Printf(_("Found %i matches"), ++foundcnt); - progress.Update(status.GetCurIndex(), foundstr); - m_SearchList -> Append(status.GetName(), status.GetContentsItem()); + case wxHELP_SEARCH_INDEX: + { + wxHtmlHelpMergedIndexItem* it = + (wxHtmlHelpMergedIndexItem*) m_IndexList->GetClientData(0); + if (it) + DisplayIndexItem(it); + break; + } } - wxYield(); - } - m_SearchButton -> Enable(TRUE); - m_SearchText -> SetSelection(0, keyword.Length()); - m_SearchText -> SetFocus(); - if (foundcnt) { - wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_SearchList -> GetClientData(0); - if (it) m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page); } - return (foundcnt > 0); -} -#define MAX_ROOTS 64 + return foundcnt > 0; +} -void wxHtmlHelpFrame::CreateContents(bool show_progress) +void wxHtmlHelpFrame::CreateContents() { if (! m_ContentsBox) return ; - wxProgressDialog *progress = NULL; - wxString proginfo; - - m_ContentsBox->Clear(); - - int cnt = m_Data->GetContentsCnt(); - int div = (cnt / PROGRESS_STEP) + 1; - int i; - - wxHtmlContentsItem *it; + if (m_PagesHash) + { + WX_CLEAR_HASH_TABLE(*m_PagesHash); + delete m_PagesHash; + } + + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + + size_t cnt = contents.size(); - if (show_progress) - progress = new wxProgressDialog(_("Building contents tree..."), wxEmptyString, - cnt, this, wxPD_APP_MODAL | wxPD_CAN_ABORT | - wxPD_AUTO_HIDE); + 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(); - 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; + roots[0] = m_ContentsBox->AddRoot(_("(Help)")); + imaged[0] = true; - for (it = m_Data->GetContents(), i = 0; i < cnt; i++, it++) { - if (show_progress && ((i % div) == 0)) { - proginfo.Printf(_("Added %d/%d items"), i, cnt); - if (! progress->Update(i, proginfo)) - break; - wxYield(); + 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; } - roots[it -> m_Level + 1] = m_ContentsBox -> AppendItem( - roots[it -> m_Level], it -> m_Name, IMG_Page, -1, - new wxHtmlHelpTreeItemData(it)); - - 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; + // ...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; } } - if (show_progress) - delete progress; - m_ContentsBox -> Expand(roots[0]); } -void wxHtmlHelpFrame::CreateIndex(bool show_progress) +void wxHtmlHelpFrame::CreateIndex() { - if (! m_IndexBox) + if (! m_IndexList) return ; - wxProgressDialog *progress = NULL; - wxString proginfo; + m_IndexList->Clear(); - m_IndexBox->Clear(); + size_t cnt = m_mergedIndex->size(); - int cnt = m_Data->GetIndexCnt(); - int div = (cnt / PROGRESS_STEP) + 1; - - wxHtmlContentsItem* index = m_Data->GetIndex(); - - if (show_progress) - progress = new wxProgressDialog(_("Building index list..."), wxEmptyString, - cnt, this, wxPD_APP_MODAL | wxPD_CAN_ABORT | - wxPD_AUTO_HIDE); - for (int i = 0; i < cnt; i++) { - if (show_progress && ((i % div) == 0)) { - proginfo.Printf(_("Added %d/%d items"), i, cnt); - if (! progress->Update(i, proginfo)) - break; - wxYield(); - } - m_IndexBox -> 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; - if (show_progress) - delete progress; + 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(_("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++) @@ -510,10 +1030,13 @@ void wxHtmlHelpFrame::CreateSearch() } -void wxHtmlHelpFrame::RefreshLists(bool show_progress) +void wxHtmlHelpFrame::RefreshLists() { - CreateContents(show_progress); - CreateIndex(show_progress); + // Update m_mergedIndex: + UpdateMergedIndex(); + // Update the controls + CreateContents(); + CreateIndex(); CreateSearch(); } @@ -522,29 +1045,57 @@ void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path) wxString oldpath; wxString tmp; - if (path != wxEmptyString) { - oldpath = cfg -> GetPath(); - cfg -> SetPath(path); + if (path != wxEmptyString) + { + oldpath = cfg->GetPath(); + cfg->SetPath(_T("/") + path); } - m_Cfg.navig_on = cfg -> Read("hcNavigPanel", m_Cfg.navig_on) != 0; - m_Cfg.sashpos = cfg -> Read("hcSashPos", m_Cfg.sashpos); - m_Cfg.x = cfg -> Read("hcX", m_Cfg.x); - m_Cfg.y = cfg -> Read("hcY", m_Cfg.y); - m_Cfg.w = cfg -> Read("hcW", m_Cfg.w); - m_Cfg.h = cfg -> Read("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("hcBaseFontSize"), m_FontSize); + + { + int i; + int cnt; + wxString val, s; + + 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)")); + } - m_FixedFace = cfg -> Read("hcFixedFace", m_FixedFace); - m_NormalFace = cfg -> Read("hcNormalFace", m_NormalFace); - m_FontSize = cfg -> Read("hcFontSize", m_FontSize); - m_NormalItalic = cfg -> Read("hcNormalItalic", m_NormalItalic); - m_FixedItalic = cfg -> Read("hcFixedItalic", m_FixedItalic); + for (i = 0; i < cnt; i++) + { + val.Printf(wxT("hcBookmark_%i"), i); + s = cfg->Read(val); + m_BookmarksNames.Add(s); + if (m_Bookmarks) m_Bookmarks->Append(s); + val.Printf(wxT("hcBookmark_%i_url"), i); + s = cfg->Read(val); + m_BookmarksPages.Add(s); + } + } + } if (m_HtmlWin) - m_HtmlWin->ReadCustomization(cfg, path); + m_HtmlWin->ReadCustomization(cfg); if (path != wxEmptyString) - cfg -> SetPath(oldpath); + cfg->SetPath(oldpath); } void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path) @@ -552,218 +1103,253 @@ void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path wxString oldpath; wxString tmp; - if (path != wxEmptyString) { - oldpath = cfg -> GetPath(); - cfg -> SetPath(path); + if (path != wxEmptyString) + { + oldpath = cfg->GetPath(); + cfg->SetPath(_T("/") + path); } - cfg -> Write("hcNavigPanel", m_Cfg.navig_on); - cfg -> Write("hcSashPos", (long)m_Cfg.sashpos); - cfg -> Write("hcX", (long)m_Cfg.x); - cfg -> Write("hcY", (long)m_Cfg.y); - cfg -> Write("hcW", (long)m_Cfg.w); - cfg -> Write("hcH", (long)m_Cfg.h); - cfg -> Write("hcFixedFace", m_FixedFace); - cfg -> Write("hcNormalFace", m_NormalFace); - cfg -> Write("hcFontSize", (long)m_FontSize); - cfg -> Write("hcNormalItalic", (long)m_NormalItalic); - cfg -> Write("hcFixedItalic", (long)m_FixedItalic); + 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++) + { + val.Printf(wxT("hcBookmark_%i"), i); + cfg->Write(val, m_BookmarksNames[i]); + val.Printf(wxT("hcBookmark_%i_url"), i); + cfg->Write(val, m_BookmarksPages[i]); + } + } if (m_HtmlWin) - m_HtmlWin->WriteCustomization(cfg, path); + m_HtmlWin->WriteCustomization(cfg); if (path != wxEmptyString) - cfg -> SetPath(oldpath); + cfg->SetPath(oldpath); } -static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, int scalit, wxString fixf, int fixit, int size) +static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, wxString fixf, int size) { -#ifdef __WXMSW__ - static int f_sizes[3][7] = - { - {10, 12, 14, 16, 19, 24, 32}, - {12, 14, 16, 18, 24, 32, 38}, - {14, 16, 18, 24, 32, 38, 45} - }; -#else - static int f_sizes[3][7] = - { - {10, 12, 14, 16, 19, 24, 32}, - {12, 14, 16, 18, 24, 32, 38}, - {14, 16, 18, 24, 32, 38, 45} - }; -#endif - win -> SetFonts(scalf, scalit, fixf, fixit, 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: - wxListBox *NormalFont, *FixedFont; - wxRadioButton *SFI_i, *SFI_s, *FFI_i, *FFI_s; - wxRadioBox *RadioBox; - wxHtmlWindow *TestWin; +public: + wxComboBox *NormalFont, *FixedFont; + wxSpinCtrl *FontSize; + wxHtmlWindow *TestWin; + + 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); + } - wxHtmlHelpFrameOptionsDialog(wxWindow *parent) : wxDialog(parent, -1, wxString(_("Help Browser Options"))) - { - static wxString choices[3] = {_("small"), _("medium"), _("large")}; - static wxString choices2[2] = {_("italic"), _("slant")}; - wxBoxSizer *topsizer, *sizer, *sizer2, *sizer3; - - topsizer = new wxBoxSizer(wxVERTICAL); - - sizer = new wxBoxSizer(wxHORIZONTAL); - - sizer2 = new wxBoxSizer(wxVERTICAL); - sizer2 -> Add(new wxStaticText(this, -1, _("Normal font:")), - 0, wxLEFT | wxTOP, 10); - sizer2 -> Add(NormalFont = new wxListBox(this, -1, wxDefaultPosition, wxSize(200, 150)), - 1, wxEXPAND | wxLEFT | wxRIGHT, 10); - - sizer3 = new wxBoxSizer(wxHORIZONTAL); - sizer3 -> Add(SFI_i = new wxRadioButton(this, -1, _("use italic"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP), - 1, wxEXPAND, 0); - sizer3 -> Add(SFI_s = new wxRadioButton(this, -1, _("use slant"), wxDefaultPosition, wxDefaultSize, 0), - 1, wxEXPAND, 0); - sizer2 -> Add(sizer3, 0, wxEXPAND | wxLEFT | wxRIGHT, 10); - - sizer -> Add(sizer2, 0, wxEXPAND | wxLEFT | wxRIGHT, 10); - - sizer2 = new wxBoxSizer(wxVERTICAL); - sizer2 -> Add(new wxStaticText(this, -1, _("Fixed font:")), - 0, wxLEFT | wxTOP, 10); - sizer2 -> Add(FixedFont = new wxListBox(this, -1, wxDefaultPosition, wxSize(200, 150)), - 1, wxEXPAND | wxLEFT | wxRIGHT, 10); - - sizer3 = new wxBoxSizer(wxHORIZONTAL); - sizer3 -> Add(FFI_i = new wxRadioButton(this, -1, _("use italic"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP), - 1, wxEXPAND, 0); - sizer3 -> Add(FFI_s = new wxRadioButton(this, -1, _("use slant"), wxDefaultPosition, wxDefaultSize, 0), - 1, wxEXPAND, 0); - sizer2 -> Add(sizer3, 0, wxEXPAND | wxLEFT | wxRIGHT, 10); - - sizer -> Add(sizer2, 0, wxEXPAND | wxLEFT | wxRIGHT, 10); - - topsizer -> Add(sizer); - - topsizer -> Add(RadioBox = new wxRadioBox(this, -1, _("Font size:"), - wxDefaultPosition, wxDefaultSize, 3, choices, 3), - 0, wxEXPAND | wxLEFT | wxRIGHT, 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, 10); - - 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(), SFI_i -> GetValue() ? wxITALIC : wxSLANT, - FixedFont -> GetStringSelection(), FFI_i -> GetValue() ? wxITALIC : wxSLANT, - RadioBox -> GetSelection()); - TestWin -> SetPage(_("
" - "Normal faceFixed 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(" |