| IModularFeature
|
Module |
|
Header |
/Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
Include |
#include "ISourceControlProvider.h" |
class ISourceControlProvider : public IModularFeature
Interface to talking with source control providers.
Name | Description | |
---|---|---|
|
~ISourceControlProvider() |
Virtual destructor |
Name | Description | ||
---|---|---|---|
|
CanCancelOperation ( |
Check to see if we can cancel an operation. |
|
|
CancelOperation ( |
Attempt to cancel an operation in progress. |
|
|
Close() |
Shut down source control provider. |
|
|
ECommandResu... |
Execute ( |
Helper overload for operation execution, see Execute(). |
|
ECommandResu... |
Execute ( |
Helper overload for operation execution, see Execute(). |
|
ECommandResu... |
Execute ( |
Helper overload for operation execution, see Execute(). |
|
ECommandResu... |
Execute ( |
Attempt to execute an operation on the passed-in files (if any are required). |
|
ECommandResu... |
Execute ( |
Helper overload for operation execution, see Execute(). |
|
GetCachedStateByPredicate ( |
Get all cached source control state objects for which the supplied predicate returns true |
|
|
TSharedPtr< ... |
GetLabel ( |
Get a label matching the passed-in name. |
|
GetLabels ( |
Get an array of labels matching the passed-in spec. |
|
|
const FName ... |
GetName() |
Get the source control provider name |
|
TSharedPtr< ... |
GetState ( |
Helper overload for state retrieval, see GetState(). |
|
TSharedPtr< ... |
GetState ( |
Helper overload for state retrieval, see GetState(). |
|
ECommandResu... |
GetState ( |
Helper overload for state retrieval, see GetState(). |
|
ECommandResu... |
GetState ( |
Get the state of each of the passed-in files. |
|
GetStateBranchIndex ( |
Gets the state index of the specified branch, higher index branches are generally closer to releases |
|
|
GetStatusText() |
Get the source control status as plain, human-readable text |
|
|
Init ( |
Initialize source control provider. |
|
|
IsAvailable() |
Quick check if source control is available for use (server-based providers can use this to return whether the server is available or not) |
|
|
IsEnabled() |
Quick check if source control is enabled. |
|
|
ECommandResu... |
Login ( |
Login to the source control server (if any). |
|
TSharedRef< ... |
MakeSettingsWidget() |
Create a settings widget for display in the login window. |
|
QueryStateBranchConfig |
Queries branch configuration from source control |
|
|
FDelegateHan... |
RegisterSourceControlStateChanged_Handle ( |
Register a delegate to be called when source control state(s) change |
|
RegisterStateBranches |
Register branches to query for state in addition to the current branch |
|
|
Tick() |
Called every update. |
|
|
UnregisterSourceControlStateChanged_Handle ( |
Unregister a delegate to be called when source control state(s) change |
|
|
UsesChangelists() |
Whether the provider uses changelists to identify commits/revisions |
|
|
UsesCheckout() |
Whether the provider uses the checkout workflow |
|
|
UsesLocalReadOnlyState() |
Whether the provider uses local read-only state to signal whether a file is editable. |