Justification Class Reference

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

List of all members.

Public Types
enum	{   left = 1, right = 2, horizontallyCentred = 4, top = 8,   bottom = 16, verticallyCentred = 32, horizontallyJustified = 64, centred = 36,   centredLeft = 33, centredRight = 34, centredTop = 12, centredBottom = 20,   topLeft = 9, topRight = 10, bottomLeft = 17, bottomRight = 18 }
	Flag values that can be combined and used in the constructor. More...
Public Member Functions
	Justification (int flags_) throw ()
	Creates a Justification object using a combination of flags.
	Justification (const Justification &other) throw ()
	Creates a copy of another Justification object.
Justification &	operator= (const Justification &other) throw ()
	Copies another Justification object.
int	getFlags () const throw ()
	Returns the raw flags that are set for this Justification object.
bool	testFlags (int flagsToTest) const throw ()
	Tests a set of flags for this object.
int	getOnlyVerticalFlags () const throw ()
	Returns just the flags from this object that deal with vertical layout.
int	getOnlyHorizontalFlags () const throw ()
	Returns just the flags from this object that deal with horizontal layout.
void	applyToRectangle (int &x, int &y, int w, int h, int spaceX, int spaceY, int spaceW, int spaceH) const throw ()
	Adjusts the position of a rectangle to fit it into a 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.

---

Member Enumeration Documentation

anonymous enum

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)

---

Constructor & Destructor Documentation

Justification::Justification

(

int

flags_

)

throw ()

Creates a Justification object using a combination of flags.

Justification::Justification

(

const Justification &

other

)

throw ()

Creates a copy of another Justification object.

---

Member Function Documentation

Justification& Justification::operator=

(

const Justification &

other

)

throw ()

Copies another Justification object.

int Justification::getFlags

(

)

const throw ()

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

bool Justification::testFlags

(

int

flagsToTest

)

const throw ()

Tests a set of flags for this object.

Returns:

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

int Justification::getOnlyVerticalFlags

(

)

const throw ()

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

int Justification::getOnlyHorizontalFlags

(

)

const throw ()

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

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

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.

---

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

• juce_Justification.h