Класс LiquidScreen из Arduino библиотеки LiquidMenu для создания меню на LCD дисплее

Данный класс представляет собой экран, показанный на дисплее.

#include <LiquidMenu.h>

Экран состоит из объектов LiquidLine. Он содержит указатели на них и вызывает их функции, когда активен. Он также знает, на какой строке находится фокус. Объекты данного класса попадают в объект LiquidMenu, который управляет ими. Публичные методы данного класса предназначены только для конфигурации.

Содержание

• Дружественные классы
• Конструкторы
• Публичные методы
  • add_line()
  • hide()
  • set_focusPosition()

Дружественные классы

class LiquidMenu

Конструкторы

LiquidScreen()

Основной конструктор. Это главный конструктор, который вызывается каждый раз.

Синтаксис

LiquidScreen::LiquidScreen()

LiquidScreen()

Конструктор с одним объектом LiquidLine.

Синтаксис

LiquidScreen::LiquidScreen(LiquidLine & liquidLine)

Параметры

• &liquidLine – указатель на объект LiquidLine.

LiquidScreen()

Конструктор с двумя объектами LiquidLine.

Синтаксис

LiquidScreen::LiquidScreen(LiquidLine & liquidLine1,
                           LiquidLine & liquidLine2 
                          )

Параметры

• &liquidLine1 – указатель на объект LiqudiLine;
• &liquidLine2 – указатель на объект LiqudiLine.

LiquidScreen()

Конструктор с тремя объектами LiquidLine.

Синтаксис

LiquidScreen::LiquidScreen(LiquidLine & liquidLine1,
                           LiquidLine & liquidLine2,
                           LiquidLine & liquidLine3 
                           )

Параметры

• &liquidLine1 – указатель на объект LiquidLine;
• &liquidLine2 – указатель на объект LiquidLine;
• &liquidLine3 – указатель на объект LiquidLine.

LiquidScreen()

Конструктор с четырьмя объектами LiquidLine.

Синтаксис

LiquidScreen::LiquidScreen(LiquidLine & liquidLine1,
                           LiquidLine & liquidLine2,
                           LiquidLine & liquidLine3,
                           LiquidLine & liquidLine4 
                          )	

Параметры

• &liquidLine1 – указатель на объект LiquidLine;
• &liquidLine2 – указатель на объект LiquidLine;
• &liquidLine3 – указатель на объект LiquidLine;
• &liquidLine4 – указатель на объект LiqudiLine.

Публичные методы

add_line()

Добавляет объект LiquidLine на экран.

Синтаксис

bool LiquidScreen::add_line(LiquidLine & liquidLine)

Параметры

&liquidLine – указатель на объект LiquidLine.

Возвращает

true в случае успеха и false, если максимальное количество строк уже было достигнуто.

Примечание

Максимальное количество строк на экран указывается в LiquidMenu_config.h как MAX_LINES. По умолчанию равно 8.

hide()

Скрывает экран.

Скрытие экрана означает, что он будет пропуще при циклическом прокручивании экранов.

Синтаксис

void LiquidScreen::hide(bool hide)	

Параметры

• hide – true для скрытия и false для отображения.

Примечание

Он всё еще может быть показан с помощью методов change_screen.

set_focusPosition()

Устанавливает позицию фокуса для всего экрана за раз.

Допустимые значения – LEFT и RIGHT. Позиция CUSTOM является не допустимой для данной функции, поскольку ей необходимо индивидуальное указание строки и столбца для каждой строки.

Синтаксис

bool LiquidScreen::set_focusPosition(Position position)

Параметры

• position – LEFT или RIGHT.

Возвращает

true в случае успеха и false, если позиция указана неправильно.

Примечание

Position – это класс перечисления. При указании позиции используйте Position::(член класса).

Теги