Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension Class Reference

Detailed Description

GUI extension that allows to load Storage's items content to the AGUIElementsCollection instance.

Allows runtime filtering of UI elements with custom logic by overriding of the OnItemAddHandler from outside of the

Inheritance diagram for Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension:
Collaboration diagram for Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension:

Public Member Functions

delegate void ItemEventHandler (StoragesDatabase.ItemContainer source)
 Delegate for StoragesDatabase.ItemContainer related event handling. More...
 
sealed override void ApplyGUIContent ()
 Handler that calls when inspector changed its content and requesting loading to the GUI a new one related to relevant source. Content always not null. More...
 
sealed override void DropGUIContent ()
 Sealed handler that controls internal logic. Use OnItemNotSelected(StoragesDatabase.ItemContainer) instead. More...
 

Protected Member Functions

override void OnStorageNotSelected ()
 Clears collection. More...
 
override void OnStorageModified (StoragesDatabase.StorageContainer storage)
 Occurs when StoragesDatabase.StorageContainer selected as source of content in parent inspector has been changed. More...
 
virtual void OnItemAddDefaultHandler (StoragesDatabase.ItemContainer item)
 Occurs when item considering to add by default. More...
 
virtual void OnDestroy ()
 Releases component from events subscriptions. More...
 

Package Functions

virtual void ApplyGUIContentInternal ()
 Internal extension that allows to influent ApplyGUIContent event if it sealed. Useful for architecture classes. More...
 

Properties

ItemsCollectionDataConnector DataConnector [get, set]
 Data connector that handles bridge between applicable data and its GUI representation. Receives StoragesDatabase.ItemContainer as content, loads it to an ItemGUIElement and adds the control the connected GUI elements collection provided with a AGUIElementsCollection instance.
 
ItemEventHandler OnItemAddHandler [get, set]
 Handler that calls during UI collection load and using to putting content GUI elements to the collection. More...
 
AContentInspectorGUIElement< ContentType > inspector [get]
 Inspector to extend. More...
 

Member Function Documentation

◆ ApplyGUIContent()

sealed override void Doloro.InvetorySystem.UI.Extension.AStorageGUIElementExtension.ApplyGUIContent ( )
virtualinherited

Handler that calls when inspector changed its content and requesting loading to the GUI a new one related to relevant source. Content always not null.

AContentInspectorGUIElement.content property.

Implements Doloro.UIEngine2.Controls.AContentInspectorExtension< Storage >.

◆ ApplyGUIContentInternal()

virtual void Doloro.InvetorySystem.UI.Extension.AStorageGUIElementExtension.ApplyGUIContentInternal ( )
packagevirtualinherited

Internal extension that allows to influent ApplyGUIContent event if it sealed. Useful for architecture classes.

Reimplemented in Doloro.InvetorySystem.UI.Extension.AStorageFeatureGUIExtension< FeatureType >.

◆ DropGUIContent()

sealed override void Doloro.InvetorySystem.UI.Extension.AStorageGUIElementExtension.DropGUIContent ( )
virtualinherited

Sealed handler that controls internal logic. Use OnItemNotSelected(StoragesDatabase.ItemContainer) instead.

Implements Doloro.UIEngine2.Controls.AContentInspectorExtension< Storage >.

◆ ItemEventHandler()

delegate void Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension.ItemEventHandler ( StoragesDatabase.ItemContainer  source)

Delegate for StoragesDatabase.ItemContainer related event handling.

Parameters
sourceItem container caused handler invoke.

◆ OnDestroy()

virtual void Doloro.InvetorySystem.UI.Extension.AStorageGUIElementExtension.OnDestroy ( )
protectedvirtualinherited

Releases component from events subscriptions.

Reimplemented in Doloro.InvetorySystem.UI.Extension.AStorageFeatureGUIExtension< FeatureType >.

◆ OnItemAddDefaultHandler()

virtual void Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension.OnItemAddDefaultHandler ( StoragesDatabase.ItemContainer  item)
protectedvirtual

Occurs when item considering to add by default.

Parameters
itemItem stored at the storage that currently in handle.

Use to handle item container content UI displaying policy.

See also
OnItemAddHandler

◆ OnStorageModified()

override void Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension.OnStorageModified ( StoragesDatabase.StorageContainer  storage)
protectedvirtual

Occurs when StoragesDatabase.StorageContainer selected as source of content in parent inspector has been changed.

Parameters
storageModified storage
See also
StoragesDatabase.ADataContainer<ContainerType>.Modified

Reimplemented from Doloro.InvetorySystem.UI.Extension.AStorageGUIElementExtension.

◆ OnStorageNotSelected()

override void Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension.OnStorageNotSelected ( )
protectedvirtual

Property Documentation

◆ inspector

AContentInspectorGUIElement<ContentType> Doloro.UIEngine2.Controls.AContentInspectorExtension< ContentType >.inspector
getinherited

Inspector to extend.

Must be placed on the same object as the component.

◆ OnItemAddHandler

ItemEventHandler Doloro.InvetorySystem.UI.Extension.StorageContentExplorerGUIExtension.OnItemAddHandler
getset

Handler that calls during UI collection load and using to putting content GUI elements to the collection.

Can't be null. In case of null using OnItemAddDefaultHandler(StoragesDatabase.ItemContainer) member as default.


The documentation for this class was generated from the following file: