56 lines
3.1 KiB
Markdown
56 lines
3.1 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.CommonCore/Interface/SystemSettings/UISettings/IUISettingsView.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/SystemSettings/UISettings/IUISettingsViewModel.cs
|
||
|
|
generated_at: "2026-04-16T12:25:58.608548+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "2585d1c5e565105e"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: IUISettingsView & IUISettingsViewModel
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines two marker interfaces, `IUISettingsView` and `IUISettingsViewModel`, which serve as type identifiers for UI settings-related components within a Model-View-ViewModel (MVVM) architecture. These interfaces exist to establish a type hierarchy for UI settings screens, allowing components to be identified, registered, or resolved generically as settings-related views and view models without defining any additional members beyond their base contracts.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `IUISettingsView`
|
||
|
|
- **Namespace:** `DTS.Common.Interface`
|
||
|
|
- **Signature:** `public interface IUISettingsView : IBaseView`
|
||
|
|
- **Description:** A marker interface for UI settings views. Inherits from `IBaseView` (defined in `DTS.Common.Base`). Declares no additional members.
|
||
|
|
|
||
|
|
### `IUISettingsViewModel`
|
||
|
|
- **Namespace:** `DTS.Common.Interface`
|
||
|
|
- **Signature:** `public interface IUISettingsViewModel : IBaseViewModel`
|
||
|
|
- **Description:** A marker interface for UI settings view models. Inherits from `IBaseViewModel` (defined in `DTS.Common.Base`). Declares no additional members.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
|
||
|
|
- `IUISettingsView` must always be assignable to `IBaseView`.
|
||
|
|
- `IUISettingsViewModel` must always be assignable to `IBaseViewModel`.
|
||
|
|
- The actual contracts (properties, methods, events) for these interfaces are defined entirely by their base interfaces (`IBaseView` and `IBaseViewModel`), not by these interfaces themselves.
|
||
|
|
- **Unclear from source:** The specific invariants enforced by `IBaseView` and `IBaseViewModel` cannot be determined without access to `DTS.Common.Base`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
|
||
|
|
### This module depends on:
|
||
|
|
- `DTS.Common.Base` — provides `IBaseView` and `IBaseViewModel` base interfaces.
|
||
|
|
|
||
|
|
### What depends on this module:
|
||
|
|
- **Unclear from source alone.** Consumers would be any concrete view or view model classes implementing `IUISettingsView` or `IUISettingsViewModel`, as well as any registration/resolution logic (e.g., dependency injection containers, navigation services) that handles UI settings components by these types.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 5. Gotchas
|
||
|
|
|
||
|
|
- **Empty marker interfaces:** Both interfaces define no members. All functionality comes from their respective base interfaces. Developers implementing these should consult `IBaseView` and `IBaseViewModel` to understand required members.
|
||
|
|
- **Naming collision risk:** The namespace `DTS.Common.Interface` is generic; if other modules use the same namespace, type resolution conflicts could occur.
|
||
|
|
- **Unclear from source:** The reason for having separate marker interfaces (rather than using the base interfaces directly) is not documented in the source. This may relate to type discrimination for navigation, DI registration, or feature-specific handling, but this cannot be confirmed without additional context.
|