Urho3D::Localization Class Reference
Urho3D::Localization Class Reference
Localization subsystem. Stores all the strings in all languages. More...
#include <Urho3D/Resource/Localization.h>
Inheritance diagram for Urho3D::Localization:
Collaboration diagram for Urho3D::Localization:
Public Member Functions | |
| Localization (Context *context) | |
| Construct. | |
| ~Localization () override | |
| Destruct. Free all resources. | |
| int | GetNumLanguages () const |
| int | GetLanguageIndex () const |
| int | GetLanguageIndex (const String &language) |
| Return the index number of language. The index is determined by the order of loading. | |
| String | GetLanguage () |
| String | GetLanguage (int index) |
| Return the name of language. | |
| void | SetLanguage (int index) |
| Set current language. | |
| void | SetLanguage (const String &language) |
| Set current language. | |
| String | Get (const String &id) |
| Return a string in the current language. Returns String::EMPTY if id is empty. Returns id if translation is not found and logs a warning. | |
| void | Reset () |
| Clear all loaded strings. | |
| void | LoadJSONFile (const String &name, const String &language=String::EMPTY) |
| Load strings from JSONFile. The file should be UTF8 without BOM. | |
| void | LoadMultipleLanguageJSON (const JSONValue &source) |
| Load strings from JSONValue. | |
| void | LoadSingleLanguageJSON (const JSONValue &source, const String &language=String::EMPTY) |
| Load strings from JSONValue for specific language. | |
 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 (Localization, Object) | |
Private Attributes | |
| Vector< String > | languages_ |
| Language names. | |
| int | languageIndex_ |
| Index of current language. | |
| HashMap< StringHash, HashMap< StringHash, String > > | strings_ |
| Storage strings: <Language <StringId, Value> >. | |
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
Localization subsystem. Stores all the strings in all languages.
Member Function Documentation
◆ GetLanguage()
| String Urho3D::Localization::GetLanguage | ( | ) |
Return the name of current language.
Here is the caller graph for this function:
◆ GetLanguageIndex()
|
inline |
Return the index number of current language. The index is determined by the order of loading.
Here is the caller graph for this function:
◆ GetNumLanguages()
|
inline |
Return the number of languages.
Here is the caller graph for this function:
The documentation for this class was generated from the following files:
- Source/Urho3D/Resource/Localization.h
- Source/Urho3D/Resource/Localization.cpp