modm API documentation
modm::AbstractMenu< Allocator > Class Template Referenceabstract

The AbstractMenu class is the same as the AbstractView class, except it forces the developer to reimplement the handling of button presses. More...

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

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

Public Member Functions

 AbstractMenu (modm::ViewStack< Allocator > *stack, uint8_t identifier)
 
virtual void shortButtonPress (modm::MenuButtons::Button button) = 0
 shortButtonPress handle the action for the pressed button
 
modm::GraphicDisplaydisplay ()
 
virtual void draw () = 0
 draw determine the output on the Graphic Display
 
uint8_t getIdentifier ()
 getIdentifier of the view.
 
modm::ViewStack< Allocator > * getViewStack ()
 
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 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.
 

Detailed Description

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

The AbstractMenu class is the same as the AbstractView class, except it forces the developer to reimplement the handling of button presses.

Author
Thorsten Lajewski

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: