autocolor.md

Source code

# Auto color support for GUIs in libtextworker

Cuz why not!

libtextworker's auto color system is somewhat beautiful, although it's a little mess there.

## Settings

It's defined under the "color" section in your theme file, like this:

```json
{
    "color": {
        "background": "light",
        "foreground": "default",
        "auto": true // or "yes"
    }
}

Starting from version 0.1.4, you can use hex colors and RGB colors (only from the non-development release).

color->background

Type: string

Defaults to light.

On previous versions, you only can choose between "dark" and "light".

color->foreground

Type: string

Defaults to default. That means the foreground color relies on the system scheme.

Options are default and hex colors.

color->auto

Type: boolean that GetConfig.yes_values and GetConfig.no_values support (depending on the application developer). Normal booleans (JSON's true and false) should work too.

Defaults to yes (enabled).

Automatically switches colors on system scheme change.

color->foreground/background-{variant}

Note: {variant} is either dark or light.

Optional.

Type: string.

First debut: 0.1.4

No default value. Accepts hex colors or default.

highlight->background{,-{mouse,finder}}

Highlight colors. For text highlighted by mouse or a Find/Replace dialog.

Optional.

Implementation for GUIs

The main class is libtextworker::UI::ColorManager.

Functions to override (if you need that):

• GetColor: get color defines

• GetFont: get font settings

• Configure: configure (a) widget(s)

New in 0.1.4: UISync class. As the name says, this class uses darkdetect.listener to change the application color when needed.

Run ColorManager::DoAutoColor() to get started.

Custom functions for coloring

See ColorManager's set*func (* = wildcard):

• setcolorfunc: Background

• setfontcfunc: Foreground (or font color/fontc in function name, no typo here!)

• setfontandcolorfunc: The combination of the 2 functions above (available on 0.1.4+)

Pass your widget/widget class, the function you want to use, and parameters if any (tuple type seems not working, don't know why?).

ColorManager::Configure will handle this itself.

-------------------------------

Updated on 2025-03-18 at 23:10:45 +0700