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.5 KiB
C++
106 lines
3.5 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/helpbase.h
|
|
// Purpose: Help system base classes
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 04/01/98
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_HELPBASEH__
|
|
#define _WX_HELPBASEH__
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_HELP
|
|
|
|
#include "wx/object.h"
|
|
#include "wx/string.h"
|
|
#include "wx/gdicmn.h"
|
|
#include "wx/frame.h"
|
|
|
|
// Flags for SetViewer
|
|
#define wxHELP_NETSCAPE 1
|
|
|
|
// Search modes:
|
|
enum wxHelpSearchMode
|
|
{
|
|
wxHELP_SEARCH_INDEX,
|
|
wxHELP_SEARCH_ALL
|
|
};
|
|
|
|
// Defines the API for help controllers
|
|
class WXDLLIMPEXP_CORE wxHelpControllerBase: public wxObject
|
|
{
|
|
public:
|
|
inline wxHelpControllerBase(wxWindow* parentWindow = NULL) { m_parentWindow = parentWindow; }
|
|
inline ~wxHelpControllerBase() {}
|
|
|
|
// Must call this to set the filename and server name.
|
|
// server is only required when implementing TCP/IP-based
|
|
// help controllers.
|
|
virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return false; }
|
|
virtual bool Initialize(const wxString& WXUNUSED(file)) { return false; }
|
|
|
|
// Set viewer: only relevant to some kinds of controller
|
|
virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
|
|
|
|
// If file is "", reloads file given in Initialize
|
|
virtual bool LoadFile(const wxString& file = wxEmptyString) = 0;
|
|
|
|
// Displays the contents
|
|
virtual bool DisplayContents(void) = 0;
|
|
|
|
// Display the given section
|
|
virtual bool DisplaySection(int sectionNo) = 0;
|
|
|
|
// Display the section using a context id
|
|
virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return false; }
|
|
|
|
// Display the text in a popup, if possible
|
|
virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return false; }
|
|
|
|
// By default, uses KeywordSection to display a topic. Implementations
|
|
// may override this for more specific behaviour.
|
|
virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }
|
|
virtual bool DisplayBlock(long blockNo) = 0;
|
|
virtual bool KeywordSearch(const wxString& k,
|
|
wxHelpSearchMode mode = wxHELP_SEARCH_ALL) = 0;
|
|
/// Allows one to override the default settings for the help frame.
|
|
virtual void SetFrameParameters(const wxString& WXUNUSED(title),
|
|
const wxSize& WXUNUSED(size),
|
|
const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
|
|
bool WXUNUSED(newFrameEachTime) = false)
|
|
{
|
|
// does nothing by default
|
|
}
|
|
/// Obtains the latest settings used by the help frame and the help
|
|
/// frame.
|
|
virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
|
|
wxPoint *WXUNUSED(pos) = NULL,
|
|
bool *WXUNUSED(newFrameEachTime) = NULL)
|
|
{
|
|
return NULL; // does nothing by default
|
|
}
|
|
|
|
virtual bool Quit() = 0;
|
|
virtual void OnQuit() {}
|
|
|
|
/// Set the window that can optionally be used for the help window's parent.
|
|
virtual void SetParentWindow(wxWindow* win) { m_parentWindow = win; }
|
|
|
|
/// Get the window that can optionally be used for the help window's parent.
|
|
virtual wxWindow* GetParentWindow() const { return m_parentWindow; }
|
|
|
|
protected:
|
|
wxWindow* m_parentWindow;
|
|
private:
|
|
DECLARE_CLASS(wxHelpControllerBase)
|
|
};
|
|
|
|
#endif // wxUSE_HELP
|
|
|
|
#endif
|
|
// _WX_HELPBASEH__
|