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 | { useDefaultValue = -2, notAssigned = -1 } |
enum | AlignSelf : int { AlignSelf::start = 0, AlignSelf::end, AlignSelf::center, AlignSelf::stretch, AlignSelf::autoValue } |
Possible values for the alignSelf property. More... | |
enum | JustifySelf : int { JustifySelf::start = 0, JustifySelf::end, JustifySelf::center, JustifySelf::stretch, JustifySelf::autoValue } |
Possible values for the justifySelf property. More... | |
enum | Keyword { Keyword::autoValue } |
Public Member Functions | |
GridItem () noexcept | |
Creates an item with default parameters. More... | |
GridItem (Component &componentToUse) noexcept | |
Creates an item with a given Component to use. More... | |
GridItem (Component *componentToUse) noexcept | |
Creates an item with a given Component to use. More... | |
void | setArea (const String &areaName) |
Short-hand. More... | |
void | setArea (Property rowStart, Property columnStart) |
Short-hand, span of 1 by default. More... | |
void | setArea (Property rowStart, Property columnStart, Property rowEnd, Property columnEnd) |
Short-hand. More... | |
GridItem | withAlignSelf (AlignSelf newAlignSelf) const noexcept |
Returns a copy of this object with a new alignSelf property. More... | |
GridItem | withArea (const String &areaName) const noexcept |
Short-hand. More... | |
GridItem | withArea (Property rowStart, Property columnStart) const noexcept |
Short-hand, span of 1 by default. More... | |
GridItem | withArea (Property rowStart, Property columnStart, Property rowEnd, Property columnEnd) const noexcept |
Short-hand. More... | |
GridItem | withColumn (StartAndEndProperty column) const noexcept |
Returns a copy of this object with a new column property. More... | |
GridItem | withHeight (float newHeight) const noexcept |
Returns a copy of this object with a new height. More... | |
GridItem | withJustifySelf (JustifySelf newJustifySelf) const noexcept |
Returns a copy of this object with a new justifySelf property. More... | |
GridItem | withMargin (Margin newMargin) const noexcept |
Returns a copy of this object with a new margin. More... | |
GridItem | withOrder (int newOrder) const noexcept |
Returns a copy of this object with a new order. More... | |
GridItem | withRow (StartAndEndProperty row) const noexcept |
Returns a copy of this object with a new row property. More... | |
GridItem | withSize (float newWidth, float newHeight) const noexcept |
Returns a copy of this object with a new size. More... | |
GridItem | withWidth (float newWidth) const noexcept |
Returns a copy of this object with a new width. More... | |
Public Attributes | |
AlignSelf | alignSelf = AlignSelf::autoValue |
This is the align-self property of the item. More... | |
String | area |
Component * | associatedComponent = nullptr |
If this is non-null, it represents a Component whose bounds are controlled by this item. More... | |
StartAndEndProperty | column = { Keyword::autoValue, Keyword::autoValue } |
These are the start and end properties of the column. More... | |
Rectangle< float > | currentBounds |
The item's current bounds. More... | |
float | height = notAssigned |
JustifySelf | justifySelf = JustifySelf::autoValue |
This is the justify-self property of the item. More... | |
Margin | margin |
The margin to leave around this item. More... | |
float | maxHeight = notAssigned |
float | maxWidth = notAssigned |
float | minHeight = 0.0f |
float | minWidth = 0.0f |
int | order = 0 |
Determines the order used to lay out items in their grid container. More... | |
StartAndEndProperty | row = { Keyword::autoValue, Keyword::autoValue } |
These are the start and end properties of the row. More... | |
float | width = notAssigned |
|
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. |
|
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. |
|
strong |
|
noexcept |
Creates an item with default parameters.
|
noexcept |
Creates an item with a given Component to use.
|
noexcept |
Creates an item with a given Component to use.
void juce::GridItem::setArea | ( | const String & | areaName | ) |
Short-hand.
Short-hand, span of 1 by default.
void juce::GridItem::setArea | ( | Property | rowStart, |
Property | columnStart, | ||
Property | rowEnd, | ||
Property | columnEnd | ||
) |
Short-hand.
Returns a copy of this object with a new alignSelf property.
Short-hand, span of 1 by default.
|
noexcept |
Short-hand.
|
noexcept |
Returns a copy of this object with a new column property.
Returns a copy of this object with a new height.
|
noexcept |
Returns a copy of this object with a new justifySelf property.
Returns a copy of this object with a new margin.
Returns a copy of this object with a new order.
|
noexcept |
Returns a copy of this object with a new row property.
Returns a copy of this object with a new size.
Returns a copy of this object with a new width.
AlignSelf juce::GridItem::alignSelf = AlignSelf::autoValue |
This is the align-self property of the item.
This determines the alignment of the item along the column.
String juce::GridItem::area |
Component* juce::GridItem::associatedComponent = nullptr |
If this is non-null, it represents a Component whose bounds are controlled by this item.
StartAndEndProperty juce::GridItem::column = { Keyword::autoValue, Keyword::autoValue } |
These are the start and end properties of the column.
float juce::GridItem::height = notAssigned |
JustifySelf juce::GridItem::justifySelf = JustifySelf::autoValue |
This is the justify-self property of the item.
This determines the alignment of the item along the row.
Margin juce::GridItem::margin |
The margin to leave around this item.
float juce::GridItem::maxHeight = notAssigned |
float juce::GridItem::maxWidth = notAssigned |
float juce::GridItem::minHeight = 0.0f |
float juce::GridItem::minWidth = 0.0f |
int juce::GridItem::order = 0 |
Determines the order used to lay out items in their grid container.
StartAndEndProperty juce::GridItem::row = { Keyword::autoValue, Keyword::autoValue } |
These are the start and end properties of the row.
float juce::GridItem::width = notAssigned |