HPS::HighlightSearchResultsIterator Class Reference

#include <hps.h>

Inheritance diagram for HPS::HighlightSearchResultsIterator:
HPS::Object

Public Member Functions

KeyPath GetItem () const
 
Drawing::Overlay GetOverlay () const
 
bool GetPassive () const
 
UTF8 GetStyleName () const
 
 HighlightSearchResultsIterator ()
 
 HighlightSearchResultsIterator (HighlightSearchResultsIterator const &in_search_results_iterator)
 
 HighlightSearchResultsIterator (HighlightSearchResultsIterator &&in_that)
 
bool IsValid () const
 
void Next ()
 
HPS::Type ObjectType () const
 
bool operator!= (HighlightSearchResultsIterator const &in_search_results_iterator)
 
KeyPath operator* () const
 
HighlightSearchResultsIteratoroperator++ ()
 
HighlightSearchResultsIterator operator++ (int in_val)
 
HighlightSearchResultsIteratoroperator= (HighlightSearchResultsIterator &&in_that)
 
HighlightSearchResultsIteratoroperator= (HighlightSearchResultsIterator const &in_search_results_iterator)
 
bool operator== (HighlightSearchResultsIterator const &in_search_results_iterator)
 
void Reset ()
 
void Set (HighlightSearchResultsIterator const &in_search_results_iterator)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::HighlightSearchResultsIterator
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

An iterator used for traversing results from a search on an associated HighlightSearchResults object.

Constructor & Destructor Documentation

◆ HighlightSearchResultsIterator() [1/3]

HPS::HighlightSearchResultsIterator::HighlightSearchResultsIterator ( )

The default constructor creates a new HighlightSearchResultsIterator object that is not associated with any HighlightSearchResults object.

◆ HighlightSearchResultsIterator() [2/3]

HPS::HighlightSearchResultsIterator::HighlightSearchResultsIterator ( HighlightSearchResultsIterator const &  in_search_results_iterator)

The copy constructor initializes a new HighlightSearchResultsIterator object that is associated with the same HighlightSearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other.

Parameters
in_search_results_iteratorThe source of the copy.

◆ HighlightSearchResultsIterator() [3/3]

HPS::HighlightSearchResultsIterator::HighlightSearchResultsIterator ( HighlightSearchResultsIterator &&  in_that)

The move constructor creates a HighlightSearchResultsIterator by transferring the underlying impl of the rvalue reference to this HighlightSearchResultsIterator thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to HighlightSearchResultsIterator to take the impl from.

Member Function Documentation

◆ GetItem()

KeyPath HPS::HighlightSearchResultsIterator::GetItem ( ) const

Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid. This method is functionally equivalent to the overloaded operator*.

Returns
The current item.

◆ GetOverlay()

Drawing::Overlay HPS::HighlightSearchResultsIterator::GetOverlay ( ) const

Returns the overlay type for the key path that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.

Returns
The overlay type.

◆ GetPassive()

bool HPS::HighlightSearchResultsIterator::GetPassive ( ) const

Indicates whether the highlight associated with this iterator is passive. Throws an InvalidObjectException if the iterator is not valid.

Returns
Whether the highlight is passive.

◆ GetStyleName()

UTF8 HPS::HighlightSearchResultsIterator::GetStyleName ( ) const

Returns the highlight style for the key path that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.

Returns
The highlight style.

◆ IsValid()

bool HPS::HighlightSearchResultsIterator::IsValid ( ) const

Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element.

Returns
true if this iterator is pointing to a valid item, false otherwise.

◆ Next()

void HPS::HighlightSearchResultsIterator::Next ( )

Advances the iterator to the next search result item

◆ ObjectType()

HPS::Type HPS::HighlightSearchResultsIterator::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Object.

◆ operator!=()

bool HPS::HighlightSearchResultsIterator::operator!= ( HighlightSearchResultsIterator const &  in_search_results_iterator)

Comparison operator between iterators to compare inequality

Parameters
in_search_results_iteratorThe iterator to compare to

◆ operator*()

KeyPath HPS::HighlightSearchResultsIterator::operator* ( ) const

Returns the item that this iterator is currently pointing at. Throws an InvalidObjectException if the iterator is not valid.

Returns
The current item.

◆ operator++() [1/2]

HighlightSearchResultsIterator& HPS::HighlightSearchResultsIterator::operator++ ( )

Advances the iterator to the next search result item

Returns
A reference to this object.

◆ operator++() [2/2]

HighlightSearchResultsIterator HPS::HighlightSearchResultsIterator::operator++ ( int  in_val)

Advances the iterator to the next search result item

Returns
A reference to this object.

◆ operator=() [1/2]

HighlightSearchResultsIterator& HPS::HighlightSearchResultsIterator::operator= ( HighlightSearchResultsIterator &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightSearchResultsIterator thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an HighlightSearchResultsIterator to take the impl from.
Returns
A reference to this HighlightSearchResultsIterator.

◆ operator=() [2/2]

HighlightSearchResultsIterator& HPS::HighlightSearchResultsIterator::operator= ( HighlightSearchResultsIterator const &  in_search_results_iterator)

Copies a HighlightSearchResultsIterator object, associating this object with the same HighlightSearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other.

Parameters
in_search_results_iteratorThe source of the copy.
Returns
a reference to this object.

◆ operator==()

bool HPS::HighlightSearchResultsIterator::operator== ( HighlightSearchResultsIterator const &  in_search_results_iterator)

Comparison operator between iterators to compare equality

Parameters
in_search_results_iteratorThe iterator to compare to

◆ Reset()

void HPS::HighlightSearchResultsIterator::Reset ( )
virtual

Resets iterator to the beginning of the associated search results.

Reimplemented from HPS::Object.

◆ Set()

void HPS::HighlightSearchResultsIterator::Set ( HighlightSearchResultsIterator const &  in_search_results_iterator)

Copies a HighlightSearchResultsIterator object, associating this object with the same HighlightSearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other. This method is functionally equivalent to the overloaded assignment operator except for the return value.

Parameters
in_search_results_iteratorThe source of the copy.

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