mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-09 23:34:20 +00:00
186 lines
7.9 KiB
C++
186 lines
7.9 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE framework.
|
|
Copyright (c) Raw Material Software Limited
|
|
|
|
JUCE is an open source framework subject to commercial or open source
|
|
licensing.
|
|
|
|
By downloading, installing, or using the JUCE framework, or combining the
|
|
JUCE framework with any other source code, object code, content or any other
|
|
copyrightable work, you agree to the terms of the JUCE End User Licence
|
|
Agreement, and all incorporated terms including the JUCE Privacy Policy and
|
|
the JUCE Website Terms of Service, as applicable, which will bind you. If you
|
|
do not agree to the terms of these agreements, we will not license the JUCE
|
|
framework to you, and you must discontinue the installation or download
|
|
process and cease use of the JUCE framework.
|
|
|
|
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
|
|
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
|
|
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
|
|
|
|
Or:
|
|
|
|
You may also use this code under the terms of the AGPLv3:
|
|
https://www.gnu.org/licenses/agpl-3.0.en.html
|
|
|
|
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
|
|
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
|
|
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
/**
|
|
Describes the properties of an item inside a FlexBox container.
|
|
|
|
@see FlexBox
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API FlexItem final
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates an item with default parameters, and zero size. */
|
|
FlexItem() noexcept;
|
|
|
|
/** Creates an item with the given size. */
|
|
FlexItem (float width, float height) noexcept;
|
|
|
|
/** Creates an item with the given size and target Component. */
|
|
FlexItem (float width, float height, Component& targetComponent) noexcept;
|
|
|
|
/** Creates an item that represents an embedded FlexBox with a given size. */
|
|
FlexItem (float width, float height, FlexBox& flexBoxToControl) noexcept;
|
|
|
|
/** Creates an item with a given target Component. */
|
|
FlexItem (Component& componentToControl) noexcept;
|
|
|
|
/** Creates an item that represents an embedded FlexBox. This class will not
|
|
create a copy of the supplied flex box. You need to ensure that the
|
|
life-time of flexBoxToControl is longer than the FlexItem. */
|
|
FlexItem (FlexBox& flexBoxToControl) noexcept;
|
|
|
|
//==============================================================================
|
|
/** The item's current bounds. */
|
|
Rectangle<float> currentBounds;
|
|
|
|
/** If this is non-null, it represents a Component whose bounds are controlled by this item. */
|
|
Component* associatedComponent = nullptr;
|
|
|
|
/** If this is non-null, it represents a FlexBox whose bounds are controlled by this item. */
|
|
FlexBox* associatedFlexBox = nullptr;
|
|
|
|
/** Determines the order used to lay out items in their flex container.
|
|
Elements are laid out in ascending order of thus order value. Elements with the same order value
|
|
are laid out in the order in which they appear in the array.
|
|
*/
|
|
int order = 0;
|
|
|
|
/** Specifies the flex grow factor of this item.
|
|
This indicates the amount of space inside the flex container the item should take up.
|
|
*/
|
|
float flexGrow = 0.0f;
|
|
|
|
/** Specifies the flex shrink factor of the item.
|
|
This indicates the rate at which the item shrinks if there is insufficient space in
|
|
the container.
|
|
*/
|
|
float flexShrink = 1.0f;
|
|
|
|
/** Specifies the flex-basis of the item.
|
|
This is the initial main size of a flex item in the direction of flow. It determines the size
|
|
of the content-box unless specified otherwise using box-sizing.
|
|
*/
|
|
float flexBasis = 0.0f;
|
|
|
|
/** Possible value for the alignSelf property */
|
|
enum class AlignSelf
|
|
{
|
|
autoAlign, /**< Follows the FlexBox container's alignItems property. */
|
|
flexStart, /**< Item is aligned towards the start of the cross axis. */
|
|
flexEnd, /**< Item is aligned towards the end of the cross axis. */
|
|
center, /**< Item is aligned towards the center of the cross axis. */
|
|
stretch /**< Item is stretched from start to end of the cross axis. */
|
|
};
|
|
|
|
/** This is the align-self property of the item.
|
|
This determines the alignment of the item along the cross-axis (perpendicular to the direction
|
|
of flow).
|
|
*/
|
|
AlignSelf alignSelf = AlignSelf::autoAlign;
|
|
|
|
//==============================================================================
|
|
/** This constant can be used for sizes to indicate that 'auto' mode should be used. */
|
|
static const int autoValue = -2;
|
|
/** This constant can be used for sizes to indicate that no value has been set. */
|
|
static const int notAssigned = -1;
|
|
|
|
float width = (float) notAssigned; /**< The item's width. */
|
|
float minWidth = 0.0f; /**< The item's minimum width */
|
|
float maxWidth = (float) notAssigned; /**< The item's maximum width */
|
|
|
|
float height = (float) notAssigned; /**< The item's height */
|
|
float minHeight = 0.0f; /**< The item's minimum height */
|
|
float maxHeight = (float) notAssigned; /**< The item's maximum height */
|
|
|
|
/** Represents a margin. */
|
|
struct Margin final
|
|
{
|
|
Margin() noexcept; /**< Creates a margin of size zero. */
|
|
Margin (float size) noexcept; /**< Creates a margin with this size on all sides. */
|
|
Margin (float top, float right, float bottom, float left) noexcept; /**< Creates a margin with these sizes. */
|
|
|
|
float left; /**< Left margin size */
|
|
float right; /**< Right margin size */
|
|
float top; /**< Top margin size */
|
|
float bottom; /**< Bottom margin size */
|
|
};
|
|
|
|
/** The margin to leave around this item. */
|
|
Margin margin;
|
|
|
|
//==============================================================================
|
|
/** Returns a copy of this object with a new flex-grow value. */
|
|
FlexItem withFlex (float newFlexGrow) const noexcept;
|
|
|
|
/** Returns a copy of this object with new flex-grow and flex-shrink values. */
|
|
FlexItem withFlex (float newFlexGrow, float newFlexShrink) const noexcept;
|
|
|
|
/** Returns a copy of this object with new flex-grow, flex-shrink and flex-basis values. */
|
|
FlexItem withFlex (float newFlexGrow, float newFlexShrink, float newFlexBasis) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new width. */
|
|
FlexItem withWidth (float newWidth) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new minimum width. */
|
|
FlexItem withMinWidth (float newMinWidth) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new maximum width. */
|
|
FlexItem withMaxWidth (float newMaxWidth) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new height. */
|
|
FlexItem withHeight (float newHeight) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new minimum height. */
|
|
FlexItem withMinHeight (float newMinHeight) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new maximum height. */
|
|
FlexItem withMaxHeight (float newMaxHeight) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new margin. */
|
|
FlexItem withMargin (Margin) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new order. */
|
|
FlexItem withOrder (int newOrder) const noexcept;
|
|
|
|
/** Returns a copy of this object with a new alignSelf value. */
|
|
FlexItem withAlignSelf (AlignSelf newAlignSelf) const noexcept;
|
|
};
|
|
|
|
} // namespace juce
|