FontSearchResultsIterator
-
class HPS::FontSearchResultsIterator : public HPS::Object
An iterator used for traversing results from a search on an associated FontSearchResults object.
Public Functions
-
FontSearchResultsIterator()
The default constructor creates a new FontSearchResultsIterator object that is not associated with any FontSearchResults object.
-
FontSearchResultsIterator(FontSearchResultsIterator &&in_that)
The move constructor creates FontSearchResultsIterator by transferring the underlying impl of the rvalue reference to this Key thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to FontSearchResultsIterator to take the impl from.
-
FontSearchResultsIterator(FontSearchResultsIterator const &in_search_results_iterator)
The copy constructor initializes a new FontSearchResultsIterator object that is associated with the same FontSearchResults 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_iterator – The source of the copy.
-
FontInfoState GetItem() const
Returns the FontInfoState that this iterator is currently pointing at. Throws exception if iterator is not valid. This method is functionally equivalent to the overloaded operator*.
- Returns
The current item.
-
bool 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.
-
void Next()
Advances the iterator to the next search result item
-
inline virtual HPS::Type ObjectType() const
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.
-
bool operator!=(FontSearchResultsIterator const &in_search_results_iterator)
Comparison operator between iterators to compare inequality
- Parameters
in_search_results_iterator – The iterator to compare to
-
FontInfoState operator*() const
Returns the FontInfoState that this iterator is currently pointing at. Throws exception if iterator is not valid.
- Returns
The current font name.
-
FontSearchResultsIterator &operator++()
Advances the iterator to the next search result item
- Returns
A reference to this object.
-
FontSearchResultsIterator operator++(int in_val)
Advances the iterator to the next search result item
- Returns
A reference to this object.
-
FontSearchResultsIterator &operator=(FontSearchResultsIterator &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this FontSearchResultsIterator thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to an FontSearchResultsIterator to take the impl from.
- Returns
A reference to this FontSearchResultsIterator.
-
FontSearchResultsIterator &operator=(FontSearchResultsIterator const &in_search_results_iterator)
Copies a FontSearchResultsIterator object, associating this object with the same FontSearchResults 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_iterator – The source of the copy.
- Returns
a reference to this object.
-
bool operator==(FontSearchResultsIterator const &in_search_results_iterator)
Comparison operator between iterators to compare equality
- Parameters
in_search_results_iterator – The iterator to compare to
-
virtual void Reset()
Resets iterator to the beginning of the associated search results.
-
void Set(FontSearchResultsIterator const &in_search_results_iterator)
Copies a FontSearchResultsIterator object, associating this object with the same FontSearchResults 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_iterator – The source of the copy.
-
~FontSearchResultsIterator()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::FontSearchResultsIterator
-
FontSearchResultsIterator()
