Base class for the component that acts as the GUI for an AudioProcessor. More...

Inheritance diagram for AudioProcessorEditor:

Classes

struct  ParameterControlHighlightInfo
 Used by the setParameterHighlighting() method. More...
 

Public Member Functions

 ~AudioProcessorEditor ()
 Destructor. More...
 
AudioProcessorgetAudioProcessor () const noexcept
 Returns a pointer to the processor that this editor represents. More...
 
virtual void setControlHighlight (ParameterControlHighlightInfo)
 Some types of plugin can call this to suggest that the control for a particular parameter should be highlighted. More...
 
virtual int getControlParameterIndex (Component &)
 Called by certain plug-in wrappers to find out whether a component is used to control a parameter. More...
 
virtual bool supportsHostMIDIControllerPresence (bool hostMIDIControllerIsAvailable)
 Override this method to indicate if your editor supports the presence or absence of a host-provided MIDI controller. More...
 
virtual void hostMIDIControllerIsAvailable (bool controllerIsAvailable)
 Called to indicate if a host is providing a MIDI controller when the host reconfigures its layout. More...
 
virtual void setScaleFactor (float newScale)
 Can be called by a host to tell the editor that it should use a non-unity GUI scale. More...
 
void setResizable (bool allowHostToResize, bool useBottomRightCornerResizer)
 Marks the host's editor window as resizable. More...
 
bool isResizable () const noexcept
 Returns true if the host is allowed to resize editor's parent window. More...
 
void setResizeLimits (int newMinimumWidth, int newMinimumHeight, int newMaximumWidth, int newMaximumHeight) noexcept
 This sets the maximum and minimum sizes for the window. More...
 
ComponentBoundsConstrainergetConstrainer () noexcept
 Returns the bounds constrainer object that this window is using. More...
 
void setConstrainer (ComponentBoundsConstrainer *newConstrainer)
 Sets the bounds-constrainer object to use for resizing and dragging this window. More...
 
void setBoundsConstrained (Rectangle< int > newBounds)
 Calls the window's setBounds method, after first checking these bounds with the current constrainer. More...
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component. More...
 
virtual ~Component ()
 Destructor. More...
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time. More...
 
const StringgetName () const noexcept
 Returns the name of this component. More...
 
virtual void setName (const String &newName)
 Sets the name of this component. More...
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID(). More...
 
void setComponentID (const String &newID)
 Sets the component's ID string. More...
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible. More...
 
bool isVisible () const noexcept
 Tests whether the component is visible or not. More...
 
virtual void visibilityChanged ()
 Called when this component's visibility changes. More...
 
bool isShowing () const
 Tests whether this component and all its parents are visible. More...
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop. More...
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it. More...
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop. More...
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component. More...
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window. More...
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised. More...
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop. More...
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings. More...
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings. More...
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component. More...
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings. More...
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings. More...
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge. More...
 
int getY () const noexcept
 Returns the y coordinate of the top of this component. More...
 
int getWidth () const noexcept
 Returns the component's width in pixels. More...
 
int getHeight () const noexcept
 Returns the component's height in pixels. More...
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge. More...
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point. More...
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component. More...
 
Rectangle< int > getBounds () const noexcept
 Returns this component's bounding box. More...
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin. More...
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers. More...
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin. More...
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin. More...
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left. More...
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left. More...
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space. More...
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space. More...
 
Rectangle< int > getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space. More...
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate. More...
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate. More...
 
