GfxMenuConfig.h File Reference

This file contains the base drawing structures and helper methods for drawing onto graphical screens, be it mono or colour. More...

Go to the source code of this file.

Classes
struct	tcgfx::ColorGfxMenuConfig< FONTPTR >
class	tcgfx::GridPosition
class	tcgfx::GridPositionWithId
class	tcgfx::ItemDisplayProperties
class	tcgfx::ItemDisplayPropertiesFactory
class	tcgfx::NullItemDisplayPropertiesFactory
class	tcgfx::ConfigurableItemDisplayPropertiesFactory

Enumerations
enum	tcgfx::EditCursorMode { tcgfx::CURSOR_MODE_UNDERLINE , tcgfx::CURSOR_MODE_BACKGROUND_BOX }

Functions
void	tcgfx::prepareDefaultGfxConfig (ColorGfxMenuConfig< void * > *config)
bool	tcgfx::itemNeedsValue (GridPosition::GridJustification justification)
bool	tcgfx::itemNeedsName (GridPosition::GridJustification justification)
GridPosition::GridJustification	tcgfx::coreJustification (GridPosition::GridJustification j)
uint32_t	tcgfx::MakePropsKey (uint16_t menuId, bool parentKey, ItemDisplayProperties::ComponentType ty)

Variables
const uint8_t PROGMEM	loResEditingIcon [] = { 0x7c, 0x06, 0x18, 0x18, 0x06, 0x7c }
const uint8_t PROGMEM	loResActiveIcon [] = { 0x20, 0x60, 0xfe, 0xfe, 0x60, 0x20 }
const uint8_t PROGMEM	defActiveIcon []
const uint8_t PROGMEM	defEditingIcon []

Detailed Description

This file contains the base drawing structures and helper methods for drawing onto graphical screens, be it mono or colour.

Enumeration Type Documentation

EditCursorMode

enum tcgfx::EditCursorMode

How the editing cursor should be represented on the display

Enumerator
CURSOR_MODE_UNDERLINE	Show an underline underneath the area being edited, default
CURSOR_MODE_BACKGROUND_BOX	Fill the area being edited in a different color

Function Documentation

prepareDefaultGfxConfig()

void tcgfx::prepareDefaultGfxConfig

(

ColorGfxMenuConfig< void * > *

config

)

Deprecated:

don't use in new designs, for backward compatibility, may be removed in future.

Parameters

config

the config object to fill in.

Deprecated:

do not use in new designs use drawing properties instead, may be removed in a future release

Parameters

config

the config to be filled in.

itemNeedsValue()

bool tcgfx::itemNeedsValue ( GridPosition::GridJustification  justification )

inline

A helper function that checks if a particular justification includes the value

Parameters

justification

the justification to check

Returns

true if the value is needed

itemNeedsName()

bool tcgfx::itemNeedsName ( GridPosition::GridJustification  justification )

inline

A helper function that checks if a particular justification includes the name

Parameters

justification

the justification to check

Returns

true if the name is needed

coreJustification()

GridPosition::GridJustification tcgfx::coreJustification ( GridPosition::GridJustification  j )

inline

Get the core justification part, eg left, right centre

Parameters

j	the justification to check

Returns

the core part, just left, right centre etc.

Variable Documentation

loResEditingIcon

const uint8_t loResEditingIcon = { 0x7c, 0x06, 0x18, 0x18, 0x06, 0x7c }

extern

The default editing icon for approx 100-150 dpi resolution displays

The low resolution icon for editing status

loResActiveIcon

const uint8_t loResActiveIcon = { 0x20, 0x60, 0xfe, 0xfe, 0x60, 0x20 }

extern

The default active icon for approx 100-150 dpi resolution displays

The low resolution icon for indicating active status

defActiveIcon

const uint8_t defActiveIcon

extern

Initial value:

= {
        0x00, 0x01, 0x80, 0x03, 0x80, 0x07, 0x80, 0x0f, 0x80, 0x1f, 0xff, 0x3f,
        0xff, 0x3f, 0x80, 0x1f, 0x80, 0x0f, 0x80, 0x07, 0x80, 0x03, 0x00, 0x01
}

The low resolution icon for indicating active status

The default active icon for approx 100-150 dpi resolution displays

defEditingIcon

const uint8_t PROGMEM defEditingIcon[]

extern

The low resolution icon for editing status