lspserver::ShowDocumentParams Struct Reference

#include <Protocol.h>

Collaboration diagram for lspserver::ShowDocumentParams:

Public Attributes
URIForFile	uri
	The document URI to show (for file:// URIs).
std::optional< std::string >	externalUri
std::optional< bool >	external
std::optional< bool >	takeFocus
std::optional< Range >	selection

Detailed Description

Parameters for the window/showDocument request.

Since

LSP 3.16.0

Definition at line 1245 of file lspserver/include/lspserver/Protocol.h.

Member Data Documentation

external

std::optional<bool> lspserver::ShowDocumentParams::external

Indicates to show the resource in an external program. To show, for example, https://noogle.dev/ in the default web browser, set external to true.

Definition at line 1256 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::toJSON().

externalUri

std::optional<std::string> lspserver::ShowDocumentParams::externalUri

External URI string (for https:// or other non-file URIs). When set, this takes precedence over uri in serialization.

Definition at line 1251 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::toJSON().

selection

std::optional<Range> lspserver::ShowDocumentParams::selection

An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

Definition at line 1266 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::toJSON().

takeFocus

std::optional<bool> lspserver::ShowDocumentParams::takeFocus

An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

Definition at line 1261 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::toJSON().

uri

URIForFile lspserver::ShowDocumentParams::uri

The document URI to show (for file:// URIs).

Definition at line 1247 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::toJSON().

---

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

• lspserver/include/lspserver/Protocol.h