Constructor.

Creates an IControl NOTE: An IControl does not know about the delegate or graphics context to which it belongs in the constructor If you need to do something once those things are known, see IControl::OnInit()

Parameters

bounds	The rectangular area that the control occupies
paramIdx	If this is > -1 (kNoParameter) this control will be associated with a plugin parameter
actionFunc	pass in a lambda function to provide custom functionality when the control "action" happens (usually mouse down).

Definition at line 83 of file IControl.cpp.

Constructor (range of parameters)

Creates an IControl which is linked to multiple parameters NOTE: An IControl does not know about the delegate or graphics context to which it belongs in the constructor If you need to do something once those things are known, see IControl::OnInit()

Parameters

bounds	The rectangular area that the control occupies
params	An initializer list of valid integer parameter indexes
actionFunc	pass in a lambda function to provide custom functionality when the control "action" happens (usually mouse down).

Definition at line 91 of file IControl.cpp.

Constructor (no paramIdx)

Creates an IControl which is not linked to a parameter NOTE: An IControl does not know about the delegate or graphics context to which it belongs in the constructor If you need to do something once those things are known, see IControl::OnInit()

Parameters

bounds	The rectangular area that the control occupies
actionFunc	pass in a lambda function to provide custom functionality when the control "action" happens (usually mouse down).

Definition at line 102 of file IControl.cpp.

Destructor.

Clean up any resources that your control owns.

Definition at line 81 of file IControl.h.

Disable/enable default prompt for user input.

Parameters

disable

Set true to disable prompt

Definition at line 420 of file IControl.h.

Draw the control to the graphics context.

Parameters

g	The graphics context to which this control belongs.

Implemented in IBubbleControl, IColorPickerControl, IVLabelControl, IVButtonControl, IVSwitchControl, IVSlideSwitchControl, IVTabSwitchControl, IVKnobControl, IVSliderControl, IVRangeSliderControl, IVXYPadControl, IVPlotControl, IVGroupControl, IVPanelControl, IVColorSwatchControl, ISVGKnobControl, ISVGButtonControl, ISVGToggleControl, ISVGSwitchControl, ISVGSliderControl, IBButtonControl, IBSwitchControl, IBKnobControl, IBKnobRotaterControl, IBSliderControl, IBTextControl, IBMeterControl, ICornerResizerControl, IFPSDisplayControl, ILEDControl, IPlatformViewControl, IPopupMenuControl, IShaderControl, ITextEntryControl, IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IVDisplayControl, IVKeyboardControl, IWheelControl, IVMeterControl< MAXNC >, IVMeterControl< MAXNC >, IVMeterControl< 1 >, IVMultiSliderControl< MAXNC >, IVMultiSliderControl< 1 >, IVNumberBoxControl, IVBakedPresetManagerControl, IVDiskPresetManagerControl, IVScopeControl< MAXNC, MAXBUF >, IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IVTabPage, IVTabbedPagesControl, IWebViewControl, ISkLottieControl, ISkParagraphControl, TestAnimationControl, TestArcControl, TestBezierControl, TestBlendControl, TestColorControl, TestCursorControl, TestCustomShaderControl, TestDirBrowseControl, TestDragAndDropControl, TestDrawContextControl, TestDropShadowControl, TestFlexBoxControl, TestFontControl, TestGesturesControl, GFXLabelControl, TestGradientControl, TestImageControl, TestKeyboardControl, TestLayerControl, TestMaskControl, TestMPSControl, TestMultiPathControl, TestMTControl, TestPolyControl, TestShadowGradientControl, TestSizeControl, TestSVGControl, TestTextControl, TestTextOrientationControl, TestTextSizeControl, IContainerBase, IPanelControl, ILambdaControl, IBitmapControl, ISVGControl, ITextControl, IMultiLineTextControl, IURLControl, ICaptionControl, PlaceHolder, and IGraphicsLiveEdit.

Implement this to customise how a colored highlight is drawn on the control in ProTools (AAX format only), when a control is linked to a parameter that is automated.

Parameters

g	The graphics context to which this control belongs.

Definition at line 389 of file IControl.cpp.

References IGraphics::FillCircle().

template<typename T , typename... Args>

A helper template function to call a method for an individual value, or for all values.

Parameters

valIdx	If this is > kNoValIdx execute the function for an individual value. If equal to kNoValIdx call the function for all values
func	A function that takes a single integer argument, the value index
args	Arguments to the function

Definition at line 532 of file IControl.h.

References NVals().

Referenced by SetDirty(), SetValueToDefault(), and SnapToMouse().

Get the control's action function, if it exists.

Definition at line 508 of file IControl.h.

Get the duration of animations applied to the control.

