iplugview.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// Project     : SDK Core
// Version     : 1.0
//
// Category    : SDK GUI Interfaces
// Filename    : iplugview.h
// Created by  : Steinberg, 12/2007
// Modified    : $Date: 2008/01/15 16:00:24 $
// Description : Plug-In User Interface
//
//-----------------------------------------------------------------------------
// LICENSE
// © 2008, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// This Software Development Kit may not be distributed in parts or its entirety  
// without prior written agreement by Steinberg Media Technologies GmbH. 
// This SDK must not be used to re-engineer or manipulate any technology used  
// in any Steinberg or Third-party application or software module, 
// unless permitted by law.
// Neither the name of the Steinberg Media Technologies nor the names of its
// contributors may be used to endorse or promote products derived from this 
// software without specific prior written permission.
// 
// THIS SDK IS PROVIDED BY STEINBERG MEDIA TECHNOLOGIES GMBH "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL STEINBERG MEDIA TECHNOLOGIES GMBH BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//------------------------------------------------------------------------------

#ifndef __iplugview__
#define __iplugview__

#include "../base/funknown.h"

namespace Steinberg {

class IPlugFrame;

//------------------------------------------------------------------------
//------------------------------------------------------------------------
struct ViewRect
{
//------------------------------------------------------------------------
        ViewRect (int32 l = 0, int32 t = 0, int32 r = 0, int32 b = 0)
        : left (l), top (t), right (r), bottom (b) {}

        int32 left;
        int32 top;
        int32 right;
        int32 bottom;
//------------------------------------------------------------------------
        int32 getWidth () const { return right - left; }
        int32 getHeight () const { return bottom - top; }
//------------------------------------------------------------------------
};

//------------------------------------------------------------------------
const FIDString kPlatformTypeHWND = "HWND";                     

const FIDString kPlatformTypeHIView = "HIView";         

const FIDString kPlatformTypeNSView = "NSView";         

//------------------------------------------------------------------------

//------------------------------------------------------------------------
//------------------------------------------------------------------------
class IPlugView: public FUnknown
{
public:
//------------------------------------------------------------------------
        virtual tresult PLUGIN_API isPlatformTypeSupported (FIDString type) = 0;
        
        virtual tresult PLUGIN_API attached (void* parent, FIDString type) = 0;

        virtual tresult PLUGIN_API removed () = 0;

        virtual tresult PLUGIN_API onWheel (float distance) = 0;
        
        virtual tresult PLUGIN_API onKeyDown (char16 key, int16 keyCode, int16 modifiers) = 0;

        virtual tresult PLUGIN_API onKeyUp (char16 key, int16 keyCode, int16 modifiers) = 0;

        virtual tresult PLUGIN_API getSize (ViewRect* size) = 0;

        virtual tresult PLUGIN_API onSize (ViewRect* newSize) = 0;

        virtual tresult PLUGIN_API onFocus (TBool state) = 0;

        virtual tresult PLUGIN_API setFrame (IPlugFrame* frame) = 0;

        virtual tresult PLUGIN_API canResize () = 0;

        virtual tresult PLUGIN_API checkSizeConstraint (ViewRect* rect) = 0;
//------------------------------------------------------------------------
        static const FUID iid;
};

DECLARE_CLASS_IID (IPlugView, 0x5BC32507, 0xD06049EA, 0xA6151B52, 0x2B755B29)

//------------------------------------------------------------------------
//------------------------------------------------------------------------
class IPlugFrame: public FUnknown
{
public:
//------------------------------------------------------------------------
        virtual tresult PLUGIN_API resizeView (IPlugView* view, ViewRect* newSize) = 0;
//------------------------------------------------------------------------
        static const FUID iid;
};

DECLARE_CLASS_IID (IPlugFrame, 0x367FAF01, 0xAFA94693, 0x8D4DA2A0, 0xED0882A3)

} // namespace Steinberg

#endif __iplugview__

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.