JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::BorderSize< ValueType > Class Template Reference

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. More...
 
 BorderSize (const BorderSize &)=default
 Creates a copy of another border. More...
 
 BorderSize (ValueType topGap, ValueType leftGap, ValueType bottomGap, ValueType rightGap) noexcept
 Creates a border with the given gaps. More...
 
 BorderSize (ValueType allGaps) noexcept
 Creates a border with the given gap on all sides. More...
 
Rectangle< ValueType > addedTo (const Rectangle< ValueType > &original) const noexcept
 Returns a rectangle with these borders added around it. More...
 
void addTo (Rectangle< ValueType > &rectangle) const noexcept
 Adds this border around a given rectangle. More...
 
ValueType getBottom () const noexcept
 Returns the gap that should be left at the bottom of the region. More...
 
ValueType getLeft () const noexcept
 Returns the gap that should be left at the left of the region. More...
 
ValueType getLeftAndRight () const noexcept
 Returns the sum of the left and right gaps. More...
 
ValueType getRight () const noexcept
 Returns the gap that should be left at the right of the region. More...
 
ValueType getTop () const noexcept
 Returns the gap that should be left at the top of the region. More...
 
ValueType getTopAndBottom () const noexcept
 Returns the sum of the top and bottom gaps. More...
 
bool isEmpty () const noexcept
 Returns true if this border has no thickness along any edge. More...
 
bool operator!= (const BorderSize &other) const noexcept
 
bool operator== (const BorderSize &other) const noexcept
 
void setBottom (ValueType newBottomGap) noexcept
 Changes the bottom gap. More...
 
void setLeft (ValueType newLeftGap) noexcept
 Changes the left gap. More...
 
void setRight (ValueType newRightGap) noexcept
 Changes the right gap. More...
 
void setTop (ValueType newTopGap) noexcept
 Changes the top gap. More...
 
Rectangle< ValueType > subtractedFrom (const Rectangle< ValueType > &original) const noexcept
 Returns a rectangle with these borders removed from it. More...
 
void subtractFrom (Rectangle< ValueType > &rectangle) const noexcept
 Removes this border from a given rectangle. More...
 

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

{Graphics}

Constructor & Destructor Documentation

◆ BorderSize() [1/4]

template<typename ValueType>
juce::BorderSize< ValueType >::BorderSize ( )
default

Creates a null border.

All sizes are left as 0.

◆ BorderSize() [2/4]

template<typename ValueType>
juce::BorderSize< ValueType >::BorderSize ( const BorderSize< ValueType > &  )
default

Creates a copy of another border.

◆ BorderSize() [3/4]

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

Creates a border with the given gaps.

◆ BorderSize() [4/4]

template<typename ValueType>
juce::BorderSize< ValueType >::BorderSize ( ValueType  allGaps)
inlineexplicitnoexcept

Creates a border with the given gap on all sides.

Member Function Documentation

◆ addedTo()

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

Returns a rectangle with these borders added around it.

Referenced by juce::BorderSize< int >::addTo().

◆ addTo()

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

Adds this border around a given rectangle.

◆ getBottom()

template<typename ValueType>
ValueType juce::BorderSize< ValueType >::getBottom ( ) const
inlinenoexcept

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

◆ getLeft()

template<typename ValueType>
ValueType juce::BorderSize< ValueType >::getLeft ( ) const
inlinenoexcept

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

◆ getLeftAndRight()

template<typename ValueType>
ValueType juce::BorderSize< ValueType >::getLeftAndRight ( ) const
inlinenoexcept

Returns the sum of the left and right gaps.

◆ getRight()

template<typename ValueType>
ValueType juce::BorderSize< ValueType >::getRight ( ) const
inlinenoexcept

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

◆ getTop()

template<typename ValueType>
ValueType juce::BorderSize< ValueType >::getTop ( ) const
inlinenoexcept

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

◆ getTopAndBottom()

template<typename ValueType>
ValueType juce::BorderSize< ValueType >::getTopAndBottom ( ) const
inlinenoexcept

Returns the sum of the top and bottom gaps.

◆ isEmpty()

template<typename ValueType>
bool juce::BorderSize< ValueType >::isEmpty ( ) const
inlinenoexcept

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

◆ operator!=()

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

◆ operator==()

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

◆ setBottom()

template<typename ValueType>
void juce::BorderSize< ValueType >::setBottom ( ValueType  newBottomGap)
inlinenoexcept

Changes the bottom gap.

◆ setLeft()

template<typename ValueType>
void juce::BorderSize< ValueType >::setLeft ( ValueType  newLeftGap)
inlinenoexcept

Changes the left gap.

◆ setRight()

template<typename ValueType>
void juce::BorderSize< ValueType >::setRight ( ValueType  newRightGap)
inlinenoexcept

Changes the right gap.

◆ setTop()

template<typename ValueType>
void juce::BorderSize< ValueType >::setTop ( ValueType  newTopGap)
inlinenoexcept

Changes the top gap.

◆ subtractedFrom()

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

Returns a rectangle with these borders removed from it.

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

◆ subtractFrom()

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

Removes this border from a given rectangle.

Member Data Documentation

◆ bottom

◆ left

◆ right

◆ top


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