helpsys.h

Go to the documentation of this file.

// Copyright 2010 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.

#pragma once
#include "maxheap.h"
#include <WTypes.h>
#include "ifnpub.h"
#include "GetCOREInterface.h"
#include "contextids.h"

#define IID_IHelpSystem Interface_ID(0x3a4c02c3, 0x4980c58)

namespace MaxSDK {
class IHelpSystem : public FPStaticInterface
{
public:

    enum ProductHelpLocationType {
        OnlineHelp
        , LocalHelp
    };

    virtual ProductHelpLocationType ProductHelpLocation() const = 0;
    virtual void SeProducttHelpLocation( ProductHelpLocationType location = OnlineHelp ) = 0;

    virtual const MCHAR * LocalProductHelpPath() const = 0;
    virtual void SetLocalProductHelpPath( const MCHAR * path ) = 0;
    virtual const MCHAR * DefaultLocalProductHelpPath() const = 0;

    virtual void ShowProductHelp() const = 0;

    // \param contextId Can be one of the values defined in contextids.h
    virtual void ShowProductHelpForTopic( int contextId ) const = 0;

    // \remarks Reserved for internal use.
    // \param topic The topic string that to uniquely identify the desired topic.
    virtual void ShowProductHelpForTopic( const MCHAR * topic ) const = 0;

    // \param searchFor String to search for in Maxscript help. When searchFor is NULL the table of contents is shown.
    virtual void ShowMaxscriptHelp( const MCHAR * searchFor = NULL ) const = 0;

    // \param path Pointer to a path to a chm file. The chm file will be opened. Third party plug-in developpers can use this function to open a chm file.
    virtual void OpenChmFile( const MCHAR * path ) const = 0;

    static IHelpSystem * GetInstance() {
        return static_cast<IHelpSystem*>(GetCOREInterface(IID_IHelpSystem));
    }
};

}

//========= Deprecated ==============

#define DoHelp(cmd,data)
#pragma deprecated("DoHelp")

#define F1Focus(cmd,data)
#pragma deprecated("F1Focus")

#define F1Help()
#pragma deprecated("F1Help")

#define GetClickHelp()
#pragma deprecated("GetClickHelp")

class MAX_DEPRECATED HelpSys: public MaxHeapOperators {

public:
    HelpSys( );
    ~HelpSys( );
    void setClickHelp(int onOff);
    int getClickHelp( );
    HWND getHelpHWnd();
    void setHelpFocus(UINT uCommand, DWORD dwData);
    int doHelpFocus( );
    void setExportedFunctionPointers(void (*enableAcc)(), void (*disableAcc)(), BOOL (*accEnabled)());
    
};

MAX_DEPRECATED struct IDPair {
    DWORD CID;
    DWORD HID;
};

MAX_DEPRECATED DWORD CIDtoHID(int CID, IDPair *array);

MAX_DEPRECATED void SetDialogHelpIDs(HWND hDlg, IDPair *array);

MAX_DEPRECATED HWND GetHTMLHelpHWnd();

MAX_DEPRECATED void getHelpSys(void);