更新 ThermometerWRC 以引发事件
更新 Thermometer.idl,使其看起来如下所示。 此示例说明了如何使用单精度浮点数的参数声明委托类型为 EventHandler 的事件。
// Thermometer.idl
namespace ThermometerWRC
{
runtimeclass Thermometer
{
Thermometer();
void AdjustTemperature(Single deltaFahrenheit);
event Windows.Foundation.EventHandler<Single> TemperatureIsBelowFreezing;
};
}
保存该文件。 项目不会在当前状态下完成生成,但在所有情况下立即执行生成可生成 \ThermometerWRC\ThermometerWRC\Generated Files\sources\Thermometer.h 和 Thermometer.cpp 存根文件的更新版本。 现在,可在这些文件中看到 TemperatureIsBelowFreezing 事件的存根实现。 在 C++/WinRT 中,IDL 声明事件作为一组重载函数实现(类似于属性作为重载 get 和 set 函数实现的方式)。 一个重载需要注册一个委托,并返回令牌 (winrt::event_token)。 另一个重载则需要令牌,并撤销关联代理的注册。
现在,打开 Thermometer.h 和 Thermometer.cpp,并更新 Thermometer 运行时类的实现。 在 Thermometer.h 中,添加两个重载的 TemperatureIsBelowFreezing 函数,以及用于实现这些函数的专用事件数据成员。
// Thermometer.h
...
namespace winrt::ThermometerWRC::implementation
{
struct Thermometer : ThermometerT<Thermometer>
{
...
winrt::event_token TemperatureIsBelowFreezing(Windows::Foundation::EventHandler<float> const& handler);
void TemperatureIsBelowFreezing(winrt::event_token const& token) noexcept;
private:
winrt::event<Windows::Foundation::EventHandler<float>> m_temperatureIsBelowFreezingEvent;
...
};
}
...
如上所示,事件由 winrt::event 结构模板表示,该结构模板由特定委托类型(其本身可以由 args 类型进行参数化)进行参数化。
在 Thermometer.cpp 中,实现两个重载的 TemperatureIsBelowFreezing 函数。
// Thermometer.cpp
...
namespace winrt::ThermometerWRC::implementation
{
winrt::event_token Thermometer::TemperatureIsBelowFreezing(Windows::Foundation::EventHandler<float> const& handler)
{
return m_temperatureIsBelowFreezingEvent.add(handler);
}
void Thermometer::TemperatureIsBelowFreezing(winrt::event_token const& token) noexcept
{
m_temperatureIsBelowFreezingEvent.remove(token);
}
void Thermometer::AdjustTemperature(float deltaFahrenheit)
{
m_temperatureFahrenheit += deltaFahrenheit;
if (m_temperatureFahrenheit < 32.f) m_temperatureIsBelowFreezingEvent(*this, m_temperatureFahrenheit);
}
}
其他重载(注册和手动撤销重载)不会合并到投影中。 这是为了让你能够灵活地以最佳方式针对自己的方案来实现它们。 像这些实现中所示那样调用 event::add 和 event::remove 是高效且并发/线程安全的默认设置。 但是,如果你有大量事件,那么你可能不希望每个事件都有一个事件字段,而是改为选择某些类型的稀疏实现。
你还可以在上方看到,如果温度低于冰点,AdjustTemperature 函数的实现已更新为引发 TemperatureIsBelowFreezing 事件 。
更新 ThermometerCoreApp 以处理事件
在 ThermometerCoreApp 项目的 App.cpp 中,对代码进行以下更改以注册事件处理程序,然后使温度降至冰点以下。
WINRT_ASSERT 是宏定义,并且扩展到 _ASSERTE。
struct App : implements<App, IFrameworkViewSource, IFrameworkView>
{
winrt::event_token m_eventToken;
...
void Initialize(CoreApplicationView const &)
{
m_eventToken = m_thermometer.TemperatureIsBelowFreezing([](const auto &, float temperatureFahrenheit)
{
WINRT_ASSERT(temperatureFahrenheit < 32.f); // Put a breakpoint here.
});
}
...
void Uninitialize()
{
m_thermometer.TemperatureIsBelowFreezing(m_eventToken);
}
...
void OnPointerPressed(IInspectable const &, PointerEventArgs const & args)
{
m_thermometer.AdjustTemperature(-1.f);
...
}
...
};
请注意对 OnPointerPressed 方法的更改。 现在,每次单击窗口时,都会从温度计的温度中减去 1 华氏度。 现在,该应用正在处理温度低于冰点时引发的事件。 要演示按预期引发事件,请在用于处理 TemperatureIsBelowFreezing 事件的 lambda 表达式内部放置一个断点,运行该应用,然后在窗口内部单击。
跨 ABI 的参数化委托
如果事件必须跨应用程序二进制接口 (ABI) 可访问(例如在组件及其所用应用程序之间),那么该事件必须使用 Windows 运行时委托类型。 上述示例使用 Windows::Foundation::EventHandler<T> Windows 运行时委托类型。 TypedEventHandler<TSender, TResult> 是另一种 Windows 运行时委托类型。
这两种委托类型的类型参数必须跨 ABI,因此类型参数也必须是 Windows 运行时类型。 这包括 Windows 运行时类、第三方运行时类,以及数字和字符串等基本类型。 如果你忘记了此约束,编译器将帮助你处理“T 必须为 WinRT 类型”错误。
下面是代码列表形式的示例。 从在本文前面部分创建的 ThermometerWRC 和 ThermometerCoreApp 项目开始,然后编辑这些项目中的代码,使它们看起来与这些列表中的代码相似 。
第一个列表针对 ThermometerWRC 项目。 按如下所示编辑 ThermometerWRC.idl 后,生成项目,然后将 MyEventArgs.h 和 .cpp 复制到项目中(从 Generated Files 文件夹),就像之前对 Thermometer.h 和 .cpp 一样。 记得删除这两个文件中的 static_assert。
// ThermometerWRC.idl
namespace ThermometerWRC
{
[default_interface]
runtimeclass MyEventArgs
{
Single TemperatureFahrenheit{ get; };
}
[default_interface]
runtimeclass Thermometer
{
...
event Windows.Foundation.EventHandler<ThermometerWRC.MyEventArgs> TemperatureIsBelowFreezing;
...
};
}
// MyEventArgs.h
#pragma once
#include "MyEventArgs.g.h"
namespace winrt::ThermometerWRC::implementation
{
struct MyEventArgs : MyEventArgsT<MyEventArgs>
{
MyEventArgs() = default;
MyEventArgs(float temperatureFahrenheit);
float TemperatureFahrenheit();
private:
float m_temperatureFahrenheit{ 0.f };
};
}
// MyEventArgs.cpp
#include "pch.h"
#include "MyEventArgs.h"
#include "MyEventArgs.g.cpp"
namespace winrt::ThermometerWRC::implementation
{
MyEventArgs::MyEventArgs(float temperatureFahrenheit) : m_temperatureFahrenheit(temperatureFahrenheit)
{
}
float MyEventArgs::TemperatureFahrenheit()
{
return m_temperatureFahrenheit;
}
}
// Thermometer.h
...
struct Thermometer : ThermometerT<Thermometer>
{
...
winrt::event_token TemperatureIsBelowFreezing(Windows::Foundation::EventHandler<ThermometerWRC::MyEventArgs> const& handler);
...
private:
winrt::event<Windows::Foundation::EventHandler<ThermometerWRC::MyEventArgs>> m_temperatureIsBelowFreezingEvent;
...
}
...
// Thermometer.cpp
#include "MyEventArgs.h"
...
winrt::event_token Thermometer::TemperatureIsBelowFreezing(Windows::Foundation::EventHandler<ThermometerWRC::MyEventArgs> const& handler) { ... }
...
void Thermometer::AdjustTemperature(float deltaFahrenheit)
{
m_temperatureFahrenheit += deltaFahrenheit;
if (m_temperatureFahrenheit < 32.f)
{
auto args = winrt::make_self<winrt::ThermometerWRC::implementation::MyEventArgs>(m_temperatureFahrenheit);
m_temperatureIsBelowFreezingEvent(*this, *args);
}
}
...
此列表针对 ThermometerCoreApp 项目。
// App.cpp
...
void Initialize(CoreApplicationView const&)
{
m_eventToken = m_thermometer.TemperatureIsBelowFreezing([](const auto&, ThermometerWRC::MyEventArgs args)
{
float degrees = args.TemperatureFahrenheit();
WINRT_ASSERT(degrees < 32.f); // Put a breakpoint here.
});
}
...