Urho3D::Console Class Reference

Console window with log history and command line prompt. More...

#include <Console.h>

Inheritance diagram for Urho3D::Console:

Collaboration diagram for Urho3D::Console:

Public Member Functions
	Console (Context *context)
	Construct.
	~Console ()
	Destruct.
void	SetDefaultStyle (XMLFile *style)
	Set UI elements' style from an XML file.
void	SetVisible (bool enable)
	Show or hide.
void	Toggle ()
	Toggle visibility.
void	SetAutoVisibleOnError (bool enable)
	Automatically set console to visible when receiving an error log message.
void	SetCommandInterpreter (const String &interpreter)
	Set the command interpreter.
void	SetNumBufferedRows (unsigned rows)
	Set number of buffered rows.
void	SetNumRows (unsigned rows)
	Set number of displayed rows.
void	SetNumHistoryRows (unsigned rows)
	Set command history maximum size, 0 disables history.
void	SetFocusOnShow (bool enable)
	Set whether to automatically focus the line edit when showing. Default true on desktops and false on mobile devices, as on mobiles it would pop up the screen keyboard.
void	UpdateElements ()
	Update elements to layout properly. Call this after manually adjusting the sub-elements.
XMLFile *	GetDefaultStyle () const
	Return the UI style file.
BorderImage *	GetBackground () const
	Return the background element.
LineEdit *	GetLineEdit () const
	Return the line edit element.
Button *	GetCloseButton () const
	Return the close butoon element.
bool	IsVisible () const
	Return whether is visible.
bool	IsAutoVisibleOnError () const
	Return true when console is set to automatically visible when receiving an error log message.
const String &	GetCommandInterpreter () const
	Return the last used command interpreter.
unsigned	GetNumBufferedRows () const
	Return number of buffered rows.
unsigned	GetNumRows () const
	Return number of displayed rows.
void	CopySelectedRows () const
	Copy selected rows to system clipboard.
unsigned	GetNumHistoryRows () const
	Return history maximum size.
unsigned	GetHistoryPosition () const
	Return current history position.
const String &	GetHistoryRow (unsigned index) const
	Return history row at index.
bool	GetFocusOnShow () const
	Return whether automatically focuses the line edit when showing.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual Urho3D::StringHash	GetType () const =0
	Return type hash.
virtual Urho3D::StringHash	GetBaseType () const =0
	Return base class type hash.
virtual const Urho3D::String &	GetTypeName () const =0
	Return type name.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	OBJECT (Console)
bool	PopulateInterpreter ()
	Populate the command line interpreters that could handle the console command.
void	HandleInterpreterSelected (StringHash eventType, VariantMap &eventData)
	Handle interpreter being selected on the drop down list.
void	HandleTextFinished (StringHash eventType, VariantMap &eventData)
	Handle enter pressed on the line edit.
void	HandleLineEditKey (StringHash eventType, VariantMap &eventData)
	Handle unhandled key on the line edit for scrolling the history.
void	HandleCloseButtonPressed (StringHash eventType, VariantMap &eventData)
	Handle close button being pressed.
void	HandleScreenMode (StringHash eventType, VariantMap &eventData)
	Handle rendering window resize.
void	HandleLogMessage (StringHash eventType, VariantMap &eventData)
	Handle a log message.
void	HandlePostUpdate (StringHash eventType, VariantMap &eventData)
	Handle the application post-update.

Private Attributes
bool	autoVisibleOnError_
	Auto visible on error flag.
SharedPtr< BorderImage >	background_
	Background.
ListView *	rowContainer_
	Container for text rows.
UIElement *	commandLine_
	Container for the command line.
DropDownList *	interpreters_
	Interpreter drop down list.
LineEdit *	lineEdit_
	Line edit.
SharedPtr< Button >	closeButton_
	Close button.
String	commandInterpreter_
	Last used command interpreter.
Vector< String >	history_
	Command history.
Vector< Pair< int, String > >	pendingRows_
	Pending log message rows.
String	currentRow_
	Current row being edited.
unsigned	displayedRows_
	Maximum displayed rows.
unsigned	historyRows_
	Command history maximum rows.
unsigned	historyPosition_
	Command history current position.
bool	printing_
	Flag when printing messages to prevent endless loop.
bool	focusOnShow_
	Flag for automatically focusing the line edit on showing the console.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Console window with log history and command line prompt.

---

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

• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Engine/Console.h
• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Engine/Console.cpp