Definition at line 514 of file IControl.h.

Returns

true if the control ignores mouse events

Definition at line 384 of file IControl.h.

Returns

the last recognized gesture

Definition at line 449 of file IControl.h.

Get double click as single click By default, mouse double click has its own handler.

A control can set mDblAsSingleClick to true which maps double click to single click for this control (and also causes the mouse to be captured by the control on double click).

Returns

/c true if double clicks should be mapped to single clicks

Definition at line 353 of file IControl.h.

Referenced by IGraphics::OnMouseDblClick().

Returns

true if the control responds to other mouse events when disabled

Definition at line 381 of file IControl.h.

Returns

true if the control responds to mouse overs when disabled

Definition at line 378 of file IControl.h.

Get a const pointer to the IParam object (owned by the editor delegate class), associated with this control.

Returns

const pointer to an IParam or nullptr if the control is not associated with a parameter

Definition at line 122 of file IControl.cpp.

References IEditorDelegate::GetParam(), and GetParamIdx().

Referenced by ICaptionControl::Draw(), IVMenuButtonControl::IVMenuButtonControl(), IVSwitchControl::OnInit(), IVTabSwitchControl::OnInit(), IVKnobControl::OnInit(), IVSliderControl::OnInit(), IVNumberBoxControl::OnInit(), ISwitchControlBase::OnInit(), ITextEntryControl::OnKeyDown(), IVNumberBoxControl::OnMouseDown(), ISliderControlBase::OnMouseDown(), IKnobControlBase::OnMouseDrag(), ISliderControlBase::OnMouseDrag(), IVNumberBoxControl::OnMouseUp(), IKnobControlBase::OnMouseWheel(), ISliderControlBase::OnMouseWheel(), OnPopupMenuSelection(), ICaptionControl::OnResize(), IGraphics::PromptUserInput(), PromptUserInput(), IGraphics::SetControlValueAfterTextEdit(), IVSwitchControl::SetDirty(), IVKnobControl::SetDirty(), IVSliderControl::SetDirty(), IVTrackControlBase::SetParams(), IVMenuButtonControl::SetValueFromDelegate(), IVNumberBoxControl::SetValueFromDelegate(), IVMenuButtonControl::SetValueFromUserInput(), IVNumberBoxControl::SetValueFromUserInput(), SetValueToDefault(), ShowBubbleHorizontalActionFunc(), and ShowBubbleVerticalActionFunc().

Get the index of a parameter that the control is linked to Normaly controls are either linked to a single parameter or no parameter but some may be linked to multiple parameters.

Parameters

valIdx

An index to choose which of the control's linked parameters to retrieve. NOTE: since controls usually have only 1 parameter you can omit this argument and use the default index of 0

Returns

Parameter index, or kNoParameter if there is no parameter linked with this control at valIdx

Definition at line 109 of file IControl.cpp.

References NVals().

Referenced by IGraphics::CreateTextEntry(), GetParam(), IGraphics::GetParamIdxForPTAutomation(), ISwitchControlBase::OnInit(), IGraphics::OnMouseDown(), IVNumberBoxControl::OnMouseDown(), IGraphics::OnMouseUp(), IVNumberBoxControl::OnMouseUp(), OnPopupMenuSelection(), PromptUserInput(), IGEditorDelegate::SendParameterValueFromDelegate(), IGraphics::SetControlValueAfterPopupMenu(), SetDirty(), and IGraphics::UpdatePeers().

Get the rectangular draw area for this control, within the graphics context.

Returns

The control's bounds

Definition at line 316 of file IControl.h.

Referenced by IVNumberBoxControl::Draw(), IGraphicsLiveEdit::Draw(), IBitmapBase::DrawBitmap(), IGraphics::IsDirty(), IVNumberBoxControl::OnMouseDblClick(), IGraphicsLiveEdit::OnMouseDown(), IGraphicsLiveEdit::OnMouseDrag(), IGraphicsLiveEdit::OnMouseOver(), IGraphicsLiveEdit::OnMouseUp(), IVNumberBoxControl::OnResize(), ShowBubbleHorizontalActionFunc(), ShowBubbleVerticalActionFunc(), and IGraphics::StartLayer().

Get the rectangular mouse tracking target area, within the graphics context for this control.

Returns

The control's target bounds within the graphics context

Definition at line 324 of file IControl.h.

Referenced by IGraphicsLiveEdit::OnMouseDown().

Get the Text object for the control.

Returns

const IText& The control's mText object, typically used to determine font/layout/size etc of the main text in a control.

Definition at line 293 of file IControl.h.

Referenced by IGraphics::PromptUserInput().

Get the max number of characters that are allowed in text entry.

Returns

