FontSearchResults

class HPS::FontSearchResults : public HPS::Object

The FontSearchResults class is a smart-pointer to a database object. It contains the results of a Find operation.

Public Functions

void Assign(FontSearchResults const &in_search_results)

Share the underlying smart-pointer if the assignment source. This method is functionally equivalent to the overloaded assignment operator except for the return value.

Parameters

in_search_results – The source of the assignment.

FontSearchResults()

The default constructor creates an empty FontSearchResults object, not associated with any search.

FontSearchResults(FontSearchResults &&in_that)

The move constructor creates FontSearchResults 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 FontSearchResults to take the impl from.

FontSearchResults(FontSearchResults const &in_search_results)

The copy constructor creates a new FontSearchResults object that shares the underlying smart-pointer of the source.

Parameters

in_search_results – The source of the copy.

size_t GetCount() const

Gets the number of items that were found in the associated search.

Returns

The number of unique items found.

FontSearchResultsIterator GetIterator() const

Returns a FontSearchResultsIterator used to iterate through the found search results.

Returns

An iterator pointing to the beginning of the search results list.

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.

FontSearchResults &operator=(FontSearchResults &&in_that)

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

Parameters

in_that – An rvalue reference to an FontSearchResults to take the impl from.

Returns

A reference to this FontSearchResults.

FontSearchResults &operator=(FontSearchResults const &in_search_results)

Share the underlying smart-pointer of the assignment source.

Parameters

in_search_results – The source of the assignment.

Returns

a reference to this object.

virtual void Reset()

Resets this object to its initial, uninitialized state.

~FontSearchResults()

The destructor decrements the number of users of the search results. If there are no remaining users, the results are released.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::FontSearchResults