BrowserHelpClient.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 <HelpSystem\IHelpClient.h>
12 #include <Bentley\WString.h>
13 
14 #define FILE_PATH_BUFFER_SIZE 1024
15 
17 
18 // Significant fields are important while mapping the product version with its online help publication
20  {
24  };
25 
26 //=======================================================================================
32 //=======================================================================================
34  {
35  public:
36  virtual ~IBrowserHelpClient() {}
37 
38  virtual void _SetUriRoot (WCharCP uriRootP) = 0;
39 
40  virtual bool _GetLocalHelpLocation (WStringR helpLocation, WCharCP productName, int release, int major, int minor) = 0;
41 
42  virtual bool _GetOnlineHelpLocation(WStringR helpLocation, int productID, int releaseVersion, int majorVersion, int minorVersion, int subMinor, SignificantVersionFields versionsignificantFields,
43  WStringCR languageCode, bool forceQA) = 0;
44  };
45 //=======================================================================================
49 //=======================================================================================
51  {
52  private:
53  WString m_uriRoot;
54  WString m_dbFilePath;
55 
56  IHelpClientHost* m_host;
57 
58  int GenerateLocationString
59  (
60  WStringR url,
61  WCharCP fileP,
62  WCharCP topicP,
63  WCharCP windowP
64  );
65 
66  StatusInt LaunchURL
67  (
68  WCharCP url
69  );
70 
71  int LaunchPdfReader
72  (
73  WCharCP readerExeName,
74  WCharCP pdfDocName
75  );
76 
77  public:
79 
80  virtual void _DisplayTopic
81  (
82  WCharCP windowNameP,
83  WCharCP stringP
84  ) override;
85 
86  virtual void _DisplayALink
87  (
88  WCharCP windowNameP,
89  WCharCP stringP
90  ) override;
91 
92  virtual void _DisplayToolIndex
93  (
94  WCharCP windowNameP,
95  WCharCP indexNameP,
96  WCharCP stringP
97  ) override;
98 
99  virtual void _DisplayIndex
100  (
101  WCharCP windowNameP,
102  WCharCP stringP
103  ) override;
104 
105  virtual void _DisplayContents
106  (
107  WCharCP windowNameP,
108  WCharCP topicP
109  ) override;
110 
111  virtual void _DisplaySearch
112  (
113  WCharCP windowNameP,
114  WCharCP stringP
115  ) override;
116 
117  virtual void _CloseAll () override;
118 
119  virtual void _Cleanup () override;
120 
121  virtual void _ShowQuickStartPDF () override;
122 
123 #if defined (BESQLITE_NOT_YET_USED)
124  virtual void _DisplayFeature (WCharCP featureTrackingIDP) override;
125 
126  virtual void _SetDBFilePath (WCharCP dbFileStringP) override;
127 #endif
128 
129  virtual void _SetUriRoot (WCharCP uriRootP) override;
130 
131  virtual bool _GetLocalHelpLocation (WStringR helpLocation, WCharCP productName, int release, int major, int minor) override;
132 
133  virtual bool _GetOnlineHelpLocation(WStringR helpLocation, int productID, int releaseVersion, int majorVersion, int minorVersion, int subMinorVersion, SignificantVersionFields versionsignificantFields,
134  WStringCR languageCode, bool forceQA) override;
135  };
BrowsrHelpClient provides implementation for IBrowserHelpClient interface.
Definition: BrowserHelpClient.h:50
Definition: BrowserHelpClient.h:33
virtual void _DisplayToolIndex(WCharCP windowNameP, WCharCP indexNameP, WCharCP stringP) override
#define END_BENTLEY_HELPSYSTEM_NAMESPACE
Definition: HelpSystem.h:15
BrowserHelpClient(IHelpClientHost *host)
virtual ~IBrowserHelpClient()
Definition: BrowserHelpClient.h:36
struct Bentley::WString const & WStringCR
Definition: Bentley.h:239
virtual bool _GetOnlineHelpLocation(WStringR helpLocation, int productID, int releaseVersion, int majorVersion, int minorVersion, int subMinorVersion, SignificantVersionFields versionsignificantFields, WStringCR languageCode, bool forceQA) override
wchar_t const * WCharCP
Definition: Bentley.h:224
virtual void _DisplaySearch(WCharCP windowNameP, WCharCP stringP) override
struct Bentley::WString & WStringR
Definition: Bentley.h:239
virtual void _DisplayIndex(WCharCP windowNameP, WCharCP stringP) override
virtual bool _GetLocalHelpLocation(WStringR helpLocation, WCharCP productName, int release, int major, int minor)=0
virtual void _DisplayALink(WCharCP windowNameP, WCharCP stringP) override
virtual bool _GetOnlineHelpLocation(WStringR helpLocation, int productID, int releaseVersion, int majorVersion, int minorVersion, int subMinor, SignificantVersionFields versionsignificantFields, WStringCR languageCode, bool forceQA)=0
virtual void _DisplayContents(WCharCP windowNameP, WCharCP topicP) override
#define BEGIN_BENTLEY_HELPSYSTEM_NAMESPACE
Definition: HelpSystem.h:14
virtual void _ShowQuickStartPDF() override
virtual void _CloseAll() override
int StatusInt
Definition: Bentley.h:222
virtual void _SetUriRoot(WCharCP uriRootP) override
virtual bool _GetLocalHelpLocation(WStringR helpLocation, WCharCP productName, int release, int major, int minor) override
virtual void _DisplayTopic(WCharCP windowNameP, WCharCP stringP) override
virtual void _SetUriRoot(WCharCP uriRootP)=0
virtual void _Cleanup() override
Definition: IHelpClientHost.h:23
Definition: IHelpClient.h:22
SignificantVersionFields
Definition: BrowserHelpClient.h:19

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