int The max number of characters allowed in text entry

Definition at line 308 of file IControl.h.

Referenced by IGraphics::CreateTextEntry().

Returns

Currently set tooltip text

Definition at line 224 of file IControl.h.

Returns

A const pointer to the IGraphics context that owns this control

Definition at line 475 of file IControl.h.

Get the control's value.

Returns

Value of the control, normalized in the range 0-1

Parameters

valIdx

The index of the value to set, which should be between 0 and NVals()

Definition at line 153 of file IControl.cpp.

References NVals().

Referenced by ISVGKnobControl::Draw(), ISVGButtonControl::Draw(), ISVGToggleControl::Draw(), ISVGSliderControl::Draw(), IBKnobRotaterControl::Draw(), ILEDControl::Draw(), IWheelControl::Draw(), TestArcControl::Draw(), TestBlendControl::Draw(), TestGradientControl::Draw(), TestLayerControl::Draw(), TestMultiPathControl::Draw(), TestPolyControl::Draw(), TestTextOrientationControl::Draw(), TestTextSizeControl::Draw(), IBitmapBase::DrawBitmap(), IVToggleControl::DrawValue(), IVButtonControl::DrawWidget(), IVToggleControl::DrawWidget(), IVKnobControl::DrawWidget(), IVSliderControl::DrawWidget(), IVRangeSliderControl::DrawWidget(), IVXYPadControl::DrawWidget(), IWheelControl::IWheelControl(), IBSwitchControl::OnMouseDown(), IVMultiSliderControl< MAXNC >::OnMouseDown(), IKnobControlBase::OnMouseDown(), ISliderControlBase::OnMouseDown(), ISwitchControlBase::OnMouseDown(), ITextToggleControl::OnMouseDown(), IVRangeSliderControl::OnMouseDrag(), IWheelControl::OnMouseUp(), IKnobControlBase::OnMouseWheel(), ISliderControlBase::OnMouseWheel(), ITextToggleControl::SetDirty(), SetDirty(), SetValueFromDelegate(), IVMenuButtonControl::SetValueFromUserInput(), SetValueFromUserInput(), IVMultiSliderControl< MAXNC >::SnapToMouse(), and IGraphics::UpdatePeers().

Returns

/c true if this control supports multiple touches

Definition at line 438 of file IControl.h.

Returns

true if the control is disabled

Definition at line 367 of file IControl.h.

Referenced by IVLabelControl::Draw(), IVKeyboardControl::Draw(), IGraphicsLiveEdit::Draw(), IVButtonControl::DrawWidget(), IVSwitchControl::DrawWidget(), IVToggleControl::DrawWidget(), IVTabSwitchControl::DrawWidget(), IVRadioButtonControl::DrawWidget(), IVNumberBoxControl::OnMouseDblClick(), IBMeterControl::OnMsgFromDelegate(), IRTTextControl< MAXNC, T >::OnMsgFromDelegate(), IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::OnMsgFromDelegate(), IVDisplayControl::OnMsgFromDelegate(), IVMeterControl< MAXNC >::OnMsgFromDelegate(), IVPeakAvgMeterControl< MAXNC >::OnMsgFromDelegate(), IVMultiSliderControl< MAXNC >::OnMsgFromDelegate(), IVScopeControl< MAXNC, MAXBUF >::OnMsgFromDelegate(), and IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::OnMsgFromDelegate().

Returns

The number of values for this control

Definition at line 244 of file IControl.h.

Referenced by IVRangeSliderControl::DrawWidget(), IVTrackControlBase::DrawWidget(), ForValIdx(), GetParamIdx(), IVTrackControlBase::GetValIdxForPos(), GetValue(), LinkedToParam(), IGraphics::OnMouseDown(), IVRangeSliderControl::OnMouseDrag(), IVRangeSliderControl::OnMouseOver(), IGraphics::OnMouseUp(), IGEditorDelegate::SendParameterValueFromDelegate(), IGraphics::SetControlValueAfterPopupMenu(), SetDirty(), SetParamIdx(), SetValue(), SetValueToDefault(), and IVMultiSliderControl< MAXNC >::SnapToMouse().

Called just prior to when the control is attached, after its delegate and graphics member variable set.

Reimplemented in IVSwitchControl, IVTabSwitchControl, IVKnobControl, IVSliderControl, IVGroupControl, IVNumberBoxControl, TestGesturesControl, ISwitchControlBase, ITextControl, and IGraphicsLiveEdit.

Definition at line 156 of file IControl.h.

Referenced by SetDelegate().

Implement this method to respond to a key up event on this control.

Parameters

x	The X coordinate of the mouse at the time of this key down event
y	The Y coordinate of the mouse at the time of this key down event
key	Info about the keypress

