juce/source/src/audio/processors/juce_AudioProcessorEditor.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_AUDIOPROCESSOREDITOR_JUCEHEADER__
  27 #define __JUCE_AUDIOPROCESSOREDITOR_JUCEHEADER__
  28
  29 #include "../../gui/components/juce_Component.h"
  30 class AudioProcessor;
  31
  32
  33 //==============================================================================
  34 /**
  35     Base class for the component that acts as the GUI for an AudioProcessor.
  36
  37     Derive your editor component from this class, and create an instance of it
  38     by overriding the AudioProcessor::createEditor() method.
  39
  40     @see AudioProcessor, GenericAudioProcessorEditor
  41 */
  42 class JUCE_API  AudioProcessorEditor  : public Component
  43 {
  44 protected:
  45     //==============================================================================
  46     /** Creates an editor for the specified processor.
  47     */
  48     AudioProcessorEditor (AudioProcessor* owner);
  49
  50 public:
  51     /** Destructor. */
  52     ~AudioProcessorEditor();
  53
  54
  55     //==============================================================================
  56     /** Returns a pointer to the processor that this editor represents. */
  57     AudioProcessor* getAudioProcessor() const noexcept        { return owner; }
  58
  59
  60 private:
  61     //==============================================================================
  62     AudioProcessor* const owner;
  63
  64     JUCE_DECLARE_NON_COPYABLE (AudioProcessorEditor);
  65 };
  66
  67
  68 #endif   // __JUCE_AUDIOPROCESSOREDITOR_JUCEHEADER__