Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2025-12-16 03:37:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

[example_powertoy] Remove example_powertoy (#3955)

Browse Source 
* Remove example_powertoy

* Address PR comments
This commit is contained in:
stefansjfw
2020-06-04 12:28:30 +02:00
committed by GitHub
parent e6060048bd
commit f5dc197e8b
17 changed files with 11 additions and 744 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
tools/project_template/README.md
View File

@@ -11,8 +11,7 @@ If you'd like to work on a PowerToy template, make required modifications to `\t
## Create a new PowerToy Module
- Add the new PowerToy project to the `src\modules\` folder for all the relative paths to work.
- For the module interface implementation take a look at [the interface](/src/modules/interface) and
[the example PowerToy implementation](/src/modules/example_powertoy/dllmain.cpp)
- For the module interface implementation take a look at [the interface](/src/modules/interface).
- Each PowerToy is built as a DLL and in order to be loaded at run-time, the PowerToy's DLL name needs to be added to the `known_dlls` map in [src/runner/main.cpp](/src/runner/main.cpp).
## DPI Awareness
@@ -48,7 +47,7 @@ A PowerToy can define settings of the following types:
Here's an example of what the settings look like in the Settings screen:
![Image of the Options](/doc/images/example_powertoy/settings.png)
![Image of the Options](/doc/images/settings/example_settings.png)
### How to add your module's settings page
@@ -56,7 +55,7 @@ The PowerToy can set its settings information and controls by overriding the [Po
The PowerToy can receive the new values by overriding the [PowerToy's Interface `set_config` method](/src/modules/interface/README.md#set_config), parsing the serialized [`PowerToysSettings::PowerToyValues`](/src/common/settings_object.h) object and applying the new settings.
Here's an example from [the example PowerToy implementation](/src/modules/example_powertoy/dllmain.cpp):
Here's an example settings implementation:
```cpp
// Return JSON with the configuration options.
virtual bool get_config(wchar_t* buffer, int* buffer_size) override {
@@ -343,7 +342,7 @@ Loading and saving the settings in the default location can be achieved through
The PowerToy can load the saved `PowerToyValues` object through the use of the `load_from_settings_file` method.
Here's an example from [the example PowerToy implementation](/src/modules/example_powertoy/dllmain.cpp):
Here's an example:
```cpp
// Load the settings file.
void ExamplePowertoy::init_settings() {
@@ -382,7 +381,7 @@ void ExamplePowertoy::init_settings() {
The PowerToy can save the `PowerToyValues` object received in `set_config` through the use of the `save_to_settings_file` method.
Here's an example from [the example PowerToy implementation](/src/modules/example_powertoy/dllmain.cpp):
Here's an example:
```cpp
// Called by the runner to pass the updated settings values as a serialized JSON.
virtual void set_config(const wchar_t* config) override {