| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_IViewContainer.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019, 2021, 2023-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 *
24 */
25
32/*================================================================================================*/
33
34
35#ifndef _AAX_IVIEWCONTAINER_H_
36#define _AAX_IVIEWCONTAINER_H_
37
38#include "AAX_GUITypes.h"
39#include "AAX.h"
40
41
50 class AAX_IViewContainer
51{
52 public:
53 virtual ~AAX_IViewContainer(void) {}
54
60 virtual int32_t GetType () = 0;
63 virtual void * GetPtr () = 0;
75 virtual AAX_Result GetModifiers ( uint32_t * outModifiers ) = 0;
77
90 virtual AAX_Result SetViewSize ( AAX_Point & inSize ) = 0;
92
124 virtual AAX_Result HandleParameterMouseDown ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
137 virtual AAX_Result HandleParameterMouseDrag ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
150 virtual AAX_Result HandleParameterMouseUp ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
151
161 virtual AAX_Result HandleParameterMouseEnter ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
162
172 virtual AAX_Result HandleParameterMouseExit( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
173
183 virtual AAX_Result HandleMultipleParametersMouseDown ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
198 virtual AAX_Result HandleMultipleParametersMouseDrag ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
213 virtual AAX_Result HandleMultipleParametersMouseUp ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
215};
216
217#endif
218
AAX_GUITypes.h
Constants and other definitions used by AAX plug-in GUIs.
AAX.h
Various utility definitions for AAX.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:362
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_Point
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:52
AAX_IViewContainer
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:51
AAX_IViewContainer::GetType
virtual int32_t GetType()=0
Returns the raw view type as one of AAX_EViewContainer_Type.
AAX_IViewContainer::GetPtr
virtual void * GetPtr()=0
Returns a pointer to the raw view.
AAX_IViewContainer::HandleParameterMouseUp
virtual AAX_Result HandleParameterMouseUp(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse up event.
AAX_IViewContainer::HandleMultipleParametersMouseDrag
virtual AAX_Result HandleMultipleParametersMouseDrag(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse drag event.
AAX_IViewContainer::HandleParameterMouseDown
virtual AAX_Result HandleParameterMouseDown(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse down event.
AAX_IViewContainer::HandleParameterMouseDrag
virtual AAX_Result HandleParameterMouseDrag(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse drag event.
AAX_IViewContainer::HandleParameterMouseEnter
virtual AAX_Result HandleParameterMouseEnter(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse enter event to the parameter's control.
AAX_IViewContainer::GetModifiers
virtual AAX_Result GetModifiers(uint32_t *outModifiers)=0
Queries the host for the current modifier keys.
AAX_IViewContainer::SetViewSize
virtual AAX_Result SetViewSize(AAX_Point &inSize)=0
Request a change to the main view size.
AAX_IViewContainer::HandleMultipleParametersMouseUp
virtual AAX_Result HandleMultipleParametersMouseUp(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse up event.
AAX_IViewContainer::HandleMultipleParametersMouseDown
virtual AAX_Result HandleMultipleParametersMouseDown(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse down event.
AAX_IViewContainer::~AAX_IViewContainer
virtual ~AAX_IViewContainer(void)
Definition: AAX_IViewContainer.h:53
AAX_IViewContainer::HandleParameterMouseExit
virtual AAX_Result HandleParameterMouseExit(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse exit event from the parameter's control.