ipslhostcommands.h

Go to the documentation of this file.

//************************************************************************************************
//
// PreSonus Plug-In Extensions
// Written and placed in the PUBLIC DOMAIN by PreSonus Software Ltd.
//
// Filename    : ipslhostcommands.h
// Created by  : PreSonus Software Ltd., 11/2009
// Description : Host Command Interface
//
//************************************************************************************************
/*
        DISCLAIMER:
        The PreSonus Plug-In Extensions are host-specific extensions of existing proprietary technologies,
        provided to the community on an AS IS basis. They are not part of any official 3rd party SDK and
        PreSonus is not affiliated with the owner of the underlying technology in any way.
*/
//************************************************************************************************
 
#ifndef _ipslhostcommands_h
#define _ipslhostcommands_h
 
#include "pluginterfaces/vst/vsttypes.h"
#include "pluginterfaces/base/funknown.h"
#include "pluginterfaces/base/falignpush.h"
 
namespace Steinberg {
class IPlugView; }
 
namespace Presonus {
 
struct ICommandList;
 
//************************************************************************************************
// IHostCommandHandler
//************************************************************************************************
 
struct IHostCommandHandler: Steinberg::FUnknown
{
        virtual ICommandList* PLUGIN_API createParamCommands (Steinberg::Vst::ParamID tag) = 0;
        
        virtual Steinberg::tresult PLUGIN_API popupCommandMenu (ICommandList* commandList, Steinberg::int32 xPos, Steinberg::int32 yPos, Steinberg::IPlugView* view = 0) = 0;
 
        static const Steinberg::FUID iid;
};
 
DECLARE_CLASS_IID (IHostCommandHandler, 0xF92032CD, 0x7A84407C, 0xABE6F863, 0x058EA6C2)
 
//************************************************************************************************
// CommandInfo
//************************************************************************************************
 
struct CommandInfo
{
        Steinberg::Vst::String128 title;        
        Steinberg::int32 flags;                         
        
        enum CommandFlags
        {
                kCanExecute  = 1<<0,    
                kIsSeparator = 1<<1,    
                kIsChecked   = 1<<2             
        };
};
 
//************************************************************************************************
// ICommandList
//************************************************************************************************
 
struct ICommandList: Steinberg::FUnknown
{
        virtual Steinberg::int32 PLUGIN_API getCommandCount () = 0;
        
        virtual Steinberg::tresult PLUGIN_API getCommandInfo (Steinberg::int32 index, CommandInfo& info) = 0;
        
        virtual Steinberg::tresult PLUGIN_API executeCommand (Steinberg::int32 index) = 0;
 
        static const Steinberg::FUID iid;
};
 
DECLARE_CLASS_IID (ICommandList, 0xC5A687DB, 0x82F344E9, 0xB378254A, 0x47C4D712)
 
} // namespace Presonus
 
#include "pluginterfaces/base/falignpop.h"
 
#endif // _ipslhostcommands_h