Description:

An entry in the vector of search results generated by the method Search.

Definition at line 384 of file index.hpp.

#include <index.hpp>

Public Field Index:
int	FunctionArgumentMatch
alib::String	HTMLAnchor
	The HTML anchor hash. Set only with members.
alib::String	HTMLBaseURL
alib::String	HTMLFile
bool	IsIndirectByInheritance
	Set if a member was found in a base type and not in the originally given one.
bool	IsIndirectByTypeDef
bool	IsIndirectLinkToScannedHTMLSourceFile
	Set if the method DoxygenXLinks::tryResolveHTMLTargetFile" is needed and succeeds.
bool	IsResolvedTypeDef
	Set the XLink targets a type-definition and requested to resolve that.
bool	LinksToAScannedHTMLFile
Node	Node
	The cursor pointing to the result.
bool	QualifiersHintMatch

Public Method Index:
template<typename TGT>
const TGT *	Cast () const

Field Details:

◆ FunctionArgumentMatch

int dxl::Index::SearchResult::FunctionArgumentMatch

The result of MATCH. Note that function arguments are only added to the display, if they precisely match.

Definition at line 402 of file index.hpp.

◆ HTMLAnchor

alib::String dxl::Index::SearchResult::HTMLAnchor

The HTML anchor hash. Set only with members.

Definition at line 398 of file index.hpp.

◆ HTMLBaseURL

alib::String dxl::Index::SearchResult::HTMLBaseURL

Set if the user has given some hint to match the qualifiers. Note that in the case of qualifiers, they are all added to the display, even if just a hint was given.

Definition at line 391 of file index.hpp.

◆ HTMLFile

alib::String dxl::Index::SearchResult::HTMLFile

The name of the target HTML-file. If empty, the HTMLAnchor resides in the same file as it was found

Definition at line 395 of file index.hpp.

◆ IsIndirectByInheritance

bool dxl::Index::SearchResult::IsIndirectByInheritance

Set if a member was found in a base type and not in the originally given one.

Definition at line 410 of file index.hpp.

◆ IsIndirectByTypeDef

bool dxl::Index::SearchResult::IsIndirectByTypeDef

Set if the given outer scope is a type definition and the member was found in its target type.

Definition at line 414 of file index.hpp.

◆ IsIndirectLinkToScannedHTMLSourceFile

bool dxl::Index::SearchResult::IsIndirectLinkToScannedHTMLSourceFile

Set if the method DoxygenXLinks::tryResolveHTMLTargetFile" is needed and succeeds.

Definition at line 424 of file index.hpp.

◆ IsResolvedTypeDef

bool dxl::Index::SearchResult::IsResolvedTypeDef

Set the XLink targets a type-definition and requested to resolve that.

Definition at line 417 of file index.hpp.

◆ LinksToAScannedHTMLFile

bool dxl::Index::SearchResult::LinksToAScannedHTMLFile

Set if a link targets file that is not in indexed (in the tag-file) but evaluated by the file-scanner of DoxygenXLinks. (Done with the method tryResolveHTMLTargetFile.)

Definition at line 421 of file index.hpp.

◆ Node

Node dxl::Index::SearchResult::Node

The cursor pointing to the result.

Definition at line 386 of file index.hpp.

◆ QualifiersHintMatch

bool dxl::Index::SearchResult::QualifiersHintMatch

Set if the user has given some hint to match the qualifiers. Note that in the case of qualifiers, they are all added to the display, even if just a hint was given.

Definition at line 407 of file index.hpp.

Method Details:

◆ Cast()

template<typename TGT>

const TGT * dxl::Index::SearchResult::Cast ( ) const

Shortcut to Cast(const Target*) passing the Node's value.

Template Parameters

TGT	The requested target type.

Returns: The cast type or nullptr if the Node's target is not of the requested type.

Definition at line 548 of file index.hpp.

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

index.hpp