/////////////////////////////////////////////////////////////////////////////
-// Name: helpfrm.cpp
+// Name: src/html/helpfrm.cpp
// Purpose: wxHtmlHelpFrame
// Notes: Based on htmlhelp.cpp, implementing a monolithic
// HTML Help controller class, by Vaclav Slavik
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
// For compilers that support precompilation, includes "wx.h"
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
-#include "wx/defs.h"
-
-#if wxUSE_HTML
-#ifndef WXPRECOMP
-#include "wx/wx.h"
-#endif
+#if wxUSE_WXHTML_HELP
+
+#ifndef WX_PRECOMP
+ #include "wx/object.h"
+ #include "wx/dynarray.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
+ #if wxUSE_STREAMS
+ #include "wx/stream.h"
+ #endif
+
+ #include "wx/sizer.h"
+
+ #include "wx/bmpbuttn.h"
+ #include "wx/statbox.h"
+ #include "wx/radiobox.h"
+ #include "wx/menu.h"
+ #include "wx/settings.h"
+ #include "wx/msgdlg.h"
+ #include "wx/textctrl.h"
+ #include "wx/toolbar.h"
+ #include "wx/choicdlg.h"
+ #include "wx/filedlg.h"
+#endif // WX_PRECOMP
#include "wx/html/helpfrm.h"
+#include "wx/html/helpctrl.h"
#include "wx/notebook.h"
#include "wx/imaglist.h"
#include "wx/treectrl.h"
#include "wx/html/htmlwin.h"
#include "wx/busyinfo.h"
#include "wx/progdlg.h"
-#include "wx/toolbar.h"
#include "wx/fontenum.h"
+#include "wx/artprov.h"
+#include "wx/spinctrl.h"
+#include "wx/app.h"
-// Bitmaps:
+IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame)
-#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"
+BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame)
+ EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate)
+ 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
-
-#include "wx/stream.h"
-
-// number of times that the contents/index creation progress dialog
-// is updated.
-#define PROGRESS_STEP 40
-
-// what is considered "small index"?
-#define INDEX_IS_SMALL 100
-
-
-//--------------------------------------------------------------------------
-// wxHtmlHelpTreeItemData (private)
-//--------------------------------------------------------------------------
-
-class wxHtmlHelpTreeItemData : public wxTreeItemData
-{
- private:
- wxString m_Page;
-
- public:
- wxHtmlHelpTreeItemData(wxHtmlContentsItem *it) : wxTreeItemData()
- {
- m_Page = it -> m_Book -> GetBasePath() + it -> m_Page;
- }
- const wxString& GetPage() { return m_Page; }
-};
-
-
-
-
-//---------------------------------------------------------------------------
-// wxHtmlHelpFrame
-//---------------------------------------------------------------------------
-
-IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame)
+END_EVENT_TABLE()
wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString& title,
- int style, wxHtmlHelpData* data)
+ int style, wxHtmlHelpData* data,
+ wxConfigBase *config, const wxString& rootpath)
{
Init(data);
- Create(parent, id, title, style);
+ Create(parent, id, title, style, config, rootpath);
}
void wxHtmlHelpFrame::Init(wxHtmlHelpData* data)
{
- if (data) {
- m_Data = data;
- m_DataCreated = FALSE;
- } else {
- m_Data = new wxHtmlHelpData();
- 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;
- m_IndexButtonAll = NULL;
- m_IndexText = NULL;
- m_SearchList = NULL;
- m_SearchButton = NULL;
- m_SearchText = NULL;
- m_SearchChoice = NULL;
- m_Splitter = NULL;
- m_NavigPan = NULL;
- m_HtmlWin = NULL;
- m_Bookmarks = NULL;
- m_Config = NULL;
- m_ConfigRoot = wxEmptyString;
-
- m_Cfg.x = m_Cfg.y = 0;
- m_Cfg.w = 700;
- m_Cfg.h = 480;
- m_Cfg.sashpos = 240;
- m_Cfg.navig_on = TRUE;
-
- m_NormalFonts = m_FixedFonts = NULL;
- m_FontSize = 1;
- m_NormalFace = m_FixedFace = wxEmptyString;
+ // Simply pass the pointer on to the help window
+ m_Data = data;
+ m_HtmlHelpWin = NULL;
+ m_helpController = (wxHtmlHelpController*) 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_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,
+ wxConfigBase *config, const wxString& rootpath)
{
- // 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");
-
- GetPosition(&m_Cfg.x, &m_Cfg.y);
-
- SetIcon(wxICON(whelp));
-
- int notebook_page = 0;
-
+ m_HtmlHelpWin = new wxHtmlHelpWindow(m_Data);
+ if ( config)
+ m_HtmlHelpWin->UseConfig(config, rootpath);
+
+ wxFrame::Create(parent, id, _("Help"),
+ wxPoint(m_HtmlHelpWin->GetCfgData().x, m_HtmlHelpWin->GetCfgData().y),
+ wxSize(m_HtmlHelpWin->GetCfgData().w, m_HtmlHelpWin->GetCfgData().h),
+ wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp"));
+#if wxUSE_STATUSBAR
CreateStatusBar();
-
- // 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();
-
- if (style & wxHF_BOOKMARKS) {
- m_Bookmarks = new wxComboBox(toolBar, wxID_HTML_BOOKMARKSLIST, wxEmptyString,
- wxDefaultPosition, wxSize(300,-1), 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);
- toolBar -> AddControl(m_Bookmarks);
-#ifdef __WXGTK__
- toolBar -> AddSeparator();
#endif
- toolBar -> AddTool(wxID_HTML_BOOKMARKSADD, wxBITMAP(wbkadd), wxNullBitmap,
- FALSE, -1, -1, (wxObject *) NULL,
- _("Add current page to bookmarks"));
- toolBar -> AddTool(wxID_HTML_BOOKMARKSREMOVE, wxBITMAP(wbkdel), wxNullBitmap,
- FALSE, -1, -1, (wxObject *) NULL,
- _("Remove current page from bookmarks"));
- }
+ m_HtmlHelpWin->Create(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
+ wxTAB_TRAVERSAL|wxNO_BORDER, style);
- toolBar -> AddSeparator();
- toolBar -> AddTool(wxID_HTML_OPTIONS, wxBITMAP(woptions), wxNullBitmap,
- FALSE, -1, -1, (wxObject *) NULL,
- _("Display options dialog"));
+ GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData()).y);
- toolBar -> Realize();
- }
-
- 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 wxHtmlWindow(this);
- }
-
- m_HtmlWin -> SetRelatedFrame(this, m_TitleFormat);
- m_HtmlWin -> SetRelatedStatusBar(0);
- 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,
- wxDefaultPosition, wxDefaultSize,
- wxTR_HAS_BUTTONS | wxSUNKEN_BORDER);
- m_ContentsBox -> SetImageList(m_ContentsImageList);
- m_NavigPan -> AddPage(m_ContentsBox, _("Contents"));
- m_ContentsPage = notebook_page++;
- }
+ SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER));
- // index listbox panel?
- if (style & wxHF_INDEX) {
- wxWindow *dummy = new wxPanel(m_NavigPan, wxID_HTML_INDEXPAGE);
+ // 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;
- 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);
+ wxMenu* fileMenu = new wxMenu;
+ fileMenu->Append(wxID_HTML_OPENFILE, _("&Open..."));
+ fileMenu->AppendSeparator();
+ fileMenu->Append(wxID_CLOSE, _("&Close"));
- 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;
- 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 *b3 = new wxLayoutConstraints;
- m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST, wxDefaultPosition, wxDefaultSize, 0, NULL, wxLB_SINGLE | wxLB_ALWAYS_SB);
- b3 -> top.Below (m_IndexButton, 10);
- b3 -> left.SameAs (dummy, wxLeft, 0);
- b3 -> right.SameAs (dummy, wxRight, 0);
- b3 -> bottom.SameAs (dummy, wxBottom, 0);
- m_IndexList -> SetConstraints(b3);
-
-#if wxUSE_TOOLTIPS
- m_IndexButtonAll -> SetToolTip(_("Show all items in index"));
- m_IndexButton -> SetToolTip(_("Display all index items that contain given substring. Note that this is case sensitive, so 'window' and 'Window' is something else!"));
-#endif //wxUSE_TOOLTIPS
-
- dummy -> SetAutoLayout(TRUE);
- dummy -> Layout();
-
- m_NavigPan -> 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 *b2 = new wxLayoutConstraints;
- 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
- 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, NULL, wxLB_SINGLE | wxLB_ALWAYS_SB);
- 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);
+ wxMenu* helpMenu = new wxMenu;
+ helpMenu->Append(wxID_ABOUT, _("&About..."));
+ // Ensures we don't get an empty help menu
+ helpMenu->Append(wxID_HELP_CONTENTS, _("&About..."));
- //RefreshLists();
+ menuBar->Append(fileMenu,_("&File"));
+ menuBar->Append(helpMenu,_("&Help"));
+ SetMenuBar(menuBar);
+#endif
- // 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);
- }
- else {
- m_NavigPan -> Show(FALSE);
- m_Splitter -> Initialize(m_HtmlWin);
- }
- }
- return TRUE;
+ m_HtmlHelpWin->GetHtmlWindow()->SetRelatedFrame(this, m_TitleFormat);
+#if wxUSE_STATUSBAR
+ m_HtmlHelpWin->GetHtmlWindow()->SetRelatedStatusBar(0);
+#endif
+ return true;
}
wxHtmlHelpFrame::~wxHtmlHelpFrame()
{
- delete m_ContentsImageList;
- if (m_DataCreated)
- delete m_Data;
- if (m_NormalFonts) delete m_NormalFonts;
- if (m_FixedFonts) delete m_FixedFonts;
-}
-
-bool wxHtmlHelpFrame::Display(const wxString& x)
-{
- wxString url = m_Data->FindPageByName(x);
- if (! url.IsEmpty()) {
- m_HtmlWin->LoadPage(url);
- return TRUE;
- }
- return FALSE;
}
-bool wxHtmlHelpFrame::Display(const int id)
+void wxHtmlHelpFrame::SetTitleFormat(const wxString& format)
{
- wxString url = m_Data->FindPageById(id);
- if (! url.IsEmpty()) {
- m_HtmlWin->LoadPage(url);
- return TRUE;
- }
- return FALSE;
+ if (GetHelpWindow() && GetHelpWindow()->GetHtmlWindow())
+ GetHelpWindow()->GetHtmlWindow()->SetRelatedFrame(this, format);
+ m_TitleFormat = format;
}
+/*
+EVENT HANDLING :
+*/
-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;
- }
- m_NavigPan -> SetSelection(0);
- return TRUE;
-}
-
-
-
-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);
- }
- m_NavigPan -> SetSelection(1);
- return TRUE;
-}
-
-bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword)
-{
- if (! (m_SearchList && m_SearchButton && m_SearchText && m_SearchChoice))
- 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);
- }
- 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, 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 (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());
- }
- 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
-
-void wxHtmlHelpFrame::CreateContents(bool show_progress)
-{
- 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 (show_progress)
- progress = new wxProgressDialog(_("Building contents tree..."), wxEmptyString,
- cnt, this, wxPD_APP_MODAL | wxPD_CAN_ABORT |
- wxPD_AUTO_HIDE);
-
- wxTreeItemId roots[MAX_ROOTS];
- bool imaged[MAX_ROOTS];
-
- 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++) {
- if (show_progress && ((i % div) == 0)) {
- proginfo.Printf(_("Added %d/%d items"), i, cnt);
- if (! progress->Update(i, proginfo))
- break;
- wxYield();
- }
- 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;
- }
- }
- if (show_progress)
- delete progress;
- m_ContentsBox -> Expand(roots[0]);
-}
-
-
-void wxHtmlHelpFrame::CreateIndex(bool show_progress)
-{
- if (! m_IndexList)
- return ;
-
- wxProgressDialog *progress = NULL;
- wxString proginfo;
-
- m_IndexList->Clear();
-
- int cnt = m_Data->GetIndexCnt();
-
- if (cnt > INDEX_IS_SMALL) return;
-
- 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_IndexList -> Append(index[i].m_Name, (char*)(index + i));
- }
-
- if (show_progress)
- delete progress;
-}
-
-void wxHtmlHelpFrame::CreateSearch()
+void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event)
{
- if (! (m_SearchList && m_SearchChoice))
- return ;
- m_SearchList -> Clear();
- m_SearchChoice -> Clear();
- m_SearchChoice -> Append(_("all books"));
- const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray();
- int i, cnt = bookrec.GetCount();
- for (i = 0; i < cnt; i++)
- m_SearchChoice->Append(bookrec[i].GetTitle());
- m_SearchChoice->SetSelection(0);
-}
-
+ // 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_HtmlHelpWin)
+ m_HtmlHelpWin->GetHtmlWindow()->SetFocus();
+#endif
-void wxHtmlHelpFrame::RefreshLists(bool show_progress)
-{
- CreateContents(show_progress);
- CreateIndex(show_progress);
- CreateSearch();
+ event.Skip();
}
-void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path)
+void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt)
{
- wxString oldpath;
- wxString tmp;
-
- if (path != wxEmptyString) {
- oldpath = cfg -> GetPath();
- cfg -> SetPath(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_FixedFace = cfg -> Read("hcFixedFace", m_FixedFace);
- m_NormalFace = cfg -> Read("hcNormalFace", m_NormalFace);
- m_FontSize = cfg -> Read("hcFontSize", m_FontSize);
-
+ if (!IsIconized())
{
- int i;
- int cnt;
- wxString val, s;
-
- cnt = cfg -> Read("hcBookmarksCnt", 0L);
- if (cnt != 0) {
- m_BookmarksNames.Clear();
- m_BookmarksPages.Clear();
- if (m_Bookmarks) {
- m_Bookmarks -> Clear();
- m_Bookmarks -> Append(_("<bookmarks>"));
- }
-
- 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);
- }
- }
+ GetSize(& (m_HtmlHelpWin->GetCfgData().w), &(m_HtmlHelpWin->GetCfgData().h));
+ GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData().y));
}
- if (m_HtmlWin)
- m_HtmlWin->ReadCustomization(cfg, path);
-
- if (path != wxEmptyString)
- cfg -> SetPath(oldpath);
-}
-
-void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path)
-{
- wxString oldpath;
- wxString tmp;
-
- if (path != wxEmptyString) {
- oldpath = cfg -> GetPath();
- cfg -> SetPath(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);
-
- if (m_Bookmarks) {
- int i;
- int cnt = m_BookmarksNames.GetCount();
- wxString val;
-
- cfg -> Write("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);
-
- if (path != wxEmptyString)
- cfg -> SetPath(oldpath);
-}
-
-
-
-
-
-static void SetFontsToHtmlWin(wxHtmlWindow *win, wxString scalf, wxString fixf, int size)
-{
- static int f_sizes[3][7] =
- {
- { 8, 9, 12, 14, 16, 19, 22},
- {10, 12, 14, 16, 19, 24, 32},
- {14, 16, 18, 24, 32, 38, 45}
- };
-
- win -> SetFonts(scalf, fixf, f_sizes[size]);
-}
-
-
-class wxHtmlHelpFrameOptionsDialog : public wxDialog
-{
- public:
- wxComboBox *NormalFont, *FixedFont;
- wxRadioBox *RadioBox;
- wxHtmlWindow *TestWin;
-
- wxHtmlHelpFrameOptionsDialog(wxWindow *parent) : wxDialog(parent, -1, wxString(_("Help Browser Options")))
- {
- wxString choices[3] = {_("small"), _("medium"), _("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);
-
- topsizer -> Add(RadioBox = new wxRadioBox(this, -1, _("Font size:"),
- wxDefaultPosition, wxDefaultSize, 3, choices, 3),
- 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);
-
- 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(_("<html><body>"
- "Normal face<br>(and <u>underlined</u>. <i>Italic face.</i> "
- "<b>Bold face.</b> <b><i>Bold italic face.</i></b><br>"
- "<font size=-2>font size -2</font><br>"
- "<font size=-1>font size -1</font><br>"
- "<font size=+0>font size +0</font><br>"
- "<font size=+1>font size +1</font><br>"
- "<font size=+2>font size +2</font><br>"
- "<font size=+3>font size +3</font><br>"
- "<font size=+4>font size +4</font><br>"
-
- "<p><tt>Fixed size face.<br> <b>bold</b> <i>italic</i> "
- "<b><i>bold italic <u>underlined</u></i></b><br>"
- "<font size=-2>font size -2</font><br>"
- "<font size=-1>font size -1</font><br>"
- "<font size=+0>font size +0</font><br>"
- "<font size=+1>font size +1</font><br>"
- "<font size=+2>font size +2</font><br>"
- "<font size=+3>font size +3</font><br>"
- "<font size=+4>font size +4</font></tt>"
- "</body></html>"));
- }
-
- void OnUpdate(wxCloseEvent& event)
- {
- UpdateTestWin();
- }
-
- DECLARE_EVENT_TABLE()
-};
-
-BEGIN_EVENT_TABLE(wxHtmlHelpFrameOptionsDialog, wxDialog)
- EVT_COMBOBOX(-1, wxHtmlHelpFrameOptionsDialog::OnUpdate)
- EVT_RADIOBOX(-1, wxHtmlHelpFrameOptionsDialog::OnUpdate)
-END_EVENT_TABLE()
-
-
-void wxHtmlHelpFrame::OptionsDialog()
-{
- wxHtmlHelpFrameOptionsDialog dlg(this);
- unsigned i;
-
- if (m_NormalFonts == NULL) {
- wxFontEnumerator enu;
- enu.EnumerateFacenames();
- m_NormalFonts = new wxArrayString;
- *m_NormalFonts = *enu.GetFacenames();
- m_NormalFonts -> Sort();
- }
- if (m_FixedFonts == NULL) {
- wxFontEnumerator enu;
- enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, TRUE);
- m_FixedFonts = new wxArrayString;
- *m_FixedFonts = *enu.GetFacenames();
- m_FixedFonts -> 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);
- dlg.UpdateTestWin();
-
- if (dlg.ShowModal() == wxID_OK) {
- m_NormalFace = dlg.NormalFont -> GetStringSelection();
- m_FixedFace = dlg.FixedFont -> GetStringSelection();
- m_FontSize = dlg.RadioBox -> GetSelection();
- SetFontsToHtmlWin(m_HtmlWin, m_NormalFace, m_FixedFace, m_FontSize);
+#ifdef __WXGTK__
+ if (IsGrabbed())
+ {
+ RemoveGrab();
}
-}
-
-
-
-
-
-/*
-EVENT HANDLING :
-*/
-
-
-void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event)
-{
- switch (event.GetId()) {
-
- case wxID_HTML_BACK :
- m_HtmlWin -> HistoryBack();
- break;
-
- case wxID_HTML_FORWARD :
- m_HtmlWin -> HistoryForward();
- break;
+#endif
- case wxID_HTML_PANEL :
- 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;
- }
- break;
+ if (m_HtmlHelpWin->GetSplitterWindow() && m_HtmlHelpWin->GetCfgData().navig_on)
+ m_HtmlHelpWin->GetCfgData().sashpos = m_HtmlHelpWin->GetSplitterWindow()->GetSashPosition();
- case wxID_HTML_OPTIONS :
- OptionsDialog();
- break;
-
- 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);
- m_BookmarksNames.Add(item);
- m_BookmarksPages.Add(url);
- }
- }
- break;
-
- case wxID_HTML_BOOKMARKSREMOVE :
- {
- wxString item;
- int pos;
-
- 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());
- }
- }
- break;
+ if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController)))
+ {
+ ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt);
}
-}
-
-
-void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event)
-{
- wxHtmlHelpTreeItemData *pg;
-
- pg = (wxHtmlHelpTreeItemData*) m_ContentsBox -> GetItemData(event.GetItem());
- if (pg) m_HtmlWin -> LoadPage(pg -> GetPage());
-}
-
-
-
-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);
+ evt.Skip();
}
-
-void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event)
+// Make the help controller's frame 'modal' if
+// needed
+void wxHtmlHelpFrame::AddGrabIfNeeded()
{
- wxString sr = m_IndexText -> GetLineText(0);
- if (sr == wxEmptyString)
- OnIndexAll(event);
-
- else {
- wxBusyCursor bcur;
- const wxChar *cstr = sr.c_str();
- bool first = TRUE;
-
- m_IndexList->Clear();
- int cnt = m_Data->GetIndexCnt();
- wxHtmlContentsItem* index = m_Data->GetIndex();
+ // So far, wxGTK only
+#ifdef __WXGTK__
+ bool needGrab = false;
- for (int i = 0; i < cnt; i++)
- if (wxStrstr(index[i].m_Name, cstr) != NULL) {
- m_IndexList -> Append(index[i].m_Name, (char*)(index + i));
- if (first) {
- m_HtmlWin -> LoadPage(index[i].m_Book -> GetBasePath() + index[i].m_Page);
- first = FALSE;
- }
- }
+ // Check if there are any modal windows present,
+ // in which case we need to add a grab.
+ for ( wxWindowList::iterator it = wxTopLevelWindows.begin();
+ it != wxTopLevelWindows.end();
+ ++it )
+ {
+ wxWindow *win = *it;
+ wxDialog *dialog = wxDynamicCast(win, wxDialog);
- m_IndexText -> SetSelection(0, sr.Length());
- m_IndexText -> SetFocus();
+ if (dialog && dialog->IsModal())
+ needGrab = true;
}
-}
-
-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);
- first = FALSE;
- }
- }
+ if (needGrab)
+ AddGrab();
+#endif // __WXGTK__
}
-
-void wxHtmlHelpFrame::OnSearchSel(wxCommandEvent& WXUNUSED(event))
+// For compatibility
+void wxHtmlHelpFrame::UseConfig(wxConfigBase *config, const wxString& rootPath)
{
- wxHtmlContentsItem *it = (wxHtmlContentsItem*) m_SearchList -> GetClientData(m_SearchList -> GetSelection());
- if (it) m_HtmlWin -> LoadPage(it -> m_Book -> GetBasePath() + it -> m_Page);
+ if (m_HtmlHelpWin)
+ m_HtmlHelpWin->UseConfig(config, rootPath);
}
-void wxHtmlHelpFrame::OnSearch(wxCommandEvent& WXUNUSED(event))
+#ifdef __WXMAC__
+void wxHtmlHelpFrame::OnClose(wxCommandEvent& WXUNUSED(event))
{
- wxString sr = m_SearchText -> GetLineText(0);
-
- if (sr != wxEmptyString) KeywordSearch(sr);
+ Close(true);
}
-void wxHtmlHelpFrame::OnBookmarksSel(wxCommandEvent& WXUNUSED(event))
+void wxHtmlHelpFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
{
- wxString sr = m_Bookmarks -> GetStringSelection();
-
- if (sr != wxEmptyString && sr != _("<bookmarks>"))
- m_HtmlWin -> LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]);
+ wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2006, Vaclav Slavik et al"), wxT("HelpView"),
+ wxICON_INFORMATION|wxOK, this);
}
+#endif
-void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt)
+// we don't want to prevent the app from closing just because a help window
+// remains opened
+bool wxHtmlHelpFrame::ShouldPreventAppExit() const
{
- 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();
-
- if (m_Config)
- WriteCustomization(m_Config, m_ConfigRoot);
-
- evt.Skip();
+ return (wx_const_cast(wxHtmlHelpFrame*, this) == wxTheApp->GetTopWindow());
}
-BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame)
- EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpFrame::OnToolbar)
- EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL, wxHtmlHelpFrame::OnContentsSel)
- EVT_LISTBOX(wxID_HTML_INDEXLIST, wxHtmlHelpFrame::OnIndexSel)
- EVT_LISTBOX(wxID_HTML_SEARCHLIST, wxHtmlHelpFrame::OnSearchSel)
- EVT_BUTTON(wxID_HTML_SEARCHBUTTON, wxHtmlHelpFrame::OnSearch)
- EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT, wxHtmlHelpFrame::OnSearch)
- EVT_BUTTON(wxID_HTML_INDEXBUTTON, wxHtmlHelpFrame::OnIndexFind)
- 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)
-END_EVENT_TABLE()
-
-#endif
+#endif // wxUSE_WXHTML_HELP
projects / wxWidgets.git / blobdiff