]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/helpbase.h
Added SetFont to most controls and controls sample
[wxWidgets.git] / include / wx / helpbase.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: helpbase.h
3// Purpose: Help system base classes
4// Author: Julian Smart
5// Modified by:
6// Created: 04/01/98
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart and Markus Holzem
9// Licence: wxWindows license
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_HELPBASEH__
13#define _WX_HELPBASEH__
14
15#ifdef __GNUG__
16#pragma interface "helpbase.h"
17#endif
18
19#include "wx/wx.h"
20
21#if USE_HELP
22
23// Defines the API for help controllers
24class WXDLLEXPORT wxHelpControllerBase: public wxObject
25{
26 DECLARE_CLASS(wxHelpControllerBase)
27
28 public:
29 inline wxHelpControllerBase(void) {}
30 inline ~wxHelpControllerBase(void) {};
31
32 // Must call this to set the filename and server name.
33 // server is only required when implementing TCP/IP-based
34 // help controllers.
35 virtual bool Initialize(const wxString& file, int server) { return FALSE; };
36 virtual bool Initialize(const wxString& file) = 0;
37
38 // If file is "", reloads file given in Initialize
39 virtual bool LoadFile(const wxString& file = "") = 0;
40 virtual bool DisplayContents(void) = 0;
41 virtual bool DisplaySection(int sectionNo) = 0;
42 virtual bool DisplayBlock(long blockNo) = 0;
43 virtual bool KeywordSearch(const wxString& k) = 0;
44
45 virtual bool Quit(void) = 0;
46 virtual void OnQuit(void) {};
47};
48
49#endif // USE_HELP
50#endif
51 // _WX_HELPBASEH__