MPLABĀ® Harmony Graphics Suite  GFX v3.13.0
Legato API Documentation
legato_scheme.h File Reference

Schemes support various properties that make it possible to customize the color of widgets. More...

Include dependency graph for legato_scheme.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

union  leSchemeColorTable
 
struct  leScheme
 

Macros

#define LE_SCHEME_COLOR_COUNT   16
 
#define LE_SCHEME_COLOR_MODE_COUNT   LE_COLOR_MODE_COUNT
 

Typedefs

typedef enum leSchemeColor leSchemeColor
 
typedef union leSchemeColorTable leSchemeColorTable
 
typedef struct leScheme leScheme
 

Enumerations

enum  leSchemeColorModes {
  LE_SCHM_COLOR_MODE_GS_8 = LE_COLOR_MODE_GS_8, LE_SCHM_COLOR_MODE_RGB_332 = LE_COLOR_MODE_RGB_332, LE_SCHM_COLOR_MODE_RGB_565 = LE_COLOR_MODE_RGB_565, LE_SCHM_COLOR_MODE_RGBA_5551 = LE_COLOR_MODE_RGBA_5551,
  LE_SCHM_COLOR_MODE_RGB_888 = LE_COLOR_MODE_RGB_888, LE_SCHM_COLOR_MODE_RGBA_8888 = LE_COLOR_MODE_RGBA_8888, LE_SCHM_COLOR_MODE_ARGB_8888 = LE_COLOR_MODE_ARGB_8888, LE_SCHM_COLOR_MODE_GLOBALPALETTE = LE_COLOR_MODE_PALETTE,
  LE_SCHM_COLOR_MODE_MONOCHROME = LE_COLOR_MODE_MONOCHROME
}
 
enum  leSchemeColor {
  LE_SCHM_BASE, LE_SCHM_HIGHLIGHT, LE_SCHM_HIGHLIGHTLIGHT, LE_SCHM_SHADOW,
  LE_SCHM_SHADOWDARK, LE_SCHM_FOREGROUND, LE_SCHM_FOREGROUND_INACTIVE, LE_SCHM_FOREGROUND_DISABLED,
  LE_SCHM_BACKGROUND, LE_SCHM_BACKGROUND_INACTIVE, LE_SCHM_BACKGROUND_DISABLED, LE_SCHM_TEXT,
  LE_SCHM_TEXT_HIGHLIGHT, LE_SCHM_TEXT_HIGHLIGHTTEXT, LE_SCHM_TEXT_INACTIVE, LE_SCHM_TEXT_DISABLED
}
 

Functions

void leScheme_Initialize (leScheme *scheme)
 Initialize scheme. More...
 
leColor leScheme_GetColor (const leScheme *schm, leSchemeColor clr, leColorMode mode)
 Gets a scheme color. More...
 
leColor leScheme_GetRenderColor (const leScheme *schm, leSchemeColor clr)
 Gets a scheme render color for the current layer color mode. More...
 

Variables

const struct leScheme leDefaultScheme
 

Detailed Description

Schemes support various properties that make it possible to customize the color of widgets.

A scheme is a collection of colors that can be referenced by one or more widgets. Widgets may use schemes in different ways. While the color names strive to be intuitive they aren't always used in the manner in which they describe.

Function Documentation

◆ leScheme_GetColor()

leColor leScheme_GetColor ( const leScheme schm,
leSchemeColor  clr,
leColorMode  mode 
)

Gets a scheme color.

Gets a scheme color

clr = leScheme_GetColor(schm, LE_SCHM_BASE, CM_RGB_565);
Parameters
schemeis the scheme to query.
clris the scheme color to get.
modeis the color mode to get.
Returns
leColor.

◆ leScheme_GetRenderColor()

leColor leScheme_GetRenderColor ( const leScheme schm,
leSchemeColor  clr 
)

Gets a scheme render color for the current layer color mode.

Gets a scheme color

leScheme* scheme;
clr = leScheme_GetRenderColor(schm, LE_SCHM_BASE);
Parameters
schemeis the scheme to query.
clris the scheme color to get.
Returns
leColor.

◆ leScheme_Initialize()

void leScheme_Initialize ( leScheme scheme)

Initialize scheme.

Initializes scheme

const leScheme* scheme;
Parameters
schemeis the scheme to initialize.
Returns
void.