Share via

modelo de struct winrt::observable_vector_base (C++/WinRT)

  • Artigo

Uma classe base da qual você pode derivar para implementar seu próprio vetor observável personalizado. Para obter mais informações e exemplos de código, consulte Coleções com C++/WinRT.

Syntax

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

Parâmetros de modelo

typename D Seu nome de tipo derivado.

typename T O tipo dos elementos no observable_vector_base.

Requisitos

SDK mínimo com suporte: Windows SDK versão 10.0.17763.0 (Windows 10, versão 1809)

Namespace: winrt

Cabeçalho: %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (incluído por padrão)

Funções de membro

Função Descrição
Função observable_vector_base::Append Acrescenta um elemento ao final do objeto observable_vector_base .
função observable_vector_base::Clear Remove todos os elementos do objeto observable_vector_base .
função observable_vector_base::First Recupera um IIterator que representa o primeiro elemento no objeto observable_vector_base .
função observable_vector_base::GetAt Recupera o elemento no índice especificado no objeto observable_vector_base .
Função observable_vector_base::GetMany Recupera uma coleção de elementos no objeto observable_vector_base começando no índice fornecido.
Função observable_vector_base::GetView Recupera uma exibição imutável do objeto observable_vector_base .
Função observable_vector_base::IndexOf Recupera o índice de um elemento especificado no objeto observable_vector_base .
Função observable_vector_base::InsertAt Insere um elemento no índice especificado no objeto observable_vector_base .
função observable_vector_base::RemoveAt Remove o elemento no índice especificado no objeto observable_vector_base .
Função observable_vector_base::RemoveAtEnd Remove o último elemento do objeto observable_vector_base .
Função observable_vector_base::ReplaceAll Substitui todos os elementos no objeto observable_vector_base pelos elementos especificados.
Função observable_vector_base::SetAt Define o valor do elemento no índice especificado no objeto observable_vector_base .
Função observable_vector_base::Size Recupera o número de elementos no objeto observable_vector_base .
Função observable_vector_base::VectorChanged Registra e revoga um delegado que manipula o evento alterado pelo vetor do objeto observable_vector_base .

Iterators

Um observable_vector_base é um intervalo e esse intervalo é definido por funções livres internas (cada uma das quais recupera um iterador) compatíveis com os recursos de linguagem padrão. Por isso, você pode enumerar os elementos em um objeto observable_vector_base com uma instrução baseada em for intervalo.

Você também pode recuperar um IIterator da função observable_vector_base::First e usá-lo para iterar por meio dos elementos em um objeto 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();
}

Função observable_vector_base::Append

Acrescenta um elemento ao final do objeto observable_vector_base .

Sintaxe

void Append(T const& value);

Parâmetros

value O elemento a ser acrescentado.

função observable_vector_base::Clear

Remove todos os elementos do objeto observable_vector_base .

Syntax

void Clear() noexcept;

função observable_vector_base::First

Recupera um IIterator que representa o primeiro elemento no objeto observable_vector_base .

Sintaxe

auto First();

Valor retornado

Um IIterator que representa o primeiro elemento no objeto observable_vector_base .

função observable_vector_base::GetAt

Recupera o elemento no índice especificado no objeto observable_vector_base .

Sintaxe

T GetAt(uint32_t const index) const;

Parâmetros

index Um índice de elemento baseado em zero.

Valor retornado

O elemento no índice especificado no objeto observable_vector_base .

Função observable_vector_base::GetMany

Recupera uma coleção de elementos no objeto observable_vector_base começando no índice fornecido.

Sintaxe

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

Parâmetros

startIndex Um índice de elemento baseado em zero a ser iniciado.

values Um array_view para copiar os itens.

Valor retornado

Um valor que representa o número de elementos recuperados.

Função observable_vector_base::GetView

Recupera uma exibição imutável do objeto observable_vector_base .

Sintaxe

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

Valor retornado

Um IVectorView que contém uma exibição imutável do observable_vector_base.

Função observable_vector_base::IndexOf

Recupera o índice de um elemento especificado no objeto observable_vector_base .

Sintaxe

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

Parâmetros

value O elemento, no objeto observable_vector_base , a ser buscado.

index O índice baseado em zero do elemento se o elemento for encontrado, caso contrário, o número de elementos no objeto observable_vector_base .

Valor retornado

true se o elemento for encontrado, caso contrário false.

Função observable_vector_base::InsertAt

Insere um elemento no índice especificado no objeto observable_vector_base .

Sintaxe

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

Parâmetros

index O índice baseado em zero no qual inserir o elemento.

value O elemento a ser inserido.

função observable_vector_base::RemoveAt

Remove o elemento no índice especificado no objeto observable_vector_base .

Sintaxe

void RemoveAt(uint32_t const index);

Parâmetros

index O índice baseado em zero do elemento a ser removido.

função observable_vector_base::RemoveAtEnd

Remove o último elemento do objeto observable_vector_base .

Syntax

void RemoveAtEnd();

Função observable_vector_base::ReplaceAll

Substitui todos os elementos no objeto observable_vector_base pelos elementos especificados.

Sintaxe

void ReplaceAll(array_view<T const> value);

Parâmetros

value Um array_view que contém os novos elementos.

Função observable_vector_base::SetAt

Define o valor do elemento no índice especificado no objeto observable_vector_base .

Sintaxe

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

Parâmetros

index O índice baseado em zero do elemento cujo valor a ser definido.

value O valor do elemento a ser definido.

Função observable_vector_base::Size

Recupera o número de elementos no objeto observable_vector_base .

Sintaxe

uint32_t Size() const noexcept;

Valor retornado

Um valor que representa o número de elementos no objeto observable_vector_base .

Função observable_vector_base::VectorChanged

Registra e/ou revoga um delegado que manipula o evento com alteração de vetor do objeto observable_vector_base .

Sintaxe

// 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;

Valor retornado

Ou void, um winrt::event_token com o qual você pode revogar um delegado registrado ou um VectorChanged_revoker (um alias de tipo para um winrt::event_revoker< IObservableVectorT<>>) com o qual você pode revogar um delegado registrado.

Exemplo

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

Confira também