DsGaugeBase Class Reference

DsGaugeBase is a base class for all gauge views. More...

#include <ds_gauge_base.h>

Inheritance diagram for DsGaugeBase:

Public Member Functions
DsGaugeBase &	setBorderColor (DsColor color)
	Sets the border color.
DsGaugeBase &	setTrackColor (DsColor color)
	Sets the track color.
DsGaugeBase &	setActiveColor (DsColor color)
	Sets the active color.
DsGaugeBase &	setBorderThickness (uint8_t thickness)
	Sets the border thickness.
DsGaugeBase &	setValueColor (DsColor color)
	Sets the value text color.
DsGaugeBase &	setValueFont (const ds_bitmap_font_t *font)
	Sets the font used to render the value.
DsGaugeBase &	setValueFormat (const char *format)
	Sets the printf() style format string used to print the value.
DsGaugeBase &	setValueOffset (int16_t offset)
	Sets the vertical value offset in pixels.
DsGaugeBase &	setTitleColor (DsColor color)
	Sets the title color.
DsGaugeBase &	setTitleFont (const ds_bitmap_font_t *font)
	Sets the font used to render the title.
DsGaugeBase &	setTitle (const char *title)
	Sets the title.
DsGaugeBase &	setTitleOffset (int16_t offset)
	Sets the vertical title offset in pixels.
DsGaugeBase &	setUnitColor (DsColor color)
	Sets the unit color.
DsGaugeBase &	setUnitFont (const ds_bitmap_font_t *font)
	Sets the font used to render the unit.
DsGaugeBase &	setUnit (const char *unit)
	Sets the unit.
DsGaugeBase &	setUnitOffset (int16_t offset)
	Sets the vertical unit offset in pixels.

Protected Attributes
DsColor	mBorderColor
DsColor	mTrackColor
DsColor	mActiveColor
DsColor	mValueColor
const ds_bitmap_font_t *	mValueFont
const char *	mValueFormat
DsRect	mValueRegion
DsColor	mTitleColor
const ds_bitmap_font_t *	mTitleFont
const char *	mTitleText
DsRect	mTitleRegion
DsColor	mUnitColor
const ds_bitmap_font_t *	mUnitFont
const char *	mUnitText
DsRect	mUnitRegion
int16_t	mValueOffset
int16_t	mTitleOffset
int16_t	mUnitOffset
uint8_t	mBorderThickness

Detailed Description

DsGaugeBase is a base class for all gauge views.

Member Function Documentation

setActiveColor()

DsGaugeBase & DsGaugeBase::setActiveColor

(

DsColor

color

)

Sets the active color.

Parameters

color

Color

Return values

Reference

to the current object. This allows daisy-chaining calls.

setBorderColor()

DsGaugeBase & DsGaugeBase::setBorderColor

(

DsColor

color

)

Sets the border color.

Parameters

color

Color

Return values

Reference

to the current object. This allows daisy-chaining calls.

setBorderThickness()

DsGaugeBase & DsGaugeBase::setBorderThickness

(

uint8_t

thickness

)

Sets the border thickness.

Parameters

thickness

Border thickness in pixels

Return values

Reference

to the current object. This allows daisy-chaining calls.

setTitle()

DsGaugeBase & DsGaugeBase::setTitle

(

const char *

title

)

Sets the title.

Parameters

title

Pointer to a C string

Return values

Reference

to the current object. This allows daisy-chaining calls.

setTitleColor()

DsGaugeBase & DsGaugeBase::setTitleColor

(

DsColor

color

)

Sets the title color.

Parameters

color

Color

Return values

Reference

to the current object. This allows daisy-chaining calls.

setTitleFont()

DsGaugeBase & DsGaugeBase::setTitleFont

(

const ds_bitmap_font_t *

font

)

Sets the font used to render the title.

Parameters

font

Font

Return values

Reference

to the current object. This allows daisy-chaining calls.

setTitleOffset()

DsGaugeBase & DsGaugeBase::setTitleOffset

(

int16_t

offset

)

Sets the vertical title offset in pixels.

Parameters

offset

Offset in pixels (positive will print the title lower on the screen)

Return values

Reference

to the current object. This allows daisy-chaining calls.

setTrackColor()

DsGaugeBase & DsGaugeBase::setTrackColor

(

DsColor

color

)

Sets the track color.

Parameters

color

Color

Return values

Reference

to the current object. This allows daisy-chaining calls.

setUnit()

DsGaugeBase & DsGaugeBase::setUnit

(

const char *

unit

)

Sets the unit.

Parameters

title

Pointer to a C string

Return values

Reference

to the current object. This allows daisy-chaining calls.

setUnitColor()

DsGaugeBase & DsGaugeBase::setUnitColor

(

DsColor

color

)

Sets the unit color.

Parameters

color

Color

Return values

Reference

to the current object. This allows daisy-chaining calls.

setUnitFont()

DsGaugeBase & DsGaugeBase::setUnitFont

(

const ds_bitmap_font_t *

font

)

Sets the font used to render the unit.

Parameters

font

Font

Return values

Reference

to the current object. This allows daisy-chaining calls.

setUnitOffset()

DsGaugeBase & DsGaugeBase::setUnitOffset

(

int16_t

offset

)

Sets the vertical unit offset in pixels.

Parameters

offset

Offset in pixels (positive will print the unit higher on the screen)

Return values

Reference

to the current object. This allows daisy-chaining calls.

setValueColor()

DsGaugeBase & DsGaugeBase::setValueColor

(

DsColor

color

)

Sets the value text color.

Parameters

color

Color

Return values

Reference

to the current object. This allows daisy-chaining calls.

setValueFont()

DsGaugeBase & DsGaugeBase::setValueFont

(

const ds_bitmap_font_t *

font

)

Sets the font used to render the value.

Parameters

font

Font

Return values

Reference

to the current object. This allows daisy-chaining calls.

setValueFormat()

DsGaugeBase & DsGaugeBase::setValueFormat

(

const char *

format

)

Sets the printf() style format string used to print the value.

Parameters

format

printf() style format string. Only one float value is passed to the printf() formatting function.

Return values

Reference

to the current object. This allows daisy-chaining calls.

setValueOffset()

DsGaugeBase & DsGaugeBase::setValueOffset

(

int16_t

offset

)

Sets the vertical value offset in pixels.

Parameters

offset

Offset in pixels (positive will print the value lower on the screen)

Return values

Reference

to the current object. This allows daisy-chaining calls.

---

The documentation for this class was generated from the following file:

• inc/ds_gauge_base.h