Rectangle< int > localAreaToGlobal (Rectangle< int > localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate. More...
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position. More...
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position. More...
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position. More...
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component. More...
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size. More...
 
void setBounds (Rectangle< int > newBounds)
 Changes the component's position and size. More...
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size. More...
 
void setBoundsInset (BorderSize< int > borders)
 Changes the component's position and size based on the amount of space to leave around it. More...
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged. More...
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre. More...
 
void setCentrePosition (Point< int > newCentrePosition)
 Changes the position of the component's centre. More...
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre. More...
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent. More...
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component. More...
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component. More...
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component. More...
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width. More...
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height. More...
 
int getParentWidth () const noexcept
 Returns the width of the component's parent. More...
 
int getParentHeight () const noexcept
 Returns the height of the component's parent. More...
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component. More...
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains. More...
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index. More...
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components. More...
 
const Array< Component * > & getChildren () const noexcept
 Provides access to the underlying array of child components. More...
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID. More...
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one. More...
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one. More...
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already. More...
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already. More...
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID. More...
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components. More...
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index. More...
 
void removeAllChildren ()
 Removes all this component's children. More...
 
void deleteAllChildren ()
 Removes and deletes all of this component's children. More...
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside. More...
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class. More...
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents. More...
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children. More...
 
virtual void parentHierarchyChanged ()
 Called to indicate that the component's parents have changed. More...
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes. More...
 
virtual bool hitTest (int x, int y)
 Tests whether a given point is inside the component. More...
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method. More...
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags. More...
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children. More...
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account. More...
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one. More...
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one. More...
 
void repaint ()
 Marks the whole component as needing to be redrawn. More...
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn. More...
 
void repaint (Rectangle< int > area)
 Marks a subsection of this component as needing to be redrawn. More...
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing. More...
 
Image createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component. More...
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context. More...
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted. More...
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance. More...
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect. More...
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component. More...
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component. More...
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting. More...
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children. More...
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent. More...
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent. More...
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked. More...
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on. More...
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not. More...
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus. More...
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus. More...
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus(). More...
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component. More...
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus. More...
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings. More...
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component. More...
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified. More...
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed. More...
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed. More...
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container. More...
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled. More...
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component. More...
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled. More...
 
float getAlpha () const noexcept
 Returns the component's current transparancy level. More...
 
void setAlpha (float newAlpha)
 Changes the transparency of this component. More...
 
virtual void alphaChanged ()
 Called when setAlpha() is used to change the alpha value of this component. More...
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component. More...
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component. More...
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated. More...
 
virtual void paint (Graphics &g)
 Components can override this method to draw their content. More...
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children. More...
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component. More...
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component. More...
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component. More...
 
virtual void mouseDown (const MouseEvent &event) override
 Called when a mouse button is pressed. More...
 
virtual void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down. More...
 
virtual void mouseUp (const MouseEvent &event) override
 Called when a mouse button is released. More...
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component. More...
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved. More...
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used. More...
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component. More...
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component. More...
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener. More...
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives. More...
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener. More...
 
virtual bool keyPressed (const KeyPress &key)
 Called when a key is pressed. More...
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released. More...
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released. More...
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus. More...
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus. More...
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate a change in whether or not this component is the parent of the currently-focused component. More...
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component. More...
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component. More...
 
bool isMouseOverOrDragging (bool includeChildren=false) const
 True if the mouse is over this component, or if it's being dragged in this component. More...
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component. More...
 
virtual void resized ()
 Called when this component's size has been changed. More...
 
virtual void moved ()
 Called when this component's position has been changed. More...
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized. More...
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized. More...
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings. More...
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position. More...
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener. More...
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component. More...
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage(). More...
 
int runModalLoop ()
 Runs a component modally, waiting until the loop terminates. More...
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Puts the component into a modal state. More...
 
void exitModalState (int returnValue)
 Ends a component's modal state. More...
 
bool isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
 Returns true if this component is the modal one. More...
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages. More...
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events. More...
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component. More...
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component. More...
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component. More...
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number. More...
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose. More...
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it. More...
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method. More...
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component. More...
 
virtual void colourChanged ()
 This method is called when a colour is changed by the setColour() method. More...
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList. More...
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component. More...
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component. More...
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component. More...
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting. More...
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage(). More...
 
void setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
 Sets a flag to indicate whether mouse drag events on this Component should be ignored when it is inside a Viewport with drag-to-scroll functionality enabled. More...
 
bool getViewportIgnoreDragFlag () const noexcept
 Retrieves the current state of the Viewport drag-to-scroll functionality flag. More...
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
 JUCE_DEPRECATED (void setBounds(const RelativeRectangle &))
 
 JUCE_DEPRECATED (void setBounds(const String &))
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 Destructor. More...
 

Public Attributes

AudioProcessorprocessor
 The AudioProcessor that this editor represents. More...
 
ScopedPointer< ResizableCornerComponentresizableCorner
 

Protected Member Functions

 AudioProcessorEditor (AudioProcessor &) noexcept
 Creates an editor for the specified processor. More...
 
 AudioProcessorEditor (AudioProcessor *) noexcept
 Creates an editor for the specified processor. More...
 

Additional Inherited Members

- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 
- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus. More...
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it. More...
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation. More...
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down. More...
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state. More...
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal. More...
 

Detailed Description

Base class for the component that acts as the GUI for an AudioProcessor.

Derive your editor component from this class, and create an instance of it by overriding the AudioProcessor::createEditor() method.

See also
AudioProcessor, GenericAudioProcessorEditor

Constructor & Destructor Documentation

◆ AudioProcessorEditor() [1/2]

AudioProcessorEditor::AudioProcessorEditor ( AudioProcessor )
protectednoexcept

Creates an editor for the specified processor.

◆ AudioProcessorEditor() [2/2]

AudioProcessorEditor::AudioProcessorEditor ( AudioProcessor )
protectednoexcept

Creates an editor for the specified processor.

◆ ~AudioProcessorEditor()

AudioProcessorEditor::~AudioProcessorEditor ( )

Destructor.

Member Function Documentation

◆ getAudioProcessor()

AudioProcessor* AudioProcessorEditor::getAudioProcessor ( ) const
noexcept

Returns a pointer to the processor that this editor represents.

This method is here to support legacy code, but it's easier to just use the AudioProcessorEditor::processor member variable directly to get this object.

◆ setControlHighlight()

virtual void AudioProcessorEditor::setControlHighlight ( ParameterControlHighlightInfo  )
virtual

Some types of plugin can call this to suggest that the control for a particular parameter should be highlighted.

Currently only AAX plugins will call this, and implementing it is optional.

◆ getControlParameterIndex()

virtual int AudioProcessorEditor::getControlParameterIndex ( Component )
virtual

Called by certain plug-in wrappers to find out whether a component is used to control a parameter.

If the given component represents a particular plugin parameter, then this method should return the index of that parameter. If not, it should return -1. Currently only AAX plugins will call this, and implementing it is optional.

◆ supportsHostMIDIControllerPresence()

virtual bool AudioProcessorEditor::supportsHostMIDIControllerPresence ( bool  hostMIDIControllerIsAvailable)
virtual

Override this method to indicate if your editor supports the presence or absence of a host-provided MIDI controller.

Currently only AUv3 plug-ins compiled for MacOS 10.13 or iOS 11.0 (or later) support this functionality, and even then the host may choose to ignore this information.

The default behaviour is to report support for both cases.

◆ hostMIDIControllerIsAvailable()

virtual void AudioProcessorEditor::hostMIDIControllerIsAvailable ( bool  controllerIsAvailable)
virtual

Called to indicate if a host is providing a MIDI controller when the host reconfigures its layout.

Use this as an opportunity to hide or display your own onscreen keyboard or other input component.

Currently only AUv3 plug-ins compiled for MacOS 10.13 or iOS 11.0 (or later) support this functionality.

◆ setScaleFactor()

virtual void AudioProcessorEditor::setScaleFactor ( float  newScale)
virtual

Can be called by a host to tell the editor that it should use a non-unity GUI scale.

◆ setResizable()

void AudioProcessorEditor::setResizable ( bool  allowHostToResize,
bool  useBottomRightCornerResizer 
)

Marks the host's editor window as resizable.

Parameters
allowHostToResizewhether the editor's parent window can be resized by the user or the host. Even if this is false, you can still resize your window yourself by calling setBounds (for example, when a user clicks on a button in your editor to drop out a panel) which will bypass any resizable/constraints checks. If you are using your own corner resizer than this will also bypass any checks.
useBottomRightCornerResizer
See also
setResizeLimits, isResizable

◆ isResizable()

bool AudioProcessorEditor::isResizable ( ) const
noexcept

Returns true if the host is allowed to resize editor's parent window.

See also
setResizable

◆ setResizeLimits()

void AudioProcessorEditor::setResizeLimits ( int  newMinimumWidth,
int  newMinimumHeight,
int  newMaximumWidth,
int  newMaximumHeight 
)
noexcept

This sets the maximum and minimum sizes for the window.

If the window's current size is outside these limits, it will be resized to make sure it's within them.

A direct call to setBounds() will bypass any constraint checks, but when the window is dragged by the user or resized by other indirect means, the constrainer will limit the numbers involved.

See also
setResizable

◆ getConstrainer()

ComponentBoundsConstrainer* AudioProcessorEditor::getConstrainer ( )
noexcept

Returns the bounds constrainer object that this window is using.

You can access this to change its properties.

◆ setConstrainer()

void AudioProcessorEditor::setConstrainer ( ComponentBoundsConstrainer newConstrainer)

Sets the bounds-constrainer object to use for resizing and dragging this window.

A pointer to the object you pass in will be kept, but it won't be deleted by this object, so it's the caller's responsibility to manage it.

If you pass a nullptr, then no contraints will be placed on the positioning of the window.

◆ setBoundsConstrained()

void AudioProcessorEditor::setBoundsConstrained ( Rectangle< int >  newBounds)

Calls the window's setBounds method, after first checking these bounds with the current constrainer.

See also
setConstrainer

Member Data Documentation

◆ processor

AudioProcessor& AudioProcessorEditor::processor

The AudioProcessor that this editor represents.

◆ resizableCorner

ScopedPointer<ResizableCornerComponent> AudioProcessorEditor::resizableCorner

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