LLVM 22.0.0git
llvm::lsp::InlayHint Struct Reference

Inlay hint information. More...

#include "llvm/Support/LSP/Protocol.h"

Public Member Functions

 InlayHint (InlayHintKind kind, Position pos)

Public Attributes

Position position
 The position of this hint.
std::string label
 The label of this hint.
InlayHintKind kind
 The kind of this hint.
bool paddingLeft = false
 Render padding before the hint.
bool paddingRight = false
 Render padding after the hint.

Detailed Description

Inlay hint information.

Definition at line 1113 of file Protocol.h.

Constructor & Destructor Documentation

◆ InlayHint()

llvm::lsp::InlayHint::InlayHint ( InlayHintKind kind,
Position pos )
inline

Definition at line 1114 of file Protocol.h.

References kind, and position.

Member Data Documentation

◆ kind

InlayHintKind llvm::lsp::InlayHint::kind

The kind of this hint.

Can be omitted in which case the client should fall back to a reasonable default.

Definition at line 1127 of file Protocol.h.

Referenced by InlayHint(), llvm::lsp::operator<(), and llvm::lsp::operator==().

◆ label

std::string llvm::lsp::InlayHint::label

The label of this hint.

A human readable string or an array of InlayHintLabelPart label parts.

Note that neither the string nor the label part can be empty.

Definition at line 1123 of file Protocol.h.

Referenced by llvm::lsp::operator<(), and llvm::lsp::operator==().

◆ paddingLeft

bool llvm::lsp::InlayHint::paddingLeft = false

Render padding before the hint.

Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

Definition at line 1134 of file Protocol.h.

◆ paddingRight

bool llvm::lsp::InlayHint::paddingRight = false

Render padding after the hint.

Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

Definition at line 1141 of file Protocol.h.

◆ position

Position llvm::lsp::InlayHint::position

The position of this hint.

Definition at line 1117 of file Protocol.h.

Referenced by InlayHint(), llvm::lsp::operator<(), and llvm::lsp::operator==().


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