CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
CFxUIMenuItemCollection Class Referenceabstract

#include <FxUI.h>

Public Member Functions

virtual ~CFxUIMenuItemCollection ()
 
virtual bool InsertAfter (const CFxUIMenuItem *pPosition, CFxUIMenuItem *pItem)=0
 
virtual bool Add (CFxUIMenuItem *pItem)=0
 
virtual bool Remove (CFxUIMenuItem *pItem)=0
 
virtual unsigned int GetCount () const =0
 
virtual CFxUIMenuItemGetItem (unsigned int index)=0
 
virtual void Clear (bool bDeleteItems)=0
 
virtual bool Has (const CFxUIMenuItem *pItem) const =0
 

Detailed Description

Description: Represents the menu item collection of the user interface. Library: DDKERNEL

Definition at line 1309 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUIMenuItemCollection()

virtual CFxUIMenuItemCollection::~CFxUIMenuItemCollection ( )
inlinevirtual

Definition at line 1312 of file FxUI.h.

Member Function Documentation

◆ Add()

virtual bool CFxUIMenuItemCollection::Add ( CFxUIMenuItem pItem)
pure virtual

Description: Adds pItem.. Arguments:

Parameters
[in,out]pItemIf non-null, the CFxUIMenuItem* to add.

Return Value: true if it succeeds, false if it fails.

◆ Clear()

virtual void CFxUIMenuItemCollection::Clear ( bool  bDeleteItems)
pure virtual

Description: Clears this object to its blank/initial state. Arguments:

Parameters
bDeleteItemstrue to delete the items.

◆ GetCount()

virtual unsigned int CFxUIMenuItemCollection::GetCount ( ) const
pure virtual

Description: Gets the count.

Return Value: The count.

◆ GetItem()

virtual CFxUIMenuItem* CFxUIMenuItemCollection::GetItem ( unsigned int  index)
pure virtual

Description: Description: Gets an item. Arguments:

Parameters
indexZero-based index of the.

Return Value: null if it fails, else the item.

◆ Has()

virtual bool CFxUIMenuItemCollection::Has ( const CFxUIMenuItem pItem) const
pure virtual

◆ InsertAfter()

virtual bool CFxUIMenuItemCollection::InsertAfter ( const CFxUIMenuItem pPosition,
CFxUIMenuItem pItem 
)
pure virtual

Description: Inserts an after. Arguments:

Parameters
pPositionThe position.
[in,out]pItemIf non-null, the item.

Return Value: true if it succeeds, false if it fails.

◆ Remove()

virtual bool CFxUIMenuItemCollection::Remove ( CFxUIMenuItem pItem)
pure virtual

Description: Removes the given pItem. Arguments:

Parameters
[in,out]pItemIf non-null, the CFxUIMenuItem* to remove.

Return Value: true if it succeeds, false if it fails.


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