Kanzi  3.9.6
Kanzi Engine API
kanzi::SplitStringRange::SplitStringRangeLocation Class Reference

Location implementation for split string range. More...

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

Inheritance diagram for kanzi::SplitStringRange::SplitStringRangeLocation:
[legend]

Static Public Member Functions

static AbstractRangeLocationPtr create (SplitStringRange &range, const SplitPosition &pos)
 Creates a new range location. More...
 

Protected Member Functions

bool advanceOverride () override
 AbstractRangeLocation::advanceOverride() implementation. More...
 
AbstractRangeLocationPtr cloneOverride () override
 AbstractRangeLocation::cloneOverride() implementation. More...
 
PropertyObjectSharedPtr getPropertyObjectOverride () override
 AbstractRangeLocation::getPropertyObjectOverride() implementation. More...
 
bool getPropertyValueOverride (AbstractPropertyType propertyType, Variant &value) override
 AbstractRangeLocation::getPropertyValueOverride() implementation. More...
 
SplitStringRangegetRange ()
 Accesses the range with correct type. More...
 
const SplitStringRangegetRange () const
 Accesses the range with correct type. More...
 
bool getValueOverride (Variant &value) override
 AbstractRangeLocation::getValueOverride() implementation. More...
 
bool isValidOverride () const override
 AbstractRangeLocation::isValidOverride() implementation. More...
 
bool matchesOverride (const AbstractRangeLocation &other) const override
 AbstractRangeLocation::matchesOverride() implementation. More...
 
 SplitStringRangeLocation (SplitStringRange &range, const SplitPosition &pos)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractRangeLocation
 AbstractRangeLocation (AbstractRange &range)
 Constructor. More...
 

Protected Attributes

SplitPosition m_splitPos
 Split position. More...
 
- Protected Attributes inherited from kanzi::AbstractRangeLocation
AbstractRangem_range
 Reference to source range. More...
 

Additional Inherited Members

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

Detailed Description

Location implementation for split string range.

Constructor & Destructor Documentation

◆ SplitStringRangeLocation()

kanzi::SplitStringRange::SplitStringRangeLocation::SplitStringRangeLocation ( SplitStringRange range,
const SplitPosition pos 
)
explicitprotected

Constructor.

Parameters
rangeParent range.
posSplit position.

Member Function Documentation

◆ create()

static AbstractRangeLocationPtr kanzi::SplitStringRange::SplitStringRangeLocation::create ( SplitStringRange range,
const SplitPosition pos 
)
inlinestatic

Creates a new range location.

Parameters
rangeParent range.
posSplit position.

◆ getRange() [1/2]

SplitStringRange& kanzi::SplitStringRange::SplitStringRangeLocation::getRange ( )
inlineprotected

Accesses the range with correct type.

Returns
Casted range.

◆ getRange() [2/2]

const SplitStringRange& kanzi::SplitStringRange::SplitStringRangeLocation::getRange ( ) const
inlineprotected

Accesses the range with correct type.

Returns
Casted range.

◆ cloneOverride()

AbstractRangeLocationPtr kanzi::SplitStringRange::SplitStringRangeLocation::cloneOverride ( )
overrideprotectedvirtual

◆ matchesOverride()

bool kanzi::SplitStringRange::SplitStringRangeLocation::matchesOverride ( const AbstractRangeLocation other) const
overrideprotectedvirtual

◆ isValidOverride()

bool kanzi::SplitStringRange::SplitStringRangeLocation::isValidOverride ( ) const
overrideprotectedvirtual

◆ advanceOverride()

bool kanzi::SplitStringRange::SplitStringRangeLocation::advanceOverride ( )
overrideprotectedvirtual

◆ getPropertyObjectOverride()

PropertyObjectSharedPtr kanzi::SplitStringRange::SplitStringRangeLocation::getPropertyObjectOverride ( )
overrideprotectedvirtual

◆ getPropertyValueOverride()

bool kanzi::SplitStringRange::SplitStringRangeLocation::getPropertyValueOverride ( AbstractPropertyType  propertyType,
Variant value 
)
overrideprotectedvirtual

◆ getValueOverride()

bool kanzi::SplitStringRange::SplitStringRangeLocation::getValueOverride ( Variant value)
overrideprotectedvirtual

Member Data Documentation

◆ m_splitPos

SplitPosition kanzi::SplitStringRange::SplitStringRangeLocation::m_splitPos
protected

Split position.


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