Specifies a set of gaps to be left around the sides of a rectangle. More...

#include <juce_BorderSize.h>

Inheritance diagram for juce::BorderSize< ValueType >:

Collaboration diagram for juce::BorderSize< ValueType >:

Public Member Functions
	BorderSize ()=default
	Creates a null border.

	BorderSize (ValueType allGaps) noexcept
	Creates a border with the given gap on all sides.

	BorderSize (ValueType topGap, ValueType leftGap, ValueType bottomGap, ValueType rightGap) noexcept
	Creates a border with the given gaps.

BorderSize< ValueType >	addedTo (const BorderSize< ValueType > &other) const noexcept
	Adds this border to another border.

Rectangle< ValueType >	addedTo (const Rectangle< ValueType > &original) const noexcept
	Returns a rectangle with these borders added around it.

void	addTo (Rectangle< ValueType > &rectangle) const noexcept
	Adds this border around a given rectangle.

ValueType	getBottom () const noexcept
	Returns the gap that should be left at the bottom of the region.

ValueType	getLeft () const noexcept
	Returns the gap that should be left at the left of the region.

ValueType	getLeftAndRight () const noexcept
	Returns the sum of the left and right gaps.

ValueType	getRight () const noexcept
	Returns the gap that should be left at the right of the region.

ValueType	getTop () const noexcept
	Returns the gap that should be left at the top of the region.

ValueType	getTopAndBottom () const noexcept
	Returns the sum of the top and bottom gaps.

bool	isEmpty () const noexcept
	Returns true if this border has no thickness along any edge.

template<typename ScalarType >
BorderSize< ValueType >	multipliedBy (ScalarType scalar) const noexcept
	Multiplies each member of the border by a scalar.

bool	operator!= (const BorderSize &other) const noexcept

bool	operator== (const BorderSize &other) const noexcept

void	setBottom (ValueType newBottomGap) noexcept
	Changes the bottom gap.

void	setLeft (ValueType newLeftGap) noexcept
	Changes the left gap.

void	setRight (ValueType newRightGap) noexcept
	Changes the right gap.

void	setTop (ValueType newTopGap) noexcept
	Changes the top gap.

BorderSize< ValueType >	subtractedFrom (const BorderSize< ValueType > &other) const noexcept
	Removes this border from another border.

Rectangle< ValueType >	subtractedFrom (const Rectangle< ValueType > &original) const noexcept
	Returns a rectangle with these borders removed from it.

void	subtractFrom (Rectangle< ValueType > &rectangle) const noexcept
	Removes this border from a given rectangle.

Private Member Functions
auto	tie () const

Private Attributes
ValueType	bottom {}

ValueType	left {}

ValueType	right {}

ValueType	top {}

Detailed Description

template<typename ValueType>
class juce::BorderSize< ValueType >

Specifies a set of gaps to be left around the sides of a rectangle.

This is basically the size of the spaces at the top, bottom, left and right of a rectangle. It's used by various component classes to specify borders.

See also: Rectangle

@tags{Graphics}

Constructor & Destructor Documentation

◆ BorderSize() [1/3]

template<typename ValueType >

juce::BorderSize< ValueType >::BorderSize ( )

default

Creates a null border.

All sizes are left as 0.

◆ BorderSize() [2/3]

template<typename ValueType >

juce::BorderSize< ValueType >::BorderSize	(	ValueType	topGap,
		ValueType	leftGap,
		ValueType	bottomGap,
		ValueType	rightGap
	)

inlinenoexcept

Creates a border with the given gaps.

◆ BorderSize() [3/3]

template<typename ValueType >

juce::BorderSize< ValueType >::BorderSize ( ValueType allGaps )

inlineexplicitnoexcept

Creates a border with the given gap on all sides.

Member Function Documentation

◆ addedTo() [1/2]

template<typename ValueType >

BorderSize< ValueType > juce::BorderSize< ValueType >::addedTo ( const BorderSize< ValueType > & other ) const

inlinenoexcept

Adds this border to another border.

References juce::BorderSize< ValueType >::bottom, juce::BorderSize< ValueType >::left, juce::BorderSize< ValueType >::right, and juce::BorderSize< ValueType >::top.

◆ addedTo() [2/2]

template<typename ValueType >

