AWind
Gauge Class Reference

Gauge window class, that allows visualisaion of data in form of bar or radial pointer. More...

#include <Gauge.h>

Inheritance diagram for Gauge:
Window GaugeBar GaugeRadialPointer

Public Member Functions

 Gauge (int left, int top, int width, int height)
 Constructor. More...
 
void SetFillColor (Color fillColor)
 Sets fill color.
 
void SetMinMax (float minVal, float maxVal)
 Sets values range. More...
 
float SetValue (float value)
 Sets display value. More...
 
- Public Member Functions inherited from Window
 Window (const __FlashStringHelper *name, int left, int top, int width, int height)
 Constructor. More...
 
virtual void SetDecorators (DecoratorList *decorators)
 Sets window decorators list.
 
DecoratorList * GetDecorators ()
 Returns window decorators list.
 
void AddDecorator (Decorator *decorator)
 Adds decorator to the decaorator list.
 
DialogFindDialog (const __FlashStringHelper *id)
 
void RegisterDialog (const __FlashStringHelper *id, Dialog *dlg)
 
IDialogClosedEventReceiver::DialogResults DoDialog (Dialog *dlg)
 
void RegisterTouchEventReceiver (ITouchEventReceiver *touchEventReceiver)
 Registers receiver for touch event. More...
 
virtual bool IsAwaitTouch ()
 Returns true if window await touch action (like button) or false if touch manager should ignore this window during processing of touch events.
 
virtual void OnTouching (DC *dc)
 Touch manager calls this function in the loop as long as touch action proceeds.
 
virtual bool OnTouch (int x, int y)
 Touch manager calls this function right after touch is released.
 
WindowRootWindow ()
 Returns pointer to root window. MainWindow does not have any parents.
 
virtual void Move (int left, int top, int width, int height)
 Moves and resizes window relativly to the parent window. More...
 
void Invalidate ()
 If function is called than the window manager updates the window.
 
bool IsDirty ()
 Returns true if window has to be updated.
 
int Left ()
 Returns window left coordinate relative to the parent window.
 
int Top ()
 Returns window top coordinate relative to the parent window.
 
int Width ()
 Returns window width.
 
int Height ()
 Returns window height.
 
void AddChild (Window *window)
 Adds window child window.
 
WindowParent ()
 Returns Parent window.
 
void SetVisible (bool isVisible)
 Sets window visibility status.
 
bool IsVisible ()
 Returns true if window visible and false is hidden.
 
LinkedList< Window > & Children ()
 Returns list of children window.
 
void Redraw (DC *dc)
 Performs full window redraw. More...
 

Public Attributes

Color _fillColor
 Gauge fill color.
 
float _value
 Current gauge value.
 
float _oldValue
 Previos gauge value.
 
float _minValue
 Gauge min limit.
 
float _maxValue
 Gauge max limit.
 
bool _drawOnlyPointer
 Defines whether only pointer (not scale has to be drawn)
 

Static Public Attributes

static const float _sector_angle_rad = 3.14 / 2 * 0.8
 

Additional Inherited Members

- Protected Member Functions inherited from Window
void PrepareDC (DC *dc)
 Setups window coordinate system. This function called by window manager right before window has to be redrawn and it is intended for internal use. More...
 
virtual void OnDraw (DC *dc)
 If derived class needs to draw something in window client area, this function has to be ovverriden. More...
 
- Protected Attributes inherited from Window
int _left
 window left coordinate relative to the parent window
 
int _top
 window top coordinate relative to the parent window
 
int _width
 window width
 
int _height
 window height
 
bool _isVisible
 if this variable is false this window and all child windows are not visualized
 
LinkedList< Window_children
 list of children windows. All children window are positioned relative to parent window
 
Window_parent
 pointer to parent window
 
bool _isDirty
 if true than window manager will redraw this window.
 
DecoratorList * _decorators
 contains list of drawig commands. If they are shared between more than one window -> SRAM usage optimisation
 
ITouchEventReceiver_touchEventReceiver
 call back event receiver for touch actions
 

Detailed Description

Gauge window class, that allows visualisaion of data in form of bar or radial pointer.

Constructor & Destructor Documentation

Gauge::Gauge ( int  left,
int  top,
int  width,
int  height 
)
inline

Constructor.

Parameters
gaugeTypedefines gauge appearance
leftleft coordinate relative to parent indow
toptop coordinate relative to parent indow
widthwindow width
heightwindow height

Member Function Documentation

void Gauge::SetMinMax ( float  minVal,
float  maxVal 
)
inline

Sets values range.

Parameters
minValmin value
maxValmax value
float Gauge::SetValue ( float  value)
inline

Sets display value.

Parameters
valuedesired value
Returns
if value is above limits than limit otherwise value

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