Mouse Utils - Find My Mouse (#13916)

* Initial FindMyMouse implementation * Proper enable/disable code * Settings page * Change FindMyMouse window name * Add Oobe page. * Add icons * Change settings preview * Fix mouse utilities aka.ms link spelling * Remove right control exit behavior * Remove dllmain boilerplate comments and code * Add filters to vcxproj * Add logging * Add telemetry * Add installer instructions * Add dll to pipelines * Fix Task Manager name for runner changing * Add a description in dllmain * Proper resource file creation * Add reference of link to the docs * Fix spellchecker errors * Call DestroyWindow on correct thread * Add attribution * Proper ordering of module in Settings and Oobe * Update Target Platform Version to 18362 * Fix project filters * Add attribution to Community.md * Lowercase "utilities" * [Mouse utils] Adding icon (#13933) * Adding images to docs folder * Updated imagery Co-authored-by: Laute <Niels.Laute@philips.com> * Add settings deeplink Co-authored-by: Niels Laute <niels.laute@live.nl> Co-authored-by: Laute <Niels.Laute@philips.com>
2025-12-16 11:48:06 +01:00 · 2021-10-22 13:30:18 +01:00
parent dadb12a6e5
commit 8d383cba9d
44 changed files with 1665 additions and 5 deletions
--- a/src/modules/MouseUtils/FindMyMouse/dllmain.cpp
+++ b/src/modules/MouseUtils/FindMyMouse/dllmain.cpp
@@ -0,0 +1,148 @@
+#include "pch.h"
+#include <interface/powertoy_module_interface.h>
+#include <common/SettingsAPI/settings_objects.h>
+#include "trace.h"
+#include "FindMyMouse.h"
+#include <thread>
+#include <common/utils/logger_helper.h>
+
+extern "C" IMAGE_DOS_HEADER __ImageBase;
+
+HMODULE m_hModule;
+
+BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID lpReserved)
+{
+    m_hModule = hModule;
+    switch (ul_reason_for_call)
+    {
+    case DLL_PROCESS_ATTACH:
+        Trace::RegisterProvider();
+        break;
+    case DLL_THREAD_ATTACH:
+    case DLL_THREAD_DETACH:
+        break;
+    case DLL_PROCESS_DETACH:
+        Trace::UnregisterProvider();
+        break;
+    }
+    return TRUE;
+}
+
+// The PowerToy name that will be shown in the settings.
+const static wchar_t* MODULE_NAME = L"FindMyMouse";
+// Add a description that will we shown in the module settings page.
+const static wchar_t* MODULE_DESC = L"Focus the mouse pointer";
+
+// Implement the PowerToy Module Interface and all the required methods.
+class FindMyMouse : public PowertoyModuleIface
+{
+private:
+    // The PowerToy state.
+    bool m_enabled = false;
+
+    // Load initial settings from the persisted values.
+    void init_settings();
+
+public:
+    // Constructor
+    FindMyMouse()
+    {
+        LoggerHelpers::init_logger(MODULE_NAME, L"ModuleInterface", LogSettings::findMyMouseLoggerName);
+        init_settings();
+    };
+
+    // Destroy the powertoy and free memory
+    virtual void destroy() override
+    {
+        delete this;
+    }
+
+    // Return the localized display name of the powertoy
+    virtual const wchar_t* get_name() override
+    {
+        return MODULE_NAME;
+    }
+
+    // Return the non localized key of the powertoy, this will be cached by the runner
+    virtual const wchar_t* get_key() override
+    {
+        return MODULE_NAME;
+    }
+
+    // Return JSON with the configuration options.
+    virtual bool get_config(wchar_t* buffer, int* buffer_size) override
+    {
+        HINSTANCE hinstance = reinterpret_cast<HINSTANCE>(&__ImageBase);
+
+        // Create a Settings object.
+        PowerToysSettings::Settings settings(hinstance, get_name());
+        settings.set_description(MODULE_DESC);
+
+        return settings.serialize_to_buffer(buffer, buffer_size);
+    }
+
+    // Signal from the Settings editor to call a custom action.
+    // This can be used to spawn more complex editors.
+    virtual void call_custom_action(const wchar_t* action) override
+    {
+    }
+
+    // Called by the runner to pass the updated settings values as a serialized JSON.
+    virtual void set_config(const wchar_t* config) override
+    {
+        try
+        {
+            // Parse the input JSON string.
+            PowerToysSettings::PowerToyValues values =
+                PowerToysSettings::PowerToyValues::from_json_string(config, get_key());
+
+            values.save_to_settings_file();
+        }
+        catch (std::exception&)
+        {
+            // Improper JSON.
+        }
+    }
+
+    // Enable the powertoy
+    virtual void enable()
+    {
+        m_enabled = true;
+        Trace::EnableFindMyMouse(true);
+        std::thread([]() { FindMyMouseMain(m_hModule); }).detach();
+    }
+
+    // Disable the powertoy
+    virtual void disable()
+    {
+        m_enabled = false;
+        Trace::EnableFindMyMouse(false);
+        FindMyMouseDisable();
+    }
+
+    // Returns if the powertoys is enabled
+    virtual bool is_enabled() override
+    {
+        return m_enabled;
+    }
+};
+
+// Load the settings file.
+void FindMyMouse::init_settings()
+{
+    try
+    {
+        // Load and parse the settings file for this PowerToy.
+        PowerToysSettings::PowerToyValues settings =
+            PowerToysSettings::PowerToyValues::load_from_settings_file(FindMyMouse::get_key());
+    }
+    catch (std::exception&)
+    {
+        // Error while loading from the settings file. Let default values stay as they are.
+    }
+}
+
+extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create()
+{
+    return new FindMyMouse();
+}