Rectangle< ValueType > juce::BorderSize< ValueType >::addedTo ( const Rectangle< ValueType > & original ) const

inlinenoexcept

Returns a rectangle with these borders added around it.

References juce::BorderSize< ValueType >::bottom, juce::BorderSize< ValueType >::left, juce::BorderSize< ValueType >::right, and juce::BorderSize< ValueType >::top.

Referenced by juce::BorderSize< ValueType >::addTo(), and juce::StandaloneFilterWindow::MainContentComponent::computeBorder().

◆ addTo()

template<typename ValueType >

void juce::BorderSize< ValueType >::addTo ( Rectangle< ValueType > & rectangle ) const

inlinenoexcept

Adds this border around a given rectangle.

References juce::BorderSize< ValueType >::addedTo().

◆ getBottom()

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::getBottom ( ) const

inlinenoexcept

Returns the gap that should be left at the bottom of the region.

References juce::BorderSize< ValueType >::bottom.

◆ getLeft()

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::getLeft ( ) const

inlinenoexcept

Returns the gap that should be left at the left of the region.

References juce::BorderSize< ValueType >::left.

◆ getLeftAndRight()

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::getLeftAndRight ( ) const

inlinenoexcept

Returns the sum of the left and right gaps.

References juce::BorderSize< ValueType >::left, and juce::BorderSize< ValueType >::right.

◆ getRight()

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::getRight ( ) const

inlinenoexcept

Returns the gap that should be left at the right of the region.

References juce::BorderSize< ValueType >::right.

◆ getTop()

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::getTop ( ) const

inlinenoexcept

Returns the gap that should be left at the top of the region.

References juce::BorderSize< ValueType >::top.

◆ getTopAndBottom()

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::getTopAndBottom ( ) const

inlinenoexcept

Returns the sum of the top and bottom gaps.

References juce::BorderSize< ValueType >::bottom, and juce::BorderSize< ValueType >::top.

◆ isEmpty()

template<typename ValueType >

bool juce::BorderSize< ValueType >::isEmpty ( ) const

inlinenoexcept

Returns true if this border has no thickness along any edge.

References juce::BorderSize< ValueType >::bottom, juce::BorderSize< ValueType >::left, juce::BorderSize< ValueType >::right, and juce::BorderSize< ValueType >::top.

◆ multipliedBy()

template<typename ValueType >

template<typename ScalarType >

BorderSize< ValueType > juce::BorderSize< ValueType >::multipliedBy ( ScalarType scalar ) const

inlinenoexcept

Multiplies each member of the border by a scalar.

References juce::BorderSize< ValueType >::bottom, juce::BorderSize< ValueType >::left, juce::BorderSize< ValueType >::right, and juce::BorderSize< ValueType >::top.

◆ operator!=()

template<typename ValueType >

bool juce::BorderSize< ValueType >::operator!= ( const BorderSize< ValueType > & other ) const

inlinenoexcept

References juce::BorderSize< ValueType >::tie().

◆ operator==()

template<typename ValueType >

bool juce::BorderSize< ValueType >::operator== ( const BorderSize< ValueType > & other ) const

inlinenoexcept

References juce::BorderSize< ValueType >::tie().

◆ setBottom()

template<typename ValueType >

void juce::BorderSize< ValueType >::setBottom ( ValueType newBottomGap )

inlinenoexcept

Changes the bottom gap.

References juce::BorderSize< ValueType >::bottom.

◆ setLeft()

template<typename ValueType >

void juce::BorderSize< ValueType >::setLeft ( ValueType newLeftGap )

inlinenoexcept

Changes the left gap.

References juce::BorderSize< ValueType >::left.

◆ setRight()

template<typename ValueType >

void juce::BorderSize< ValueType >::setRight ( ValueType newRightGap )

inlinenoexcept

Changes the right gap.

References juce::BorderSize< ValueType >::right.

◆ setTop()

template<typename ValueType >

void juce::BorderSize< ValueType >::setTop ( ValueType newTopGap )

inlinenoexcept

Changes the top gap.

References juce::BorderSize< ValueType >::top.

◆ subtractedFrom() [1/2]

template<typename ValueType >

BorderSize< ValueType > juce::BorderSize< ValueType >::subtractedFrom ( const BorderSize< ValueType > & other ) const

inlinenoexcept

Removes this border from another border.

References juce::BorderSize< ValueType >::bottom, juce::BorderSize< ValueType >::left, juce::BorderSize< ValueType >::right, and juce::BorderSize< ValueType >::top.

◆ subtractedFrom() [2/2]

template<typename ValueType >

Rectangle< ValueType > juce::BorderSize< ValueType >::subtractedFrom ( const Rectangle< ValueType > & original ) const

inlinenoexcept

Returns a rectangle with these borders removed from it.

References juce::BorderSize< ValueType >::bottom, juce::BorderSize< ValueType >::left, juce::BorderSize< ValueType >::right, and juce::BorderSize< ValueType >::top.

Referenced by juce::BorderSize< ValueType >::subtractFrom().

◆ subtractFrom()

template<typename ValueType >

void juce::BorderSize< ValueType >::subtractFrom ( Rectangle< ValueType > & rectangle ) const

inlinenoexcept

Removes this border from a given rectangle.

References juce::BorderSize< ValueType >::subtractedFrom().

◆ tie()

template<typename ValueType >

auto juce::BorderSize< ValueType >::tie ( ) const

inlineprivate

References juce::BorderSize< ValueType >::bottom, juce::BorderSize< ValueType >::left, juce::BorderSize< ValueType >::right, and juce::BorderSize< ValueType >::top.

Referenced by juce::BorderSize< ValueType >::operator!=(), and juce::BorderSize< ValueType >::operator==().

Member Data Documentation

◆ bottom

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::bottom {}

private

Referenced by juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::getBottom(), juce::BorderSize< ValueType >::getTopAndBottom(), juce::BorderSize< ValueType >::isEmpty(), juce::BorderSize< ValueType >::multipliedBy(), juce::BorderSize< ValueType >::setBottom(), juce::BorderSize< ValueType >::subtractedFrom(), juce::BorderSize< ValueType >::subtractedFrom(), and juce::BorderSize< ValueType >::tie().

◆ left

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::left {}

private

Referenced by juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::getLeft(), juce::BorderSize< ValueType >::getLeftAndRight(), juce::BorderSize< ValueType >::isEmpty(), juce::BorderSize< ValueType >::multipliedBy(), juce::BorderSize< ValueType >::setLeft(), juce::BorderSize< ValueType >::subtractedFrom(), juce::BorderSize< ValueType >::subtractedFrom(), and juce::BorderSize< ValueType >::tie().

◆ right

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::right {}

private

Referenced by juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::getLeftAndRight(), juce::BorderSize< ValueType >::getRight(), juce::BorderSize< ValueType >::isEmpty(), juce::BorderSize< ValueType >::multipliedBy(), juce::BorderSize< ValueType >::setRight(), juce::BorderSize< ValueType >::subtractedFrom(), juce::BorderSize< ValueType >::subtractedFrom(), and juce::BorderSize< ValueType >::tie().

◆ top

template<typename ValueType >

ValueType juce::BorderSize< ValueType >::top {}

private

Referenced by juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::addedTo(), juce::BorderSize< ValueType >::getTop(), juce::BorderSize< ValueType >::getTopAndBottom(), juce::BorderSize< ValueType >::isEmpty(), juce::BorderSize< ValueType >::multipliedBy(), juce::BorderSize< ValueType >::setTop(), juce::BorderSize< ValueType >::subtractedFrom(), juce::BorderSize< ValueType >::subtractedFrom(), and juce::BorderSize< ValueType >::tie().

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

juce_BorderSize.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BorderSize() [1/3]

◆ BorderSize() [2/3]

◆ BorderSize() [3/3]

Member Function Documentation

◆ addedTo() [1/2]

◆ addedTo() [2/2]

◆ addTo()

◆ getBottom()

◆ getLeft()

◆ getLeftAndRight()

◆ getRight()

◆ getTop()

◆ getTopAndBottom()

◆ isEmpty()

◆ multipliedBy()

◆ operator!=()

◆ operator==()

◆ setBottom()

◆ setLeft()

◆ setRight()

◆ setTop()

◆ subtractedFrom() [1/2]

◆ subtractedFrom() [2/2]

◆ subtractFrom()

◆ tie()

Member Data Documentation

◆ bottom

◆ left

◆ right

◆ top