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

Classe de base à partir de laquelle vous pouvez dériver pour implémenter votre propre vecteur observable personnalisé. Pour plus d’informations et des exemples de code, consultez Collections avec C++/WinRT.

Syntax

template <typename D, typename T>
struct observable_vector_base : vector_base<D, T>

Paramètres de modèle

typename D Nom de votre type dérivé.

typename T Type des éléments dans le observable_vector_base.

Spécifications

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

Espace de noms : winrt

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

Fonctions Membre

Iterators

Un observable_vector_base est une plage et cette plage est définie par des fonctions libres internes (chacune d’elles récupère un itérateur) compatibles avec les fonctionnalités de langage standard. En raison de cela, vous pouvez énumérer les éléments d’un objet observable_vector_base avec une instruction basée sur for une plage.

Vous pouvez également récupérer un IIterator à partir de la fonction observable_vector_base::First et l’utiliser pour itérer dans les éléments d’un objet observable_vector_base .

...
#include <iostream>
using namespace winrt;
using namespace Windows::Foundation::Collections;
...
struct MyObservableVector :
    implements<MyObservableVector, IObservableVector<float>, IVector<float>, IVectorView<float>, IIterable<float>>,
    winrt::observable_vector_base<MyObservableVector, float>
{
    auto& get_container() const noexcept
    {
        return m_values;
    }

    auto& get_container() noexcept
    {
        return m_values;
    }

private:
    std::vector<float> m_values{ 0.1f, 0.2f, 0.3f };
};
...
IObservableVector<float> coll{ winrt::make<MyObservableVector>() };

for (auto const& el : coll)
{
    std::wcout << el << std::endl;
}

IIterator<float> it{ coll.First() };
while (it.HasCurrent())
{
    std::wcout << it.Current() << std::endl;
    it.MoveNext();
}

observable_vector_base::Append, fonction

Ajoute un élément à la fin de l’objet observable_vector_base .

Syntaxe

void Append(T const& value);

Paramètres

value Élément à ajouter.

observable_vector_base::Clear, fonction

Supprime tous les éléments de l’objet observable_vector_base .

Syntax

void Clear() noexcept;

observable_vector_base::First, fonction

Récupère un IIterator représentant le premier élément de l’objet observable_vector_base .

Syntaxe

auto First();

Valeur de retour

IIterator représentant le premier élément de l’objet observable_vector_base.

observable_vector_base::GetAt, fonction

Récupère l’élément à l’index spécifié dans l’objet observable_vector_base .

Syntaxe

T GetAt(uint32_t const index) const;

Paramètres

index Index d’élément de base zéro.

Valeur retournée

Élément à l’index spécifié dans l’objet observable_vector_base .

observable_vector_base::GetMany, fonction

Récupère une collection d’éléments dans l’objet observable_vector_base commençant à l’index donné.

Syntaxe

uint32_t GetMany(uint32_t const startIndex, array_view<T> values) const;

Paramètres

startIndex Index d’élément de base zéro à démarrer.

values Un array_view pour copier les éléments dans.

Valeur retournée

Valeur représentant le nombre d’éléments récupérés.

observable_vector_base::GetView, fonction

Récupère une vue immuable de l’objet observable_vector_base .

Syntaxe

winrt::Windows::Foundation::Collections::IVectorView<T> GetView() const noexcept;

Valeur de retour

IVectorView contenant une vue immuable du observable_vector_base.

observable_vector_base::IndexOf, fonction

Récupère l’index d’un élément spécifié dans l’objet observable_vector_base .

Syntaxe

bool IndexOf(T const& value, uint32_t& index) const noexcept;

Paramètres

value Élément, dans l’objet observable_vector_base , à rechercher.

index Index de base zéro de l’élément si l’élément est trouvé, sinon le nombre d’éléments dans l’objet observable_vector_base .

Valeur retournée

true si l’élément est trouvé, sinon false.

observable_vector_base::InsertAt, fonction

Insère un élément à l’index spécifié dans l’objet observable_vector_base .

Syntaxe

void InsertAt(uint32_t const index, T const& value);

Paramètres

index Index de base zéro auquel insérer l’élément.

value Élément à insérer.

observable_vector_base::RemoveAt, fonction

Supprime l’élément à l’index spécifié dans l’objet observable_vector_base .

Syntaxe

void RemoveAt(uint32_t const index);

Paramètres

index Index de base zéro de l’élément à supprimer.

fonction observable_vector_base::RemoveAtEnd

Supprime le dernier élément de l’objet observable_vector_base .

Syntax

void RemoveAtEnd();

fonction observable_vector_base::ReplaceAll

Remplace tous les éléments de l’objet observable_vector_base par les éléments spécifiés.

Syntaxe

void ReplaceAll(array_view<T const> value);

Paramètres

value Un array_view contenant les nouveaux éléments.

fonction observable_vector_base::SetAt

Définit la valeur de l’élément à l’index spécifié dans l’objet observable_vector_base .

Syntaxe

void SetAt(uint32_t const index, T const& value);

Paramètres

index Index de base zéro de l’élément dont la valeur doit être définie.

value Valeur de l’élément à définir.

fonction observable_vector_base::Size

Récupère le nombre d’éléments dans l’objet observable_vector_base .

Syntaxe

uint32_t Size() const noexcept;

Valeur de retour

Valeur représentant le nombre d’éléments dans l’objet observable_vector_base .

fonction observable_vector_base::VectorChanged

Inscrit et/ou révoque un délégué qui gère l’événement de modification vectorielle de l’objet observable_vector_base .

Syntaxe

// Register
winrt::event_token VectorChanged(winrt::Windows::Foundation::Collections::VectorChangedEventHandler<T> const& handler);

// Revoke with event_token
void VectorChanged(winrt::event_token const cookie);

// Revoke with event_revoker
VectorChanged_revoker VectorChanged(winrt::auto_revoke_t, winrt::Windows::Foundation::Collections::VectorChangedEventHandler<T> const& handler) const;

Valeur de retour

Soitvoid, un winrt::event_token avec lequel vous pouvez révoquer un délégué inscrit, soit un VectorChanged_revoker (alias de type pour un winrt::event_revoker< IObservableVectorT<>>) avec lequel vous pouvez révoquer un délégué inscrit.

Exemple

winrt::event_revoker<IObservableVector<float>> m_event_revoker;
...
m_event_revoker = coll.VectorChanged(winrt::auto_revoke, [this](IObservableVector<float> const&, IVectorChangedEventArgs const&)
{
    ...
});

Voir aussi

• Espace de noms winrt
• Modèle de fonction winrt::single_threaded_observable_vector
• Collections avec C++/WinRT