#include <hps.h>

Public Member Functions | |
FontSearchResultsIterator () | |
FontSearchResultsIterator (FontSearchResultsIterator const &in_search_results_iterator) | |
FontSearchResultsIterator (FontSearchResultsIterator &&in_that) | |
FontInfoState | GetItem () const |
bool | IsValid () const |
void | Next () |
HPS::Type | ObjectType () const |
bool | operator!= (FontSearchResultsIterator const &in_search_results_iterator) |
FontInfoState | operator* () const |
FontSearchResultsIterator & | operator++ () |
FontSearchResultsIterator | operator++ (int in_val) |
FontSearchResultsIterator & | operator= (FontSearchResultsIterator const &in_search_results_iterator) |
FontSearchResultsIterator & | operator= (FontSearchResultsIterator &&in_that) |
bool | operator== (FontSearchResultsIterator const &in_search_results_iterator) |
void | Reset () |
void | Set (FontSearchResultsIterator const &in_search_results_iterator) |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::FontSearchResultsIterator |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
An iterator used for traversing results from a search on an associated FontSearchResults object.
Constructor & Destructor Documentation
HPS::FontSearchResultsIterator::FontSearchResultsIterator | ( | ) |
The default constructor creates a new FontSearchResultsIterator object that is not associated with any FontSearchResults object.
HPS::FontSearchResultsIterator::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.
HPS::FontSearchResultsIterator::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.
Member Function Documentation
FontInfoState HPS::FontSearchResultsIterator::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 HPS::FontSearchResultsIterator::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 HPS::FontSearchResultsIterator::Next | ( | ) |
Advances the iterator to the next search result item
bool HPS::FontSearchResultsIterator::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 HPS::FontSearchResultsIterator::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& HPS::FontSearchResultsIterator::operator++ | ( | ) |
Advances the iterator to the next search result item
- Returns
- A reference to this object.
FontSearchResultsIterator HPS::FontSearchResultsIterator::operator++ | ( | int | in_val | ) |
Advances the iterator to the next search result item
- Returns
- A reference to this object.
FontSearchResultsIterator& HPS::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.
FontSearchResultsIterator& HPS::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.
bool HPS::FontSearchResultsIterator::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 |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS::Object.
void HPS::FontSearchResultsIterator::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.
The documentation for this class was generated from the following file:
- include/hps.h