Defines an item in a Grid. More...

#include "juce_GridItem.h"

Classes
struct	Margin
	Represents a margin. More...

struct	Property
	Represents a property. More...

struct	Span
	Represents a span. More...

struct	StartAndEndProperty
	Represents start and end properties. More...

Public Types
enum class	Keyword { autoValue }

enum class	JustifySelf : int { start , end , center , stretch , autoValue }
	Possible values for the justifySelf property. More...

enum class	AlignSelf : int { start , end , center , stretch , autoValue }
	Possible values for the alignSelf property. More...

enum	{ useDefaultValue , notAssigned }

Public Member Functions
	GridItem () noexcept
	Creates an item with default parameters.

	GridItem (Component &componentToUse) noexcept
	Creates an item with a given Component to use.

	GridItem (Component *componentToUse) noexcept
	Creates an item with a given Component to use.

void	setArea (Property rowStart, Property columnStart, Property rowEnd, Property columnEnd)
	Short-hand.

void	setArea (Property rowStart, Property columnStart)
	Short-hand, span of 1 by default.

void	setArea (const String &areaName)
	Short-hand.

GridItem	withArea (Property rowStart, Property columnStart, Property rowEnd, Property columnEnd) const noexcept
	Short-hand.

GridItem	withArea (Property rowStart, Property columnStart) const noexcept
	Short-hand, span of 1 by default.

GridItem	withArea (const String &areaName) const noexcept
	Short-hand.

GridItem	withRow (StartAndEndProperty row) const noexcept
	Returns a copy of this object with a new row property.

GridItem	withColumn (StartAndEndProperty column) const noexcept
	Returns a copy of this object with a new column property.

GridItem	withAlignSelf (AlignSelf newAlignSelf) const noexcept
	Returns a copy of this object with a new alignSelf property.

GridItem	withJustifySelf (JustifySelf newJustifySelf) const noexcept
	Returns a copy of this object with a new justifySelf property.

GridItem	withWidth (float newWidth) const noexcept
	Returns a copy of this object with a new width.

GridItem	withHeight (float newHeight) const noexcept
	Returns a copy of this object with a new height.

GridItem	withSize (float newWidth, float newHeight) const noexcept
	Returns a copy of this object with a new size.

GridItem	withMargin (Margin newMargin) const noexcept
	Returns a copy of this object with a new margin.

GridItem	withOrder (int newOrder) const noexcept
	Returns a copy of this object with a new order.

Public Attributes
Component *	associatedComponent
	If this is non-null, it represents a Component whose bounds are controlled by this item.

int	order
	Determines the order used to lay out items in their grid container.

JustifySelf	justifySelf
	This is the justify-self property of the item.

AlignSelf	alignSelf
	This is the align-self property of the item.

StartAndEndProperty	column
	These are the start and end properties of the column.

StartAndEndProperty	row
	These are the start and end properties of the row.

String	area

float	width

float	minWidth

float	maxWidth

float	height

float	minHeight

float	maxHeight

Margin	margin
	The margin to leave around this item.

Rectangle< float >	currentBounds
	The item's current bounds.

Detailed Description

Defines an item in a Grid.

See also: Grid

@tags{GUI}

Definition at line 35 of file juce_GridItem.h.

Class Documentation

◆ juce::GridItem::StartAndEndProperty

struct juce::GridItem::StartAndEndProperty

Represents start and end properties.

Definition at line 101 of file juce_GridItem.h.

Class Members
Property	end
Property	start

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 159 of file juce_GridItem.h.

◆ AlignSelf

enum class juce::GridItem::AlignSelf : int

strong

Possible values for the alignSelf property.

Enumerator
start	Content inside the item is aligned towards the top.
end	Content inside the item is aligned towards the bottom.
center	Content inside the item is aligned towards the center.
stretch	Content inside the item is stretched from top to bottom.
autoValue	Follows the Grid container's alignItems property.

Definition at line 115 of file juce_GridItem.h.

◆ JustifySelf

enum class juce::GridItem::JustifySelf : int

strong

Possible values for the justifySelf property.

Enumerator
start	Content inside the item is justified towards the left.
end	Content inside the item is justified towards the right.
center	Content inside the item is justified towards the center.
stretch	Content inside the item is stretched from left to right.
autoValue	Follows the Grid container's justifyItems property.

Definition at line 105 of file juce_GridItem.h.

◆ Keyword

enum class juce::GridItem::Keyword

strong

Definition at line 38 of file juce_GridItem.h.

Constructor & Destructor Documentation

◆ GridItem() [1/2]

juce::GridItem::GridItem ( Component & componentToUse )

noexcept

Creates an item with a given Component to use.

Definition at line 72 of file juce_GridItem.cpp.

◆ GridItem() [2/2]

juce::GridItem::GridItem ( Component * componentToUse )

noexcept

Creates an item with a given Component to use.

Definition at line 73 of file juce_GridItem.cpp.

Member Function Documentation

◆ setArea() [1/3]

void juce::GridItem::setArea ( const String & areaName )

Short-hand.

Definition at line 89 of file juce_GridItem.cpp.

◆ setArea() [2/3]

void juce::GridItem::setArea	(	Property	rowStart,
		Property	columnStart
	)

Short-hand, span of 1 by default.

Definition at line 83 of file juce_GridItem.cpp.

◆ setArea() [3/3]

void juce::GridItem::setArea	(	Property	rowStart,
		Property	columnStart,
		Property	rowEnd,
		Property	columnEnd
	)

Short-hand.

Definition at line 75 of file juce_GridItem.cpp.

◆ withAlignSelf()

GridItem juce::GridItem::withAlignSelf ( AlignSelf newAlignSelf ) const

