Nebula
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
IO::ConsoleHandler Class Reference

#include <consolehandler.h>

Detailed Description

Base class for all console handlers.

Console handlers are attached to Nebula's central console object and are notified by the console object about output and deliver input to the console.

Copyright
(C) 2006 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits Core::RefCounted.

Inherited by Dynui::ImguiConsoleHandler, IO::HistoryConsoleHandler, IO::LogFileConsoleHandler, OSX::OSXConsoleHandler, Posix::PosixConsoleHandler, and Win32::Win32ConsoleHandler.

Public Member Functions

 ConsoleHandler ()
 constructor
 
virtual ~ConsoleHandler ()
 destructor
 
virtual void Open ()
 called by console when attached
 
virtual void Close ()
 called by console when removed
 
bool IsOpen () const
 return true if currently open
 
virtual void Update ()
 called by Console::Update()
 
virtual void Print (const Util::String &s)
 called by console to output data
 
virtual void Error (const Util::String &s)
 called by console with serious error
 
virtual void Warning (const Util::String &s)
 called by console to output warning
 
virtual void Confirm (const Util::String &s)
 called by console to display a confirmation message box
 
virtual void DebugOut (const Util::String &s)
 called by console to output debug string
 
virtual bool HasInput ()
 return true if input is available
 
virtual Util::String GetInput ()
 read available input
 
- Public Member Functions inherited from Core::RefCounted
 RefCounted ()
 constructor
 
int GetRefCount () const
 get the current refcount
 
void AddRef ()
 increment refcount by one
 
void Release ()
 decrement refcount and destroy object if refcount is zero
 
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
 
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
 
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
 
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
 
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
 
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
 
const Util::String & GetClassName () const
 get the class name
 
Util::FourCC GetClassFourCC () const
 get the class FourCC code
 

Private Member Functions

 __DeclareClass (ConsoleHandler)
 

Private Attributes

bool isOpen
 

Additional Inherited Members

- Static Public Member Functions inherited from Core::RefCounted
static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
 
- Protected Member Functions inherited from Core::RefCounted
virtual ~RefCounted ()
 destructor (called when refcount reaches zero)
 

Constructor & Destructor Documentation

◆ ConsoleHandler()

IO::ConsoleHandler::ConsoleHandler ( )

constructor

◆ ~ConsoleHandler()

IO::ConsoleHandler::~ConsoleHandler ( )
virtual

destructor

Member Function Documentation

◆ __DeclareClass()

IO::ConsoleHandler::__DeclareClass ( ConsoleHandler )
private

◆ Close()

void IO::ConsoleHandler::Close ( )
virtual

called by console when removed

Reimplemented in Dynui::ImguiConsoleHandler, and IO::LogFileConsoleHandler.

◆ Confirm()

void IO::ConsoleHandler::Confirm ( const Util::String & s)
virtual

called by console to display a confirmation message box

Reimplemented in OSX::OSXConsoleHandler, and Win32::Win32ConsoleHandler.

◆ DebugOut()

void IO::ConsoleHandler::DebugOut ( const Util::String & s)
virtual

called by console to output debug string

Reimplemented in Dynui::ImguiConsoleHandler, IO::HistoryConsoleHandler, IO::LogFileConsoleHandler, OSX::OSXConsoleHandler, Posix::PosixConsoleHandler, and Win32::Win32ConsoleHandler.

◆ Error()

void IO::ConsoleHandler::Error ( const Util::String & s)
virtual

called by console with serious error

Reimplemented in Dynui::ImguiConsoleHandler, IO::HistoryConsoleHandler, IO::LogFileConsoleHandler, OSX::OSXConsoleHandler, Posix::PosixConsoleHandler, and Win32::Win32ConsoleHandler.

◆ GetInput()

String IO::ConsoleHandler::GetInput ( )
virtual

read available input

Reimplemented in OSX::OSXConsoleHandler, Posix::PosixConsoleHandler, and Win32::Win32ConsoleHandler.

◆ HasInput()

bool IO::ConsoleHandler::HasInput ( )
virtual

return true if input is available

Reimplemented in OSX::OSXConsoleHandler, Posix::PosixConsoleHandler, and Win32::Win32ConsoleHandler.

◆ IsOpen()

bool IO::ConsoleHandler::IsOpen ( ) const
inline

return true if currently open

◆ Open()

void IO::ConsoleHandler::Open ( )
virtual

called by console when attached

Reimplemented in Dynui::ImguiConsoleHandler, and IO::LogFileConsoleHandler.

◆ Print()

void IO::ConsoleHandler::Print ( const Util::String & s)
virtual

called by console to output data

Reimplemented in Dynui::ImguiConsoleHandler, IO::HistoryConsoleHandler, IO::LogFileConsoleHandler, OSX::OSXConsoleHandler, Posix::PosixConsoleHandler, and Win32::Win32ConsoleHandler.

◆ Update()

void IO::ConsoleHandler::Update ( )
virtual

called by Console::Update()

◆ Warning()

void IO::ConsoleHandler::Warning ( const Util::String & s)
virtual

called by console to output warning

Reimplemented in Dynui::ImguiConsoleHandler, IO::HistoryConsoleHandler, IO::LogFileConsoleHandler, OSX::OSXConsoleHandler, Posix::PosixConsoleHandler, and Win32::Win32ConsoleHandler.

Member Data Documentation

◆ isOpen

bool IO::ConsoleHandler::isOpen
private
The documentation for this class was generated from the following files: