| AAX SDK 2.6.1 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 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
19/*================================================================================================*/
20
21
22#ifndef _AAX_IVIEWCONTAINER_H_
23#define _AAX_IVIEWCONTAINER_H_
24
25#include "AAX_GUITypes.h"
26#include "AAX.h"
27
28
37 class AAX_IViewContainer
38{
39 public:
40 virtual ~AAX_IViewContainer(void) {}
41
47 virtual int32_t GetType () = 0;
50 virtual void * GetPtr () = 0;
62 virtual AAX_Result GetModifiers ( uint32_t * outModifiers ) = 0;
64
77 virtual AAX_Result SetViewSize ( AAX_Point & inSize ) = 0;
79
111 virtual AAX_Result HandleParameterMouseDown ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
124 virtual AAX_Result HandleParameterMouseDrag ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
137 virtual AAX_Result HandleParameterMouseUp ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
138
148 virtual AAX_Result HandleParameterMouseEnter ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
149
159 virtual AAX_Result HandleParameterMouseExit( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
160
170 virtual AAX_Result HandleMultipleParametersMouseDown ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
185 virtual AAX_Result HandleMultipleParametersMouseDrag ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
200 virtual AAX_Result HandleMultipleParametersMouseUp ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
202};
203
204#endif
205
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:349
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_Point
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:39
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:38
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:40
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.