class

CArcCaretBlink

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

Public functions

ReturnsNameDescription
floatIntervalSecondsHalf-period in seconds, from CArcInputSettings (the OS rate through the host bridge).
doubleNowSecondsThe clock every caret reads, in seconds.
voidAdvanceClockForTestMoves the clock forward without waiting, for headless tests.
voidResetRestart fully visible.
boolIsVisible
boolIsVisibleForIsVisible, restarting first when caretKey differs from the last call's or the caret was not asked about for a while.
uint64_tMakeKeyA key from the caret position and the text length, the two things every caret paint already has.
uint64_tMix
uint64_tTextKeyThe key for a caret that always sits at the end of its text — the filter fields popups paint for themselves.

Function details

IntervalSeconds

C++
static float IntervalSeconds()

Half-period in seconds, from CArcInputSettings (the OS rate through the host bridge). 0 when the user turned blinking off: solid caret.

NowSeconds

C++
static double NowSeconds()

The clock every caret reads, in seconds.

AdvanceClockForTest

C++
static void AdvanceClockForTest(double seconds)

Moves the clock forward without waiting, for headless tests.

Reset

C++
void Reset() const

Restart fully visible.

IsVisible

C++
bool IsVisible() const

IsVisibleFor

C++
bool IsVisibleFor(uint64_t caretKey) const

IsVisible, restarting first when caretKey differs from the last call's or the caret was not asked about for a while.

MakeKey

C++
static uint64_t MakeKey(int64_t caretPosition, uint64_t textLength)

A key from the caret position and the text length, the two things every caret paint already has. Combine more with Mix when a field has a selection or a composition that should also restart it.

Mix

C++
static uint64_t Mix(uint64_t a, uint64_t b)

TextKey

C++
static uint64_t TextKey(const std::string& text)

The key for a caret that always sits at the end of its text — the filter fields popups paint for themselves.

Generated from Arc/Widgets/CArcCaretBlink.h via arc.json · Nov 5, 2026Version 1.0.0