Definition at line 126 of file IControl.h.

Referenced by IGraphics::OnKeyUp().

Implement this method to respond to a mouse down event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in IAboutBoxControl, IColorPickerControl, IVTabSwitchControl, IVKnobControl, IVSliderControl, IVRangeSliderControl, IVXYPadControl, IVColorSwatchControl, IBSwitchControl, ICornerResizerControl, IFPSDisplayControl, IPlatformViewControl, IPopupMenuControl, IShaderControl, ITextEntryControl, IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IVKeyboardControl, IWheelControl, IVMultiSliderControl< MAXNC >, IVMultiSliderControl< 1 >, IVNumberBoxControl, IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, ISkLottieControl, TestAnimationControl, TestArcControl, TestBezierControl, TestCursorControl, TestDirBrowseControl, TestFlexBoxControl, TestFontControl, TestGradientControl, TestImageControl, TestKeyboardControl, TestLayerControl, TestMultiPathControl, TestMTControl, TestPolyControl, TestSVGControl, TestTextControl, TestTextOrientationControl, TestTextSizeControl, IKnobControlBase, ISliderControlBase, IButtonControlBase, ISwitchControlBase, ILambdaControl, IEditableTextControl, IURLControl, ITextToggleControl, ICaptionControl, and IGraphicsLiveEdit.

Definition at line 252 of file IControl.cpp.

References GetValIdxForPos(), and PromptUserInput().

Referenced by IGraphics::OnMouseDown(), IPopupMenuControl::OnMouseDown(), IKnobControlBase::OnMouseDown(), and ISliderControlBase::OnMouseDown().

Implement this method to respond to a mouse drag event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
dX	The X delta (difference) since the last event
dY	The Y delta (difference) since the last event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in IVRangeSliderControl, IVXYPadControl, IPopupMenuControl, IShaderControl, ITextEntryControl, IVKeyboardControl, IVMultiSliderControl< MAXNC >, IVMultiSliderControl< 1 >, IVNumberBoxControl, TestMTControl, TestTextOrientationControl, TestTextSizeControl, IKnobControlBase, ISliderControlBase, ILambdaControl, IGraphicsLiveEdit, and TestBezierControl.

Definition at line 101 of file IControl.h.

Referenced by IGraphics::OnMouseDrag().

Implement this method to respond to a mouseout event on this control.

Implementations should call base class, if you wish to use mMouseIsOver.

Reimplemented in IVSwitchControl, IVTabSwitchControl, IVKnobControl, IVSliderControl, IVRangeSliderControl, IVColorSwatchControl, ICornerResizerControl, IPopupMenuControl, IVKeyboardControl, TestCursorControl, IVTrackControlBase, and IURLControl.

Definition at line 275 of file IControl.cpp.

References mMouseIsOver, and SetDirty().

Referenced by IGraphics::OnMouseOut(), IVSwitchControl::OnMouseOut(), IVTabSwitchControl::OnMouseOut(), IVKnobControl::OnMouseOut(), IVSliderControl::OnMouseOut(), ICornerResizerControl::OnMouseOut(), TestCursorControl::OnMouseOut(), IURLControl::OnMouseOut(), and IGraphics::OnMouseOver().

Implement this method to respond to a mouseover event on this control.

Implementations should call base class, if you wish to use mMouseIsOver.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in IVTabSwitchControl, IVKnobControl, IVSliderControl, IVRangeSliderControl, IVColorSwatchControl, ICornerResizerControl, IPopupMenuControl, IVKeyboardControl, IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, TestBezierControl, IVTrackControlBase, IURLControl, and IGraphicsLiveEdit.

Definition at line 267 of file IControl.cpp.

References mMouseIsOver, and SetDirty().

Referenced by IGraphics::OnMouseOver(), IVTabSwitchControl::OnMouseOver(), IVKnobControl::OnMouseOver(), IVSliderControl::OnMouseOver(), ICornerResizerControl::OnMouseOver(), and IURLControl::OnMouseOver().

Implement this method to respond to a mouse up event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in IVKnobControl, IVSliderControl, IVRangeSliderControl, IVXYPadControl, IShaderControl, ITextEntryControl, IVKeyboardControl, IWheelControl, IVNumberBoxControl, TestArcControl, TestBezierControl, TestKeyboardControl, TestMTControl, TestPolyControl, TestTextOrientationControl, TestTextSizeControl, IKnobControlBase, ISliderControlBase, ISwitchControlBase, ILambdaControl, and IGraphicsLiveEdit.

Definition at line 93 of file IControl.h.

Referenced by IGraphics::OnMouseUp().

