BrowserHelpClient.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <HelpSystem\IHelpClient.h>
#include <HelpSystem\IHelpClientHost.h>
#include <Bentley\WString.h>

#define FILE_PATH_BUFFER_SIZE   1024

BEGIN_BENTLEY_HELPSYSTEM_NAMESPACE

// Significant fields are important while mapping the product version with its online help publication
enum class SignificantVersionFields
    {
        OnlyFirstTwoFilelds= 0,
        OnlyFirstThreeFields,
        AllSignificantFields
    };

//=======================================================================================
//=======================================================================================
class IBrowserHelpClient : public IHelpClient
    {
    public:
        virtual ~IBrowserHelpClient() {}

        virtual void _SetUriRoot (WCharCP uriRootP) = 0;

        virtual bool _GetLocalHelpLocation (WStringR helpLocation, WCharCP productName, int release, int major, int minor) = 0;

        virtual bool _GetOnlineHelpLocation(WStringR helpLocation, int productID, int releaseVersion, int majorVersion, int minorVersion, int subMinor, SignificantVersionFields versionsignificantFields, 
                                            WStringCR languageCode, bool forceQA) = 0;
    };
//=======================================================================================
//=======================================================================================
class BrowserHelpClient : public IBrowserHelpClient
    {
    private:
        WString             m_uriRoot;
        WString             m_dbFilePath;

        IHelpClientHost*    m_host;

        int GenerateLocationString
            (
            WStringR        url,
            WCharCP         fileP,
            WCharCP         topicP,
            WCharCP         windowP
            );

        StatusInt LaunchURL
            (
            WCharCP         url
            );

        int LaunchPdfReader 
            (
            WCharCP         readerExeName,
            WCharCP         pdfDocName
            );

    public:
        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;

#if defined (BESQLITE_NOT_YET_USED)
        virtual void _DisplayFeature (WCharCP featureTrackingIDP) override;

        virtual void _SetDBFilePath (WCharCP dbFileStringP) override;
#endif

        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;        
    };     
END_BENTLEY_HELPSYSTEM_NAMESPACE