Isle
Loading...
Searching...
No Matches
MxPresenterList Class Reference

[AI] List to hold pointers to MxPresenter objects with optional ownership semantics. More...

#include <mxpresenterlist.h>

Inheritance diagram for MxPresenterList:
Collaboration diagram for MxPresenterList:

Public Member Functions

 MxPresenterList (MxBool p_ownership=FALSE)
 [AI] Constructs an MxPresenterList with optional pointer ownership flag. More...
 
MxS8 Compare (MxPresenter *p_a, MxPresenter *p_b) override
 [AI] Compares two MxPresenter pointers for equality and ordering. More...
 
- Public Member Functions inherited from MxPtrList< MxPresenter >
 MxPtrList (MxBool p_ownership)
 [AI] More...
 
void SetOwnership (MxBool p_ownership)
 [AI] More...
 
- Public Member Functions inherited from MxList< T >
 MxList ()
 [AI] Constructor. Initializes the list pointers to null (empty list). [AI] More...
 
 ~MxList () override
 [AI] Destructor. Deletes all entries in the list and manages resource ownership. [AI] More...
 
void Append (T p_obj)
 [AI] More...
 
void Prepend (T p_obj)
 [AI] More...
 
void DeleteAll ()
 [AI] More...
 
void Empty ()
 [AI] More...
 
MxU32 GetNumElements ()
 [AI] More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MxPtrList< MxPresenter >
static void Destroy (MxPresenter *p_obj)
 [AI] More...
 
- Protected Member Functions inherited from MxList< T >
void DeleteEntry (MxListEntry< T > *)
 [AI] More...
 
MxListEntry< T > * InsertEntry (T, MxListEntry< T > *, MxListEntry< T > *)
 [AI] More...
 
- Protected Member Functions inherited from MxCollection< T >
 MxCollection ()
 [AI] Constructs an empty collection, initializing count and default element destructor. More...
 
virtual MxS8 Compare (T a, T b)
 [AI] Compares two elements of the collection (default implementation returns zero; override in subclasses for meaningful comparison). More...
 
 ~MxCollection () override
 [AI] Virtual destructor for proper polymorphic destruction. More...
 
void SetDestroy (void(*p_customDestructor)(T))
 [AI] Assigns a custom destructor function to be used for elements of this collection. More...
 
- Protected Member Functions inherited from MxCore
 MxCore ()
 [AI] Constructs a new MxCore object and assigns it a unique id. More...
 
virtual ~MxCore ()
 [AI] Virtual destructor. Required for correct polymorphic cleanup in derived classes. More...
 
virtual MxLong Notify (MxParam &p_param)
 [AI] Virtual callback notification mechanism. More...
 
virtual MxResult Tickle ()
 [AI] Called by tickle managers to allow the object to update itself. More...
 
virtual const char * ClassName () const
 [AI] Returns the runtime class name of this object. More...
 
virtual MxBool IsA (const char *p_name) const
 [AI] Checks whether this object's class type or parents match the given name. More...
 
MxU32 GetId ()
 [AI] Gets the unique (per-process) id assigned to this object instance. More...
 
- Static Protected Member Functions inherited from MxCollection< T >
static void Destroy (T obj)
 [AI] Static no-op destroy function; suitable for types that do not need destruction. More...
 
- Protected Attributes inherited from MxList< T >
MxListEntry< T > * m_first
 [AI] Pointer to the first entry in the list. [AI] More...
 
MxListEntry< T > * m_last
 [AI] Pointer to the last entry in the list. [AI] More...
 
- Protected Attributes inherited from MxCollection< T >
MxU32 m_count
 [AI] Number of elements currently stored in the collection. More...
 
void(* m_customDestructor )(T)
 [AI] Function pointer to the custom element destructor used for cleanup of elements. More...
 

Detailed Description

[AI] List to hold pointers to MxPresenter objects with optional ownership semantics.

[AI] MxPresenterList extends MxPtrList<MxPresenter> to provide a specialized container for handling a list of pointers to MxPresenter instances. It supports basic list operations, pointer comparison, and optional memory management based on ownership. Typically used to manage presentational state/progression, sequencing multiple presenters in the LEGO Island engine.

Definition at line 18 of file mxpresenterlist.h.

Constructor & Destructor Documentation

◆ MxPresenterList()

MxPresenterList::MxPresenterList ( MxBool  p_ownership = FALSE)
inline

[AI] Constructs an MxPresenterList with optional pointer ownership flag.

Parameters
p_ownershipIf TRUE, the list assumes ownership and will delete MxPresenter objects upon destruction or removal. [AI]

Definition at line 24 of file mxpresenterlist.h.

Member Function Documentation

◆ Compare()

MxS8 MxPresenterList::Compare ( MxPresenter p_a,
MxPresenter p_b 
)
inlineoverride

[AI] Compares two MxPresenter pointers for equality and ordering.

[AI] Returns 0 if the pointers are equal, -1 if the first is less than the second, and 1 otherwise. Used internally to support ordered list operations or uniqueness checks.

Parameters
p_aThe first MxPresenter pointer to compare. [AI]
p_bThe second MxPresenter pointer to compare. [AI]
Returns
0 if equal, -1 if p_a < p_b, 1 if p_a > p_b. [AI]

Definition at line 34 of file mxpresenterlist.h.


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