Inherits AZ::SettingsRegistryInterface.
Public Member Functions | |
MOCK_CONST_METHOD1 (GetType, SettingsType(AZStd::string_view)) | |
MOCK_CONST_METHOD2 (Visit, bool(Visitor &, AZStd::string_view)) | |
MOCK_CONST_METHOD2 (Visit, bool(const VisitorCallback &, AZStd::string_view)) | |
MOCK_METHOD1 (RegisterNotifier, NotifyEventHandler(NotifyCallback)) | |
MOCK_METHOD1 (RegisterNotifier, void(NotifyEventHandler &)) | |
MOCK_METHOD1 (RegisterPreMergeEvent, PreMergeEventHandler(PreMergeEventCallback)) | |
MOCK_METHOD1 (RegisterPreMergeEvent, void(PreMergeEventHandler &)) | |
MOCK_METHOD1 (RegisterPostMergeEvent, PostMergeEventHandler(PostMergeEventCallback)) | |
MOCK_METHOD1 (RegisterPostMergeEvent, void(PostMergeEventHandler &)) | |
MOCK_CONST_METHOD2 (Get, bool(bool &, AZStd::string_view)) | |
MOCK_CONST_METHOD2 (Get, bool(s64 &, AZStd::string_view)) | |
MOCK_CONST_METHOD2 (Get, bool(u64 &, AZStd::string_view)) | |
MOCK_CONST_METHOD2 (Get, bool(double &, AZStd::string_view)) | |
MOCK_CONST_METHOD2 (Get, bool(AZStd::string &, AZStd::string_view)) | |
MOCK_CONST_METHOD2 (Get, bool(FixedValueString &, AZStd::string_view)) | |
MOCK_CONST_METHOD3 (GetObject, bool(void *, Uuid, AZStd::string_view)) | |
MOCK_METHOD2 (Set, bool(AZStd::string_view, bool)) | |
MOCK_METHOD2 (Set, bool(AZStd::string_view, s64)) | |
MOCK_METHOD2 (Set, bool(AZStd::string_view, u64)) | |
MOCK_METHOD2 (Set, bool(AZStd::string_view, double)) | |
MOCK_METHOD2 (Set, bool(AZStd::string_view, AZStd::string_view)) | |
MOCK_METHOD2 (Set, bool(AZStd::string_view, const char *)) | |
MOCK_METHOD3 (SetObject, bool(AZStd::string_view, const void *, Uuid)) | |
MOCK_METHOD1 (Remove, bool(AZStd::string_view)) | |
MOCK_METHOD3 (MergeCommandLineArgument, bool(AZStd::string_view, AZStd::string_view, const CommandLineArgumentSettings &)) | |
MOCK_METHOD3 (MergeSettings, MergeSettingsResult(AZStd::string_view, Format, AZStd::string_view)) | |
MOCK_METHOD4 (MergeSettingsFile, MergeSettingsResult(AZStd::string_view, Format, AZStd::string_view, AZStd::vector< char > *)) | |
MOCK_METHOD5 (MergeSettingsFolder, MergeSettingsResult(AZStd::string_view, const Specializations &, AZStd::string_view, AZStd::string_view, AZStd::vector< char > *)) | |
MOCK_METHOD1 (SetNotifyForMergeOperations, void(bool)) | |
MOCK_CONST_METHOD0 (GetNotifyForMergeOperations, bool()) | |
MOCK_METHOD1 (SetUseFileIO, void(bool)) | |
Public Member Functions inherited from AZ::SettingsRegistryInterface | |
AZ_RTTI (AZ::SettingsRegistryInterface, "{D62619D8-0C0B-4D9F-9FE8-F8EBC330DC55}") | |
AZ_DISABLE_COPY_MOVE (SettingsRegistryInterface) | |
virtual SettingsType | GetType (AZStd::string_view path) const =0 |
Returns the type of an entry in the Settings Registry or Type::None if there's no value or the path is invalid. | |
virtual bool | Visit (Visitor &visitor, AZStd::string_view path) const =0 |
virtual bool | Visit (const VisitorCallback &callback, AZStd::string_view path) const =0 |
virtual NotifyEventHandler | RegisterNotifier (NotifyCallback callback)=0 |
virtual void | RegisterNotifier (NotifyEventHandler &handler)=0 |
virtual PreMergeEventHandler | RegisterPreMergeEvent (PreMergeEventCallback callback)=0 |
virtual void | RegisterPreMergeEvent (PreMergeEventHandler &handler)=0 |
virtual PostMergeEventHandler | RegisterPostMergeEvent (PostMergeEventCallback callback)=0 |
virtual void | RegisterPostMergeEvent (PostMergeEventHandler &handler)=0 |
virtual bool | Get (bool &result, AZStd::string_view path) const =0 |
virtual bool | Get (s64 &result, AZStd::string_view path) const =0 |
virtual bool | Get (u64 &result, AZStd::string_view path) const =0 |
virtual bool | Get (double &result, AZStd::string_view path) const =0 |
virtual bool | Get (AZStd::string &result, AZStd::string_view path) const =0 |
virtual bool | Get (FixedValueString &result, AZStd::string_view path) const =0 |
virtual bool | GetObject (void *result, AZ::Uuid resultTypeId, AZStd::string_view path) const =0 |
template<typename T > | |
bool | GetObject (T &result, AZStd::string_view path) const |
virtual bool | Set (AZStd::string_view path, bool value)=0 |
virtual bool | Set (AZStd::string_view path, s64 value)=0 |
virtual bool | Set (AZStd::string_view path, u64 value)=0 |
virtual bool | Set (AZStd::string_view path, double value)=0 |
virtual bool | Set (AZStd::string_view path, AZStd::string_view value)=0 |
virtual bool | Set (AZStd::string_view path, const char *value)=0 |
virtual bool | SetObject (AZStd::string_view path, const void *value, AZ::Uuid valueTypeId)=0 |
template<typename T > | |
bool | SetObject (AZStd::string_view path, const T &value) |
virtual bool | Remove (AZStd::string_view path)=0 |
virtual bool | MergeCommandLineArgument (AZStd::string_view argument, AZStd::string_view anchorKey="", const CommandLineArgumentSettings &commandLineSettings={})=0 |
virtual MergeSettingsResult | MergeSettings (AZStd::string_view data, Format format, AZStd::string_view anchorKey="")=0 |
virtual MergeSettingsResult | MergeSettingsFile (AZStd::string_view path, Format format, AZStd::string_view anchorKey="", AZStd::vector< char > *scratchBuffer=nullptr)=0 |
virtual MergeSettingsResult | MergeSettingsFolder (AZStd::string_view path, const Specializations &specializations, AZStd::string_view platform={}, AZStd::string_view anchorKey="", AZStd::vector< char > *scratchBuffer=nullptr)=0 |
virtual void | SetNotifyForMergeOperations (bool notify)=0 |
virtual bool | GetNotifyForMergeOperations () const =0 |
virtual void | SetUseFileIO (bool useFileIo)=0 |
Additional Inherited Members | |
Public Types inherited from AZ::SettingsRegistryInterface | |
enum class | Type { NoType , Null , Boolean , Integer , FloatingPoint , String , Array , Object } |
Type of the store value, or None if there's no value stored. | |
enum class | Signedness { None , Signed , Unsigned } |
Type of an integer. | |
enum class | VisitResponse { Continue , Skip , Done } |
The response to let the visit call know what to do next. More... | |
enum class | VisitAction { Begin , Value , End } |
The action the visit call is taken. More... | |
enum class | Format { JsonPatch , JsonMergePatch } |
File formats supported to load settings from. More... | |
enum class | MergeSettingsReturnCode { Unset = 0 , Success = 1 , PartialSuccess , Failure = -1 } |
using | FixedValueString = AZ::StringFunc::Path::FixedString |
using | FilenameTags = Specializations |
using | NotifyCallback = AZStd::function< void(const NotifyEventArgs ¬ifierArgs)> |
using | NotifyEvent = AZ::Event< const NotifyEventArgs & > |
using | NotifyEventHandler = typename NotifyEvent::Handler |
using | PreMergeEventCallback = AZStd::function< void(const MergeEventArgs &)> |
using | PostMergeEventCallback = AZStd::function< void(const MergeEventArgs &)> |
using | PreMergeEvent = AZ::Event< const MergeEventArgs & > |
using | PostMergeEvent = AZ::Event< const MergeEventArgs & > |
using | PreMergeEventHandler = typename PreMergeEvent::Handler |
using | PostMergeEventHandler = typename PostMergeEvent::Handler |
using | VisitorCallback = AZStd::function< VisitResponse(const VisitArgs &, VisitAction action)> |
Static Public Attributes inherited from AZ::SettingsRegistryInterface | |
static constexpr char | Extension [] = "setreg" |
static constexpr char | PatchExtension [] = "setregpatch" |
static constexpr char | RegistryFolder [] = "Registry" |
static constexpr char | DevUserRegistryFolder [] = "user" AZ_CORRECT_FILESYSTEM_SEPARATOR_STRING "Registry" |
static constexpr char | PlatformFolder [] = "Platform" |