/////////////////////////////////////////////////////////////////////////////
// Name: src/html/helpwnd.cpp
// Purpose: wxHtmlHelpWindow
// Notes: Based on htmlhelp.cpp, implementing a monolithic
// HTML Help controller class, by Vaclav Slavik
// Author: Harm van der Heijden and Vaclav Slavik
// RCS-ID: $Id: helpwnd.cpp 67259 2011-03-20 12:27:35Z JS $
// Copyright: (c) Harm van der Heijden and Vaclav Slavik
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// For compilers that support precompilation, includes "wx.h"
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#if wxUSE_WXHTML_HELP
#ifndef WXPRECOMP
#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 // WXPRECOMP
#include "wx/html/helpfrm.h"
#include "wx/html/helpdlg.h"
#include "wx/html/helpctrl.h"
#include "wx/notebook.h"
#include "wx/imaglist.h"
#include "wx/treectrl.h"
#include "wx/tokenzr.h"
#include "wx/wfstream.h"
#include "wx/html/htmlwin.h"
#include "wx/busyinfo.h"
#include "wx/progdlg.h"
#include "wx/fontenum.h"
#include "wx/artprov.h"
#include "wx/spinctrl.h"
// what is considered "small index"?
#define INDEX_IS_SMALL 100
/* Motif defines this as a macro */
#ifdef Below
#undef Below
#endif
//--------------------------------------------------------------------------
// 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;}
int m_Id;
};
//--------------------------------------------------------------------------
// wxHtmlHelpHashData (private)
//--------------------------------------------------------------------------
class wxHtmlHelpHashData : public wxObject
{
public:
wxHtmlHelpHashData(int index, wxTreeItemId id) : wxObject()
{ m_Index = index; m_Id = id;}
virtual ~wxHtmlHelpHashData() {}
int m_Index;
wxTreeItemId m_Id;
};
//--------------------------------------------------------------------------
// wxHtmlHelpHtmlWindow (private)
//--------------------------------------------------------------------------
class wxHtmlHelpHtmlWindow : public wxHtmlWindow
{
public:
wxHtmlHelpHtmlWindow(wxHtmlHelpWindow *win, wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxDefaultSize, long style = wxHW_DEFAULT_STYLE)
: wxHtmlWindow(parent, id, pos, sz, style), m_Window(win)
{
SetStandardFonts();
}
void OnLink(wxHtmlLinkEvent& ev)
{
const wxMouseEvent *e = ev.GetLinkInfo().GetEvent();
if (e == NULL || e->LeftUp())
m_Window->NotifyPageChanged();
// skip the event so that normal processing (i.e. following the link)
// is done:
ev.Skip();
}
// 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("#") << an;
}
return pg;
}
private:
wxHtmlHelpWindow *m_Window;
DECLARE_NO_COPY_CLASS(wxHtmlHelpHtmlWindow)
DECLARE_EVENT_TABLE()
};
BEGIN_EVENT_TABLE(wxHtmlHelpHtmlWindow, wxHtmlWindow)
EVT_HTML_LINK_CLICKED(wxID_ANY, wxHtmlHelpHtmlWindow::OnLink)
END_EVENT_TABLE()
//---------------------------------------------------------------------------
// wxHtmlHelpWindow::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 wxHtmlHelpWindow::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);
}
}
}
//---------------------------------------------------------------------------
// wxHtmlHelpWindow
//---------------------------------------------------------------------------
IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpWindow, wxWindow)
BEGIN_EVENT_TABLE(wxHtmlHelpWindow, wxWindow)
EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_OPTIONS, wxHtmlHelpWindow::OnToolbar)
EVT_BUTTON(wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpWindow::OnToolbar)
EVT_BUTTON(wxID_HTML_BOOKMARKSADD, wxHtmlHelpWindow::OnToolbar)
EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL, wxHtmlHelpWindow::OnContentsSel)
EVT_LISTBOX(wxID_HTML_INDEXLIST, wxHtmlHelpWindow::OnIndexSel)
EVT_LISTBOX(wxID_HTML_SEARCHLIST, wxHtmlHelpWindow::OnSearchSel)
EVT_BUTTON(wxID_HTML_SEARCHBUTTON, wxHtmlHelpWindow::OnSearch)
EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT, wxHtmlHelpWindow::OnSearch)
EVT_BUTTON(wxID_HTML_INDEXBUTTON, wxHtmlHelpWindow::OnIndexFind)
EVT_TEXT_ENTER(wxID_HTML_INDEXTEXT, wxHtmlHelpWindow::OnIndexFind)
EVT_BUTTON(wxID_HTML_INDEXBUTTONALL, wxHtmlHelpWindow::OnIndexAll)
EVT_COMBOBOX(wxID_HTML_BOOKMARKSLIST, wxHtmlHelpWindow::OnBookmarksSel)
EVT_SIZE(wxHtmlHelpWindow::OnSize)
END_EVENT_TABLE()
wxHtmlHelpWindow::wxHtmlHelpWindow(wxWindow* parent, wxWindowID id,
const wxPoint& pos,
const wxSize& size,
int style, int helpStyle, wxHtmlHelpData* data)
{
Init(data);
Create(parent, id, pos, size, style, helpStyle);
}
void wxHtmlHelpWindow::Init(wxHtmlHelpData* data)
{
if (data)
{
m_Data = data;
m_DataCreated = false;
}
else
{
m_Data = new wxHtmlHelpData();
m_DataCreated = true;
}
m_ContentsPage = 0;
m_IndexPage = 0;
m_SearchPage = 0;
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_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;
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_NormalFonts = m_FixedFonts = NULL;
m_NormalFace = m_FixedFace = wxEmptyString;
#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_toolBar = 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 wxHtmlHelpWindow::Create(wxWindow* parent, wxWindowID id,
const wxPoint& pos, const wxSize& size,
int style, int helpStyle)
{
m_hfStyle = helpStyle;
// Do the config in two steps. We read the HtmlWindow customization after we
// create the window.
if (m_Config)
ReadCustomization(m_Config, m_ConfigRoot);
wxWindow::Create(parent, id, pos, size, style, wxT("wxHtmlHelp"));
SetHelpText(_("Displays help as you browse the books on the left."));
GetPosition(&m_Cfg.x, &m_Cfg.y);
int notebook_page = 0;
// The sizer for the whole top-level window.
wxSizer *topWindowSizer = new wxBoxSizer(wxVERTICAL);
SetSizer(topWindowSizer);
SetAutoLayout(true);
#if wxUSE_TOOLBAR
// toolbar?
if (helpStyle & (wxHF_TOOLBAR | wxHF_FLAT_TOOLBAR))
{
wxToolBar *toolBar = new wxToolBar(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
wxNO_BORDER | wxTB_HORIZONTAL |
wxTB_DOCKABLE | wxTB_NODIVIDER |
(helpStyle & wxHF_FLAT_TOOLBAR ? wxTB_FLAT : 0));
toolBar->SetMargins( 2, 2 );
AddToolbarButtons(toolBar, helpStyle);
toolBar->Realize();
topWindowSizer->Add(toolBar, 0, wxEXPAND);
m_toolBar = toolBar;
}
#endif //wxUSE_TOOLBAR
wxSizer *navigSizer = NULL;
#ifdef __WXMSW__
wxBorder htmlWindowBorder = GetThemedBorderStyle();
if (htmlWindowBorder == wxBORDER_SUNKEN)
htmlWindowBorder = wxBORDER_SIMPLE;
#else
wxBorder htmlWindowBorder = wxBORDER_SUNKEN;
#endif
if (helpStyle & (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
long splitterStyle = wxSP_3D;
// Drawing moving sash can cause problems on wxMac
#ifdef __WXMAC__
splitterStyle |= wxSP_LIVE_UPDATE;
#endif
m_Splitter = new wxSplitterWindow(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, splitterStyle);
topWindowSizer->Add(m_Splitter, 1, wxEXPAND);
m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxHW_DEFAULT_STYLE|htmlWindowBorder);
m_NavigPan = new wxPanel(m_Splitter, wxID_ANY);
m_NavigNotebook = new wxNotebook(m_NavigPan, wxID_HTML_NOTEBOOK,
wxDefaultPosition, wxDefaultSize);
#ifdef __WXMAC__
m_NavigNotebook->SetWindowVariant(wxWINDOW_VARIANT_SMALL);
#endif
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, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxHW_DEFAULT_STYLE|htmlWindowBorder);
topWindowSizer->Add(m_HtmlWin, 1, wxEXPAND);
}
if ( m_Config )
m_HtmlWin->ReadCustomization(m_Config, m_ConfigRoot);
// contents tree panel?
if ( helpStyle & wxHF_CONTENTS )
{
wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
#ifdef __WXMAC__
dummy->SetWindowVariant(wxWINDOW_VARIANT_NORMAL);
#endif
wxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
topsizer->Add(0, 10);
dummy->SetSizer(topsizer);
if ( helpStyle & 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_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,
#ifdef __WXGTK20__
wxSUNKEN_BORDER |
wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT |
wxTR_NO_LINES
#else
wxSUNKEN_BORDER |
wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT |
wxTR_LINES_AT_ROOT
#endif
);
wxImageList *ContentsImageList = new wxImageList(16, 16);
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)));
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 ( helpStyle & wxHF_INDEX )
{
wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
#ifdef __WXMAC__
dummy->SetWindowVariant(wxWINDOW_VARIANT_NORMAL);
#endif
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 ( helpStyle & wxHF_SEARCH )
{
wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE);
#ifdef __WXMAC__
dummy->SetWindowVariant(wxWINDOW_VARIANT_NORMAL);
#endif
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, 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,
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 )
{
// The panel will have its own min size which the splitter
// should respect
//if (m_NavigPan)
// m_Splitter->SetMinimumPaneSize(m_NavigPan->GetBestSize().x);
//else
m_Splitter->SetMinimumPaneSize(20);
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);
}
}
// Reduce flicker by updating the splitter pane sizes before the
// frame is shown
wxSizeEvent sizeEvent(GetSize(), GetId());
ProcessEvent(sizeEvent);
if (m_Splitter)
m_Splitter->UpdateSize();
return true;
}
wxHtmlHelpWindow::~wxHtmlHelpWindow()
{
if ( m_helpController )
m_helpController->SetHelpWindow(NULL);
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)
{
WX_CLEAR_HASH_TABLE(*m_PagesHash);
delete m_PagesHash;
}
#if wxUSE_PRINTING_ARCHITECTURE
if (m_Printer) delete m_Printer;
#endif
}
void wxHtmlHelpWindow::SetController(wxHtmlHelpController* controller)
{
if (m_DataCreated)
delete m_Data;
m_helpController = controller;
m_Data = controller->GetHelpData();
m_DataCreated = false;
}
#if wxUSE_TOOLBAR
void wxHtmlHelpWindow::AddToolbarButtons(wxToolBar *toolBar, int style)
{
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() &&
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, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Show/hide navigation panel"));
toolBar->AddSeparator();
toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap,
false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Go back"));
toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap,
false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Go forward"));
toolBar->AddSeparator();
toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap,
false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Go one level up in document hierarchy"));
toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap,
false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Previous page"));
toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap,
false, wxDefaultCoord, wxDefaultCoord, (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, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Open HTML document"));
#if wxUSE_PRINTING_ARCHITECTURE
if (style & wxHF_PRINT)
toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap,
false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Print this page"));
#endif
toolBar->AddSeparator();
toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap,
false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Display options dialog"));
// Allow application to add custom buttons
wxHtmlHelpFrame* parentFrame = wxDynamicCast(GetParent(), wxHtmlHelpFrame);
wxHtmlHelpDialog* parentDialog = wxDynamicCast(GetParent(), wxHtmlHelpDialog);
if (parentFrame)
parentFrame->AddToolbarButtons(toolBar, style);
if (parentDialog)
parentDialog->AddToolbarButtons(toolBar, style);
}
#endif //wxUSE_TOOLBAR
bool wxHtmlHelpWindow::Display(const wxString& x)
{
wxString url = m_Data->FindPageByName(x);
if (!url.empty())
{
m_HtmlWin->LoadPage(url);
NotifyPageChanged();
return true;
}
return false;
}
bool wxHtmlHelpWindow::Display(const int id)
{
wxString url = m_Data->FindPageById(id);
if (!url.empty())
{
m_HtmlWin->LoadPage(url);
NotifyPageChanged();
return true;
}
return false;
}
bool wxHtmlHelpWindow::DisplayContents()
{
if (! m_ContentsBox)
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(m_ContentsPage);
if (m_Data->GetBookRecArray().GetCount() > 0)
{
wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
if (!book.GetStart().empty())
m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
}
return true;
}
bool wxHtmlHelpWindow::DisplayIndex()
{
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(m_IndexPage);
if (m_Data->GetBookRecArray().GetCount() > 0)
{
wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
if (!book.GetStart().empty())
m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
}
return true;
}
void wxHtmlHelpWindow::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 wxHtmlHelpWindow::KeywordSearch(const wxString& keyword,
wxHelpSearchMode mode)
{
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();
m_HtmlWin->Show();
m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos);
}
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);
DoIndexFind();
m_IndexButton->Enable();
m_IndexButtonAll->Enable();
foundcnt = m_IndexList->GetCount();
}
if (foundcnt)
{
switch ( mode )
{
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;
}
void wxHtmlHelpWindow::CreateContents()
{
if (! m_ContentsBox)
return ;
if (m_PagesHash)
{
WX_CLEAR_HASH_TABLE(*m_PagesHash);
delete m_PagesHash;
}
const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray();
size_t cnt = contents.size();
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 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 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;
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 a "fake"
// record about book node so that the rest of this look
// 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->name, IMG_Book, -1,
new wxHtmlHelpTreeItemData(i));
m_ContentsBox->SetItemBold(roots[1], true);
}
imaged[1] = true;
}
// ...and their contents:
else
{
roots[it->level + 1] = m_ContentsBox->AppendItem(
roots[it->level], it->name, IMG_Page,
-1, new wxHtmlHelpTreeItemData(i));
imaged[it->level + 1] = false;
}
m_PagesHash->Put(it->GetFullPath(),
new wxHtmlHelpHashData(i, roots[it->level + 1]));
// Set the icon for the node one level up in the hierarchy,
// 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;
}
}
}
void wxHtmlHelpWindow::CreateIndex()
{
if (! m_IndexList)
return ;
m_IndexList->Clear();
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);
m_IndexCountInfo->SetLabel(cnttext);
if (cnt > INDEX_IS_SMALL)
return;
for (size_t i = 0; i < cnt; i++)
m_IndexList->Append((*m_mergedIndex)[i].name,
(char*)(&(*m_mergedIndex)[i]));
}
void wxHtmlHelpWindow::CreateSearch()
{
if (! (m_SearchList && m_SearchChoice))
return ;
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++)
m_SearchChoice->Append(bookrec[i].GetTitle());
m_SearchChoice->SetSelection(0);
}
void wxHtmlHelpWindow::RefreshLists()
{
// Update m_mergedIndex:
UpdateMergedIndex();
// Update the controls
CreateContents();
CreateIndex();
CreateSearch();
}
void wxHtmlHelpWindow::ReadCustomization(wxConfigBase *cfg, const wxString& path)
{
wxString oldpath;
wxString tmp;
if (path != wxEmptyString)
{
oldpath = cfg->GetPath();
cfg->SetPath(_T("/") + path);
}
m_Cfg.navig_on = cfg->Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0;
m_Cfg.sashpos = cfg->Read(wxT("hcSashPos"), m_Cfg.sashpos);
m_Cfg.x = cfg->Read(wxT("hcX"), m_Cfg.x);
m_Cfg.y = cfg->Read(wxT("hcY"), m_Cfg.y);
m_Cfg.w = cfg->Read(wxT("hcW"), m_Cfg.w);
m_Cfg.h = cfg->Read(wxT("hcH"), m_Cfg.h);
m_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)"));
}
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);
if (path != wxEmptyString)
cfg->SetPath(oldpath);
}
void wxHtmlHelpWindow::WriteCustomization(wxConfigBase *cfg, const wxString& path)
{
wxString oldpath;
wxString tmp;
if (path != wxEmptyString)
{
oldpath = cfg->GetPath();
cfg->SetPath(_T("/") + path);
}
cfg->Write(wxT("hcNavigPanel"), m_Cfg.navig_on);
cfg->Write(wxT("hcSashPos"), (long)m_Cfg.sashpos);
// 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);
if (path != wxEmptyString)
cfg->SetPath(oldpath);
}
static void SetFontsToHtmlWin(wxHtmlWindow *win, const wxString& scalf, const wxString& fixf, int 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 wxHtmlHelpWindowOptionsDialog : public wxDialog
{
public:
wxComboBox *NormalFont, *FixedFont;
wxSpinCtrl *FontSize;
wxHtmlWindow *TestWin;
wxHtmlHelpWindowOptionsDialog(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, wxDefaultCoord),
0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
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, wxID_ANY, wxEmptyString, wxDefaultPosition,
wxDefaultSize, wxSP_ARROW_KEYS, 2, 100, 2, _T("wxSpinCtrl")));
topsizer->Add(sizer, 0, wxLEFT|wxRIGHT|wxTOP, 10);
topsizer->Add(new wxStaticText(this, wxID_ANY, _("Preview:")),
0, wxLEFT | wxTOP, 10);
int style = wxHW_SCROLLBAR_AUTO;
#ifdef __WXMSW__
style |= GetThemedBorderStyle();
#else
style |= wxBORDER_SUNKEN;
#endif
topsizer->AddSpacer(5);
topsizer->Add(TestWin = new wxHtmlWindow(this, wxID_ANY, wxDefaultPosition, wxSize(20, 150),
style),
1, wxEXPAND | wxLEFT|wxRIGHT, 10);
wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL);
wxButton *ok;
sizer2->Add(ok = new wxButton(this, wxID_OK), 0, wxALL, 10);
ok->SetDefault();
sizer2->Add(new wxButton(this, wxID_CANCEL), 0, wxALL, 10);
topsizer->Add(sizer2, 0, wxALIGN_RIGHT);
SetSizer(topsizer);
topsizer->Fit(this);
Centre(wxBOTH);
}
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(" |