NullUI Class Reference

Back to the index.

Public Member Functions | List of all members
NullUI Class Reference

Dummy UI, which does not do anything. More...

#include <NullUI.h>

Inheritance diagram for NullUI:
UI ReferenceCountable

Public Member Functions

 NullUI (GXemul *gxemul)
 Constructs a NullUI. More...
 
virtual ~NullUI ()
 
virtual void Initialize ()
 Does nothing, for the dummy UI. More...
 
virtual void UpdateUI ()
 Does nothing, for the dummy UI. More...
 
virtual void ShowStartupBanner ()
 Does nothing, for the dummy UI. More...
 
virtual void ShowDebugMessage (const string &msg)
 Does nothing, for the dummy UI. More...
 
virtual void ShowDebugMessage (Component *component, const string &msg)
 Does nothing, for the dummy UI. More...
 
virtual void ShowCommandMessage (const string &command)
 Does nothing, for the dummy UI. More...
 
virtual void FatalError (const string &msg)
 Does nothing, for the dummy UI. More...
 
virtual void RedisplayInputLine (const string &inputline, size_t cursorPosition)
 Does nothing, for the dummy UI. More...
 
virtual void InputLineDone ()
 Executed by the CommandInterpreter when a line has been completed (with a newline). More...
 
virtual int MainLoop ()
 Runs the main loop. Ignored by the NullUI. More...
 
virtual void Shutdown ()
 Shuts down the UI. More...
 
- Public Member Functions inherited from UI
 UI (GXemul *gxemul)
 Constructs a User Interface. More...
 
virtual ~UI ()
 
void SetIndentationMessage (const string &msg)
 Sets an indentation message, which indents all debug output. More...
 
string GetIndentationMessage () const
 Gets the indentation message. More...
 
- Public Member Functions inherited from ReferenceCountable
 ReferenceCountable ()
 Default constructor, which initializes the reference count to zero. More...
 
 ~ReferenceCountable ()
 

Additional Inherited Members

- Protected Attributes inherited from UI
GXemulm_gxemul
 
string m_indentationMsg
 

Detailed Description

Dummy UI, which does not do anything.

Definition at line 37 of file NullUI.h.

Constructor & Destructor Documentation

◆ NullUI()

NullUI::NullUI ( GXemul gxemul)

Constructs a NullUI.

Parameters
gxemulPointer to the owning GXemul instance.

Definition at line 32 of file NullUI.cc.

◆ ~NullUI()

NullUI::~NullUI ( )
virtual

Definition at line 38 of file NullUI.cc.

Member Function Documentation

◆ FatalError()

void NullUI::FatalError ( const string &  msg)
virtual

Does nothing, for the dummy UI.

Parameters
msgThe error message to show. (Ignored.)

Implements UI.

Definition at line 73 of file NullUI.cc.

◆ Initialize()

void NullUI::Initialize ( )
virtual

Does nothing, for the dummy UI.

Implements UI.

Definition at line 43 of file NullUI.cc.

◆ InputLineDone()

void NullUI::InputLineDone ( )
virtual

Executed by the CommandInterpreter when a line has been completed (with a newline).

For the NullUI, this is ignored.

Implements UI.

Definition at line 83 of file NullUI.cc.

◆ MainLoop()

int NullUI::MainLoop ( )
virtual

Runs the main loop. Ignored by the NullUI.

The NullUI returns 0 immediately.

Implements UI.

Definition at line 93 of file NullUI.cc.

◆ RedisplayInputLine()

void NullUI::RedisplayInputLine ( const string &  inputline,
size_t  cursorPosition 
)
virtual

Does nothing, for the dummy UI.

Parameters
inputlineThe entire input line. (Ignored.)
cursorPositionThe current cursor position. 0 is at the leftmost position. (Ignored.)

Implements UI.

Definition at line 78 of file NullUI.cc.

◆ ShowCommandMessage()

void NullUI::ShowCommandMessage ( const string &  command)
virtual

Does nothing, for the dummy UI.

Parameters
commandThe command to show. (Ignored.)

Implements UI.

Definition at line 68 of file NullUI.cc.

◆ ShowDebugMessage() [1/2]

void NullUI::ShowDebugMessage ( Component component,
const string &  msg 
)
virtual

Does nothing, for the dummy UI.

Parameters
componentA pointer to the Component. (Ignored.)
msgThe message to show. (Ignored.)

Implements UI.

Definition at line 63 of file NullUI.cc.

◆ ShowDebugMessage() [2/2]

void NullUI::ShowDebugMessage ( const string &  msg)
virtual

Does nothing, for the dummy UI.

Parameters
msgThe message to show. (Ignored.)

Implements UI.

Definition at line 58 of file NullUI.cc.

◆ ShowStartupBanner()

void NullUI::ShowStartupBanner ( )
virtual

Does nothing, for the dummy UI.

Implements UI.

Definition at line 48 of file NullUI.cc.

◆ Shutdown()

void NullUI::Shutdown ( )
virtual

Shuts down the UI.

Called from e.g. the "quit" command.

Implements UI.

Definition at line 88 of file NullUI.cc.

◆ UpdateUI()

void NullUI::UpdateUI ( )
virtual

Does nothing, for the dummy UI.

Implements UI.

Definition at line 53 of file NullUI.cc.


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

Generated on Tue Aug 25 2020 19:25:06 for GXemul by doxygen 1.8.18