IHelpClient.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
9 
10 #include <Bentley\Bentley.h>
11 #include <HelpSystem\HelpSystem.h>
12 
14 
15 //=======================================================================================
21 //=======================================================================================
23  {
24  public:
25  virtual ~IHelpClient () {}
26 
27  virtual void _DisplayTopic
28  (
29  WCharCP windowNameP,
30  WCharCP stringP
31  ) = 0;
32 
33  virtual void _DisplayALink
34  (
35  WCharCP windowNameP,
36  WCharCP stringP
37  ) = 0;
38 
39  virtual void _DisplayToolIndex
40  (
41  WCharCP windowNameP,
42  WCharCP indexNameP,
43  WCharCP stringP
44  ) = 0;
45 
46  virtual void _DisplayIndex
47  (
48  WCharCP windowNameP,
49  WCharCP stringP
50  ) = 0;
51 
52  virtual void _DisplayContents
53  (
54  WCharCP windowNameP,
55  WCharCP topicP
56  ) = 0;
57 
58  virtual void _DisplaySearch
59  (
60  WCharCP windowNameP,
61  WCharCP stringP
62  ) = 0;
63 
64  virtual void _CloseAll () = 0;
65 
66  virtual void _Cleanup () = 0;
67 
68  virtual void _ShowQuickStartPDF () = 0;
69 
70 #if defined (BESQLITE_NOT_YET_USED)
71  virtual void _DisplayFeature
72  (
73  WCharCP featureTrackingIDP
74  ) = 0;
75 
76  virtual void _SetDBFilePath
77  (
78  WCharCP dbFileStringP
79  ) = 0;
80 #endif
81 
82  };
virtual ~IHelpClient()
Definition: IHelpClient.h:25
#define END_BENTLEY_HELPSYSTEM_NAMESPACE
Definition: HelpSystem.h:15
virtual void _ShowQuickStartPDF()=0
virtual void _DisplaySearch(WCharCP windowNameP, WCharCP stringP)=0
wchar_t const * WCharCP
Definition: Bentley.h:224
virtual void _DisplayToolIndex(WCharCP windowNameP, WCharCP indexNameP, WCharCP stringP)=0
virtual void _DisplayALink(WCharCP windowNameP, WCharCP stringP)=0
virtual void _CloseAll()=0
#define BEGIN_BENTLEY_HELPSYSTEM_NAMESPACE
Definition: HelpSystem.h:14
Defines typedefs and constants that can be used across other namespaces. All Bentley-authored C++ sou...
virtual void _DisplayContents(WCharCP windowNameP, WCharCP topicP)=0
virtual void _DisplayIndex(WCharCP windowNameP, WCharCP stringP)=0
virtual void _DisplayTopic(WCharCP windowNameP, WCharCP stringP)=0
virtual void _Cleanup()=0
Definition: IHelpClient.h:22

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.