class

AToolGrid

Module
Arc
Header
#include "Arc/Widgets/AToolGrid.h"
Namespace
Arcf

Properties

TypeNameDescription
std::function<TSharedPtr<AToolTile>(const FArcToolItem&)>MakeTileBuilds the tile for an item; unset makes a plain AToolTile. A host that needs drag payloads or tooltips customises the tile here.
std::function<void(const std::string&)>OnToolActivatedA tile was clicked or activated from the keyboard.

Public functions

ReturnsNameDescription
ARC_WIDGET_ARGS
voidSetGroups
voidSetFilter
const std::string&GetFilter
voidSetSelectedId
const std::string&GetSelectedId
boolMatches
const std::vector<TSharedPtr<AToolTile>>&GetVisibleTilesThe tiles left after the filter, in reading order.
int32_tGetCursor
std::stringGetCursorId
boolMoveCursorMoves the keyboard cursor by columns (dx) and rows (dy); false at an edge.
boolActivateCursor
ArcVec2ComputeDesiredSize
voidArrangeChildren
int32_tOnPaint
CReplyOnKeyDown
voidOnFocusReceived
voidOnFocusLost
boolIsFocusable
EFocusVisualGetFocusVisual
boolPaintsOwnFocusThe tile under the keyboard cursor draws the ring.
const char*GetTypeName

Function details

ARC_WIDGET_ARGS

C++
ARC_WIDGET_ARGS(AToolGrid) ARC_ARG(int32_t, Columns) ARC_WIDGET_ARGS_END() void Construct(const CArguments& args)

SetGroups

C++
void SetGroups(std::vector<FArcToolGroup> groups)

SetFilter

C++
void SetFilter(const std::string& filter)

GetFilter

C++
const std::string& GetFilter() const

SetSelectedId

C++
void SetSelectedId(const std::string& id)

GetSelectedId

C++
const std::string& GetSelectedId() const

Matches

C++
static bool Matches(const std::string& label, const std::string& filter)

GetVisibleTiles

C++
const std::vector<TSharedPtr<AToolTile>>& GetVisibleTiles() const

The tiles left after the filter, in reading order.

GetCursor

C++
int32_t GetCursor() const

GetCursorId

C++
std::string GetCursorId() const

MoveCursor

C++
bool MoveCursor(int32_t dx, int32_t dy)

Moves the keyboard cursor by columns (dx) and rows (dy); false at an edge.

ActivateCursor

C++
bool ActivateCursor()

ComputeDesiredSize

C++
ArcVec2 ComputeDesiredSize(float scale) const override

ArrangeChildren

C++
void ArrangeChildren(const CGeometry& geo) override

OnPaint

C++
int32_t OnPaint(const CArcPaintArgs& args, const CGeometry& geo, CArcUIRenderer& renderer, int32_t layerId) const override

OnKeyDown

C++
CReply OnKeyDown(const CGeometry& geo, const CKeyEvent& event) override

OnFocusReceived

C++
void OnFocusReceived(const CFocusEvent& event) override

OnFocusLost

C++
void OnFocusLost(const CFocusEvent& event) override

IsFocusable

C++
bool IsFocusable() const override

GetFocusVisual

C++
EFocusVisual GetFocusVisual() const override

PaintsOwnFocus

C++
bool PaintsOwnFocus() const override

The tile under the keyboard cursor draws the ring.

GetTypeName

C++
const char* GetTypeName() const override
Generated from Arc/Widgets/AToolGrid.h via arc.json · Nov 5, 2026Version 1.0.0