Public Member Functions | List of all members
BrowserHelpClient Class Reference

BrowsrHelpClient provides implementation for IBrowserHelpClient interface. More...

#include <BrowserHelpClient.h>

Inheritance diagram for BrowserHelpClient:
IBrowserHelpClient IHelpClient

Public Member Functions

 BrowserHelpClient (IHelpClientHost *host)
 
virtual void _DisplayTopic (WCharCP windowNameP, WCharCP stringP) override
 
virtual void _DisplayALink (WCharCP windowNameP, WCharCP stringP) override
 
virtual void _DisplayToolIndex (WCharCP windowNameP, WCharCP indexNameP, WCharCP stringP) override
 
virtual void _DisplayIndex (WCharCP windowNameP, WCharCP stringP) override
 
virtual void _DisplayContents (WCharCP windowNameP, WCharCP topicP) override
 
virtual void _DisplaySearch (WCharCP windowNameP, WCharCP stringP) override
 
virtual void _CloseAll () override
 
virtual void _Cleanup () override
 
virtual void _ShowQuickStartPDF () override
 
virtual void _SetUriRoot (WCharCP uriRootP) override
 
virtual bool _GetLocalHelpLocation (WStringR helpLocation, WCharCP productName, int release, int major, int minor) override
 
virtual bool _GetOnlineHelpLocation (WStringR helpLocation, int productID, int releaseVersion, int majorVersion, int minorVersion, int subMinorVersion, SignificantVersionFields versionsignificantFields, WStringCR languageCode, bool forceQA) override
 
- Public Member Functions inherited from IBrowserHelpClient
virtual ~IBrowserHelpClient ()
 
- Public Member Functions inherited from IHelpClient
virtual ~IHelpClient ()
 

Detailed Description

BrowsrHelpClient provides implementation for IBrowserHelpClient interface.

Constructor & Destructor Documentation

Member Function Documentation

virtual void _Cleanup ( )
overridevirtual

Implements IHelpClient.

virtual void _CloseAll ( )
overridevirtual

Implements IHelpClient.

virtual void _DisplayALink ( WCharCP  windowNameP,
WCharCP  stringP 
)
overridevirtual

Implements IHelpClient.

virtual void _DisplayContents ( WCharCP  windowNameP,
WCharCP  topicP 
)
overridevirtual

Implements IHelpClient.

virtual void _DisplayIndex ( WCharCP  windowNameP,
WCharCP  stringP 
)
overridevirtual

Implements IHelpClient.

virtual void _DisplaySearch ( WCharCP  windowNameP,
WCharCP  stringP 
)
overridevirtual

Implements IHelpClient.

virtual void _DisplayToolIndex ( WCharCP  windowNameP,
WCharCP  indexNameP,
WCharCP  stringP 
)
overridevirtual

Implements IHelpClient.

virtual void _DisplayTopic ( WCharCP  windowNameP,
WCharCP  stringP 
)
overridevirtual

Implements IHelpClient.

virtual bool _GetLocalHelpLocation ( WStringR  helpLocation,
WCharCP  productName,
int  release,
int  major,
int  minor 
)
overridevirtual

Implements IBrowserHelpClient.

virtual bool _GetOnlineHelpLocation ( WStringR  helpLocation,
int  productID,
int  releaseVersion,
int  majorVersion,
int  minorVersion,
int  subMinorVersion,
SignificantVersionFields  versionsignificantFields,
WStringCR  languageCode,
bool  forceQA 
)
overridevirtual

Implements IBrowserHelpClient.

virtual void _SetUriRoot ( WCharCP  uriRootP)
overridevirtual

Implements IBrowserHelpClient.

virtual void _ShowQuickStartPDF ( )
overridevirtual

Implements IHelpClient.


The documentation for this class was generated from the following file:

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