Closes #712 ## Summary **What is the goal of this PR?** - To add new settings for toggling on/off embedded CSS styles in the reader. This gives more control and customization to the user over how the ereader experience looks. **What changes are included?** - Added new "Embedded Style" option to the Reader settings - Added new "Book's Style" option for "Paragraph Alignment" - User's selected "Paragraph Alignment" will take precedence and override the embedded CSS `text-align` property, _unless_ the user has "Book's Style" set as their "Paragraph Alignment" ## Additional Context  https://github.com/user-attachments/assets/9e404b13-c7e0-41c7-9406-4715f389166a Addresses feedback from the community about the new CSS feature: https://github.com/crosspoint-reader/crosspoint-reader/pull/700 --- ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**YES**_, Claude Code
195 lines
5.8 KiB
C++
195 lines
5.8 KiB
C++
#pragma once
|
|
#include <cstdint>
|
|
#include <iosfwd>
|
|
|
|
class CrossPointSettings {
|
|
private:
|
|
// Private constructor for singleton
|
|
CrossPointSettings() = default;
|
|
|
|
// Static instance
|
|
static CrossPointSettings instance;
|
|
|
|
public:
|
|
// Delete copy constructor and assignment
|
|
CrossPointSettings(const CrossPointSettings&) = delete;
|
|
CrossPointSettings& operator=(const CrossPointSettings&) = delete;
|
|
|
|
enum SLEEP_SCREEN_MODE {
|
|
DARK = 0,
|
|
LIGHT = 1,
|
|
CUSTOM = 2,
|
|
COVER = 3,
|
|
BLANK = 4,
|
|
COVER_CUSTOM = 5,
|
|
SLEEP_SCREEN_MODE_COUNT
|
|
};
|
|
enum SLEEP_SCREEN_COVER_MODE { FIT = 0, CROP = 1, SLEEP_SCREEN_COVER_MODE_COUNT };
|
|
enum SLEEP_SCREEN_COVER_FILTER {
|
|
NO_FILTER = 0,
|
|
BLACK_AND_WHITE = 1,
|
|
INVERTED_BLACK_AND_WHITE = 2,
|
|
SLEEP_SCREEN_COVER_FILTER_COUNT
|
|
};
|
|
|
|
// Status bar display type enum
|
|
enum STATUS_BAR_MODE {
|
|
NONE = 0,
|
|
NO_PROGRESS = 1,
|
|
FULL = 2,
|
|
BOOK_PROGRESS_BAR = 3,
|
|
ONLY_BOOK_PROGRESS_BAR = 4,
|
|
CHAPTER_PROGRESS_BAR = 5,
|
|
STATUS_BAR_MODE_COUNT
|
|
};
|
|
|
|
enum ORIENTATION {
|
|
PORTRAIT = 0, // 480x800 logical coordinates (current default)
|
|
LANDSCAPE_CW = 1, // 800x480 logical coordinates, rotated 180° (swap top/bottom)
|
|
INVERTED = 2, // 480x800 logical coordinates, inverted
|
|
LANDSCAPE_CCW = 3, // 800x480 logical coordinates, native panel orientation
|
|
ORIENTATION_COUNT
|
|
};
|
|
|
|
// Front button layout options (legacy)
|
|
// Default: Back, Confirm, Left, Right
|
|
// Swapped: Left, Right, Back, Confirm
|
|
enum FRONT_BUTTON_LAYOUT {
|
|
BACK_CONFIRM_LEFT_RIGHT = 0,
|
|
LEFT_RIGHT_BACK_CONFIRM = 1,
|
|
LEFT_BACK_CONFIRM_RIGHT = 2,
|
|
BACK_CONFIRM_RIGHT_LEFT = 3,
|
|
FRONT_BUTTON_LAYOUT_COUNT
|
|
};
|
|
|
|
// Front button hardware identifiers (for remapping)
|
|
enum FRONT_BUTTON_HARDWARE {
|
|
FRONT_HW_BACK = 0,
|
|
FRONT_HW_CONFIRM = 1,
|
|
FRONT_HW_LEFT = 2,
|
|
FRONT_HW_RIGHT = 3,
|
|
FRONT_BUTTON_HARDWARE_COUNT
|
|
};
|
|
|
|
// Side button layout options
|
|
// Default: Previous, Next
|
|
// Swapped: Next, Previous
|
|
enum SIDE_BUTTON_LAYOUT { PREV_NEXT = 0, NEXT_PREV = 1, SIDE_BUTTON_LAYOUT_COUNT };
|
|
|
|
// Font family options
|
|
enum FONT_FAMILY { BOOKERLY = 0, NOTOSANS = 1, OPENDYSLEXIC = 2, FONT_FAMILY_COUNT };
|
|
// Font size options
|
|
enum FONT_SIZE { SMALL = 0, MEDIUM = 1, LARGE = 2, EXTRA_LARGE = 3, FONT_SIZE_COUNT };
|
|
enum LINE_COMPRESSION { TIGHT = 0, NORMAL = 1, WIDE = 2, LINE_COMPRESSION_COUNT };
|
|
enum PARAGRAPH_ALIGNMENT {
|
|
JUSTIFIED = 0,
|
|
LEFT_ALIGN = 1,
|
|
CENTER_ALIGN = 2,
|
|
RIGHT_ALIGN = 3,
|
|
BOOK_STYLE = 4,
|
|
PARAGRAPH_ALIGNMENT_COUNT
|
|
};
|
|
|
|
// Auto-sleep timeout options (in minutes)
|
|
enum SLEEP_TIMEOUT {
|
|
SLEEP_1_MIN = 0,
|
|
SLEEP_5_MIN = 1,
|
|
SLEEP_10_MIN = 2,
|
|
SLEEP_15_MIN = 3,
|
|
SLEEP_30_MIN = 4,
|
|
SLEEP_TIMEOUT_COUNT
|
|
};
|
|
|
|
// E-ink refresh frequency (pages between full refreshes)
|
|
enum REFRESH_FREQUENCY {
|
|
REFRESH_1 = 0,
|
|
REFRESH_5 = 1,
|
|
REFRESH_10 = 2,
|
|
REFRESH_15 = 3,
|
|
REFRESH_30 = 4,
|
|
REFRESH_FREQUENCY_COUNT
|
|
};
|
|
|
|
// Short power button press actions
|
|
enum SHORT_PWRBTN { IGNORE = 0, SLEEP = 1, PAGE_TURN = 2, SHORT_PWRBTN_COUNT };
|
|
|
|
// Hide battery percentage
|
|
enum HIDE_BATTERY_PERCENTAGE { HIDE_NEVER = 0, HIDE_READER = 1, HIDE_ALWAYS = 2, HIDE_BATTERY_PERCENTAGE_COUNT };
|
|
|
|
// UI Theme
|
|
enum UI_THEME { CLASSIC = 0, LYRA = 1 };
|
|
|
|
// Sleep screen settings
|
|
uint8_t sleepScreen = DARK;
|
|
// Sleep screen cover mode settings
|
|
uint8_t sleepScreenCoverMode = FIT;
|
|
// Sleep screen cover filter
|
|
uint8_t sleepScreenCoverFilter = NO_FILTER;
|
|
// Status bar settings
|
|
uint8_t statusBar = FULL;
|
|
// Text rendering settings
|
|
uint8_t extraParagraphSpacing = 1;
|
|
uint8_t textAntiAliasing = 1;
|
|
// Short power button click behaviour
|
|
uint8_t shortPwrBtn = IGNORE;
|
|
// EPUB reading orientation settings
|
|
// 0 = portrait (default), 1 = landscape clockwise, 2 = inverted, 3 = landscape counter-clockwise
|
|
uint8_t orientation = PORTRAIT;
|
|
// Button layouts (front layout retained for migration only)
|
|
uint8_t frontButtonLayout = BACK_CONFIRM_LEFT_RIGHT;
|
|
uint8_t sideButtonLayout = PREV_NEXT;
|
|
// Front button remap (logical -> hardware)
|
|
// Used by MappedInputManager to translate logical buttons into physical front buttons.
|
|
uint8_t frontButtonBack = FRONT_HW_BACK;
|
|
uint8_t frontButtonConfirm = FRONT_HW_CONFIRM;
|
|
uint8_t frontButtonLeft = FRONT_HW_LEFT;
|
|
uint8_t frontButtonRight = FRONT_HW_RIGHT;
|
|
// Reader font settings
|
|
uint8_t fontFamily = BOOKERLY;
|
|
uint8_t fontSize = MEDIUM;
|
|
uint8_t lineSpacing = NORMAL;
|
|
uint8_t paragraphAlignment = JUSTIFIED;
|
|
// Auto-sleep timeout setting (default 10 minutes)
|
|
uint8_t sleepTimeout = SLEEP_10_MIN;
|
|
// E-ink refresh frequency (default 15 pages)
|
|
uint8_t refreshFrequency = REFRESH_15;
|
|
uint8_t hyphenationEnabled = 0;
|
|
|
|
// Reader screen margin settings
|
|
uint8_t screenMargin = 5;
|
|
// OPDS browser settings
|
|
char opdsServerUrl[128] = "";
|
|
char opdsUsername[64] = "";
|
|
char opdsPassword[64] = "";
|
|
// Hide battery percentage
|
|
uint8_t hideBatteryPercentage = HIDE_NEVER;
|
|
// Long-press chapter skip on side buttons
|
|
uint8_t longPressChapterSkip = 1;
|
|
// UI Theme
|
|
uint8_t uiTheme = LYRA;
|
|
// Sunlight fading compensation
|
|
uint8_t fadingFix = 0;
|
|
// Use book's embedded CSS styles for EPUB rendering (1 = enabled, 0 = disabled)
|
|
uint8_t embeddedStyle = 1;
|
|
|
|
~CrossPointSettings() = default;
|
|
|
|
// Get singleton instance
|
|
static CrossPointSettings& getInstance() { return instance; }
|
|
|
|
uint16_t getPowerButtonDuration() const {
|
|
return (shortPwrBtn == CrossPointSettings::SHORT_PWRBTN::SLEEP) ? 10 : 400;
|
|
}
|
|
int getReaderFontId() const;
|
|
|
|
bool saveToFile() const;
|
|
bool loadFromFile();
|
|
|
|
float getReaderLineCompression() const;
|
|
unsigned long getSleepTimeoutMs() const;
|
|
int getRefreshFrequency() const;
|
|
};
|
|
|
|
// Helper macro to access settings
|
|
#define SETTINGS CrossPointSettings::getInstance()
|