Schema-driven, reversible settings target with secret-reference enforcement. 更多...
#include <EditorProjectSettings.h>
Public 成员函数 | |
| ProjectSettingsTarget (std::string id, ProjectSettingsSchema schema) | |
| Project settings target. | |
| TargetId | targetId () const override |
| Target id. | |
| TargetDescriptor | describe () const override |
| Describe. | |
| void * | queryCapability (const CapabilityId &capability) override |
| Query an optional target capability. | |
| Result< void > | applyDomainOperation (const DomainOperation &operation) override |
| Applies domain operation. | |
| eve::Result< eve::Revision > | currentRevision (const SelectionSnapshot &selection) const override |
| Current revision. | |
| PropertySchema | schema (const SelectionSnapshot &selection) const override |
| Schema. | |
| PropertyReadResult | read (const SelectionSnapshot &selection, const PropertyPath &path) const override |
| Reads . | |
| Result< DomainOperation > | makeSet (const SelectionSnapshot &selection, const PropertyPath &path, const EditorValue &value, PropertySetMode mode) const override |
| Make set. | |
| Result< DomainOperation > | makeReset (const SelectionSnapshot &selection, const PropertyPath &path) const override |
| Make reset. | |
| std::vector< PropertyPath > | pendingRestart () const |
| Return settings whose changed values require subsystem restart. | |
| EditorValue | snapshotValue () const |
| Capture values without ever serializing raw sensitive values. | |
| Result< void > | loadSnapshot (const EditorValue &snapshot) |
| Atomically load matching-schema values. | |
Public 成员函数 继承自 eve::editing::EditableTargetState | |
| EditableTargetState (Revision initial=1) | |
| Constructs the shared state with an explicit initial revision. | |
| EditRegion | dirtyRegion () const override |
| Return the accumulated dirty region. | |
| void | clearDirtyRegion () override |
| Discard the dirty region; the revision does not change. | |
| std::uint64_t | revision () const override |
| Return the current revision. | |
| Revision | revisionValue () const noexcept |
| Return the revision as the shared protocol revision type. | |
Public 成员函数 继承自 eve::editing::IEditableTarget | |
| virtual | ~IEditableTarget ()=default |
| Releases IEditableTarget resources. | |
| template<class C > | |
| eve::OptionalRef< C > | capability () |
| Query a capability through its interface-owned stable identity. | |
| template<class C > | |
| eve::OptionalRef< const C > | capability () const |
| Capability. | |
| template<class C > | |
| C * | query () |
| Queries query. | |
| template<class C > | |
| const C * | query () const |
| Queries query. | |
Public 成员函数 继承自 eve::editing::IDomainOperationTarget | |
| ~IDomainOperationTarget () override=default | |
| Releases IDomainOperationTarget resources. | |
Public 成员函数 继承自 eve::editing::IPropertyProvider | |
| virtual | ~IPropertyProvider ()=default |
| Releases IPropertyProvider resources. | |
额外继承的成员函数 | |
静态 Public 成员函数 继承自 eve::editing::IPropertyProvider | |
| static CapabilityId | editingCapabilityId () |
| Stable capability identity for generic property editing. | |
Protected 成员函数 继承自 eve::editing::EditableTargetState | |
| void | widenDirty (int x, int y) |
| Widen the dirty region without advancing the revision. | |
| void | widenDirty (const EditRegion ®ion) |
| Widen the dirty region without advancing the revision. | |
| void | widenDirty () |
| Mark an unknown area dirty without advancing the revision. | |
| void | bumpRevision () |
| Advance the revision without touching the dirty region. | |
| void | setRevision (Revision revision) |
| Adopt a revision observed elsewhere, without advancing it. | |
| void | setDirtyRegion (const EditRegion ®ion) |
| Replace the dirty region wholesale, without advancing the revision. | |
| void | markDirty (int x, int y) |
| Include one cell in the dirty region and advance the revision. | |
| void | markDirty (const EditRegion ®ion) |
| Include a whole region and advance the revision. | |
| void | markDirty () |
| Mark an unknown area dirty and advance the revision. | |
详细描述
Schema-driven, reversible settings target with secret-reference enforcement.
在文件 EditorProjectSettings.h 第 31 行定义.
构造及析构函数说明
◆ ProjectSettingsTarget()
| eve::editor::ProjectSettingsTarget::ProjectSettingsTarget | ( | std::string | id, |
| ProjectSettingsSchema | schema | ||
| ) |
Project settings target.
在文件 EditorProjectSettings.cpp 第 42 行定义.
成员函数说明
◆ applyDomainOperation()
|
overridevirtual |
Applies domain operation.
实现了 eve::editing::IDomainOperationTarget.
在文件 EditorProjectSettings.cpp 第 72 行定义.
引用了 eve::editing::EditableTargetState::bumpRevision(), descriptor, eve::editing::noOp(), path, eve::editing::DomainOperation::payload, reference, eve::editing::DomainOperation::target, eve::editing::DomainOperation::type, valid, value , 以及 eve::editing::EditableTargetState::widenDirty().
◆ currentRevision()
|
overridevirtual |
Current revision.
重载 eve::editing::IPropertyProvider .
在文件 EditorProjectSettings.cpp 第 100 行定义.
引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, eve::editing::EditableTargetState::revisionValue() , 以及 eve::Result< T >::success().
◆ describe()
|
overridevirtual |
◆ loadSnapshot()
| Result< void > eve::editor::ProjectSettingsTarget::loadSnapshot | ( | const EditorValue & | snapshot | ) |
Atomically load matching-schema values.
在文件 EditorProjectSettings.cpp 第 186 行定义.
引用了 eve::editing::EditableTargetState::bumpRevision(), path, reference, schema(), eve::editor::ProjectSettingsSchema::typeId, valid, value, values, eve::editor::ProjectSettingsSchema::version , 以及 eve::editing::EditableTargetState::widenDirty().
◆ makeReset()
|
overridevirtual |
◆ makeSet()
|
overridevirtual |
Make set.
实现了 eve::editing::IPropertyProvider.
在文件 EditorProjectSettings.cpp 第 137 行定义.
引用了 descriptor, eve::editing::Value::getIf(), operation, path, reference, valid, eve::UuidIdAdapter< Tag >::value() , 以及 value.
被这些函数引用 makeReset().
◆ pendingRestart()
| std::vector< PropertyPath > eve::editor::ProjectSettingsTarget::pendingRestart | ( | ) | const |
Return settings whose changed values require subsystem restart.
在文件 EditorProjectSettings.cpp 第 167 行定义.
◆ queryCapability()
|
overridevirtual |
Query an optional target capability.
- 返回
- Borrowed pointer owned by this target, or null. @lifetime Valid until this target is destroyed or mutated.
重载 eve::editing::IEditableTarget .
在文件 EditorProjectSettings.cpp 第 56 行定义.
◆ read()
|
overridevirtual |
Reads .
实现了 eve::editing::IPropertyProvider.
在文件 EditorProjectSettings.cpp 第 115 行定义.
引用了 descriptor, found, eve::InvalidArgument, path, eve::PreconditionViolation, reference , 以及 eve::editing::ruleDiagnostic().
◆ schema()
|
overridevirtual |
Schema.
实现了 eve::editing::IPropertyProvider.
在文件 EditorProjectSettings.cpp 第 107 行定义.
引用了 eve::editing::PropertySchema::properties, eve::editor::ProjectSettingsSchema::settings, eve::editing::PropertySchema::typeId, eve::editor::ProjectSettingsSchema::typeId, eve::editing::PropertySchema::version , 以及 eve::editor::ProjectSettingsSchema::version.
被这些函数引用 loadSnapshot().
◆ snapshotValue()
| EditorValue eve::editor::ProjectSettingsTarget::snapshotValue | ( | ) | const |
Capture values without ever serializing raw sensitive values.
在文件 EditorProjectSettings.cpp 第 174 行定义.
引用了 reference, eve::editor::ProjectSettingsSchema::settings, eve::editor::ProjectSettingsSchema::typeId, value, values , 以及 eve::editor::ProjectSettingsSchema::version.
◆ targetId()
|
inlineoverridevirtual |
该类的文档由以下文件生成:
- src/modules/editor/EditorProjectSettings.h
- src/modules/editor/EditorProjectSettings.cpp
Public 成员函数 继承自