Implement to receive messages sent to the control, see IEditorDelegate:SendControlMsgFromDelegate()

Reimplemented in IBMeterControl, IRTTextControl< MAXNC, T >, IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IVDisplayControl, IVMeterControl< MAXNC >, IVMeterControl< MAXNC >, IVMeterControl< 1 >, IVPeakAvgMeterControl< MAXNC >, IVPeakAvgMeterControl< 1 >, IVMultiSliderControl< MAXNC >, IVMultiSliderControl< 1 >, IVScopeControl< MAXNC, MAXBUF >, and IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >.

Definition at line 162 of file IControl.h.

Referenced by IGEditorDelegate::SendControlMsgFromDelegate().

Implement this method to handle popup menu selection after IGraphics::CreatePopupMenu/IControlPromptUserInput.

Parameters

pSelectedMenu	If pSelectedMenu is invalid it means the user didn't select anything
valIdx	An index that indicates which of the control's vals the menu relates to

Reimplemented in TestDirBrowseControl, IVMenuButtonControl, IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IVBakedPresetManagerControl, IVDiskPresetManagerControl, IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IGraphicsLiveEdit, IWheelControl, and TestFlexBoxControl.

Definition at line 283 of file IControl.cpp.

References GetParam(), GetParamIdx(), and SetValueFromUserInput().

Referenced by IVMenuButtonControl::OnPopupMenuSelection(), and IGraphics::SetControlValueAfterPopupMenu().

Implement to do something when graphics is scaled globally (e.g.

moves to different DPI screen)

Reimplemented in IBButtonControl, IBSwitchControl, IBKnobControl, IBSliderControl, IBTextControl, IBMeterControl, ICornerResizerControl, IPlatformViewControl, IWebViewControl, TestSizeControl, and IBitmapControl.

Definition at line 150 of file IControl.h.

Referenced by SetDelegate(), and IGraphics::SetScreenScale().

Called when IControl is constructed or resized using SetRect().

NOTE: if you call SetDirty() in this method, you should call SetDirty(false) to avoid triggering parameter changes

Reimplemented in IVButtonControl, IVSwitchControl, IVSlideSwitchControl, IVTabSwitchControl, IVKnobControl, IVSliderControl, IVXYPadControl, IVPlotControl, IVGroupControl, IVPanelControl, IVColorSwatchControl, ISVGSliderControl, IBSliderControl, IPlatformViewControl, IShaderControl, IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IVDisplayControl, IVKeyboardControl, IVNumberBoxControl, IVBakedPresetManagerControl, IVDiskPresetManagerControl, IVScopeControl< MAXNC, MAXBUF >, IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >, IVTabbedPagesControl, IWebViewControl, TestColorControl, TestDirBrowseControl, TestFlexBoxControl, TestGradientControl, TestSizeControl, IContainerBase, ISliderControlBase, IVTrackControlBase, ICaptionControl, PlaceHolder, and IGraphicsLiveEdit.

Definition at line 153 of file IControl.h.

Referenced by IGraphics::Resize(), SetDelegate(), SetRECT(), and SetTargetAndDrawRECTs().

Implement this method to respond to a touch cancel event on this control.

Parameters

x	The X coordinate of the mouse event
y	The Y coordinate of the mouse event
mod	A struct indicating which modifier keys are held for the event

Reimplemented in IVKeyboardControl, and TestMTControl.

Definition at line 141 of file IControl.h.

Referenced by IGraphics::OnTouchCancelled().

Create a text entry box so the user can enter a value, or pop up a pop-up menu, if the control is linked to a parameter (mParamIdx > kNoParameter) specifying the bounds.

Parameters

bounds	The rectangle for the text entry. Pop-up menu's will appear below the rectangle.
valIdx	An index to choose which of the control's linked parameters to retrieve. NOTE: since controls usually have only 1 parameter you can omit this argument and use the default index of 0

Definition at line 357 of file IControl.cpp.

References GetParamIdx(), GetUI(), and IGraphics::PromptUserInput().

Call this method in response to a mouse event to create an edit box so the user can enter a value, or pop up a pop-up menu, if the control is linked to a parameter (mParamIdx > kNoParameter)

Parameters

valIdx

An index to choose which of the control's linked parameters to retrieve. NOTE: since controls usually have only 1 parameter you can omit this argument and use the default index of 0

Definition at line 334 of file IControl.cpp.

References GetParam(), GetParamIdx(), GetUI(), IRECT::MH(), IRECT::MW(), IGraphics::PromptUserInput(), and SetDirty().

Referenced by IVMenuButtonControl::IVMenuButtonControl(), OnMouseDblClick(), IVKnobControl::OnMouseDblClick(), IVSliderControl::OnMouseDblClick(), OnMouseDown(), IVKnobControl::OnMouseDown(), IVSliderControl::OnMouseDown(), and ICaptionControl::OnMouseDown().

Set the animation function and starts it.

Parameters

func	A std::function conforming to IAnimationFunction
duration	Duration in milliseconds for the animation

Definition at line 502 of file IControl.h.

References StartAnimation().

Set the Blend for this control.

This can be used differently by different controls, or not at all. By default it is used to change the opacity of controls when they are disabled

Definition at line 301 of file IControl.h.

Mark the control as dirty, i.e.

it should be redrawn on the next display refresh

Parameters

triggerAction

If this is true and the control is linked to a parameter notify the class implementing the IEditorDelegate interface that the parameter changed. If this control has an ActionFunction, that can also be triggered. NOTE: it is easy to forget that this method always sets the control dirty, the argument refers to whether a consecutive action should be performed

Reimplemented in ITextToggleControl, IVSwitchControl, IVSlideSwitchControl, IVKnobControl, and IVSliderControl.

Definition at line 198 of file IControl.cpp.

References Clip(), ForValIdx(), GetDelegate(), GetParamIdx(), GetUI(), GetValue(), NVals(), IEditorDelegate::SendParameterValueFromUI(), SetValue(), and IGraphics::UpdatePeers().

Referenced by IVPlotControl::AddPlotFunc(), IPopupMenuControl::CalculateMenuPanels(), IGraphics::CreateTextEntry(), Hide(), IBubbleControl::IBubbleControl(), TestDragAndDropControl::OnDrop(), TestDropShadowControl::OnDrop(), TestSVGControl::OnDrop(), TestDragAndDropControl::OnDropMultiple(), TestGesturesControl::OnInit(), IVKeyboardControl::OnMidi(), IWheelControl::OnMidi(), TestTextControl::OnMouseDblClick(), IVTabSwitchControl::OnMouseDown(), IBSwitchControl::OnMouseDown(), IVKeyboardControl::OnMouseDown(), IVMultiSliderControl< MAXNC >::OnMouseDown(), ISkLottieControl::OnMouseDown(), TestAnimationControl::OnMouseDown(), TestCursorControl::OnMouseDown(), TestDirBrowseControl::OnMouseDown(), TestFontControl::OnMouseDown(), TestGradientControl::OnMouseDown(), TestLayerControl::OnMouseDown(), TestMultiPathControl::OnMouseDown(), TestSVGControl::OnMouseDown(), TestTextControl::OnMouseDown(), IButtonControlBase::OnMouseDown(), ISwitchControlBase::OnMouseDown(), IVXYPadControl::OnMouseDrag(), IPopupMenuControl::OnMouseDrag(), IShaderControl::OnMouseDrag(), IVKeyboardControl::OnMouseDrag(), TestMTControl::OnMouseDrag(), IKnobControlBase::OnMouseDrag(), ISliderControlBase::OnMouseDrag(), ILambdaControl::OnMouseDrag(), TestBezierControl::OnMouseDrag(), OnMouseOut(), IVTabSwitchControl::OnMouseOut(), IVColorSwatchControl::OnMouseOut(), IVKeyboardControl::OnMouseOut(), IVTrackControlBase::OnMouseOut(), OnMouseOver(), IVTabSwitchControl::OnMouseOver(), IVRangeSliderControl::OnMouseOver(), IVColorSwatchControl::OnMouseOver(), IPopupMenuControl::OnMouseOver(), IVKeyboardControl::OnMouseOver(), TestBezierControl::OnMouseOver(), IVTrackControlBase::OnMouseOver(), IVXYPadControl::OnMouseUp(), IShaderControl::OnMouseUp(), ITextEntryControl::OnMouseUp(), IVKeyboardControl::OnMouseUp(), IVNumberBoxControl::OnMouseUp(), TestMTControl::OnMouseUp(), TestTextOrientationControl::OnMouseUp(), TestTextSizeControl::OnMouseUp(), IKnobControlBase::OnMouseUp(), ISliderControlBase::OnMouseUp(), ISwitchControlBase::OnMouseUp(), ILambdaControl::OnMouseUp(), IKnobControlBase::OnMouseWheel(), ISliderControlBase::OnMouseWheel(), IBMeterControl::OnMsgFromDelegate(), IRTTextControl< MAXNC, T >::OnMsgFromDelegate(), IVDisplayControl::OnMsgFromDelegate(), IVMeterControl< MAXNC >::OnMsgFromDelegate(), IVPeakAvgMeterControl< MAXNC >::OnMsgFromDelegate(), IVScopeControl< MAXNC, MAXBUF >::OnMsgFromDelegate(), TestDirBrowseControl::OnPopupMenuSelection(), TestFlexBoxControl::OnPopupMenuSelection(), IVButtonControl::OnResize(), IVTabSwitchControl::OnResize(), IVXYPadControl::OnResize(), IVPlotControl::OnResize(), IVGroupControl::OnResize(), IVColorSwatchControl::OnResize(), ISVGSliderControl::OnResize(), IBSliderControl::OnResize(), IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::OnResize(), IVDisplayControl::OnResize(), IVKeyboardControl::OnResize(), IVScopeControl< MAXNC, MAXBUF >::OnResize(), IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::OnResize(), ISliderControlBase::OnResize(), IVTrackControlBase::OnResize(), IEditableTextControl::OnTextEntryCompletion(), IVKeyboardControl::OnTouchCancelled(), PromptUserInput(), IGraphics::SetAllControlsDirty(), IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::SetBarPattern(), IURLControl::SetCLColor(), IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::SetClipIndicator(), IVectorBase::SetColor(), ITextToggleControl::SetDirty(), IVSwitchControl::SetDirty(), IVKnobControl::SetDirty(), IVSliderControl::SetDirty(), SetDisabled(), IURLControl::SetMOColor(), SetParamIdx(), SetPTParameterHighlight(), ITextControl::SetStr(), ITextControl::SetStrFmt(), SetValueFromDelegate(), IVMenuButtonControl::SetValueFromUserInput(), SetValueFromUserInput(), SetValueToDefault(), SnapToMouse(), IVMultiSliderControl< MAXNC >::SnapToMouse(), and SplashAnimationFunc().

Assign the control to a control group.

See also

Control Groups

Parameters

groupName

A CString indicating the control group that this control should belong to

Definition at line 285 of file IControl.h.

References mGroup.

Referenced by IGraphics::AttachControl().

Specify whether the control should respond to mouse events.

Parameters

ignore

true if it should ignore mouse events

Reimplemented in IWebViewControl.

Definition at line 388 of file IControl.h.

Specify whether the control should respond to other mouse events when disabled.

Parameters

allow

true if it should respond to other mouse events when disabled (false by default)

Definition at line 375 of file IControl.h.

Specify whether the control should respond to mouse overs when disabled.

Parameters

allow

true if it should respond to mouse overs when disabled (false by default)

Definition at line 371 of file IControl.h.

Set if the control should show parameter labels/units e.g.

"Hz" in text entry prompts

Definition at line 394 of file IControl.h.

Used internally by the AAX wrapper view interface to set the control parmeter highlight.

Parameters

isHighlighted	/c true if the control should be highlighted
color	An integer representing one of three colors that ProTools assigns automated controls

Definition at line 365 of file IControl.cpp.

References SetDirty().

Referenced by IGraphics::SetPTParameterHighlight().

Set the size of the control, preserving the current position.

This may need to be overriden if you maintain custom positioning data in your control, or if your TargetRECT is not the same as the main RECT.

Parameters

w	the new width of the control
h	the new height of the control

Definition at line 303 of file IControl.cpp.

References SetTargetAndDrawRECTs().

Referenced by IGraphics::SetControlSize().

Set BOTH the draw rect and the target area, within the graphics context for this control.

Parameters

bounds

The control's new draw and target bounds within the graphics context

Definition at line 332 of file IControl.h.

References mMouseIsOver, and OnResize().

Referenced by IVMenuButtonControl::IVMenuButtonControl(), IVTabbedPagesControl::OnAttached(), ICornerResizerControl::OnRescale(), IVNumberBoxControl::OnResize(), IVBakedPresetManagerControl::OnResize(), IVDiskPresetManagerControl::OnResize(), IVTabbedPagesControl::OnResize(), IBubbleControl::ResetBounds(), ITextControl::SetBoundsBasedOnStr(), IGraphics::SetControlBounds(), and SetSize().

Set the rectangular mouse tracking target area, within the graphics context for this control.

Parameters

bounds

The control's new target bounds within the graphics context

Definition at line 328 of file IControl.h.

References mMouseIsOver.

Referenced by IPopupMenuControl::CalculateMenuPanels(), IGraphicsLiveEdit::OnMouseUp(), IVButtonControl::OnResize(), IVSwitchControl::OnResize(), IVTabSwitchControl::OnResize(), IVKnobControl::OnResize(), IVSliderControl::OnResize(), IVXYPadControl::OnResize(), IVPlotControl::OnResize(), IVGroupControl::OnResize(), IVPanelControl::OnResize(), IVColorSwatchControl::OnResize(), IVBarGraphSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::OnResize(), IVDisplayControl::OnResize(), IVNumberBoxControl::OnResize(), IVScopeControl< MAXNC, MAXBUF >::OnResize(), IVSpectrumAnalyzerControl< MAXNC, MAX_FFT_SIZE >::OnResize(), IVTabbedPagesControl::OnResize(), ISliderControlBase::OnResize(), IVTrackControlBase::OnResize(), IGraphicsLiveEdit::OnResize(), and SetPosition().

