AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IViewContainer.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2017 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
22 /*================================================================================================*/
23 
24 
25 #ifndef _AAX_IVIEWCONTAINER_H_
26 #define _AAX_IVIEWCONTAINER_H_
27 
28 #include "AAX_GUITypes.h"
29 #include "AAX.h"
30 
31 
41 {
42 public:
43  virtual ~AAX_IViewContainer(void) {}
44 
50  virtual int32_t GetType () = 0;
53  virtual void * GetPtr () = 0;
65  virtual AAX_Result GetModifiers ( uint32_t * outModifiers ) = 0;
67 
80  virtual AAX_Result SetViewSize ( AAX_Point & inSize ) = 0;
82 
114  virtual AAX_Result HandleParameterMouseDown ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
127  virtual AAX_Result HandleParameterMouseDrag ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
140  virtual AAX_Result HandleParameterMouseUp ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
150  virtual AAX_Result HandleMultipleParametersMouseDown ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
165  virtual AAX_Result HandleMultipleParametersMouseDrag ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
180  virtual AAX_Result HandleMultipleParametersMouseUp ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
182 };
183 
184 #endif
185 
Various utility definitions for AAX.
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:352
int32_t AAX_Result
Definition: AAX.h:337
Constants and other definitions used by AAX plug-in GUIs.
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:42
Interface for the AAX host's view of a single instance of an effect. Used both by clients of the AAX ...
Definition: AAX_IViewContainer.h:41
virtual int32_t GetType()=0
Returns the raw view type as one of AAX_EViewContainer_Type.
virtual AAX_Result HandleParameterMouseUp(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse up event.
virtual AAX_Result HandleMultipleParametersMouseDrag(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse drag event.
virtual AAX_Result HandleParameterMouseDown(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse down event.
virtual AAX_Result HandleParameterMouseDrag(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse drag event.
virtual AAX_Result GetModifiers(uint32_t *outModifiers)=0
Queries the host for the current modifier keys.
virtual AAX_Result SetViewSize(AAX_Point &inSize)=0
Request a change to the main view size.
virtual void * GetPtr()=0
Returns a pointer to the raw view.
virtual AAX_Result HandleMultipleParametersMouseUp(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse up event.
virtual AAX_Result HandleMultipleParametersMouseDown(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse down event.
virtual ~AAX_IViewContainer(void)
Definition: AAX_IViewContainer.h:43