3f66f6a5b3
This keyword is not expanded by Git which means it's not replaced with the correct revision value in the releases made using git-based scripts and it's confusing to have lines with unexpanded "$Id$" in the released files. As expanding them with Git is not that simple (it could be done with git archive and export-subst attribute) and there are not many benefits in having them in the first place, just remove all these lines. If nothing else, this will make an eventual transition to Git simpler. Closes #14487. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
106 lines
3.4 KiB
C++
106 lines
3.4 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/generic/helpext.h
|
|
// Purpose: an external help controller for wxWidgets
|
|
// Author: Karsten Ballueder (Ballueder@usa.net)
|
|
// Modified by:
|
|
// Copyright: (c) Karsten Ballueder 1998
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef __WX_HELPEXT_H_
|
|
#define __WX_HELPEXT_H_
|
|
|
|
#if wxUSE_HELP
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// headers
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#include "wx/helpbase.h"
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxExtHelpController
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// This class implements help via an external browser.
|
|
class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase
|
|
{
|
|
public:
|
|
wxExtHelpController(wxWindow* parentWindow = NULL);
|
|
virtual ~wxExtHelpController();
|
|
|
|
#if WXWIN_COMPATIBILITY_2_8
|
|
wxDEPRECATED(void SetBrowser(const wxString& browsername = wxEmptyString, bool isNetscape = false) );
|
|
#endif
|
|
|
|
// Set viewer: new name for SetBrowser
|
|
virtual void SetViewer(const wxString& viewer = wxEmptyString,
|
|
long flags = wxHELP_NETSCAPE);
|
|
|
|
virtual bool Initialize(const wxString& dir, int WXUNUSED(server))
|
|
{ return Initialize(dir); }
|
|
|
|
virtual bool Initialize(const wxString& dir);
|
|
virtual bool LoadFile(const wxString& file = wxEmptyString);
|
|
virtual bool DisplayContents(void);
|
|
virtual bool DisplaySection(int sectionNo);
|
|
virtual bool DisplaySection(const wxString& section);
|
|
virtual bool DisplayBlock(long blockNo);
|
|
virtual bool KeywordSearch(const wxString& k,
|
|
wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
|
|
|
|
virtual bool Quit(void);
|
|
virtual void OnQuit(void);
|
|
|
|
virtual bool DisplayHelp(const wxString &) ;
|
|
|
|
virtual void SetFrameParameters(const wxString& WXUNUSED(title),
|
|
const wxSize& WXUNUSED(size),
|
|
const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
|
|
bool WXUNUSED(newFrameEachTime) = false)
|
|
{
|
|
// does nothing by default
|
|
}
|
|
|
|
virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
|
|
wxPoint *WXUNUSED(pos) = NULL,
|
|
bool *WXUNUSED(newFrameEachTime) = NULL)
|
|
{
|
|
return NULL; // does nothing by default
|
|
}
|
|
|
|
protected:
|
|
// Filename of currently active map file.
|
|
wxString m_helpDir;
|
|
|
|
// How many entries do we have in the map file?
|
|
int m_NumOfEntries;
|
|
|
|
// A list containing all id,url,documentation triples.
|
|
wxList *m_MapList;
|
|
|
|
private:
|
|
// parse a single line of the map file (called by LoadFile())
|
|
//
|
|
// return true if the line was valid or false otherwise
|
|
bool ParseMapFileLine(const wxString& line);
|
|
|
|
// Deletes the list and all objects.
|
|
void DeleteList(void);
|
|
|
|
|
|
// How to call the html viewer.
|
|
wxString m_BrowserName;
|
|
|
|
// Is the viewer a variant of netscape?
|
|
bool m_BrowserIsNetscape;
|
|
|
|
DECLARE_CLASS(wxExtHelpController)
|
|
};
|
|
|
|
#endif // wxUSE_HELP
|
|
|
|
#endif // __WX_HELPEXT_H_
|