kanzi::IteratorRange::IteratorRangeLocation Class Reference

Location implementation for iterator range. More...

#include <kanzi/core.ui/binding/iterator_range.hpp>

Inheritance diagram for kanzi::IteratorRange::IteratorRangeLocation:

Static Public Member Functions
static AbstractRangeLocationPtr	create (IteratorRange &range, bool valid)
	Creates a new range location.

Protected Member Functions
bool	advanceOverride () override
	AbstractRangeLocation::advanceOverride() implementation.
AbstractRangeLocationPtr	cloneOverride () override
	AbstractRangeLocation::cloneOverride() implementation.
PropertyObjectSharedPtr	getPropertyObjectOverride () override
	AbstractRangeLocation::getPropertyObjectOverride() implementation.
bool	getPropertyValueOverride (AbstractPropertyType propertyType, Variant &value) override
	AbstractRangeLocation::getPropertyValueOverride() implementation.
IteratorRange &	getRange ()
	Accesses the range with correct type.
const IteratorRange &	getRange () const
	Accesses the range with correct type.
bool	getValueOverride (Variant &value) override
	AbstractRangeLocation::getValueOverride() implementation.
bool	isValidOverride () const override
	AbstractRangeLocation::isValidOverride() implementation.
	IteratorRangeLocation (IteratorRange &range, bool valid)
	Constructor.
bool	matchesOverride (const AbstractRangeLocation &other) const override
	AbstractRangeLocation::matchesOverride() implementation.
Protected Member Functions inherited from kanzi::AbstractRangeLocation
	AbstractRangeLocation (AbstractRange &range)
	Constructor.

Protected Attributes
bool	m_valid
	Has this been advanced, or is it still valid?
Protected Attributes inherited from kanzi::AbstractRangeLocation
AbstractRange &	m_range
	Reference to source range.

Additional Inherited Members
Public Member Functions inherited from kanzi::AbstractRangeLocation
bool	advance ()
	Advances the location.
unique_ptr< AbstractRangeLocation >	clone ()
	Returns a clone of this range location.
PropertyObjectSharedPtr	getPropertyObject ()
	Access to a property object at the location.
bool	getPropertyValue (AbstractPropertyType propertyType, Variant &value)
	Access a property in a property object at a location.
AbstractRange &	getRange ()
	Returns a reference to the range being iterated.
const AbstractRange &	getRange () const
	Returns a const reference to the range being iterated.
bool	getValue (Variant &value)
	Access a value from a location.
bool	isValid () const
	Indicates whether the location is valid.
bool	matches (const AbstractRangeLocation &other) const
	Indicates whether a range location matches another.
	operator bool () const
	Cast to bool operator.
bool	operator!= (const AbstractRangeLocation &rhs) const
	Not equals operator.
bool	operator== (const AbstractRangeLocation &rhs) const
	Equals operator.
virtual	~AbstractRangeLocation ()=default
	Destructor.

Detailed Description

Location implementation for iterator range.

Constructor & Destructor Documentation

IteratorRangeLocation()

kanzi::IteratorRange::IteratorRangeLocation::IteratorRangeLocation ( IteratorRange & range, bool valid )

inlineexplicitprotected

Constructor.

Parameters

range	Parent range.
valid	False if the iterator range already been advanced.

Member Function Documentation

create()

static AbstractRangeLocationPtr kanzi::IteratorRange::IteratorRangeLocation::create ( IteratorRange & range, bool valid )

inlinestatic

Creates a new range location.

Parameters

range	Parent range.
valid	False if the iterator range already been advanced.

getRange() [1/2]

IteratorRange & kanzi::IteratorRange::IteratorRangeLocation::getRange ( )

inlineprotected

Accesses the range with correct type.

Returns

Casted range.

getRange() [2/2]

const IteratorRange & kanzi::IteratorRange::IteratorRangeLocation::getRange ( ) const

inlineprotected

Accesses the range with correct type.

Returns

Casted range.

cloneOverride()

AbstractRangeLocationPtr kanzi::IteratorRange::IteratorRangeLocation::cloneOverride ( )

overrideprotectedvirtual

AbstractRangeLocation::cloneOverride() implementation.

Implements kanzi::AbstractRangeLocation.

matchesOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::matchesOverride ( const AbstractRangeLocation & other ) const

overrideprotectedvirtual

AbstractRangeLocation::matchesOverride() implementation.

Implements kanzi::AbstractRangeLocation.

isValidOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::isValidOverride ( ) const

overrideprotectedvirtual

AbstractRangeLocation::isValidOverride() implementation.

Implements kanzi::AbstractRangeLocation.

advanceOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::advanceOverride ( )

overrideprotectedvirtual

AbstractRangeLocation::advanceOverride() implementation.

Implements kanzi::AbstractRangeLocation.

getPropertyObjectOverride()

PropertyObjectSharedPtr kanzi::IteratorRange::IteratorRangeLocation::getPropertyObjectOverride ( )

overrideprotectedvirtual

AbstractRangeLocation::getPropertyObjectOverride() implementation.

Implements kanzi::AbstractRangeLocation.

getPropertyValueOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::getPropertyValueOverride ( AbstractPropertyType propertyType, Variant & value )

overrideprotectedvirtual

AbstractRangeLocation::getPropertyValueOverride() implementation.

Implements kanzi::AbstractRangeLocation.

getValueOverride()

bool kanzi::IteratorRange::IteratorRangeLocation::getValueOverride ( Variant & value )

overrideprotectedvirtual

AbstractRangeLocation::getValueOverride() implementation.

Implements kanzi::AbstractRangeLocation.

Member Data Documentation

m_valid

bool kanzi::IteratorRange::IteratorRangeLocation::m_valid

protected

Has this been advanced, or is it still valid?

---

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

• kanzi/core.ui/binding/iterator_range.hpp