mirror/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2024-12-12 18:29:24 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity
3f5810bfdb
PowerToys/doc/devdocs/settingsv2/viewmodels.md
Alekhya 18eb6b4ffd
Dev documentation of SettingsV2 (#7335) 
* created a folder for settings and added an overview, hotkey information

* basic structure for communication between settings and runner

* Added information about the IPC communication between settings and runner

* Added information about the communication between the settings process and modules

* Added details on backward compatibility

* brief overview on settings utils

* added an overview of the viewmodels and anomalies

* minor modifications

* Settings v2 dev docs (#7334)

* Added settings architecture and tech stack dev docs

* Added telemetry and updated architecture docs for settings v2

* Fix image link in ui_architecture markdown

* Added table of contents for settings v2

* Correct file path for ui architecture image

* nit fix in table of contents heading

* Add doc for xaml island tweaks

Co-authored-by: Divyansh Srivastava <somm14divi@gmail.com>
2020-10-20 14:28:06 -07:00

3.1 KiB
Raw Blame History

Viewmodels

The viewmodels are located within the Microsoft.PowerToys.Settings.UI.Lib project.

Components

  • Each viewmodel takes in the general settingsRepository, the moduleSettingsRepository if it exists and the delegates for IPC communication.
  • The general settingsRepository contains the general configurations of all powertoys whereas the moduleSettingsRepository is spcific to the module. This is to ensure that the configuration details are shared amongst the viewmodels without having to re-open the settings.json file.
  • Whenever there is a change in the UI, the OnPropertyChanged event is invoked and the viewmodel sends a corresponding IPC message to the runner which would perform the designated action such as dispatching the change to the modules or enabling/disabling the powertoy etc.

Difference between viewmodels

  • The GeneralViewModel is different from the rest of the view models with regard to the IPC communication wherein it sends special IPC messages to the runner to check for updates and to restart as admin.
  • Each of the powerToy viewmodels have two types of IPC communications, one for the general status of the powerToy and the other for communication powerToy specific change in properties to the runner.

SettingsRepository

  • The SettingsRepository is a generic singleton which contains the configurations for each viewmodel.
  • As it is a generic singleton, there can only be one instance of the settings repository of a particular type. This ensures that all the viewmodels are modifying a common object and a change made in one locations reflects everywhere.
  • The singleton implementation is thread-safe. Unit tests have been added for the same.

Settings viewmodel anomalies

  • The reason behind using the SettingsRepository is to ensure that the settings process does not try to access the settings.json files directly but rather does it through this class which encapsulates all the file operations from the viewmodels.
  • However, this could not be expanded to all the viewmodels directly for the following reasons. Some refactoring must be done to unify these cases and to bring them under the same model:
    • The PowerRename viewodel does not save the settings configurations in the same format as the rest of the powertoys, ie. {name, version, properties}. However, it only stores the properties directly.
    • Some viewmodels expect the runner to create the file instead of creating the file themselves, like in keyboard manager.
    • The colorpicker powertoy creates the settings.json within the module. This must be taken care of when encapsulated within the settingsRepository.
  • Currently, all modules use the SettingsRepository to access the General Settings config.
  • However, only Fancyzones, ShortcutGuide and PowerPreview use the SettingsRepository to access the module properties.