Specifies a set of gaps to be left around the sides of a rectangle. More...
#include <juce_BorderSize.h>
Public Member Functions | |
BorderSize ()=default | |
Creates a null border. | |
BorderSize (ValueType topGap, ValueType leftGap, ValueType bottomGap, ValueType rightGap) noexcept | |
Creates a border with the given gaps. | |
BorderSize (ValueType allGaps) noexcept | |
Creates a border with the given gap on all sides. | |
ValueType | getTop () const noexcept |
Returns the gap that should be left at the top of the region. | |
ValueType | getLeft () const noexcept |
Returns the gap that should be left at the left of the region. | |
ValueType | getBottom () const noexcept |
Returns the gap that should be left at the bottom of the region. | |
ValueType | getRight () const noexcept |
Returns the gap that should be left at the right of the region. | |
ValueType | getTopAndBottom () const noexcept |
Returns the sum of the top and bottom gaps. | |
ValueType | getLeftAndRight () const noexcept |
Returns the sum of the left and right gaps. | |
bool | isEmpty () const noexcept |
Returns true if this border has no thickness along any edge. | |
void | setTop (ValueType newTopGap) noexcept |
Changes the top gap. | |
void | setLeft (ValueType newLeftGap) noexcept |
Changes the left gap. | |
void | setBottom (ValueType newBottomGap) noexcept |
Changes the bottom gap. | |
void | setRight (ValueType newRightGap) noexcept |
Changes the right gap. | |
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. | |
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. | |
BorderSize< ValueType > | subtractedFrom (const BorderSize< ValueType > &other) const noexcept |
Removes this border from another border. | |
BorderSize< ValueType > | addedTo (const BorderSize< ValueType > &other) const noexcept |
Adds this border to another border. | |
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 |
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.
|
default |
Creates a null border.
All sizes are left as 0.
|
noexcept |
Creates a border with the given gaps.
|
explicitnoexcept |
Creates a border with the given gap on all sides.
|
noexcept |
Returns the gap that should be left at the top of the region.
|
noexcept |
Returns the gap that should be left at the left of the region.
|
noexcept |
Returns the gap that should be left at the bottom of the region.
|
noexcept |
Returns the gap that should be left at the right of the region.
|
noexcept |
Returns the sum of the top and bottom gaps.
|
noexcept |
Returns the sum of the left and right gaps.
|
noexcept |
Returns true if this border has no thickness along any edge.
Changes the top gap.
|
noexcept |
Changes the left gap.
|
noexcept |
Changes the bottom gap.
|
noexcept |
Changes the right gap.
|
noexcept |
Returns a rectangle with these borders removed from it.
Referenced by BorderSize< ValueType >::subtractFrom().
|
noexcept |
Removes this border from a given rectangle.
References BorderSize< ValueType >::subtractedFrom().
|
noexcept |
Returns a rectangle with these borders added around it.
Referenced by BorderSize< ValueType >::addTo().
|
noexcept |
Adds this border around a given rectangle.
References BorderSize< ValueType >::addedTo().
|
noexcept |
Removes this border from another border.
|
noexcept |
Adds this border to another border.
|
noexcept |
Multiplies each member of the border by a scalar.
|
noexcept |
|
noexcept |