juce::Justification Class Reference

Represents a type of justification to be used when positioning graphical items. More...

#include "juce_Justification.h"

Public Types
enum	Flags {   left , right , horizontallyCentred , top ,   bottom , verticallyCentred , horizontallyJustified , centred ,   centredLeft , centredRight , centredTop , centredBottom ,   topLeft , topRight , bottomLeft , bottomRight }
	Flag values that can be combined and used in the constructor. More...

Public Member Functions
	Justification (int justificationFlags) noexcept
	Creates a Justification object using a combination of flags from the Flags enum.
	Justification (const Justification &)=default
	Creates a copy of another Justification object.
Justification &	operator= (const Justification &)=default
	Copies another Justification object.
bool	operator== (const Justification &other) const noexcept
bool	operator!= (const Justification &other) const noexcept
int	getFlags () const noexcept
	Returns the raw flags that are set for this Justification object.
bool	testFlags (int flagsToTest) const noexcept
	Tests a set of flags for this object.
int	getOnlyVerticalFlags () const noexcept
	Returns just the flags from this object that deal with vertical layout.
int	getOnlyHorizontalFlags () const noexcept
	Returns just the flags from this object that deal with horizontal layout.
template<typename ValueType >
void	applyToRectangle (ValueType &x, ValueType &y, ValueType w, ValueType h, ValueType spaceX, ValueType spaceY, ValueType spaceW, ValueType spaceH) const noexcept
	Adjusts the position of a rectangle to fit it into a space.
template<typename ValueType >
const Rectangle< ValueType >	appliedToRectangle (const Rectangle< ValueType > &areaToAdjust, const Rectangle< ValueType > &targetSpace) const noexcept
	Returns the new position of a rectangle that has been justified to fit within a given space.

Detailed Description

Represents a type of justification to be used when positioning graphical items.

e.g. it indicates whether something should be placed top-left, top-right, centred, etc.

It is used in various places wherever this kind of information is needed.

@tags{Graphics}

Definition at line 40 of file juce_Justification.h.

Member Enumeration Documentation

Flags

enum juce::Justification::Flags

Flag values that can be combined and used in the constructor.

Enumerator
left	Indicates that the item should be aligned against the left edge of the available space.
right	Indicates that the item should be aligned against the right edge of the available space.
horizontallyCentred	Indicates that the item should be placed in the centre between the left and right sides of the available space.
top	Indicates that the item should be aligned against the top edge of the available space.
bottom	Indicates that the item should be aligned against the bottom edge of the available space.
verticallyCentred	Indicates that the item should be placed in the centre between the top and bottom sides of the available space.
horizontallyJustified	Indicates that lines of text should be spread out to fill the maximum width available, so that both margins are aligned vertically.
centred	Indicates that the item should be centred vertically and horizontally. This is equivalent to (horizontallyCentred | verticallyCentred)
centredLeft	Indicates that the item should be centred vertically but placed on the left hand side. This is equivalent to (left | verticallyCentred)
centredRight	Indicates that the item should be centred vertically but placed on the right hand side. This is equivalent to (right | verticallyCentred)
centredTop	Indicates that the item should be centred horizontally and placed at the top. This is equivalent to (horizontallyCentred | top)
centredBottom	Indicates that the item should be centred horizontally and placed at the bottom. This is equivalent to (horizontallyCentred | bottom)
topLeft	Indicates that the item should be placed in the top-left corner. This is equivalent to (left | top)
topRight	Indicates that the item should be placed in the top-right corner. This is equivalent to (right | top)
bottomLeft	Indicates that the item should be placed in the bottom-left corner. This is equivalent to (left | bottom)
bottomRight	Indicates that the item should be placed in the bottom-left corner. This is equivalent to (right | bottom)

Definition at line 104 of file juce_Justification.h.

Constructor & Destructor Documentation

Justification()

juce::Justification::Justification ( int  justificationFlags )

noexcept

Creates a Justification object using a combination of flags from the Flags enum.

Definition at line 45 of file juce_Justification.h.

Member Function Documentation

appliedToRectangle()

template<typename ValueType >

const Rectangle< ValueType > juce::Justification::appliedToRectangle ( const Rectangle< ValueType > &  areaToAdjust, const Rectangle< ValueType > &  targetSpace  ) const

noexcept

Returns the new position of a rectangle that has been justified to fit within a given space.

Definition at line 93 of file juce_Justification.h.

applyToRectangle()

template<typename ValueType >

void juce::Justification::applyToRectangle ( ValueType &  x, ValueType &  y, ValueType  w, ValueType  h, ValueType  spaceX, ValueType  spaceY, ValueType  spaceW, ValueType  spaceH  ) const

noexcept

Adjusts the position of a rectangle to fit it into a space.

The (x, y) position of the rectangle will be updated to position it inside the given space according to the justification flags.

Definition at line 78 of file juce_Justification.h.

getFlags()

int juce::Justification::getFlags ( ) const

noexcept

Returns the raw flags that are set for this Justification object.

Definition at line 58 of file juce_Justification.h.

getOnlyHorizontalFlags()

int juce::Justification::getOnlyHorizontalFlags ( ) const

noexcept

Returns just the flags from this object that deal with horizontal layout.

Definition at line 69 of file juce_Justification.h.

getOnlyVerticalFlags()

int juce::Justification::getOnlyVerticalFlags ( ) const

noexcept

Returns just the flags from this object that deal with vertical layout.

Definition at line 66 of file juce_Justification.h.

operator!=()

bool juce::Justification::operator!= ( const Justification &  other ) const

noexcept

Definition at line 54 of file juce_Justification.h.

operator==()

bool juce::Justification::operator== ( const Justification &  other ) const

noexcept

Definition at line 53 of file juce_Justification.h.

testFlags()

bool juce::Justification::testFlags ( int  flagsToTest ) const

noexcept

Tests a set of flags for this object.

Returns

true if any of the flags passed in are set on this object.

Definition at line 63 of file juce_Justification.h.

---

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

• juce_graphics/placement/juce_Justification.h