noexcept

Returns a copy of this object with a new alignSelf property.

Definition at line 129 of file juce_GridItem.cpp.

◆ withArea() [1/3]

GridItem juce::GridItem::withArea ( const String & areaName ) const

noexcept

Short-hand.

Definition at line 108 of file juce_GridItem.cpp.

◆ withArea() [2/3]

GridItem juce::GridItem::withArea	(	Property	rowStart,
		Property	columnStart
	)		const

noexcept

Short-hand, span of 1 by default.

Definition at line 101 of file juce_GridItem.cpp.

◆ withArea() [3/3]

GridItem juce::GridItem::withArea	(	Property	rowStart,
		Property	columnStart,
		Property	rowEnd,
		Property	columnEnd
	)		const

noexcept

Short-hand.

Definition at line 94 of file juce_GridItem.cpp.

◆ withColumn()

GridItem juce::GridItem::withColumn ( StartAndEndProperty column ) const

noexcept

Returns a copy of this object with a new column property.

Definition at line 122 of file juce_GridItem.cpp.

◆ withHeight()

GridItem juce::GridItem::withHeight ( float newHeight ) const

noexcept

Returns a copy of this object with a new height.

Definition at line 150 of file juce_GridItem.cpp.

◆ withJustifySelf()

GridItem juce::GridItem::withJustifySelf ( JustifySelf newJustifySelf ) const

noexcept

Returns a copy of this object with a new justifySelf property.

Definition at line 136 of file juce_GridItem.cpp.

◆ withMargin()

GridItem juce::GridItem::withMargin ( Margin newMargin ) const

noexcept

Returns a copy of this object with a new margin.

Definition at line 165 of file juce_GridItem.cpp.

◆ withOrder()

GridItem juce::GridItem::withOrder ( int newOrder ) const

noexcept

Returns a copy of this object with a new order.

Definition at line 172 of file juce_GridItem.cpp.

◆ withRow()

GridItem juce::GridItem::withRow ( StartAndEndProperty row ) const

noexcept

Returns a copy of this object with a new row property.

Definition at line 115 of file juce_GridItem.cpp.

◆ withSize()

GridItem juce::GridItem::withSize	(	float	newWidth,
		float	newHeight
	)		const

noexcept

Returns a copy of this object with a new size.

Definition at line 157 of file juce_GridItem.cpp.

◆ withWidth()

GridItem juce::GridItem::withWidth ( float newWidth ) const

noexcept

Returns a copy of this object with a new width.

Definition at line 143 of file juce_GridItem.cpp.

Member Data Documentation

◆ alignSelf

AlignSelf juce::GridItem::alignSelf

This is the align-self property of the item.

This determines the alignment of the item along the column.

Definition at line 147 of file juce_GridItem.h.

◆ area

String juce::GridItem::area

Definition at line 156 of file juce_GridItem.h.

◆ associatedComponent

Component* juce::GridItem::associatedComponent

If this is non-null, it represents a Component whose bounds are controlled by this item.

Definition at line 133 of file juce_GridItem.h.

◆ column

StartAndEndProperty juce::GridItem::column

These are the start and end properties of the column.

Definition at line 150 of file juce_GridItem.h.

◆ currentBounds

Rectangle<float> juce::GridItem::currentBounds

The item's current bounds.

Definition at line 192 of file juce_GridItem.h.

◆ height

float juce::GridItem::height

Definition at line 170 of file juce_GridItem.h.

◆ justifySelf

JustifySelf juce::GridItem::justifySelf

This is the justify-self property of the item.

This determines the alignment of the item along the row.

Definition at line 142 of file juce_GridItem.h.

◆ margin

Margin juce::GridItem::margin

The margin to leave around this item.

Definition at line 189 of file juce_GridItem.h.

◆ maxHeight

float juce::GridItem::maxHeight

Definition at line 172 of file juce_GridItem.h.

◆ maxWidth

float juce::GridItem::maxWidth

Definition at line 168 of file juce_GridItem.h.

◆ minHeight

float juce::GridItem::minHeight

Definition at line 171 of file juce_GridItem.h.

◆ minWidth

float juce::GridItem::minWidth

Definition at line 167 of file juce_GridItem.h.

◆ order

int juce::GridItem::order

Determines the order used to lay out items in their grid container.

Definition at line 137 of file juce_GridItem.h.

◆ row

StartAndEndProperty juce::GridItem::row

These are the start and end properties of the row.

Definition at line 153 of file juce_GridItem.h.

◆ width

float juce::GridItem::width

Definition at line 166 of file juce_GridItem.h.

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

juce_gui_basics/layout/juce_GridItem.h
juce_gui_basics/layout/juce_GridItem.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Class Documentation

◆ juce::GridItem::StartAndEndProperty

Member Enumeration Documentation

◆ anonymous enum

◆ AlignSelf

◆ JustifySelf

◆ Keyword

Constructor & Destructor Documentation

◆ GridItem() [1/2]

◆ GridItem() [2/2]

Member Function Documentation

◆ setArea() [1/3]

◆ setArea() [2/3]

◆ setArea() [3/3]

◆ withAlignSelf()

◆ withArea() [1/3]

◆ withArea() [2/3]

◆ withArea() [3/3]

◆ withColumn()

◆ withHeight()

◆ withJustifySelf()

◆ withMargin()

◆ withOrder()

◆ withRow()

◆ withSize()

◆ withWidth()

Member Data Documentation

◆ alignSelf

◆ area

◆ associatedComponent

◆ column

◆ currentBounds

◆ height

◆ justifySelf

◆ margin

◆ maxHeight

◆ maxWidth

◆ minHeight

◆ minWidth

◆ order

◆ row

◆ width