Urho3D
Public Member Functions | Private Member Functions | Private Attributes
Urho3D::Console Class Reference

Console window with log history and AngelScript prompt. More...

#include <Console.h>

Inheritance diagram for Urho3D::Console:
Urho3D::Object Urho3D::RefCounted

List of all members.

Public Member Functions

 Console (Context *context)
 Construct.
 ~Console ()
 Destruct.
void SetStyle (XMLFile *style)
 Set UI elements' style from an XML file.
void SetVisible (bool enable)
 Show or hide. Showing automatically focuses the line edit.
void Toggle ()
 Toggle visibility.
void SetNumRows (unsigned rows)
 Set number of displayed rows.
void SetNumHistoryRows (unsigned rows)
 Set command history maximum size, 0 disables history.
void UpdateElements ()
 Update elements to layout properly. Call this after manually adjusting the sub-elements.
XMLFileGetStyle () const
 Return the UI style file.
BorderImageGetBackground () const
 Return the background element.
LineEditGetLineEdit () const
 Return the line edit element.
bool IsVisible () const
 Return whether is visible.
unsigned GetNumRows () const
 Return number of displayed rows.
unsigned GetNumHistoryRows () const
 Return history maximum size.
unsigned GetHistoryPosition () const
 Return current history position.
const StringGetHistoryRow (unsigned index) const
 Return history row at index.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () 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.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Private Member Functions

 OBJECT (Console)
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 HandleScreenMode (StringHash eventType, VariantMap &eventData)
 Handle rendering window resize.
void HandleLogMessage (StringHash eventType, VariantMap &eventData)
 Handle a log message.

Private Attributes

SharedPtr< XMLFilestyle_
 UI style file.
SharedPtr< BorderImagebackground_
 Background.
SharedPtr< UIElementrowContainer_
 Container for text rows.
Vector< SharedPtr< Text > > rows_
 Text rows.
SharedPtr< LineEditlineEdit_
 Line edit.
Vector< Stringhistory_
 Command history.
String currentRow_
 Current row being edited.
unsigned historyRows_
 Command history maximum rows.
unsigned historyPosition_
 Command history current position.
bool inLogMessage_
 Currently printing a log message flag.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.

Detailed Description

Console window with log history and AngelScript prompt.


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