]> git.saurik.com Git - wxWidgets.git/blame - include/wx/palmos/help.h
Warning fix (instead of silencing int->short with typecast, have the same type intern...
[wxWidgets.git] / include / wx / palmos / help.h
CommitLineData
ffecfa5a 1/////////////////////////////////////////////////////////////////////////////
e1d63b79 2// Name: wx/palmos/helpwin.h
ffecfa5a 3// Purpose: Help system: WinHelp implementation
e1d63b79 4// Author: William Osborne - minimal working wxPalmOS port
ffecfa5a
JS
5// Modified by:
6// Created: 10/13/04
e1d63b79 7// RCS-ID: $Id$
ffecfa5a
JS
8// Copyright: (c) William Osborne
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_HELP_H_
13#define _WX_HELP_H_
14
ffecfa5a
JS
15#include "wx/wx.h"
16
17#if wxUSE_HELP
18
19#include "wx/helpbase.h"
20
21class WXDLLEXPORT wxPalmHelpController: public wxHelpControllerBase
22{
23 DECLARE_CLASS(wxPalmHelpController)
24
25public:
26 wxPalmHelpController() {};
27 ~wxPalmHelpController() {};
28
29 // Must call this to set the filename
30 virtual bool Initialize(const wxString& file);
31 virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); }
32
33 // If file is "", reloads file given in Initialize
34 virtual bool LoadFile(const wxString& file = wxEmptyString);
35 virtual bool DisplayContents();
36 virtual bool DisplaySection(int sectionNo);
37 virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }
38 virtual bool DisplayBlock(long blockNo);
39 virtual bool DisplayContextPopup(int contextId);
40 virtual bool KeywordSearch(const wxString& k,
41 wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
42 virtual bool Quit();
43
44 inline wxString GetHelpFile() const { return m_helpFile; }
45
46protected:
47 // Append extension if necessary.
48 wxString GetValidFilename(const wxString& file) const;
e1d63b79 49
ffecfa5a
JS
50private:
51 wxString m_helpFile;
52};
53
54#endif // wxUSE_HELP
55#endif
56// _WX_HELP_H_