winrt::event, modèle de struct (C++/WinRT)

  • Article

Type que vous pouvez utiliser pour déclarer et implémenter un événement d’un type délégué spécifié. Les abonnés transmettent leurs délégués de gestion des événements à un événement ; l’événement inscrit ces délégués dans une collection ; ensuite, lorsqu’il est déclenché, l’événement appelle à son tour ses délégués inscrits afin que les abonnés puissent gérer l’événement. Pour plus d’informations sur la création d’événements et les exemples de code, consultez Création d’événements dans C++/WinRT.

Si vous avez besoin d’événements internes à votre projet, et non limités aux types Windows Runtime, utilisez eventwinrt<::d elegate>. Pour plus d’informations, consultez Délégués paramétrables, signaux simples et rappels au sein d’un projet.

Pour plus d’informations sur la gestion des événements et des exemples de code, consultez Gérer les événements à l’aide de délégués en C++/WinRT.

Syntax

template <typename Delegate>
struct event

Paramètres de modèle

typename Delegate Type de délégué pouvant s’inscrire pour gérer l’événement.

Spécifications

Kit de développement logiciel (SDK) pris en charge minimum : Windows SDK version 10.0.0.17134.0 (Windows 10, version 1803)

Espace de noms : winrt

En-tête : %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (inclus par défaut)

Alias de type membre

Nom d'alias Type
event::d elegate_type Synonyme du typename Delegate paramètre de modèle.

Constructeurs

Constructeur Description
event::event constructeur Initialise une nouvelle instance du struct d’événement .

Fonctions Membre

Fonction Description
event::add, fonction Inscrit un délégué auprès de l’objet d’événement .
event::remove, fonction Révoque l’inscription d’un délégué à partir de l’objet d’événement .

Opérateurs membres

Opérateur Description
event::operator() (opérateur d’appel de fonction) Appelle tous les délégués inscrits de l’objet événement avec les arguments fournis.
event::operator bool Vérifie si l’objet d’événement a des délégués inscrits auprès de celui-ci.

event::event constructeur

Initialise une nouvelle instance du struct d’événement .

Syntax

event();

event::add, fonction

Inscrit un délégué auprès de l’objet d’événement .

Syntaxe

winrt::event_token add(Delegate const& delegate);

Paramètres

delegate Délégué à inscrire auprès de l’objet d’événement .

Valeur retournée

Winrt::event_token qui peut ensuite être utilisé pour révoquer l’inscription du délégué.

event::operator() (opérateur d’appel de fonction)

Appelle tous les délégués inscrits de l’objet événement avec les arguments fournis.

Syntax

template<typename... Arg>
void operator()(Arg const&... args)

Paramètres de modèle

typename... Arg Pack de paramètres de modèle variadic contenant les types des paramètres que le délégué est passé lorsqu’il est appelé.

Paramètres

args Liste d’arguments variables contenant les arguments passés par le délégué lorsqu’il est appelé.

event::operator bool

Vérifie si l’objet d’événement a des délégués inscrits auprès de celui-ci.

Syntaxe

explicit operator bool() const noexcept;

Valeur de retour

true si l’objet d’événement a des délégués inscrits, sinon false.

event::remove, fonction

Révoque l’inscription d’un délégué à partir de l’objet d’événement .

Syntaxe

void remove(winrt::event_token const token);

Paramètres

tokenWinrt::event_token qui identifie le délégué dont l’inscription doit être révoquée.

Voir aussi