Public Member Functions

pl7::console::Console Class Reference

#include <Console.h>

Inheritance diagram for pl7::console::Console:
cl7::logging::Logger::IListener

List of all members.

Public Member Functions

const ApplicationGetApp () const
ApplicationGetApp ()
const LoggerGetLogger () const
LoggerGetLogger ()
bool IsDown () const
bool Init (Application *app, Logger *logger)
bool Shutdown ()
bool Move (const FrameStats &frame_stats)
void ScrollUp ()
void ScrollDown ()
void Toggle ()
void AddInput (const cl7::string_type &str)
void ClearInput (bool clear_input_cache=false)
const cl7::string_typeGetCurrentInput () const
void SetCurrentInput (const cl7::string_type &str)
size_t GetCurrentInputCursor () const
void SetInfoText (const cl7::string_type &info_text)
void SetImage (const fl7::Image &image)
void OnLog (cl7::logging::Logger *logger, const cl7::string_type &message, const cl7::logging::LogEntry::Type type, const cl7::char_type *const file_name, const unsigned line_number)

Member Function Documentation

void pl7::console::Console::AddInput ( const cl7::string_type str  ) 

Adds the given string to the input cache or processes it directly (if "complete").

Adds the given string to the input cache.

void pl7::console::Console::ClearInput ( bool  clear_input_cache = false  ) 

Clears the current input string (and the input cache, if indicated).

Application* pl7::console::Console::GetApp (  )  [inline]

Returns the application object.

const Application* pl7::console::Console::GetApp (  )  const [inline]

Returns the application object.

const cl7::string_type & pl7::console::Console::GetCurrentInput (  )  const

Returns the current input string.

size_t pl7::console::Console::GetCurrentInputCursor (  )  const

Returns the editing cursor position within the current input string.

Logger* pl7::console::Console::GetLogger (  )  [inline]

Returns the logger object.

const Logger* pl7::console::Console::GetLogger (  )  const [inline]

Returns the logger object.

bool pl7::console::Console::Init ( Application app,
Logger logger 
)

Initializes the (debug) console.

bool pl7::console::Console::IsDown (  )  const [inline]

Returns true, if the console window is visible.

bool pl7::console::Console::Move ( const FrameStats frame_stats  ) 

Performs actions.

void pl7::console::Console::OnLog ( cl7::logging::Logger logger,
const cl7::string_type message,
const cl7::logging::LogEntry::Type  type,
const cl7::char_type *const   file_name,
const unsigned  line_number 
) [virtual]

Callback function which is called after the creation of a new log entry.

Implements cl7::logging::Logger::IListener.

void pl7::console::Console::ScrollDown (  ) 

Lets the console window scroll down (to show it).

void pl7::console::Console::ScrollUp (  ) 

Lets the console window scroll up (to hide it).

void pl7::console::Console::SetCurrentInput ( const cl7::string_type str  ) 

Sets the current input string.

void pl7::console::Console::SetImage ( const fl7::Image image  ) 

Sets the image of the picture box.

void pl7::console::Console::SetInfoText ( const cl7::string_type info_text  ) 

Sets the text of the info label.

bool pl7::console::Console::Shutdown (  ) 

Shuts down the (debug) console.

void pl7::console::Console::Toggle (  ) 

Toggles the console window.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines