HPS::HighlightSearch Class Reference

#include <hps.h>

Public Types

enum  Scope : uint32_t { Scope::AtOrAbovePath, Scope::AtOrBelowPath, Scope::ExactPath }
 

Detailed Description

The HighlightSearch class is a concept class for highlight search related enum classes.

Member Enumeration Documentation

◆ Scope

enum HPS::HighlightSearch::Scope : uint32_t
strong

Enumeration of how to interpret path scope when performing a highlight search.

Enumerator
AtOrAbovePath 

Only return highlights that apply at or above the specified path.

AtOrBelowPath 

Only return highlights that apply at or below the specified path.

ExactPath 

Only return highlights that apply at exactly the specified path.


The documentation for this class was generated from the following file: