REFERENCE MANUAL
#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
An iterator used for traversing results from a search on an associated FontSearchResults object.
FontSearchResultsIterator::FontSearchResultsIterator | ( | ) |
The default constructor creates a new FontSearchResultsIterator object that is not associated with any FontSearchResults object.
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.
in_search_results_iterator | The source of the copy. |
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.
in_that | An rvalue reference to FontSearchResultsIterator to take the impl from. |
FontInfoState 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*.
bool 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.
void FontSearchResultsIterator::Next | ( | ) |
Advances the iterator to the next search result item
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool FontSearchResultsIterator::operator!= | ( | FontSearchResultsIterator const & | in_search_results_iterator | ) |
Comparison operator between iterators to compare inequality
in_search_results_iterator | The iterator to compare to |
FontInfoState FontSearchResultsIterator::operator* | ( | ) | const |
Returns the FontInfoState that this iterator is currently pointing at. Throws exception if iterator is not valid.
FontSearchResultsIterator& FontSearchResultsIterator::operator++ | ( | ) |
Advances the iterator to the next search result item
FontSearchResultsIterator FontSearchResultsIterator::operator++ | ( | int | in_val | ) |
Advances the iterator to the next search result item
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.
in_search_results_iterator | The source of the copy. |
FontSearchResultsIterator& FontSearchResultsIterator::operator= | ( | FontSearchResultsIterator && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this FontSearchResultsIterator thereby avoiding a copy.
in_that | An rvalue reference to an FontSearchResultsIterator to take the impl from. |
bool FontSearchResultsIterator::operator== | ( | FontSearchResultsIterator const & | in_search_results_iterator | ) |
Comparison operator between iterators to compare equality
in_search_results_iterator | The iterator to compare to |
|
virtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from Object.
void 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.
in_search_results_iterator | The source of the copy. |