WidgetRange

Functions

template<typename T>
inline BaseWidgetValue<T> *WIDGET_RANGE(const T value, const T step, const T min, const T max, const char *format, const uint8_t cursorOffset = 0, const bool cycle = false, void (*callback)(const T&) = nullptr)

Function to create a new WidgetRange<T> instance.

Template Parameters:

T – The type of the value.

Parameters:

  • value – The initial value of the widget.

  • step – The step value for incrementing/decrementing (use negative value to invert the range).

  • min – The minimum value of the range.

  • max – The maximum value of the range.

  • format – The format string for displaying the value.

  • cursorOffset – The offset for the cursor (default is 0).

  • cycle – Whether the value should cycle when out of range (default is false).

  • callback – The callback function to call when the value changes (default is nullptr).

template<typename T>
inline BaseWidgetValue<Ref<T>> *WIDGET_RANGE_REF(T &value, const T step, const T min, const T max, const char *format, const uint8_t cursorOffset = 0, const bool cycle = false, void (*callback)(const Ref<T>&) = nullptr)

Function to create a new WidgetRange<T> instance.

Note

Make sure that value reference is not deallocated earlier than this widget.

Template Parameters:

T – The type of the value.

Parameters:

  • value – The reference value of this widget (this value is passed by reference, so it can be updated externally).

  • step – The step value for incrementing/decrementing (use negative value to invert the range).

  • min – The minimum value of the range.

  • max – The maximum value of the range.

  • format – The format string for displaying the value.

  • cursorOffset – The offset for the cursor (default is 0).

  • cycle – Whether the value should cycle when out of range (default is false).

  • callback – The callback function to call when the value changes (default is nullptr), parameter of callback will be Ref<T>

template<typename T, typename V = T>
class WidgetRange : public BaseWidgetValue<T>
#include <WidgetRange.h>

Widget that allows user to select a value from a range. Manages a value within a specified range, allowing incrementing and decrementing.

Template Parameters:

  • T – the type of value

  • V – the type of stored value, the type should be fully compatible with T type, meaning all arithmetic operations, cast, assignment should be supported for type V. For example, T = int, V = Ref<int>.

Public Functions

inline WidgetRange(const V value, const T step, const T min, const T max, const char *format, const uint8_t cursorOffset = 0, const bool cycle = false, void (*callback)(const V&) = nullptr)
inline void setValue(const V &newValue) override

Sets the value.

Note

You need to call LcdMenu::refresh after this method to see the changes.

Parameters:

newValue – The value to set.

Protected Functions

inline virtual bool process(LcdMenu *menu, const unsigned char command) override

Process command.

Handle commands:

  • UP - increment value and trigger callback;

  • DOWN - decrement value and trigger callback;

inline bool increment()

Increments the value. If the value exceeds maxValue and cycling is enabled, the value resets to minValue.

Returns:

true if incremented or reset (in case of cycle)

inline bool decrement()

Decrements the value. If the value falls below minValue and cycling is enabled, the value resets to maxValue.

Returns:

true if decremented or reset (in case of cycle)

inline virtual uint8_t draw(char *buffer, const uint8_t start) override

Draw the widget into specified buffer.

Parameters:

  • buffer – the buffer where widget will be drawn

  • start – the index where to start drawing in the buffer

Protected Attributes

const T step
const T minValue
const T maxValue
const bool cycle