Doku für view_info

This commit is contained in:
Tristan Krause 2019-07-31 15:41:54 +02:00
parent be3545fcbb
commit 69e02c20c2
89 changed files with 576 additions and 218 deletions

View file

@ -1,4 +1,4 @@
#ifndef COMMIT_HASH_H
#define COMMIT_HASH_H
const char COMMIT_HASH[] = "9640bb00c8b16073af9eadf9e40ede3c2e0e4020";
const char COMMIT_HASH[] = "be3545fcbb7c7a41ec40d489efc952369f81bf5a";
#endif // COMMIT_HASH_H

View file

@ -3,25 +3,57 @@
#include "view.h"
/*! View for simple text message output. */
/**
* Klasse für einfache Textausgaben (Benachrichtigungen).
* Diese können mit einem Button geschlossen werden.
*/
class ViewInfo : public View
{
public:
/**
* Standard-Konstruktor ohne Argumente
*/
ViewInfo(void);
/**
* Setzt den Text dieser Benachrichtigungs-View
* \param text Text der View
*/
virtual void setText(std::string text);
virtual void setLabelClose(std::string label);;
/**
* Setzt die Beschriftung des Buttons zum Schließen
* \param label Beschriftung des Buttons
*/
virtual void setLabelClose(std::string label);
/**
* Setzt den Call der aufgerufen wird, wenn der Button angewählt wird.
* Wurde setCall weggelassen oder setCall(nullptr) gesetzt, wird diese View nur geschlossen und keine weitere Aktion ausgelöst.
* \param call Nachfolge-Aktion
*/
virtual void setCall(call_t call);
/**
* Zeichnet diese View mit dem Benachrichtigungstext.
*/
virtual void draw(void) override;
/**
* Verarbeitet einen Tastendruck, z.B. Enter = Button angewählt.
* \param key gedrückte Taste
* \return Call, der nach dem keypress ausgeführt werden soll
*/
virtual call_t keypress(int& key) override;
protected:
std::string text;
std::string label_close;
int close_offset_x = 0;
int close_offset_y = 0;
constexpr static int text_offset_x = 2;
constexpr static int text_offset_y = 3;
std::string text; //!< Benachrichtigungstext dieser View
std::string label_close; //!< Beschriftung für Button zum Schließen
int close_offset_x = 0; //!< Relative X Koordinate des Buttons zum Schließen im Window
int close_offset_y = 0; //!< Relative Y Koordinate des Buttons zum Schließen im Window
constexpr static int text_offset_x = 2; //!< Relativer Abstand des Textes zum linken Rahmen
constexpr static int text_offset_y = 3; //!< Relativer Abstand des Textes zum oberen Rahmen
};
#endif // VIEW_INFO