7df9fbc3f1
========
At present, if you wish to load a .hhc file instead of add books manually, you can only have one book - UNLESS you omit the outer <ul> </ul>. Then the contents will appear to have more than book, although in fact it's just one book that's displayed on level zero and therefore get the Book icons.
However, you'll also get a dummy 'book' with the name of the project but no children. So my hack detects whether the .hhc file is trying to add books at level zero, and if so, throws away the first 'book', so that only the hhc-specified books get shown.
So the end result is that our hhc file can specify multiple sections that don't all hang off one dummy book node which itself hangs off the root node -- which is a UI pain!
Fix 2.
====
I changed the test
if (!m_Page.IsEmpty())
to
if (tag.GetParam("TYPE") == "text/sitemap")
at around L.120 of helpdata.cpp as suggested in the comment, so we don't have to specify a URL for the node to be valid. Sometimes you don't want a URL in a contents item. I've added some tests to stop it complaining if you click on a URL-less item.
Feature enhancement/Hack 3.
======================
I've added wxHtmlHelpController::SetBookBasePath so that the .hhp/.hhc files don't have to be in the same hierarchy as the HTML files.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@9792 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
112 lines
4.2 KiB
C++
112 lines
4.2 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: helpctrl.h
|
|
// Purpose: wxHtmlHelpController
|
|
// 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$
|
|
// Copyright: (c) Harm van der Heijden and Vaclav Slavik
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_HELPCTRL_H_
|
|
#define _WX_HELPCTRL_H_
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface
|
|
#endif
|
|
|
|
#if wxUSE_HTML
|
|
|
|
#include "wx/html/helpfrm.h"
|
|
#include "wx/helpbase.h"
|
|
|
|
class WXDLLEXPORT wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxHtmlHelpController)
|
|
|
|
public:
|
|
wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
|
|
virtual ~wxHtmlHelpController();
|
|
|
|
void SetTitleFormat(const wxString& format);
|
|
void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); }
|
|
bool AddBook(const wxString& book, bool show_wait_msg = FALSE);
|
|
bool Display(const wxString& x)
|
|
{
|
|
CreateHelpWindow(); return m_helpFrame->Display(x);
|
|
}
|
|
bool Display(int id)
|
|
{
|
|
CreateHelpWindow(); return m_helpFrame->Display(id);
|
|
}
|
|
bool DisplayContents()
|
|
{
|
|
CreateHelpWindow(); return m_helpFrame->DisplayContents();
|
|
}
|
|
bool DisplayIndex()
|
|
{
|
|
CreateHelpWindow(); return m_helpFrame->DisplayIndex();
|
|
}
|
|
bool KeywordSearch(const wxString& keyword)
|
|
{
|
|
CreateHelpWindow(); return m_helpFrame->KeywordSearch(keyword);
|
|
}
|
|
wxHtmlHelpFrame* GetFrame() { return m_helpFrame; }
|
|
void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
|
|
|
|
// Assigns config object to the Ctrl. This config is then
|
|
// used in subsequent calls to Read/WriteCustomization of both help
|
|
// Ctrl and it's wxHtmlWindow
|
|
virtual void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
|
|
virtual void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
|
|
|
|
//// Backward compatibility with wxHelpController API
|
|
|
|
virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize(file); }
|
|
virtual bool Initialize(const wxString& file);
|
|
virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
|
|
virtual bool LoadFile(const wxString& file = "");
|
|
virtual bool DisplaySection(int sectionNo);
|
|
virtual bool DisplaySection(const wxString& section) { return Display(section); }
|
|
virtual bool DisplayBlock(long blockNo) { return DisplaySection(blockNo); }
|
|
virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
|
|
|
|
virtual void SetFrameParameters(const wxString& title,
|
|
const wxSize& size,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
bool newFrameEachTime = FALSE);
|
|
/// Obtains the latest settings used by the help frame and the help
|
|
/// frame.
|
|
virtual wxFrame *GetFrameParameters(wxSize *size = NULL,
|
|
wxPoint *pos = NULL,
|
|
bool *newFrameEachTime = NULL);
|
|
|
|
// Sets the specified book or all books to have the given base path
|
|
virtual void SetBookBasePath(const wxString& basePath, int which = -1);
|
|
|
|
virtual bool Quit() ;
|
|
virtual void OnQuit() {};
|
|
|
|
void OnCloseFrame(wxCloseEvent& evt);
|
|
protected:
|
|
virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data);
|
|
|
|
virtual void CreateHelpWindow();
|
|
virtual void DestroyHelpWindow();
|
|
|
|
wxHtmlHelpData m_helpData;
|
|
wxHtmlHelpFrame* m_helpFrame;
|
|
wxConfigBase * m_Config;
|
|
wxString m_ConfigRoot;
|
|
wxString m_titleFormat;
|
|
int m_FrameStyle;
|
|
// DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
#endif
|
|
|
|
#endif // _WX_HELPCTRL_H_
|