MLIR  16.0.0git
Public Member Functions | Public Attributes | List of all members
mlir::lsp::InlayHint Struct Reference

Inlay hint information. More...

#include "Tools/lsp-server-support/Protocol.h"

+ Collaboration diagram for mlir::lsp::InlayHint:

Public Member Functions

 InlayHint (InlayHintKind kind, Position pos)
 

Public Attributes

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

Detailed Description

Inlay hint information.

Definition at line 1063 of file Protocol.h.

Constructor & Destructor Documentation

◆ InlayHint()

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

Definition at line 1064 of file Protocol.h.

Member Data Documentation

◆ kind

InlayHintKind mlir::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 1077 of file Protocol.h.

Referenced by mlir::lsp::toJSON().

◆ label

std::string mlir::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 1073 of file Protocol.h.

Referenced by shouldAddHintFor(), and mlir::lsp::toJSON().

◆ paddingLeft

bool mlir::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 1084 of file Protocol.h.

Referenced by mlir::lsp::toJSON().

◆ paddingRight

bool mlir::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 1091 of file Protocol.h.

Referenced by shouldAddHintFor(), and mlir::lsp::toJSON().

◆ position

Position mlir::lsp::InlayHint::position

The position of this hint.

Definition at line 1067 of file Protocol.h.

Referenced by mlir::lsp::toJSON().


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