#include "wx/spinctrl.h"
#include "wx/dynarray.h"
#include "wx/choicdlg.h"
+#include "wx/settings.h"
// what is considered "small index"?
#define INDEX_IS_SMALL 100
class wxHtmlHelpHtmlWindow : public wxHtmlWindow
{
public:
- wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) : wxHtmlWindow(parent), m_Frame(fr) {}
+ wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent)
+ : wxHtmlWindow(parent), m_Frame(fr)
+ {
+ SetStandardFonts();
+ }
virtual void OnLinkClicked(const wxHtmlLinkInfo& link)
{
m_Frame->NotifyPageChanged();
}
+ // Returns full location with anchor (helper)
+ static wxString GetOpenedPageWithAnchor(wxHtmlWindow *win)
+ {
+ if(!win)
+ return wxEmptyString;
+
+ wxString an = win->GetOpenedAnchor();
+ wxString pg = win->GetOpenedPage();
+ if(!an.empty())
+ {
+ pg << wxT("#");
+ pg << an;
+ }
+ return pg;
+ }
+
private:
wxHtmlHelpFrame *m_Frame;
// wxHtmlHelpFrame::m_mergedIndex
//---------------------------------------------------------------------------
-WX_DEFINE_ARRAY(const wxHtmlHelpDataItem*, wxHtmlHelpDataItemPtrArray);
+WX_DEFINE_ARRAY_PTR(const wxHtmlHelpDataItem*, wxHtmlHelpDataItemPtrArray);
struct wxHtmlHelpMergedIndexItem
{
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)
{
mi->parent = (item.level == 0) ? NULL : history[item.level - 1];
history[item.level] = mi;
merged.Add(mi);
- }
+ }
}
}
-
+
//---------------------------------------------------------------------------
// wxHtmlHelpFrame
m_Config = NULL;
m_ConfigRoot = wxEmptyString;
- m_Cfg.x = m_Cfg.y = 0;
+ m_Cfg.x = m_Cfg.y = -1;
m_Cfg.w = 700;
m_Cfg.h = 480;
m_Cfg.sashpos = 240;
m_hfStyle = style;
wxImageList *ContentsImageList = new wxImageList(16, 16);
- ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, wxART_HELP_BROWSER));
- ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, wxART_HELP_BROWSER));
- ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, wxART_HELP_BROWSER));
+ ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK,
+ wxART_HELP_BROWSER,
+ wxSize(16, 16)));
+ ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER,
+ wxART_HELP_BROWSER,
+ wxSize(16, 16)));
+ ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE,
+ wxART_HELP_BROWSER,
+ wxSize(16, 16)));
// Do the config in two steps. We read the HtmlWindow customization after we
// create the window.
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"));
int notebook_page = 0;
+#if wxUSE_STATUSBAR
CreateStatusBar();
+#endif // wxUSE_STATUSBAR
#if wxUSE_TOOLBAR
// toolbar?
}
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);
wxBitmapButton *bmpbt1, *bmpbt2;
bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD,
wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK,
- wxART_HELP_BROWSER));
+ wxART_BUTTON));
bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE,
wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK,
- wxART_HELP_BROWSER));
+ wxART_BUTTON));
#if wxUSE_TOOLTIPS
bmpbt1->SetToolTip(_("Add current page to bookmarks"));
bmpbt2->SetToolTip(_("Remove current page from bookmarks"));
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);
+ wxTR_LINES_AT_ROOT
+#endif
+ );
m_ContentsBox->AssignImageList(ContentsImageList);
wxDefaultPosition, wxDefaultSize,
wxTE_PROCESS_ENTER);
m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE,
- wxDefaultPosition, wxDefaultSize);
+ wxDefaultPosition, wxSize(125,-1));
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"));
wxHtmlHelpFrame::~wxHtmlHelpFrame()
{
+ delete m_mergedIndex;
+
// PopEventHandler(); // wxhtmlhelpcontroller (not any more!)
if (m_DataCreated)
delete m_Data;
void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style)
{
wxBitmap wpanelBitmap =
- wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_TOOLBAR);
wxBitmap wbackBitmap =
- wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_TOOLBAR);
wxBitmap wforwardBitmap =
- wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_TOOLBAR);
wxBitmap wupnodeBitmap =
- wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_TOOLBAR);
wxBitmap wupBitmap =
- wxArtProvider::GetBitmap(wxART_GO_UP, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_GO_UP, wxART_TOOLBAR);
wxBitmap wdownBitmap =
- wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_TOOLBAR);
wxBitmap wopenBitmap =
- wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_TOOLBAR);
wxBitmap wprintBitmap =
- wxArtProvider::GetBitmap(wxART_PRINT, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_PRINT, wxART_TOOLBAR);
wxBitmap woptionsBitmap =
- wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_HELP_BROWSER);
+ wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_TOOLBAR);
wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() &&
wforwardBitmap.Ok() && wupnodeBitmap.Ok() &&
toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Show/hide navigation panel"));
toolBar->AddSeparator();
toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Go back"));
toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Go forward"));
toolBar->AddSeparator();
toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Go one level up in document hierarchy"));
toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Previous page"));
toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Next page"));
if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES))
if (style & wxHF_OPEN_FILES)
toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Open HTML document"));
#if wxUSE_PRINTING_ARCHITECTURE
if (style & wxHF_PRINT)
toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Print this page"));
#endif
toolBar->AddSeparator();
toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap,
- false, -1, -1, (wxObject *) NULL,
+ false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL,
_("Display options dialog"));
}
#endif //wxUSE_TOOLBAR
bool wxHtmlHelpFrame::Display(const wxString& x)
{
wxString url = m_Data->FindPageByName(x);
- if (!url.IsEmpty())
+ if (!url.empty())
{
m_HtmlWin->LoadPage(url);
NotifyPageChanged();
bool wxHtmlHelpFrame::Display(const int id)
{
wxString url = m_Data->FindPageById(id);
- if (!url.IsEmpty())
+ if (!url.empty())
{
m_HtmlWin->LoadPage(url);
NotifyPageChanged();
if (m_Data->GetBookRecArray().GetCount() > 0)
{
wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
- if (!book.GetStart().IsEmpty())
+ if (!book.GetStart().empty())
m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
}
if (m_Data->GetBookRecArray().GetCount() > 0)
{
wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0];
- if (!book.GetStart().IsEmpty())
+ if (!book.GetStart().empty())
m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart()));
}
case wxHELP_SEARCH_INDEX:
{
- wxHtmlHelpMergedIndexItem* it =
+ wxHtmlHelpMergedIndexItem* it =
(wxHtmlHelpMergedIndexItem*) m_IndexList->GetClientData(0);
if (it)
DisplayIndexItem(it);
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 neccessary because m_Data has flat structure
+ // given level. This is necessary because m_Data has a flat structure
// and there's no way of recognizing if some item has subitems or not.
// We set the icon later: when we find an item with level=n, we know
- // that the last item with level=n-1 was folder with subitems, so we
+ // that the last item with level=n-1 was afolder with subitems, so we
// set its icon accordingly
bool imaged[MAX_ROOTS];
m_ContentsBox->DeleteAllItems();
{
if (m_hfStyle & wxHF_MERGE_BOOKS)
// VS: we don't want book nodes, books' content should
- // appear under tree's root. This line will create "fake"
+ // appear under tree's root. This line will create a "fake"
// record about book node so that the rest of this look
- // will believe there really _is_ book node and will
+ // will believe there really _is_ a book node and will
// behave correctly.
roots[1] = roots[0];
else
m_PagesHash->Put(it->GetFullPath(),
new wxHtmlHelpHashData(i, roots[it->level + 1]));
- // Set the icon for the node one level up in the hiearachy,
+ // Set the icon for the node one level up in the hierarchy,
// unless already done (see comment above imaged[] declaration)
if (!imaged[it->level])
{
sizer->Add(new wxStaticText(this, wxID_ANY, _("Font size:")));
sizer->Add(NormalFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
- wxSize(200, -1),
+ wxSize(200, wxDefaultCoord),
0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
sizer->Add(FixedFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
- wxSize(200, -1),
+ wxSize(200, wxDefaultCoord),
0, NULL, wxCB_DROPDOWN | wxCB_READONLY));
sizer->Add(FontSize = new wxSpinCtrl(this, wxID_ANY));
wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL);
wxButton *ok;
- sizer2->Add(ok = new wxButton(this, wxID_OK, _("OK")), 0, wxALL, 10);
+ sizer2->Add(ok = new wxButton(this, wxID_OK), 0, wxALL, 10);
ok->SetDefault();
- sizer2->Add(new wxButton(this, wxID_CANCEL, _("Cancel")), 0, wxALL, 10);
+ sizer2->Add(new wxButton(this, wxID_CANCEL), 0, wxALL, 10);
topsizer->Add(sizer2, 0, wxALIGN_RIGHT);
SetSizer(topsizer);
enu.EnumerateFacenames();
m_NormalFonts = new wxArrayString;
*m_NormalFonts = *enu.GetFacenames();
- m_NormalFonts->Sort(wxStringSortAscending);
+ m_NormalFonts->Sort(); // ascending sort
}
if (m_FixedFonts == NULL)
{
enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, true /*enum fixed width only*/);
m_FixedFonts = new wxArrayString;
*m_FixedFonts = *enu.GetFacenames();
- m_FixedFonts->Sort(wxStringSortAscending);
+ m_FixedFonts->Sort(); // ascending sort
}
// VS: We want to show the font that is actually used by wxHtmlWindow.
{
if (m_UpdateContents && m_PagesHash)
{
- wxString an = m_HtmlWin->GetOpenedAnchor();
- wxHtmlHelpHashData *ha;
- if (an.IsEmpty())
- ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
- else
- ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
+ wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin);
+ wxHtmlHelpHashData *ha = NULL;
+ if (!page.empty())
+ ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page);
+
if (ha)
{
bool olduc = m_UpdateContents;
case wxID_HTML_UP :
if (m_PagesHash)
{
- wxString an = m_HtmlWin->GetOpenedAnchor();
- wxHtmlHelpHashData *ha;
- if (an.IsEmpty())
- ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
- else
- ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
+ wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin);
+ wxHtmlHelpHashData *ha = NULL;
+ if (!page.empty())
+ ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page);
if (ha && ha->m_Index > 0)
{
const wxHtmlHelpDataItem& it = m_Data->GetContentsArray()[ha->m_Index - 1];
case wxID_HTML_UPNODE :
if (m_PagesHash)
{
- wxString an = m_HtmlWin->GetOpenedAnchor();
- wxHtmlHelpHashData *ha;
- if (an.IsEmpty())
- ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage());
- else
- ha = (wxHtmlHelpHashData*) m_PagesHash->Get(m_HtmlWin->GetOpenedPage() + wxT("#") + an);
+ wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin);
+ wxHtmlHelpHashData *ha = NULL;
+ if (!page.empty())
+ ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page);
if (ha && ha->m_Index > 0)
{
- int level =
+ int level =
m_Data->GetContentsArray()[ha->m_Index].level - 1;
int ind = ha->m_Index - 1;
- const wxHtmlHelpDataItem *it =
+ const wxHtmlHelpDataItem *it =
&m_Data->GetContentsArray()[ind];
while (ind >= 0 && it->level != level)
{
case wxID_HTML_DOWN :
if (m_PagesHash)
{
- wxString an = m_HtmlWin->GetOpenedAnchor();
- wxString adr;
- wxHtmlHelpHashData *ha;
-
- if (an.IsEmpty()) adr = m_HtmlWin->GetOpenedPage();
- else adr = m_HtmlWin->GetOpenedPage() + wxT("#") + an;
-
- ha = (wxHtmlHelpHashData*) m_PagesHash->Get(adr);
+ wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin);
+ wxHtmlHelpHashData *ha = NULL;
+ if (!page.empty())
+ ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page);
const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray();
if (ha && ha->m_Index < (int)contents.size() - 1)
{
size_t idx = ha->m_Index + 1;
- while (contents[idx].GetFullPath() == adr) idx++;
+ while (contents[idx].GetFullPath() == page) idx++;
if (!contents[idx].page.empty())
{
filemask,
wxOPEN | wxFILE_MUST_EXIST,
this);
- if (!s.IsEmpty())
+ if (!s.empty())
{
wxString ext = s.Right(4).Lower();
if (ext == _T(".zip") || ext == _T(".htb") ||
void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent& WXUNUSED(event))
{
- wxHtmlHelpMergedIndexItem *it = (wxHtmlHelpMergedIndexItem*)
+ wxHtmlHelpMergedIndexItem *it = (wxHtmlHelpMergedIndexItem*)
m_IndexList->GetClientData(m_IndexList->GetSelection());
if (it)
DisplayIndexItem(it);
if (displ++ == 0)
{
- m_IndexList->SetSelection(0);
- DisplayIndexItem(&index[i]);
+ // don't automatically show topic selector if this
+ // item points to multiple pages:
+ if (index[i].items.size() == 1)
+ {
+ m_IndexList->SetSelection(0);
+ DisplayIndexItem(&index[i]);
+ }
}
// if this is nested item of the index, show its parent(s)
wxHtmlHelpMergedIndexItem *parent = index[i].parent;
while (parent)
{
- if (pos == 0 ||
+ if (pos == 0 ||
(index.Index(*(wxHtmlHelpMergedIndexItem*)m_IndexList->GetClientData(pos-1))) < index.Index(*parent))
{
m_IndexList->Insert(parent->name,
}
else break;
}
+
+ // finally, it the item we just added is itself a parent for
+ // other items, show them as well, because they are refinements
+ // of the displayed index entry (i.e. it is implicitly contained
+ // in them: "foo" with parent "bar" reads as "bar, foo"):
+ int level = index[i].items[0]->level;
+ i++;
+ while (i < cnt && index[i].items[0]->level > level)
+ {
+ m_IndexList->Append(index[i].name, (char*)(&index[i]));
+ i++;
+ }
+ i--;
}
}
m_IndexList->Append(index[i].name, (char*)(&index[i]));
if (first)
{
- DisplayIndexItem(&index[i]);
+ // don't automatically show topic selector if this
+ // item points to multiple pages:
+ if (index[i].items.size() == 1)
+ {
+ DisplayIndexItem(&index[i]);
+ }
first = false;
}
}
#ifdef __WXMAC__
EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose)
EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout)
+ EVT_MENU(wxID_HELP_CONTENTS, wxHtmlHelpFrame::OnAbout)
#endif
END_EVENT_TABLE()