74a1a6eca2
This upgrades to [v0.0.24](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.24). A number of GitHub APIs are being turned off shortly, so you need to upgrade or various uncertain outcomes will occur. There's a new accessibility forbidden pattern: > Do not use `(click) here` links > For more information, see: > * https://www.w3.org/QA/Tips/noClickHere > * https://webaim.org/techniques/hypertext/link_text > * https://granicus.com/blog/why-click-here-links-are-bad/ > * https://heyoka.medium.com/dont-use-click-here-f32f445d1021 ```pl (?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\() ``` There are some minor bugs that I'm aware of and which I've fixed since this release, but I don't expect to make another release this month. I've added a pair of patterns for includes and pragmas. My argument is that the **compiler** will _generally_ tell you if you've misspelled an include and the **linker** will _generally_ tell you if you misspell a lib. - There's a caveat here: If your include case-insensitively matches the referenced file (but doesn't properly match it), then unless you either use a case-sensitive file system (as opposed to case-preserving) or beg clang to warn, you won't notice when you make this specific mistake -- this matters in that a couple of Windows headers (e.g. Unknwn.h) have particular case and repositories don't tend to consistently/properly write them.
4.5 KiB
Classes and structures
This document is outdated and will soon be renewed.
class Animation: header source
Animation helper class with two easing-in animations: linear and exponential.
class AsyncMessageQueue: header
Header-only asynchronous message queue. Used by TwoWayPipeMessageIPC.
class TwoWayPipeMessageIPC: header
Header-only asynchronous IPC messaging class. Used by the runner to communicate with the settings window.
class DPIAware: header source
Helper class for creating DPI-aware applications.
struct MonitorInfo: header source
Class for obtaining information about physical displays connected to the machine.
class Settings, class PowerToyValues, class CustomActionObject: header source
Classes used to define settings screens for the PowerToys modules.
class Tasklist: header source
Class that can detect the position of the windows buttons on the taskbar. It also detects which window will react to pressing WinKey + number.
struct WindowsColors: header source
Class for detecting the current Windows color scheme.
Helpers
Common helpers: header source
Various helper functions.
Settings helpers: header
Helper methods for the settings.
Start visible helper: header source
Contains function to test if the Start menu is visible.
Toast Notifications
Notifications API header source
To use UWP-style toast notifications, simply include the header and call one of these functions:
void show_toast(std::wstring_view message); // #1
void show_toast_background_activated( // #2
std::wstring_view message,
std::wstring_view background_handler_id,
std::vector<std::wstring_view> button_labels);
We might add more functions in the future if the need arises, e.g. show_toast_xml which will accept raw XML for rich customization.
Description:
#1is for sending simple notifications without any callbacks or buttons#2is capable of showing a toast with multiple buttons and background activationmessageis a plain-text argument
Implement a toast activation handler/callback as a function in handler_functions.cpp and register its background_handler_id via handlers_map, e.g.:
// Your .cpp where you'd like to show a toast
#include <common/notifications.h>
void some_func() {
// ...
notifications::show_toast_background_activated(
L"Toast message!", // text displayed in a toast
L"awesome_toast", // activation handler id
{L"Press me!", L"Also could press me!", L"I'm here to be pressed!"} // buttons in a toast
);
// handler_functions.cpp
void awesome_toast_handler(IBackgroundTaskInstance, const size_t button_id)
{
switch(button_id)
{
case 0:
// handle "Press me!" button click
case 1:
// handle "Also could press me!" button click
case 2:
// handle "I'm here to be pressed!" button click
}
}
namespace
{
const std::unordered_map<std::wstring_view, handler_function_t> handlers_map = {
// ...other handlers...
{L"awesome_toast", awesome_toast_handler}
};}
Note: since background activation implies that your toast handler will be invoked in a separate process, you can't share data directly from within a handler and your PT process. Also, since PT is currently a Desktop Bridge app, foreground activation is handled the same as background, therefore we don't make a dedicated API for it. You can read more on the rationale of the current design.