source/includes/vst3sdk/pluginterfaces/vst/ivstplugview.h

   1 //------------------------------------------------------------------------
   2 // Project     : VST SDK
   3 //
   4 // Category    : Interfaces
   5 // Filename    : pluginterfaces/vst/ivstplugview.h
   6 // Created by  : Steinberg, 01/2009
   7 // Description : Plug-in User Interface Extension
   8 //
   9 //-----------------------------------------------------------------------------
  10 // This file is part of a Steinberg SDK. It is subject to the license terms
  11 // in the LICENSE file found in the top-level directory of this distribution
  12 // and at www.steinberg.net/sdklicenses.
  13 // No part of the SDK, including this file, may be copied, modified, propagated,
  14 // or distributed except according to the terms contained in the LICENSE file.
  15 //-----------------------------------------------------------------------------
  16
  17 #pragma once
  18
  19 #include "pluginterfaces/base/funknown.h"
  20 #include "pluginterfaces/vst/vsttypes.h"
  21
  22 //------------------------------------------------------------------------
  23 #include "pluginterfaces/base/falignpush.h"
  24 //------------------------------------------------------------------------
  25
  26 //------------------------------------------------------------------------
  27 namespace Steinberg {
  28 namespace Vst {
  29 //------------------------------------------------------------------------
  30 // IParameterFinder Interface
  31 //------------------------------------------------------------------------
  32 /** Extension for IPlugView to find view parameters (lookup value under mouse support): Vst::IParameterFinder
  33 \ingroup pluginGUI vst302
  34 - [plug imp]
  35 - [extends IPlugView]
  36 - [released: 3.0.2]
  37 - [optional]
  38
  39 It is highly recommended to implement this interface.
  40 A host can implement important functionality when a plug-in supports this interface.
  41
  42 For example, all Steinberg hosts require this interface in order to support the "AI Knob".
  43 */
  44 class IParameterFinder: public FUnknown
  45 {
  46 public:
  47         //------------------------------------------------------------------------
  48         /** Find out which parameter in plug-in view is at given position (relative to plug-in view). */
  49         virtual tresult PLUGIN_API findParameter (int32 xPos, int32 yPos, ParamID& resultTag /*out*/) = 0;
  50         //------------------------------------------------------------------------
  51         static const FUID iid;
  52 };
  53
  54 DECLARE_CLASS_IID (IParameterFinder, 0x0F618302, 0x215D4587, 0xA512073C, 0x77B9D383)
  55
  56 //------------------------------------------------------------------------
  57 } // namespace Vst
  58 } // namespace Steinberg
  59
  60 //------------------------------------------------------------------------
  61 #include "pluginterfaces/base/falignpop.h"
  62 //------------------------------------------------------------------------