JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
juce::Component::Positioner Class Referenceabstract

Base class for objects that can be used to automatically position a component according to some kind of algorithm. More...

#include "juce_Component.h"

Inheritance diagram for juce::Component::Positioner:
juce::RelativeCoordinatePositionerBase juce::RelativeRectangleComponentPositioner

Public Member Functions

 Positioner (Component &component) noexcept
 Creates a Positioner which can control the specified component.
 
virtual ~Positioner ()=default
 Destructor.
 
ComponentgetComponent () const noexcept
 Returns the component that this positioner controls.
 
virtual void applyNewBounds (const Rectangle< int > &newBounds)=0
 Attempts to set the component's position to the given rectangle.
 

Detailed Description

Base class for objects that can be used to automatically position a component according to some kind of algorithm.

The component class simply holds onto a reference to a Positioner, but doesn't actually do anything with it - all the functionality must be implemented by the positioner itself (e.g. it might choose to watch some kind of value and move the component when the value changes).

Definition at line 2375 of file juce_Component.h.

Constructor & Destructor Documentation

◆ Positioner()

juce::Component::Positioner::Positioner ( Component component)
explicitnoexcept

Creates a Positioner which can control the specified component.

Definition at line 1925 of file juce_Component.cpp.

Member Function Documentation

◆ applyNewBounds()

virtual void juce::Component::Positioner::applyNewBounds ( const Rectangle< int > &  newBounds)
pure virtual

Attempts to set the component's position to the given rectangle.

Unlike simply calling Component::setBounds(), this may involve the positioner being smart enough to adjust itself to fit the new bounds.

Implemented in juce::RelativeRectangleComponentPositioner.

◆ getComponent()

Component & juce::Component::Positioner::getComponent ( ) const
noexcept

Returns the component that this positioner controls.

Definition at line 2384 of file juce_Component.h.


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