IHelpClientHost.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>
#include <windows.h>

BEGIN_BENTLEY_HELPSYSTEM_NAMESPACE

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

        virtual HWND _GetHostWindowHandle () = 0;

        virtual HINSTANCE _GetHostInstance (HWND hWnd) = 0;

        virtual void _GetMacroExpansion 
            (
            WStringR        expansion, 
            WCharCP         expression, 
            bool            immediate, 
            bool            fmtExpansion
            ) = 0;

        virtual bool _IsMakeChildWindow () = 0;

        virtual bool _IsAggregrator () = 0;

        virtual int _GetDebugFile (WStringR value) = 0;

        virtual void _GetQuickStartGuidePath (WStringR path) = 0;

        virtual void _DebugPrintf
            (
            CharP           string,
            ...
            ) = 0;

        virtual void _DebugPrintfW
            (
            WCharCP         string,
            ...
            ) = 0;

    };
END_BENTLEY_HELPSYSTEM_NAMESPACE