Set the Text object typically used to determine font/layout/size etc of the main text in a control.

Parameters

txt	An IText struct with the desired formatting

Reimplemented in IURLControl.

Definition at line 297 of file IControl.h.

Set the max number of characters that are allowed in text entry.

Parameters

len	The max number of characters allowed in text entry

Definition at line 312 of file IControl.h.

Set a tooltip for the control.

Parameters

str	CString tooltip to be displayed

Returns

Ptr to this control, for chaining

Definition at line 221 of file IControl.h.

Set one of the control's values.

Parameters

value	The normalized 0-1 value
valIdx	The index of the value to set, which should be between 0 and NVals()

Definition at line 147 of file IControl.cpp.

References NVals().

Referenced by IVSlideSwitchControl::IVSlideSwitchControl(), IWheelControl::IWheelControl(), IWheelControl::OnMidi(), IVTabSwitchControl::OnMouseDown(), IBSwitchControl::OnMouseDown(), IVMultiSliderControl< MAXNC >::OnMouseDown(), IButtonControlBase::OnMouseDown(), ISwitchControlBase::OnMouseDown(), ITextToggleControl::OnMouseDown(), IVXYPadControl::OnMouseDrag(), IKnobControlBase::OnMouseDrag(), ISliderControlBase::OnMouseDrag(), IWheelControl::OnMouseUp(), IKnobControlBase::OnMouseWheel(), ISliderControlBase::OnMouseWheel(), IBMeterControl::OnMsgFromDelegate(), IVMeterControl< MAXNC >::OnMsgFromDelegate(), IVPeakAvgMeterControl< MAXNC >::OnMsgFromDelegate(), SetDirty(), SetValueFromDelegate(), IVMenuButtonControl::SetValueFromUserInput(), SetValueFromUserInput(), SetValueToDefault(), SnapToMouse(), and IVMultiSliderControl< MAXNC >::SnapToMouse().

Set one or all of the control's values to the default value of the associated parameter.

Parameters

valIdx

either an integer > -1 (kNoValIdx) in order to set an individual value to the default value of the associated parameter, or kNoValIdx to default all values This method will call through to SetDirty(true, valIdx), which will mean that the new value gets sent back to the delegate

Definition at line 183 of file IControl.cpp.

References ForValIdx(), IParam::GetDefault(), GetParam(), NVals(), SetDirty(), and SetValue().

Referenced by OnMouseDblClick(), IVKnobControl::OnMouseDblClick(), and IVSliderControl::OnMouseDblClick().

Specify whether this control supports multiple touches.

Definition at line 435 of file IControl.h.

Set control value based on x, y position within a rectangle.

Commonly used for slider/fader controls.

Parameters

x	The X coordinate for snapping
y	The Y coordinate for snapping
direction	The direction of the control's travel- horizontal or vertical fader
bounds	The area in which the track of e.g. a slider should be snapped
valIdx	The value that the current mouse gesture should snap

Reimplemented in IVMultiSliderControl< MAXNC >, and IVMultiSliderControl< 1 >.

Definition at line 397 of file IControl.cpp.

References Clip(), IRECT::Constrain(), ForValIdx(), IRECT::H(), SetDirty(), SetValue(), and IRECT::W().

Referenced by ISliderControlBase::OnMouseDown(), IVRangeSliderControl::OnMouseDrag(), and ISliderControlBase::OnMouseDrag().

if mGraphics::mHandleMouseOver = true, this will be true when the mouse is over control.

If you need finer grained control of mouseovers, you can override OnMouseOver() and OnMouseOut()

Definition at line 565 of file IControl.h.

Referenced by IVPanelControl::Draw(), ISVGButtonControl::Draw(), ISVGToggleControl::Draw(), IVNumberBoxControl::Draw(), TestAnimationControl::Draw(), TestCursorControl::Draw(), TestDirBrowseControl::Draw(), TestDragAndDropControl::Draw(), TestImageControl::Draw(), TestSVGControl::Draw(), IURLControl::Draw(), ICaptionControl::Draw(), IVButtonControl::DrawWidget(), IVSwitchControl::DrawWidget(), IVToggleControl::DrawWidget(), GetMouseIsOver(), OnMouseOut(), OnMouseOver(), SetRECT(), SetTargetAndDrawRECTs(), and SetTargetRECT().