File: helpViewer.sip

package info (click to toggle)
ball 1.5.0%2Bgit20180813.37fc53c-6
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 239,888 kB
  • sloc: cpp: 326,149; ansic: 4,208; python: 2,303; yacc: 1,778; lex: 1,099; xml: 958; sh: 322; makefile: 95
file content (25 lines) | stat: -rw-r--r-- 698 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class HelpViewer
	: DockWidget
{
%TypeHeaderCode
	#include <BALL/VIEW/WIDGETS/helpViewer.h>
%End
	public:

	virtual ~HelpViewer() throw();
	virtual void initializeWidget(MainControl&) throw();
	virtual void onNotify(Message *) throw();
	virtual void showHelp(const String&);
	void setDefaultPage(const String&);
	const String& getDefaultPage() const;
	void setBaseDirectory(const String&);
	const String& getBaseDirectory() const;
	virtual void registerMenuEntryForHelpSystem(Index, const String&);
	void unregisterMenuEntryForHelpSystem(Index);
	bool hasHelpFor(Index) const;
	bool showDocumentationForObject();

	virtual void showHelp();
	void enterWhatsThisMode();
	void exitWhatsThisMode();
};