7414c52cd0
Set to 1 to: - provide different icons. - add an open file icon for the toolbar. - use a flat toolbar style. - show a file selector if no file was given on the command line. - remove 'Help:' from the title bar. Set to 0 to revert to previous behaviour. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@16074 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
275 lines
7.5 KiB
C++
275 lines
7.5 KiB
C++
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: helpview.cpp
|
|
// Purpose: wxHtml help browser
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef __GNUG__
|
|
#pragma implementation "help.cpp"
|
|
#pragma interface "help.cpp"
|
|
#endif
|
|
|
|
// For compilers that support precompilation, includes "wx/wx.h".
|
|
#include "wx/wxprec.h"
|
|
|
|
#ifdef __BORLANDC__
|
|
#pragma hdrstop
|
|
#endif
|
|
|
|
// for all others, include the necessary headers (this file is usually all you
|
|
// need because it includes almost all "standard" wxWindows headers
|
|
#ifndef WX_PRECOMP
|
|
#include "wx/wx.h"
|
|
#endif
|
|
|
|
#include "wx/image.h"
|
|
#include "wx/wxhtml.h"
|
|
#include "wx/fs_zip.h"
|
|
#include "wx/log.h"
|
|
#include "wx/artprov.h"
|
|
#include "wx/filedlg.h"
|
|
|
|
// Set to 1 to:
|
|
//
|
|
// - provide different icons.
|
|
// - add an open file icon for the toolbar.
|
|
// - use a flat toolbar style.
|
|
// - show a file selector if no file was given on the command line.
|
|
// - remove 'Help:' from the title bar.
|
|
//
|
|
// Set to 0 to revert to previous behaviour.
|
|
|
|
#define USE_ALTERNATE_UI 0
|
|
|
|
#if USE_ALTERNATE_UI
|
|
class AlternateArtProvider : public wxArtProvider
|
|
{
|
|
protected:
|
|
virtual wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client,
|
|
const wxSize& size);
|
|
};
|
|
#endif
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// private classes
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
// Define a new application type, each program should derive a class from wxApp
|
|
class MyApp : public wxApp
|
|
{
|
|
public:
|
|
// override base class virtuals
|
|
// ----------------------------
|
|
|
|
// this one is called on application startup and is a good place for the app
|
|
// initialization (doing it here and not in the ctor allows to have an error
|
|
// return: if OnInit() returns false, the application terminates)
|
|
|
|
virtual bool OnInit();
|
|
virtual int OnExit();
|
|
|
|
// Prompt the user for a book to open
|
|
bool OpenBook(wxHtmlHelpController* controller);
|
|
|
|
private:
|
|
wxHtmlHelpController *help;
|
|
};
|
|
|
|
|
|
IMPLEMENT_APP(MyApp)
|
|
|
|
|
|
bool MyApp::OnInit()
|
|
{
|
|
#ifdef __WXMOTIF__
|
|
delete wxLog::SetActiveTarget(new wxLogStderr); // So dialog boxes aren't used
|
|
#endif
|
|
|
|
#if USE_ALTERNATE_UI
|
|
wxArtProvider::PushProvider(new AlternateArtProvider);
|
|
#endif
|
|
|
|
wxInitAllImageHandlers();
|
|
wxFileSystem::AddHandler(new wxZipFSHandler);
|
|
|
|
SetVendorName("wxWindows");
|
|
SetAppName("wxHTMLHelp");
|
|
wxConfig::Get(); // create an instance
|
|
|
|
help = new wxHtmlHelpController(
|
|
#if USE_ALTERNATE_UI
|
|
wxHF_DEFAULT_STYLE|wxHF_FLAT_TOOLBAR|wxHF_OPEN_FILES
|
|
#endif
|
|
);
|
|
|
|
#if USE_ALTERNATE_UI
|
|
help->SetTitleFormat(wxT("%s"));
|
|
if (argc < 2) {
|
|
if (!OpenBook(help))
|
|
return FALSE;
|
|
}
|
|
#else
|
|
if (argc < 2) {
|
|
wxLogError(wxT("Usage : helpview <helpfile> [<more helpfiles>]"));
|
|
wxLogError(wxT(" helpfile may be .hhp, .zip or .htb"));
|
|
return FALSE;
|
|
}
|
|
#endif
|
|
|
|
for (int i = 1; i < argc; i++)
|
|
help -> AddBook(argv[i]);
|
|
|
|
#ifdef __WXMOTIF__
|
|
delete wxLog::SetActiveTarget(new wxLogGui);
|
|
#endif
|
|
|
|
help -> DisplayContents();
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
|
|
int MyApp::OnExit()
|
|
{
|
|
delete help;
|
|
delete wxConfig::Set(NULL);
|
|
|
|
return 0;
|
|
}
|
|
|
|
bool MyApp::OpenBook(wxHtmlHelpController* controller)
|
|
{
|
|
wxString s = wxFileSelector(_("Open help file"),
|
|
wxGetCwd(),
|
|
wxEmptyString,
|
|
wxEmptyString,
|
|
_(
|
|
"Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|\
|
|
HTML Help Project (*.hhp)|*.hhp"),
|
|
wxOPEN | wxFILE_MUST_EXIST,
|
|
NULL);
|
|
|
|
if (!s.IsEmpty())
|
|
{
|
|
wxString ext = s.Right(4).Lower();
|
|
if (ext == _T(".zip") || ext == _T(".htb") || ext == _T(".hhp"))
|
|
{
|
|
wxBusyCursor bcur;
|
|
controller->AddBook(s);
|
|
return TRUE;
|
|
}
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
#if USE_ALTERNATE_UI
|
|
|
|
/*
|
|
* Art provider class
|
|
*/
|
|
|
|
// ---------------------------------------------------------------------
|
|
// helper macros
|
|
// ---------------------------------------------------------------------
|
|
|
|
// Standard macro for getting a resource from XPM file:
|
|
#define ART(artId, xpmRc) \
|
|
if ( id == artId ) return wxBitmap(xpmRc##_xpm);
|
|
|
|
// Compatibility hack to use wxApp::GetStdIcon of overriden by the user
|
|
#if WXWIN_COMPATIBILITY_2_2
|
|
#define GET_STD_ICON_FROM_APP(iconId) \
|
|
if ( client == wxART_MESSAGE_BOX ) \
|
|
{ \
|
|
wxIcon icon = wxTheApp->GetStdIcon(iconId); \
|
|
if ( icon.Ok() ) \
|
|
{ \
|
|
wxBitmap bmp; \
|
|
bmp.CopyFromIcon(icon); \
|
|
return bmp; \
|
|
} \
|
|
}
|
|
#else
|
|
#define GET_STD_ICON_FROM_APP(iconId)
|
|
#endif
|
|
|
|
// There are two ways of getting the standard icon: either via XPMs or via
|
|
// wxIcon ctor. This depends on the platform:
|
|
#if defined(__WXUNIVERSAL__)
|
|
#define CREATE_STD_ICON(iconId, xpmRc) return wxNullBitmap;
|
|
#elif defined(__WXGTK__) || defined(__WXMOTIF__)
|
|
#define CREATE_STD_ICON(iconId, xpmRc) return wxBitmap(xpmRc##_xpm);
|
|
#else
|
|
#define CREATE_STD_ICON(iconId, xpmRc) \
|
|
{ \
|
|
wxIcon icon(_T(iconId)); \
|
|
wxBitmap bmp; \
|
|
bmp.CopyFromIcon(icon); \
|
|
return bmp; \
|
|
}
|
|
#endif
|
|
|
|
// Macro used in CreateBitmap to get wxICON_FOO icons:
|
|
#define ART_MSGBOX(artId, iconId, xpmRc) \
|
|
if ( id == artId ) \
|
|
{ \
|
|
GET_STD_ICON_FROM_APP(iconId) \
|
|
CREATE_STD_ICON(#iconId, xpmRc) \
|
|
}
|
|
|
|
// ---------------------------------------------------------------------
|
|
// XPMs with the art
|
|
// ---------------------------------------------------------------------
|
|
|
|
// XPM hack: make the arrays const
|
|
//#define static static const
|
|
|
|
#include "bitmaps/helpback.xpm"
|
|
#include "bitmaps/helpbook.xpm"
|
|
#include "bitmaps/helpdown.xpm"
|
|
#include "bitmaps/helpforward.xpm"
|
|
#include "bitmaps/helpoptions.xpm"
|
|
#include "bitmaps/helppage.xpm"
|
|
#include "bitmaps/helpsidepanel.xpm"
|
|
#include "bitmaps/helpup.xpm"
|
|
#include "bitmaps/helpuplevel.xpm"
|
|
#include "bitmaps/helpicon.xpm"
|
|
#include "bitmaps/helpopen.xpm"
|
|
|
|
//#undef static
|
|
|
|
// ---------------------------------------------------------------------
|
|
// CreateBitmap routine
|
|
// ---------------------------------------------------------------------
|
|
|
|
wxBitmap AlternateArtProvider::CreateBitmap(const wxArtID& id,
|
|
const wxArtClient& client,
|
|
const wxSize& WXUNUSED(size))
|
|
{
|
|
ART(wxART_HELP_SIDE_PANEL, helpsidepanel)
|
|
ART(wxART_HELP_SETTINGS, helpoptions)
|
|
ART(wxART_HELP_BOOK, helpbook)
|
|
ART(wxART_HELP_FOLDER, helpbook)
|
|
ART(wxART_HELP_PAGE, helppage)
|
|
//ART(wxART_ADD_BOOKMARK, addbookm)
|
|
//ART(wxART_DEL_BOOKMARK, delbookm)
|
|
ART(wxART_GO_BACK, helpback)
|
|
ART(wxART_GO_FORWARD, helpforward)
|
|
ART(wxART_GO_UP, helpup)
|
|
ART(wxART_GO_DOWN, helpdown)
|
|
ART(wxART_GO_TO_PARENT, helpuplevel)
|
|
ART(wxART_FILE_OPEN, helpopen)
|
|
if (client == wxART_HELP_BROWSER)
|
|
{
|
|
ART(wxART_FRAME_ICON, helpicon)
|
|
}
|
|
|
|
//ART(wxART_GO_HOME, home)
|
|
|
|
// Any wxWindows icons not implemented here
|
|
// will be provided by the default art provider.
|
|
return wxNullBitmap;
|
|
}
|
|
|
|
#endif |