7615330240
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@993 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
52 lines
1.4 KiB
C++
52 lines
1.4 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: helpbase.h
|
|
// Purpose: Help system base classes
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 04/01/98
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Julian Smart and Markus Holzem
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_HELPBASEH__
|
|
#define _WX_HELPBASEH__
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface "helpbase.h"
|
|
#endif
|
|
|
|
#include "wx/wx.h"
|
|
|
|
#if wxUSE_HELP
|
|
|
|
// Defines the API for help controllers
|
|
class WXDLLEXPORT wxHelpControllerBase: public wxObject
|
|
{
|
|
DECLARE_CLASS(wxHelpControllerBase)
|
|
|
|
public:
|
|
inline wxHelpControllerBase(void) {}
|
|
inline ~wxHelpControllerBase(void) {};
|
|
|
|
// 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& file) = 0;
|
|
|
|
// If file is "", reloads file given in Initialize
|
|
virtual bool LoadFile(const wxString& file = "") = 0;
|
|
virtual bool DisplayContents(void) = 0;
|
|
virtual bool DisplaySection(int sectionNo) = 0;
|
|
virtual bool DisplayBlock(long blockNo) = 0;
|
|
virtual bool KeywordSearch(const wxString& k) = 0;
|
|
|
|
virtual bool Quit(void) = 0;
|
|
virtual void OnQuit(void) {};
|
|
};
|
|
|
|
#endif // wxUSE_HELP
|
|
#endif
|
|
// _WX_HELPBASEH__
|