Shellminator V3.0.1
Simple Terminal
Loading...
Searching...
No Matches
ShellminatorListDetailed Class Reference

#include <Shellminator-List-Detailed.hpp>

Inheritance diagram for ShellminatorListDetailed:
Collaboration diagram for ShellminatorListDetailed:

Public Member Functions

 ShellminatorListDetailed ()
 Empty constructor. More...
 
 ShellminatorListDetailed (const char *optionsList_p[], const char *detailList_p[], int listSize_p, const char *instruction_p)
 
void init (Shellminator *parent_p, Stream *channel_p) override
 Init function. More...
 
void printExtra (int index, bool noClear) override
 
- Public Member Functions inherited from ShellminatorList
 ShellminatorList ()
 Empty constructor. More...
 
 ShellminatorList (const char *optionsList_p[], int listSize_p, const char *instruction_p)
 
void init (Shellminator *parent_p, Stream *channel_p) override
 Init function. More...
 
void draw (bool noClear=false) override
 Draw function. More...
 
void update (int width_p, int height_p) override
 Update function. More...
 
void forceRedraw () override
 
void attachCallback (void(*func_p)(const char *[], int, int, ShellminatorScreen *))
 
virtual void printExtra (int index, bool noClear)
 
- Public Member Functions inherited from ShellminatorScreen
virtual void draw (bool noClear=false)
 Draw function. More...
 
virtual void init (Shellminator *parent_p, Stream *channel_p)
 Init function. More...
 
virtual void setOrigin (int x, int y)
 Origin of the top left corner. More...
 
virtual void update (int width_p, int height_p)
 Update function. More...
 
virtual void forceRedraw ()
 
int left ()
 Return the coordinate of the left column next to the object. More...
 
int right ()
 Return the coordinate of the right column next to the object. More...
 
int up ()
 Return the coordinate of the upper row next to the object. More...
 
int down ()
 Return the coordinate of the lower row next to the object. More...
 
ShellminatorgetParent ()
 
void attachEndFunction (void(*end_func_p)(Shellminator *))
 
void removeEndFunction ()
 

Protected Attributes

int detailStart = 0
 
const char ** detailList = NULL
 
- Protected Attributes inherited from ShellminatorList
bool redraw = true
 This flag shows that redraw is necessary. More...
 
int selected = 0
 
int drawOffset = 0
 
void(* func )(const char *[], int, int, ShellminatorScreen *) = NULL
 Pointer to the event callback function. More...
 
const char ** optionsList = NULL
 Pointer to the options list. More...
 
int listSize = 0
 Size of the options list. More...
 
const char * instruction = NULL
 Pointer to the instruction list. More...
 
int instructionLines = 0
 
- Protected Attributes inherited from ShellminatorScreen
Shellminatorparent = NULL
 Pointer to the caller terminal object. More...
 
Stream * channel = NULL
 
int width = 1
 Actual width of the object. More...
 
int height = 1
 Actual height of the object. More...
 
int originX = 1
 X coordinate of the origin. More...
 
int originY = 1
 Y coordinate of the origin. More...
 
void(* end_func )(Shellminator *) = NULL
 

Additional Inherited Members

- Public Attributes inherited from ShellminatorScreen
int row = 1
 It is used by the grid layout. More...
 
int column = 1
 It is used by the grid layout. More...
 
int columnSpan = 1
 It is used by the grid layout. More...
 
int rowSpan = 1
 It is used by the grid layout. More...
 
ShellminatorScreennextElement = NULL
 It is used by the grid layout. More...
 
void(*)(Shellminator *) getEndFunction ()
 

Detailed Description

Definition at line 56 of file Shellminator-List-Detailed.hpp.

Constructor & Destructor Documentation

◆ ShellminatorListDetailed() [1/2]

ShellminatorListDetailed::ShellminatorListDetailed ( )

Empty constructor.

Definition at line 36 of file Shellminator-List-Detailed.cpp.

◆ ShellminatorListDetailed() [2/2]

ShellminatorListDetailed::ShellminatorListDetailed ( const char *  optionsList_p[],
const char *  detailList_p[],
int  listSize_p,
const char *  instruction_p 
)

Definition at line 47 of file Shellminator-List-Detailed.cpp.

Member Function Documentation

◆ init()

void ShellminatorListDetailed::init ( Shellminator parent_p,
Stream *  channel_p 
)
overridevirtual

Init function.

This function is called by the host terminal, when the plot object gets registered to it. You can put all the initialisation section here.

Parameters
parent_pPointer to the caller terminal object.
channel_pThis is a pointer to a Stream object, which can be used to print the output data.
Note
Please use the channel_p object instead of parent -> channel method. This object can be a regular channel or a buffer accelerated one. The logic behind the buffering and flushing is handled by the caller terminal.

Reimplemented from ShellminatorScreen.

Definition at line 63 of file Shellminator-List-Detailed.cpp.

◆ printExtra()

void ShellminatorListDetailed::printExtra ( int  index,
bool  noClear 
)
overridevirtual

Reimplemented from ShellminatorList.

Definition at line 95 of file Shellminator-List-Detailed.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ detailList

const char** ShellminatorListDetailed::detailList = NULL
protected

Definition at line 82 of file Shellminator-List-Detailed.hpp.

◆ detailStart

int ShellminatorListDetailed::detailStart = 0
protected

Definition at line 81 of file Shellminator-List-Detailed.hpp.