class
ADrawer
- Module
- Arc
- Header
#include "Arc/Widgets/ADrawer.h"- Namespace
Arcf
Constructors
| Signature | Name | Description |
|---|---|---|
~ADrawer() override | ~ADrawer |
Public functions
| Returns | Name | Description |
|---|---|---|
ARC_WIDGET_ARGS | ||
void | Open | |
void | Close | |
void | CloseImmediate | |
void | Toggle | |
bool | IsOpen | |
float | GetCurrentOpenAmount | |
float | GetSize | |
void | SetSize | |
float | GetInset | 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. |
void | SetInset | |
ArcRect | GetPanelRect | The panel rect in absolute space at the current open amount, gutter applied. |
void | SetHandleResizes | |
void | SetOnClosed | |
void | SetOnCloseFinished | |
ArcVec2 | ComputeDesiredSize | |
void | ArrangeChildren | |
bool | CanSkipArrange | Refused: the content rect is derived from the open amount, which is driven by a clock rather than by a setter. |
int32_t | OnPaint | |
CReply | OnMouseButtonDown | |
CReply | OnMouseButtonUp | |
CReply | OnMouseMove | |
void | OnMouseLeave | |
EArcCursorType | OnCursorQuery | |
bool | ClaimsPointerExclusively | |
EHitTestResult | OnHitTest | |
bool | CanCacheDesiredSize | Reports 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() overrideARC_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() constGetCurrentOpenAmount
C++
float GetCurrentOpenAmount() constGetSize
C++
float GetSize() constSetSize
C++
void SetSize(float size)GetInset
C++
float GetInset() constGutter 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() constThe 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 overrideArrangeChildren
C++
void ArrangeChildren(const CGeometry& geo) overrideCanSkipArrange
C++
bool CanSkipArrange() const overrideRefused: 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 overrideOnMouseButtonDown
C++
CReply OnMouseButtonDown(const CGeometry& geo, const CPointerEvent& event) overrideOnMouseButtonUp
C++
CReply OnMouseButtonUp(const CGeometry& geo, const CPointerEvent& event) overrideOnMouseMove
C++
CReply OnMouseMove(const CGeometry& geo, const CPointerEvent& event) overrideOnMouseLeave
C++
void OnMouseLeave(const CPointerEvent& event) overrideOnCursorQuery
C++
EArcCursorType OnCursorQuery(const CGeometry& geo, const CPointerEvent& event) const overrideClaimsPointerExclusively
C++
bool ClaimsPointerExclusively(const CGeometry& geo, const ArcVec2& absolutePosition) const overrideOnHitTest
C++
EHitTestResult OnHitTest(const CGeometry& geo, const ArcVec2& absolutePosition) const overrideCanCacheDesiredSize
C++
bool CanCacheDesiredSize() const overrideReports 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 overrideGenerated from Arc/Widgets/ADrawer.h via arc.json · Nov 5, 2026Version 1.0.0