class

ADrawer

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

Constructors

SignatureNameDescription
~ADrawer() override~ADrawer

Public functions

ReturnsNameDescription
ARC_WIDGET_ARGS
voidOpen
voidClose
voidCloseImmediate
voidToggle
boolIsOpen
floatGetCurrentOpenAmount
floatGetSize
voidSetSize
floatGetInsetGutter left between the panel and the three window edges it does not emerge from — the room its shadow needs in order to read as floating over the layout rather than as another docked strip.
voidSetInset
ArcRectGetPanelRectThe panel rect in absolute space at the current open amount, gutter applied.
voidSetHandleResizes
voidSetOnClosed
voidSetOnCloseFinished
ArcVec2ComputeDesiredSize
voidArrangeChildren
boolCanSkipArrangeRefused: the content rect is derived from the open amount, which is driven by a clock rather than by a setter.
int32_tOnPaint
CReplyOnMouseButtonDown
CReplyOnMouseButtonUp
CReplyOnMouseMove
voidOnMouseLeave
EArcCursorTypeOnCursorQuery
boolClaimsPointerExclusively
EHitTestResultOnHitTest
boolCanCacheDesiredSizeReports nothing of its own — the drawer occupies the overlay it is placed in and slides its content inside that.
const char*GetTypeName

Function details

~ADrawer

C++
~ADrawer() override

ARC_WIDGET_ARGS

C++
ARC_WIDGET_ARGS(ADrawer) ARC_ARG(EDrawerEdge, Edge) ARC_ARG(float, Size) ARC_ARG(bool, DimBackground) ARC_ARG(ArcColor, BackgroundColor) ARC_ARG(ArcColor, BorderColor) ARC_ARG(float, Inset) ARC_ARG(float, CornerRadius) ARC_CONTENT(ADrawer, Content) ARC_WIDGET_ARGS_END() void Construct(const CArguments& args)

Open

C++
void Open()

Close

C++
void Close()

CloseImmediate

C++
void CloseImmediate()

Toggle

C++
void Toggle()

IsOpen

C++
bool IsOpen() const

GetCurrentOpenAmount

C++
float GetCurrentOpenAmount() const

GetSize

C++
float GetSize() const

SetSize

C++
void SetSize(float size)

GetInset

C++
float GetInset() const

Gutter left between the panel and the three window edges it does not emerge from — the room its shadow needs in order to read as floating over the layout rather than as another docked strip.

SetInset

C++
void SetInset(float inset)

GetPanelRect

C++
ArcRect GetPanelRect() const

The panel rect in absolute space at the current open amount, gutter applied. Empty while the drawer is fully retracted.

SetHandleResizes

C++
void SetHandleResizes(bool handleResizes)

SetOnClosed

C++
void SetOnClosed(std::function<void()> onClosed)

SetOnCloseFinished

C++
void SetOnCloseFinished(std::function<void()> onCloseFinished)

ComputeDesiredSize

C++
ArcVec2 ComputeDesiredSize(float scale) const override

ArrangeChildren

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

CanSkipArrange

C++
bool CanSkipArrange() const override

Refused: the content rect is derived from the open amount, which is driven by a clock rather than by a setter. A skip freezes the slide.

OnPaint

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

OnMouseButtonDown

C++
CReply OnMouseButtonDown(const CGeometry& geo, const CPointerEvent& event) override

OnMouseButtonUp

C++
CReply OnMouseButtonUp(const CGeometry& geo, const CPointerEvent& event) override

OnMouseMove

C++
CReply OnMouseMove(const CGeometry& geo, const CPointerEvent& event) override

OnMouseLeave

C++
void OnMouseLeave(const CPointerEvent& event) override

OnCursorQuery

C++
EArcCursorType OnCursorQuery(const CGeometry& geo, const CPointerEvent& event) const override

ClaimsPointerExclusively

C++
bool ClaimsPointerExclusively(const CGeometry& geo, const ArcVec2& absolutePosition) const override

OnHitTest

C++
EHitTestResult OnHitTest(const CGeometry& geo, const ArcVec2& absolutePosition) const override

CanCacheDesiredSize

C++
bool CanCacheDesiredSize() const override

Reports nothing of its own — the drawer occupies the overlay it is placed in and slides its content inside that.

GetTypeName

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