Urho3D::Console Class Reference

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

#include <Urho3D/Engine/Console.h>

Inheritance diagram for Urho3D::Console:

Collaboration diagram for Urho3D::Console:

Public Member Functions
	Console (Context *context)
	Construct.
	~Console () override
	Destruct.
void	SetDefaultStyle (XMLFile *style)
void	SetVisible (bool enable)
void	Toggle ()
	Toggle visibility.
void	SetAutoVisibleOnError (bool enable)
void	SetCommandInterpreter (const String &interpreter)
void	SetNumBufferedRows (unsigned rows)
void	SetNumRows (unsigned rows)
void	SetNumHistoryRows (unsigned rows)
void	SetFocusOnShow (bool enable)
void	AddAutoComplete (const String &option)
	Add auto complete option.
void	RemoveAutoComplete (const String &option)
	Remove auto complete option.
void	UpdateElements ()
	Update elements to layout properly. Call this after manually adjusting the sub-elements.
XMLFile *	GetDefaultStyle () const
BorderImage *	GetBackground () const
LineEdit *	GetLineEdit () const
Button *	GetCloseButton () const
bool	IsVisible () const
bool	IsAutoVisibleOnError () const
const String &	GetCommandInterpreter () const
unsigned	GetNumBufferedRows () const
unsigned	GetNumRows () const
void	CopySelectedRows () const
	Copy selected rows to system clipboard.
unsigned	GetNumHistoryRows () const
unsigned	GetHistoryPosition () const
const String &	GetHistoryRow (unsigned index) const
bool	GetFocusOnShow () const
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const String &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
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	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	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.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
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
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
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.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
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
int	WeakRefs () const
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	URHO3D_OBJECT (Console, Object)
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	HandleTextChanged (StringHash eventType, VariantMap &eventData)
	Handle text change in the line edit.
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	HandleRootElementResized (StringHash eventType, VariantMap &eventData)
	Handle UI root 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.
Vector< String >	autoComplete_
unsigned	autoCompletePosition_
	Command auto complete current position.
String	autoCompleteLine_
	Store the original line which is being auto-completed.
bool	printing_
	Flag when printing messages to prevent endless loop.
bool	focusOnShow_
	Flag for automatically focusing the line edit on showing the console.
bool	historyOrAutoCompleteChange_
	Internal flag whether currently in an autocomplete or history change.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Console window with log history and command line prompt.

Member Function Documentation

GetBackground()

BorderImage* Urho3D::Console::GetBackground ( ) const

inline

Return the background element.

GetCloseButton()

Button* Urho3D::Console::GetCloseButton ( ) const

inline

Return the close butoon element.

GetCommandInterpreter()

const String& Urho3D::Console::GetCommandInterpreter ( ) const

inline

Return the last used command interpreter.

GetDefaultStyle()

XMLFile * Urho3D::Console::GetDefaultStyle

(

)

const

Return the UI style file.

GetFocusOnShow()

bool Urho3D::Console::GetFocusOnShow ( ) const

inline

Return whether automatically focuses the line edit when showing.

GetHistoryPosition()

unsigned Urho3D::Console::GetHistoryPosition ( ) const

inline

Return current history position.

GetHistoryRow()

const String & Urho3D::Console::GetHistoryRow

(

unsigned

index

)

const

Return history row at index.

Here is the call graph for this function:

GetLineEdit()

LineEdit* Urho3D::Console::GetLineEdit ( ) const

inline

Return the line edit element.

GetNumBufferedRows()

unsigned Urho3D::Console::GetNumBufferedRows

(

)

const

Return number of buffered rows.

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumHistoryRows()

unsigned Urho3D::Console::GetNumHistoryRows ( ) const

inline

Return history maximum size.

GetNumRows()

unsigned Urho3D::Console::GetNumRows ( ) const

inline

Return number of displayed rows.

IsAutoVisibleOnError()

bool Urho3D::Console::IsAutoVisibleOnError ( ) const

inline

Return true when console is set to automatically visible when receiving an error log message.

IsVisible()

bool Urho3D::Console::IsVisible

(

)

const

Return whether is visible.

Here is the caller graph for this function:

SetAutoVisibleOnError()

void Urho3D::Console::SetAutoVisibleOnError ( bool  enable )

inline

Automatically set console to visible when receiving an error log message.

SetCommandInterpreter()

void Urho3D::Console::SetCommandInterpreter ( const String &  interpreter )

inline

Set the command interpreter.

SetDefaultStyle()

void Urho3D::Console::SetDefaultStyle

(

XMLFile *

style

)

Set UI elements' style from an XML file.

Here is the call graph for this function:

SetFocusOnShow()

void Urho3D::Console::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.

SetNumBufferedRows()

void Urho3D::Console::SetNumBufferedRows

(

unsigned

rows

)

Set number of buffered rows.

Here is the call graph for this function:

Here is the caller graph for this function:

SetNumHistoryRows()

void Urho3D::Console::SetNumHistoryRows

(

unsigned

rows

)

Set command history maximum size, 0 disables history.

Here is the call graph for this function:

SetNumRows()

void Urho3D::Console::SetNumRows

(

unsigned

rows

)

Set number of displayed rows.

Here is the call graph for this function:

Here is the caller graph for this function:

SetVisible()

void Urho3D::Console::SetVisible

(

bool

enable

)

Show or hide.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

autoComplete_

Vector<String> Urho3D::Console::autoComplete_

private

Command auto complete options.

down arrow key Unless currently going through history options, will loop through next auto complete options.

up arrow key Unless currently going through history options, will go through previous auto complete options. When no previous options are left will start going through history options.

---

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

• Source/Urho3D/Engine/Console.h
• Source/Urho3D/Engine/Console.cpp