API Search || Global Search
HPS.FontSearchResults Class Reference

More...

Inheritance diagram for HPS.FontSearchResults:
HPS.Object

Public Member Functions

void Assign (HPS.FontSearchResults 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. More...
 
override void Dispose ()
 
 FontSearchResults (HPS.FontSearchResults in_search_results)
 The copy constructor creates a new FontSearchResults object that shares the underlying smart-pointer of the source. More...
 
ulong GetCount ()
 Gets the number of items that were found in the associated search. More...
 
HPS.FontSearchResultsIterator GetIterator ()
 Returns a FontSearchResultsIterator used to iterate through the found search results. More...
 
override HPS.Type ObjectType ()
 
override void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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)
 
virtual 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...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.FontSearchResults.FontSearchResults ( HPS.FontSearchResults  in_search_results)
inline

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

Parameters
in_search_resultsThe source of the copy.

Member Function Documentation

void HPS.FontSearchResults.Assign ( HPS.FontSearchResults  in_search_results)
inline

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_resultsThe source of the assignment.
ulong HPS.FontSearchResults.GetCount ( )
inline

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

Returns
The number of unique items found.
HPS.FontSearchResultsIterator HPS.FontSearchResults.GetIterator ( )
inline

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

Returns
An iterator pointing to the beginning of the search results list.
override void HPS.FontSearchResults.Reset ( )
inlinevirtual

Resets this object to its initial, uninitialized state.

Reimplemented from HPS.Object.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.FontSearchResults.cs