CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
CFxUIRibbonItemCollection< T > Class Template Referenceabstract

#include <FxUIRibbon.h>

Public Member Functions

virtual ~CFxUIRibbonItemCollection ()
 
virtual bool InsertAfter (const T *pPosition, T *pItem)=0
 
virtual bool Add (T *pItem)=0
 
virtual bool Remove (T *pItem)=0
 
virtual unsigned int GetCount () const =0
 
virtual T * GetItem (unsigned int index)=0
 
virtual void Clear (bool bDeleteItems)=0
 
virtual bool Has (const T *pItem) const =0
 
virtual bool HasControl (const CFxString &strUID)=0
 

Detailed Description

template<class T>
class CFxUIRibbonItemCollection< T >

Definition at line 84 of file FxUIRibbon.h.

Constructor & Destructor Documentation

◆ ~CFxUIRibbonItemCollection()

template<class T >
virtual CFxUIRibbonItemCollection< T >::~CFxUIRibbonItemCollection ( )
inlinevirtual

Definition at line 87 of file FxUIRibbon.h.

Member Function Documentation

◆ Add()

template<class T >
virtual bool CFxUIRibbonItemCollection< T >::Add ( T *  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()

template<class T >
virtual void CFxUIRibbonItemCollection< T >::Clear ( bool  bDeleteItems)
pure virtual

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

Parameters
bDeleteItemstrue to delete the items.

◆ GetCount()

template<class T >
virtual unsigned int CFxUIRibbonItemCollection< T >::GetCount ( ) const
pure virtual

Description: Gets the count.

Return Value: The count.

◆ GetItem()

template<class T >
virtual T* CFxUIRibbonItemCollection< T >::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()

template<class T >
virtual bool CFxUIRibbonItemCollection< T >::Has ( const T *  pItem) const
pure virtual

Description: Description: Finds an item. Arguments:

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

Return Value: true if the item is in the collection.

◆ HasControl()

template<class T >
virtual bool CFxUIRibbonItemCollection< T >::HasControl ( const CFxString strUID)
pure virtual

Description: Description: Finds an item recursively. Arguments:

Parameters
[in]strUIDUID of a control.

Return Value: true if the string is in the collection.

◆ InsertAfter()

template<class T >
virtual bool CFxUIRibbonItemCollection< T >::InsertAfter ( const T *  pPosition,
T *  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()

template<class T >
virtual bool CFxUIRibbonItemCollection< T >::Remove ( T *  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: