Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::DocumentPropertyEditor::ValueStringSort Class Reference

Inherits AZ::DocumentPropertyEditor::RowSortAdapter.

Classes

struct  StringSortNode
 

Public Member Functions

void SetSortAttribute (AZStd::string_view attributeName)
 
void SetSortColumn (size_t sortColumn)
 
- Public Member Functions inherited from AZ::DocumentPropertyEditor::RowSortAdapter
void SetSortActive (bool active)
 
void InvalidateSort ()
 
Dom::Path MapFromSourcePath (const Dom::Path &sourcePath) const override
 
Dom::Path MapToSourcePath (const Dom::Path &filterPath) const override
 
Dom::Path MapPath (const Dom::Path &sourcePath, bool mapFromSource) const
 
- Public Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
void SetSourceAdapter (DocumentAdapterPtr sourceAdapter)
 
virtual Dom::Path MapFromSourcePath (const Dom::Path &sourcePath) const =0
 
virtual Dom::Path MapToSourcePath (const Dom::Path &filterPath) const =0
 
ExpanderSettingsCreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string()) override
 
- Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
 AZ_RTTI (DocumentAdapter, "{8CEFE485-45C2-4ECC-B9D1-BBE75C7B02AB}")
 
Dom::Value GetContents () const
 
void ConnectResetHandler (ResetEvent::Handler &handler)
 
void ConnectChangedHandler (ChangedEvent::Handler &handler)
 
void ConnectMessageHandler (MessageEvent::Handler &handler)
 
virtual void SetRouter (RoutingAdapter *router, const Dom::Path &route)
 
Dom::Value SendAdapterMessage (const AdapterMessage &message)
 
bool IsEmpty ()
 
virtual ExpanderSettingsCreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string())
 

Protected Member Functions

SortInfoNodeNewSortInfoNode () const override
 
void CacheDomInfoForNode (const Dom::Value &domValue, SortInfoNode *sortNode) const override
 
bool LessThan (SortInfoNode *lhs, SortInfoNode *rhs) const override
 
- Protected Member Functions inherited from AZ::DocumentPropertyEditor::RowSortAdapter
Dom::Value GenerateContents () override
 
virtual SortInfoNodeNewSortInfoNode () const =0
 
virtual void CacheDomInfoForNode (const Dom::Value &domValue, SortInfoNode *sortNode) const =0
 
virtual bool LessThan (SortInfoNode *lhs, SortInfoNode *rhs) const
 
void HandleReset () override
 
void HandleDomChange (const Dom::Patch &patch) override
 
SortInfoNodeGetNodeAtSourcePath (Dom::Path sourcePath)
 
void GenerateFullTree ()
 
void PopulateChildren (const Dom::Value &value, SortInfoNode *sortInfo)
 
Dom::Value GetSortedValue (const Dom::Value &sourceValue, SortInfoNode *sortInfo)
 
void ResortRow (Dom::Path sourcePath, Dom::Patch &outgoingPatch)
 re-sorts the row at the given path relative to its siblings and adds a patch operation if its place changed
 
void GenerateMovePatches (const SortInfoNode *sortNode, Dom::Path parentPath, bool mapToSource, Dom::Patch &outgoingPatch)
 
- Protected Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
void HandleDomMessage (const AZ::DocumentPropertyEditor::AdapterMessage &message, Dom::Value &value)
 
virtual void HandleReset ()=0
 
virtual void HandleDomChange (const Dom::Patch &patch)=0
 
bool IsRow (const Dom::Path &sourcePath) const
 
Dom::Path GetRowPath (const Dom::Path &sourcePath) const
 returns the first path in the ancestry of sourcePath that is of type Row, including self
 
- Protected Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
virtual Dom::Value GenerateContents ()=0
 
virtual Dom::Value HandleMessage (const AdapterMessage &message)
 
void NotifyResetDocument (DocumentResetType resetType=DocumentResetType::SoftReset)
 
void NotifyContentsChanged (const Dom::Patch &patch)
 

Protected Attributes

bool m_caseSensitive = false
 
size_t m_sortColumn = 0
 
Name m_sortAttributeName
 
- Protected Attributes inherited from AZ::DocumentPropertyEditor::RowSortAdapter
AZStd::unique_ptr< SortInfoNodem_rootNode
 
bool m_sortActive = true
 
- Protected Attributes inherited from AZ::DocumentPropertyEditor::MetaAdapter
DocumentAdapter::ResetEvent::Handler m_resetHandler
 
ChangedEvent::Handler m_changedHandler
 
MessageEvent::Handler m_domMessageHandler
 
DocumentAdapterPtr m_sourceAdapter
 

Additional Inherited Members

- Public Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
using ResetEvent = Event<>
 
using ChangedEvent = Event< const Dom::Patch & >
 
using MessageEvent = Event< const AdapterMessage &, Dom::Value & >
 
- Static Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
static bool IsDebugModeEnabled ()
 
static void SetDebugModeEnabled (bool enableDebugMode)
 
static bool IsRow (const Dom::Value &domValue)
 convenience method to determine whether a particular Dom Value is a row
 
- Protected Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
enum class  DocumentResetType { SoftReset , HardReset }
 Specifies the type of reset operation triggered in NotifyResetDocument. More...
 
- Static Protected Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
static bool IsRow (const Dom::Value &domValue)
 convenience method to determine whether a particular Dom Value is a row
 

Member Function Documentation

◆ CacheDomInfoForNode()

void AZ::DocumentPropertyEditor::ValueStringSort::CacheDomInfoForNode ( const Dom::Value &  domValue,
SortInfoNode sortNode 
) const
overrideprotectedvirtual

◆ LessThan()

bool AZ::DocumentPropertyEditor::ValueStringSort::LessThan ( SortInfoNode lhs,
SortInfoNode rhs 
) const
overrideprotectedvirtual

virtual method that determines the ordering of the nodes within the adapter NB! The implementation relies on there never being a tie, i.e. don't allow this: !(a < b) && !(b < a) The best way to avoid this is to call this base implementation (which maintains the original sorting of the source adapter) for otherwise equal values

Reimplemented from AZ::DocumentPropertyEditor::RowSortAdapter.

◆ NewSortInfoNode()

SortInfoNode * AZ::DocumentPropertyEditor::ValueStringSort::NewSortInfoNode ( ) const
overrideprotectedvirtual

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