modm API documentation
Public Member Functions | Friends | List of all members
modm::AbstractView< Allocator > Class Template Referenceabstract
User interface » Display Menu

The AbstractView class is the base class for all screens handled by the ViewStack class. More...

#include <modm/ui/menu/abstract_view.hpp>

Inheritance diagram for modm::AbstractView< Allocator >:
modm::IAbstractView modm::AbstractMenu< Allocator > modm::ChoiceMenu< Allocator > modm::StandardMenu< Allocator >

Public Member Functions

 AbstractView (modm::ViewStack< Allocator > *stack, uint8_t identifier)
 
modm::ViewStack< Allocator > * getViewStack ()
 
modm::GraphicDisplay & display ()
 
virtual void draw () = 0
 draw determine the output on the Graphic Display
 
uint8_t getIdentifier ()
 getIdentifier of the view.
 
virtual bool hasChanged () = 0
 hasChanged indicates the current displayed view has changed. This function prevents unnecessary drawing of the display More...
 
bool isAlive () const
 isAlive tells the ViewStack if it should remove this screen. More...
 
virtual void onRemove ()
 onRemove will be called right before the view gets deleted, can be reimplemented to reset external data.
 
void remove ()
 remove the view from the screen. The viewStack handles the deletion.
 
virtual void shortButtonPress (modm::MenuButtons::Button)
 shortButtonPress handle the action for the pressed button
 
virtual void update ()
 update The update function of the top most display gets called as often as possible. Only the update of the top view in each ViewStack gets called.
 

Friends

template<typename T >
class ViewStack
 

Detailed Description

template<typename Allocator = std::allocator<IAbstractView>>
class modm::AbstractView< Allocator >

The AbstractView class is the base class for all screens handled by the ViewStack class.

Author
Thorsten Lajewski

Constructor & Destructor Documentation

template<typename Allocator = std::allocator<IAbstractView>>
modm::AbstractView< Allocator >::AbstractView ( modm::ViewStack< Allocator > *  stack,
uint8_t  identifier 
)
inline
Parameters
stackpointer to the stack, the screen should be displayed on.
identifiercan be used to determine which screen is the currently displayed on the graphicDisplay

Member Function Documentation

virtual bool modm::IAbstractView::hasChanged ( )
inheritedpure virtual

hasChanged indicates the current displayed view has changed. This function prevents unnecessary drawing of the display

Returns
if true the display has to be redrawn.

Implemented in modm::StandardMenu< Allocator >, and modm::ChoiceMenu< Allocator >.

bool modm::IAbstractView::isAlive ( ) const
inheritedinline

isAlive tells the ViewStack if it should remove this screen.

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