An iterator used for traversing results from a search on an associated FontSearchResults object.
More...
|
override void | Dispose () |
|
| FontSearchResultsIterator () |
| The default constructor creates a new FontSearchResultsIterator object that is not associated with any FontSearchResults object. More...
|
|
| FontSearchResultsIterator (HPS.FontSearchResultsIterator 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. More...
|
|
HPS.FontInfoState | GetItem () |
| 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*. More...
|
|
bool | IsValid () |
| Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element. More...
|
|
void | Next () |
| Advances the iterator to the next search result item More...
|
|
override HPS.Type | ObjectType () |
| This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
|
|
override void | Reset () |
| Resets iterator to the beginning of the associated search results. More...
|
|
void | Set (HPS.FontSearchResultsIterator 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. More...
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
| Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
|
|
bool | HasType (HPS.Type in_mask) |
| This function indicates whether this Object has the given Type mask. More...
|
|
| Object (HPS.Object that) |
|
HPS.Type | Type () |
| This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
|
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
An iterator used for traversing results from a search on an associated FontSearchResults object.
HPS.FontSearchResultsIterator.FontSearchResultsIterator |
( |
| ) |
|
|
inline |
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. |
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 |
( |
| ) |
|
|
inline |
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 |
( |
| ) |
|
|
inline |
Advances the iterator to the next search result item
override HPS.Type HPS.FontSearchResultsIterator.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
override void HPS.FontSearchResultsIterator.Reset |
( |
| ) |
|
|
inlinevirtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS.Object.
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:
- internals/hps_core/source/cs/HPS.FontSearchResultsIterator.cs