AAX_VViewContainer Class Reference

#include <AAX_VViewContainer.h>

Inheritance diagram for AAX_VViewContainer:

Collaboration diagram for AAX_VViewContainer:

Description

Version-managed concrete AAX_IViewContainer class.

Public Member Functions
	AAX_VViewContainer (IACFUnknown *pUnknown)
virtual	~AAX_VViewContainer ()
virtual int32_t	GetType ()
	Returns the raw view type as one of AAX_EViewContainer_Type. More...
virtual void *	GetPtr ()
	Returns a pointer to the raw view. More...
virtual AAX_Result	GetModifiers (uint32_t *outModifiers)
	Queries the host for the current modifier keys. More...
virtual AAX_Result	SetViewSize (AAX_Point &inSize)
	Request a change to the main view size. More...
virtual AAX_Result	HandleParameterMouseDown (AAX_CParamID inParamID, uint32_t inModifiers)
	Alert the host to a mouse down event. More...
virtual AAX_Result	HandleParameterMouseDrag (AAX_CParamID inParamID, uint32_t inModifiers)
	Alert the host to a mouse drag event. More...
virtual AAX_Result	HandleParameterMouseUp (AAX_CParamID inParamID, uint32_t inModifiers)
	Alert the host to a mouse up event. More...
Public Member Functions inherited from AAX_IViewContainer
virtual	~AAX_IViewContainer (void)

Constructor & Destructor Documentation

AAX_VViewContainer::AAX_VViewContainer

(

IACFUnknown *

pUnknown

)

virtual AAX_VViewContainer::~AAX_VViewContainer ( )

virtual

Member Function Documentation

virtual int32_t AAX_VViewContainer::GetType ( )

virtual

Returns the raw view type as one of AAX_EViewContainer_Type.

Implements AAX_IViewContainer.

virtual void* AAX_VViewContainer::GetPtr ( )

virtual

Returns a pointer to the raw view.

Implements AAX_IViewContainer.

virtual AAX_Result AAX_VViewContainer::GetModifiers ( uint32_t *  oModifiers )

virtual

Queries the host for the current modifier keys.

This method returns a bit mask with bits set for each of the currently active modifier keys. This method does not return the state of the AAX_eModifiers_SecondaryButton.

Host Compatibility Notes:

Although this method allows plug-ins to acquire the current state of the Windows key (normally blocked by Pro Tools), plug-ins should not use key combinations that require this key.

Implements AAX_IViewContainer.

virtual AAX_Result AAX_VViewContainer::SetViewSize ( AAX_Point &  iSize )

virtual

Request a change to the main view size.

Note

• For compatibility with the smallest supported displays, plug-in GUI dimensions should not exceed 749x617 pixels, or 749x565 pixels for plug-ins with sidechain support.

Parameters

[in]

iSize

The new size to which the plug-in view should be set

Implements AAX_IViewContainer.

virtual AAX_Result AAX_VViewContainer::HandleParameterMouseDown ( AAX_CParamID  iParamID, uint32_t  iModifiers  )

virtual

Alert the host to a mouse down event.

Parameters

[in]	iParamID	ID of the parameter whose control is being edited
[in]	iModifiers	A bitmask of AAX_EModifiers values

Implements AAX_IViewContainer.

virtual AAX_Result AAX_VViewContainer::HandleParameterMouseDrag ( AAX_CParamID  iParamID, uint32_t  iModifiers  )

virtual

Alert the host to a mouse drag event.

Parameters

[in]	iParamID	ID of the parameter whose control is being edited
[in]	iModifiers	A bitmask of AAX_EModifiers values

Implements AAX_IViewContainer.

virtual AAX_Result AAX_VViewContainer::HandleParameterMouseUp ( AAX_CParamID  iParamID, uint32_t  iModifiers  )

virtual

Alert the host to a mouse up event.

Parameters

[in]	iParamID	ID of the parameter whose control is being edited
[in]	iModifiers	A bitmask of AAX_EModifiers values

Implements AAX_IViewContainer.

---

The documentation for this class was generated from the following file:

• AAX_VViewContainer.h