APropertyRow
- Module
- Arc
- Header
#include "Arc/Widgets/APropertyRow.h"- Namespace
Arcf
Properties
| Type | Name | Description |
|---|---|---|
static constexpr int32_t | kInvalidDropFlashMs | Default 400. |
ArcDelegate<void()> | OnScrubBegin | |
ArcDelegate<void(float)> | OnScrubDelta | |
ArcDelegate<void()> | OnScrubEnd | |
ArcDelegate<void()> | OnResetToDefault | The reset arrow was clicked. |
Public functions
| Returns | Name | Description |
|---|---|---|
ARC_WIDGET_ARGS | under it across the row. | |
void | Construct | |
void | SetLabel | |
const std::string& | GetLabel | |
void | SetValue | |
TSharedPtr<AWidget> | GetValue | |
void | SetLabelWidget | A widget in the label column instead of the painted label: an editable map key, say. |
TSharedPtr<AWidget> | GetLabelWidget | |
void | SetLabelToolTip | The tooltip the label column shows (the value keeps its own). |
void | SetLabelColor | A token the label is drawn in instead of the state's, while the row has no error: a prefab override reads InfoText. |
void | SetIndent | Nesting depth in pixels: the dot and label move right, the value column stays where the rows above it put theirs. |
float | GetIndent | |
void | SetLabelSpansValue | A boolean's segments take only their own width at the end of the value column, and the label runs on up to them instead of stopping at the label column's edge. |
void | SetTrailing | Controls after the reset column: an array element's grip, duplicate and remove. |
void | SetStacked | |
bool | IsStacked | |
void | SetScrubbable | The label scrubs the value (property-row-number): a press that travels more than 2 px begins, every move reports the pixels travelled so far — Shift counts ten times, Ctrl a tenth — and the release ends it. |
bool | IsScrubbable | |
bool | IsScrubbing | |
void | SetSelectedProvider | Selection read at paint: a list's keyboard row, which the row's owner knows and the row does not. |
void | SetModified | The value differs from its default: dot, bright label, reset arrow. |
bool | IsModified | |
void | SetHasError | |
bool | HasError | |
void | SetSelected | |
bool | IsSelected | |
void | FlashInvalidDrop | A drop the row refuses: the border goes Error for a moment. |
bool | IsFlashingInvalidDrop | |
void | SetLabelWidth | The label column; 0 keeps the spec's. |
void | SetDotBeforeLabel | |
float | GetLabelWidth | |
float | GetRowHeight | |
ArcRect | GetResetRect | |
ArcRect | GetValueRect | |
ArcRect | GetLabelRect | |
ArcRect | GetTrailingRect | |
TSharedPtr<AWidget> | MakeEnumValue | The value control an enum property gets: a segmented control for up to three options, a dropdown past that. |
TSharedPtr<AWidget> | MakeBoolValue | The value control every boolean property gets (owner, 2026-10-06): the Mobility-style segmented control, "Enabled / Disabled" unless the property names its own labels, at the END of the value column so a long label is never squeezed by it. |
ArcVec2 | ComputeDesiredSize | |
void | ArrangeChildren | |
int32_t | OnPaint | |
CReply | OnMouseButtonDown | |
CReply | OnMouseMove | |
CReply | OnMouseButtonUp | |
void | OnMouseCaptureLost | |
void | OnMouseEnter | |
void | OnMouseLeave | |
bool | CanRetainPaint | |
int32_t | GetNumChildren | |
TSharedPtr<AWidget> | GetChildAt | |
const char* | GetTypeName |
Function details
ARC_WIDGET_ARGS
ARC_WIDGET_ARGS(APropertyRow) ARC_ARG(std::string, Label) ARC_ARG(bool, IsAsset) ARC_ARG(float, HeightOverride) ARC_ARG(float, LabelWidth) ARC_ARG(bool, DotBeforeLabel) ARC_ARG(bool, Stacked) ARC_CONTENT(APropertyRow, Value) ARC_WIDGET_ARGS_END() static constexpr int32_t kSegmentedEnumLimit = 3under it across the row.
Construct
void Construct(const CArguments& args)SetLabel
void SetLabel(const std::string& label)GetLabel
const std::string& GetLabel() constSetValue
void SetValue(TSharedPtr<AWidget> value)GetValue
TSharedPtr<AWidget> GetValue() constSetLabelWidget
void SetLabelWidget(TSharedPtr<AWidget> widget)A widget in the label column instead of the painted label: an editable map key, say. It is arranged across the column's width.
GetLabelWidget
TSharedPtr<AWidget> GetLabelWidget() constSetLabelToolTip
void SetLabelToolTip(const std::string& text)The tooltip the label column shows (the value keeps its own).
SetLabelColor
void SetLabelColor(const ArcColor* token)A token the label is drawn in instead of the state's, while the row has no error: a prefab override reads InfoText. Null clears it.
SetIndent
void SetIndent(float indent)Nesting depth in pixels: the dot and label move right, the value column stays where the rows above it put theirs.
GetIndent
float GetIndent() constSetLabelSpansValue
void SetLabelSpansValue(bool spans)A boolean's segments take only their own width at the end of the value column, and the label runs on up to them instead of stopping at the label column's edge.
SetTrailing
void SetTrailing(TSharedPtr<AWidget> widget)Controls after the reset column: an array element's grip, duplicate and remove.
SetStacked
void SetStacked(bool stacked)IsStacked
bool IsStacked() constSetScrubbable
void SetScrubbable(bool scrubbable)The label scrubs the value (property-row-number): a press that travels more than 2 px begins, every move reports the pixels travelled so far — Shift counts ten times, Ctrl a tenth — and the release ends it.
IsScrubbable
bool IsScrubbable() constIsScrubbing
bool IsScrubbing() constSetSelectedProvider
void SetSelectedProvider(std::function<bool()> provider)Selection read at paint: a list's keyboard row, which the row's owner knows and the row does not.
SetModified
void SetModified(bool modified)The value differs from its default: dot, bright label, reset arrow.
IsModified
bool IsModified() constSetHasError
void SetHasError(bool hasError)HasError
bool HasError() constSetSelected
void SetSelected(bool selected)IsSelected
bool IsSelected() constFlashInvalidDrop
void FlashInvalidDrop()A drop the row refuses: the border goes Error for a moment. Held on a clock rather than the motion system, so reduced motion still shows it.
IsFlashingInvalidDrop
bool IsFlashingInvalidDrop() constSetLabelWidth
void SetLabelWidth(float width)The label column; 0 keeps the spec's. A narrow mode panel sets 100.
SetDotBeforeLabel
void SetDotBeforeLabel(bool dotBeforeLabel)GetLabelWidth
float GetLabelWidth() constGetRowHeight
float GetRowHeight() constGetResetRect
ArcRect GetResetRect(const ArcRect& rowRect) constGetValueRect
ArcRect GetValueRect(const ArcRect& rowRect) constGetLabelRect
ArcRect GetLabelRect(const ArcRect& rowRect) constGetTrailingRect
ArcRect GetTrailingRect(const ArcRect& rowRect) constMakeEnumValue
static TSharedPtr<AWidget> MakeEnumValue(const std::vector<std::string>& options, int32_t selected, std::function<void(int32_t)> onChanged)The value control an enum property gets: a segmented control for up to three options, a dropdown past that.
MakeBoolValue
static TSharedPtr<AWidget> MakeBoolValue(std::function<bool()> get, std::function<void(bool)> set, std::function<bool()> mixed = nullptr, const std::string& trueLabel = std::string(), const std::string& falseLabel = std::string())The value control every boolean property gets (owner, 2026-10-06): the Mobility-style segmented control, "Enabled / Disabled" unless the property names its own labels, at the END of the value column so a long label is never squeezed by it. mixed true (co-selected values disagree) selects neither segment. Arrows and Space change it.
ComputeDesiredSize
ArcVec2 ComputeDesiredSize(float scale) const overrideArrangeChildren
void ArrangeChildren(const CGeometry& geo) overrideOnPaint
int32_t OnPaint(const CArcPaintArgs& args, const CGeometry& geo, CArcUIRenderer& renderer, int32_t layerId) const overrideOnMouseButtonDown
CReply OnMouseButtonDown(const CGeometry& geo, const CPointerEvent& event) overrideOnMouseMove
CReply OnMouseMove(const CGeometry& geo, const CPointerEvent& event) overrideOnMouseButtonUp
CReply OnMouseButtonUp(const CGeometry& geo, const CPointerEvent& event) overrideOnMouseCaptureLost
void OnMouseCaptureLost() overrideOnMouseEnter
void OnMouseEnter(const CGeometry& geo, const CPointerEvent& event) overrideOnMouseLeave
void OnMouseLeave(const CPointerEvent& event) overrideCanRetainPaint
bool CanRetainPaint() const overrideGetNumChildren
int32_t GetNumChildren() const overrideGetChildAt
TSharedPtr<AWidget> GetChildAt(int32_t index) const overrideGetTypeName
const char* GetTypeName() const override