An inlay hint label part allows for interactive and composite labels of inlay hints. More...

#include <Protocol.h>

Public Member Functions
	InlayHintLabelPart ()=default
	InlayHintLabelPart (std::string value, std::optional< Location > location=std::nullopt)

Public Attributes
std::string	value
	The value of this label part.
std::optional< MarkupContent >	tooltip
	The tooltip text when you hover over this label part.
std::optional< Location >	location
	An optional source code location that represents this label part.
std::optional< Command >	command
	An optional command for this label part.

Detailed Description

An inlay hint label part allows for interactive and composite labels of inlay hints.

Definition at line 1717 of file Protocol.h.

Constructor & Destructor Documentation

◆ InlayHintLabelPart() [1/2]

clang::clangd::InlayHintLabelPart::InlayHintLabelPart ( )

default

◆ InlayHintLabelPart() [2/2]

clang::clangd::InlayHintLabelPart::InlayHintLabelPart	(	std::string	value,
		std::optional< Location >	location = std::nullopt )

inline

Definition at line 1721 of file Protocol.h.

References location, and value.

Member Data Documentation

◆ command

std::optional<Command> clang::clangd::InlayHintLabelPart::command

An optional command for this label part.

Depending on the client capability inlayHint.resolveSupport clients might resolve this property late using the resolve request.

Definition at line 1750 of file Protocol.h.

Referenced by clang::clangd::toJSON().

◆ location

std::optional<Location> clang::clangd::InlayHintLabelPart::location

An optional source code location that represents this label part.

The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands.

Depending on the client capability inlayHint.resolveSupport clients might resolve this property late using the resolve request.

Definition at line 1744 of file Protocol.h.

Referenced by InlayHintLabelPart(), clang::clangd::operator<(), clang::clangd::operator<<(), clang::clangd::operator==(), and clang::clangd::toJSON().

◆ tooltip

std::optional<MarkupContent> clang::clangd::InlayHintLabelPart::tooltip

The tooltip text when you hover over this label part.

Depending on the client capability inlayHint.resolveSupport, clients might resolve this property late using the resolve request.

Definition at line 1731 of file Protocol.h.

Referenced by clang::clangd::toJSON().

◆ value

std::string clang::clangd::InlayHintLabelPart::value

The value of this label part.

Definition at line 1726 of file Protocol.h.