IHelpClient.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 <Bentley\Bentley.h>
#include <HelpSystem\HelpSystem.h>

BEGIN_BENTLEY_HELPSYSTEM_NAMESPACE

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

        virtual void _DisplayTopic 
            (
            WCharCP         windowNameP,
            WCharCP         stringP
            ) = 0;

        virtual void _DisplayALink 
            (
            WCharCP         windowNameP,
            WCharCP         stringP
            ) = 0;

        virtual void _DisplayToolIndex 
            (
            WCharCP         windowNameP,
            WCharCP         indexNameP,
            WCharCP         stringP
            ) = 0;

        virtual void _DisplayIndex 
            (
            WCharCP         windowNameP,
            WCharCP         stringP
            ) = 0;

        virtual void _DisplayContents 
            (
            WCharCP         windowNameP,
            WCharCP         topicP
            ) = 0;

        virtual void _DisplaySearch 
            (
            WCharCP         windowNameP,
            WCharCP         stringP
            ) = 0;

        virtual void _CloseAll () = 0;

        virtual void _Cleanup () = 0;

        virtual void _ShowQuickStartPDF () = 0;

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

        virtual void _SetDBFilePath 
            (
            WCharCP         dbFileStringP
            ) = 0;
#endif

    };
END_BENTLEY_HELPSYSTEM_NAMESPACE