clang-tools 20.0.0git
Public Member Functions | Public Attributes | List of all members
clang::clangd::InlayHintLabelPart Struct Reference

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< MarkupContenttooltip
 The tooltip text when you hover over this label part.
 
std::optional< Locationlocation
 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 1694 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 1698 of file Protocol.h.

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 1727 of file Protocol.h.

◆ 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 1721 of file Protocol.h.

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

◆ 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 1708 of file Protocol.h.

◆ value

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

The value of this label part.

Definition at line 1703 of file Protocol.h.

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


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