CFxVariantCollection Struct Reference

#include <FxVariant.h>

Public Types
typedef std::vector< CFxVariantCollectionElement >	CONTAINER

Public Member Functions
	CFxVariantCollection ()
bool	operator== (const CFxVariantCollection &collection) const
bool	HasVaries () const
const CONTAINER &	GetCollectionDataForRead () const
CONTAINER &	GetCollectionDataForWrite ()
CFxVariant	GetActiveItemValue () const

Public Attributes
int	_selectedIndex
bool	_bEditable

Protected Attributes
CONTAINER	_collection

Detailed Description

Description: Represents the variant collection. Library: DDKernel

Definition at line 117 of file FxVariant.h.

Member Typedef Documentation

CONTAINER

typedef std::vector<CFxVariantCollectionElement> CFxVariantCollection::CONTAINER

Description: typedef for a vector for CFxVariantCollectionElement objects.

Definition at line 143 of file FxVariant.h.

Constructor & Destructor Documentation

CFxVariantCollection()

CFxVariantCollection::CFxVariantCollection

(

)

Description: Constructor for CFxVariantCollection class that initializes with default values

Member Function Documentation

GetActiveItemValue()

CFxVariant CFxVariantCollection::GetActiveItemValue

(

)

const

Description: Retrieves the value of the active item in the collection vector Return Value: Returns a CFxVariant object representing the value of the active item.

GetCollectionDataForRead()

const CONTAINER & CFxVariantCollection::GetCollectionDataForRead ( ) const

inline

Description: Retrieves the collection data for read-only access. Return Value: const CONTAINER& - A constant reference to the collection data.

Definition at line 160 of file FxVariant.h.

GetCollectionDataForWrite()

CONTAINER & CFxVariantCollection::GetCollectionDataForWrite ( )

inline

Description: Retrieves the collection data for writing. Return Value: A reference to the collection data container.

Definition at line 170 of file FxVariant.h.

HasVaries()

bool CFxVariantCollection::HasVaries

(

)

const

Description: Checks if the collection has a "varies" value. Return Value: Returns true if the collection has a "varies" value, otherwise false.

operator==()

bool CFxVariantCollection::operator==

(

const CFxVariantCollection &

collection

)

const

Description: Equality operator for CFxVariantCollection class that compares two collections. Arguments:

Parameters

collection

The CFxVariantCollection object to be compared with. Return Value: Returns true if the collections are equal, otherwise false.

Member Data Documentation

_bEditable

bool CFxVariantCollection::_bEditable

Description: Indicates whether the variant is editable.

Definition at line 153 of file FxVariant.h.

_collection

CONTAINER CFxVariantCollection::_collection

protected

Description: A vector for CFxVariantCollectionElement objects.

Definition at line 186 of file FxVariant.h.

_selectedIndex

int CFxVariantCollection::_selectedIndex

Description: Index of the selected item of _collection.

Definition at line 148 of file FxVariant.h.

---

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

• FxVariant.h