gen_lsp v0.8.1

View Source GenLSP.Structures.ShowDocumentParams (gen_lsp v0.8.1)

Params to show a document.

@since 3.16.0

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.ShowDocumentParams{}

Fields

  • uri: The document uri to show.
  • external: Indicates to show the resource in an external program. To show for example https://code.visualstudio.com/ in the default WEB browser set external to true.
  • take_focus: 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.
  • 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.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.ShowDocumentParams{
  external: boolean() | nil,
  selection: GenLSP.Structures.Range.t() | nil,
  take_focus: boolean() | nil,
  uri: GenLSP.BaseTypes.uri()
}

Link to this section Functions

Link to this function

%GenLSP.Structures.ShowDocumentParams{}

View Source (struct)

fields

 Fields

  • uri: The document uri to show.
  • external: Indicates to show the resource in an external program. To show for example https://code.visualstudio.com/ in the default WEB browser set external to true.
  • take_focus: 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.
  • 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.