unreal.MVVMView

class unreal.MVVMView(outer: Object | None = None, name: Name | str = 'None')

Bases: UserWidgetExtension

Instance UMVVMClassExtension_View for the UUserWdiget

C++ Source:

  • Plugin: ModelViewViewModel

  • Module: ModelViewViewModel

  • File: MVVMView.h

Editor Properties: (see get_editor_property/set_editor_property)

  • bindings_initialized (bool): [Read-Only] Is the Initialize method called.

  • constructed (bool): [Read-Only] Is the Construct method called.

  • events_initialized (bool): [Read-Only] Is the Initialize method called.

  • has_default_tick_binding (bool): [Read-Only] Is the view is registered to the binding subsystem for tick.

  • log_binding (bool): [Read-Write] Should log when a binding is executed.

  • number_of_source_with_tick_binding (uint8): [Read-Only] The number of source has at least one binding that need to be ticked every frame.

  • sources (Array[MVVMView_Source]): [Read-Only]

  • sources_initialized (bool): [Read-Only] Is the Initialize method called.

  • valid_sources (uint64): [Read-Only] The view has at least one binding that need to be ticked every frame.

are_bindings_initialized() → bool

The bindings were initialized, manually or automatically.

Return type:

bool

are_events_initialized() → bool

The events were initialized, manually or automatically.

Return type:

bool

are_sources_initialized() → bool

The sources were initialized, manually or automatically.

Return type:

bool

get_view_model(view_model_name) → NotifyFieldValueChanged

Find and return the viewmodel with the specified name.

Parameters:

view_model_name (Name) –

Return type:

NotifyFieldValueChanged

initialize_bindings() → None

Initialize the bindings if they are not already initialized. Initializing the bindings will execute them.

initialize_events() → None

Initialize the events if they are not already initialized.

initialize_sources() → None

Initialize the sources if they are not already initialized. Initializing the sources will also initialize the bindings if the option bInitializeBindingsOnConstruct is enabled. note: A sources can be a viewmodel or any other object used by a binding.

set_view_model(view_model_name, view_model) → bool

Set the viewmodel of the specified name. The viewmodel needs to be settable and the type should match (child of the defined viewmodel). If the view is initialized, all bindings that uses that viewmodel will be re-executed with the new viewmodel instance.

Parameters:

  • view_model_name (Name) –

  • view_model (NotifyFieldValueChanged) –

Return type:

bool

set_view_model_by_class(new_value) → bool

Set the first viewmodel matching the exact specified type. If none is found, set the first viewmodel matching a child of the specified type The viewmodel needs to be settable and it should have a valid name. If the view is initialized, all bindings that uses that viewmodel will be re-executed with the new viewmodel instance.

Parameters:

new_value (NotifyFieldValueChanged) –

Return type:

bool

uninitialize_bindings() → None

Uninitialize the bindings if they are already initialized.

uninitialize_events() → None

Uninitialize the events if they are already initialized.

uninitialize_sources() → None

Uninitialize the sources if they are already initialized. It will uninitialized the bindings.