ILocalizationServiceProvider

Interface to talking with localization service providers.

Windows
MacOS
Linux

Inheritance Hierarchy

IModularFeature

ILocalizationServiceProvider

References

Module

LocalizationService

Header

/Engine/Source/Developer/LocalizationService/Public/ILocalizationServiceProvider.h

Include

#include "ILocalizationServiceProvider.h"

Syntax

class ILocalizationServiceProvider : public IModularFeature

Remarks

Interface to talking with localization service providers.

Destructors

Name Description

Public function Virtual

~ILocalizationServiceProvider()

Virtual destructor

Functions

Name Description

Public function Const

bool

 

CanCancelOperation

(
    const TSharedRef< ILocalizationServ...
)

Check to see if we can cancel an operation.

Public function

void

 

CancelOperation

(
    const TSharedRef< ILocalizationServ...
)

Attempt to cancel an operation in progress.

Public function

void

 

Close()

Shut down localization service provider.

Public function Const

void

 

CustomizeSettingsDetails

(
    IDetailCategoryBuilder& DetailCate...
)

Create a settings widget for display in the localization dashboard.

Public function Const

void

 

CustomizeTargetDetails

(
    IDetailCategoryBuilder& DetailCate...,
    TWeakObjectPtr< ULocalizationTarget...
)

Create a settings widget for display in the localization target editor.

Public function Const

void

 

CustomizeTargetSetToolbar

(
    TSharedRef< FExtender >& MenuExten...,
    TWeakObjectPtr< ULocalizationTarget...
)

Create a settings widget for display in the localization target set editor.

Public function Const

void

 

CustomizeTargetToolbar

(
    TSharedRef< FExtender >& MenuExten...,
    TWeakObjectPtr< ULocalizationTarget...
)

Create a settings widget for display in the localization target editor.

Public function Virtual

ELocalizatio...

 

Execute

(
    const TSharedRef< ILocalizationServ...,
    const FLocalizationServiceTranslati...,
    const ELocalizationServiceOperation...,
    const FLocalizationServiceOperation...
)

Helper overload for operation execution, see Execute().

Public function

ELocalizatio...

 

Execute

Attempt to execute an operation on the passed-in files (if any are required).

Public function Virtual

ELocalizatio...

 

Execute

(
    const TSharedRef< ILocalizationServ...,
    const ELocalizationServiceOperation...,
    const FLocalizationServiceOperation...
)

Helper overload for operation execution, see Execute().

Public function Const

const FText

 

GetDisplayName()

Get the localization service provider display name

Public function Const

const FName ...

 

GetName()

Get the localization service provider name

Public function

ELocalizatio...

 

GetState

Get the state of each of the passed-in files.

Public function Virtual

TSharedPtr< ...

 

GetState

Helper overload for state retrieval, see GetState().

Public function Const

FText

 

GetStatusText()

Get the localization service status as plain, human-readable text

Public function

void

 

Init

(
    bool bForceConnection
)

Initialize localization service provider.

Public function Const

bool

 

IsAvailable()

Quick check if localization service is available for use (server-based providers can use this to return whether the server is available or not)

Public function Const

bool

 

IsEnabled()

Quick check if localization service is enabled

Public function Virtual

ELocalizatio...

 

Login

(
    const FString& InPassword,
    ELocalizationServiceOperationConcur...,
    const FLocalizationServiceOperation...
)

Login to the localization service server (if any).

Public function

void

 

Tick()

Called every update.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback