gen_lsp v0.8.1

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

Additional information about the context in which a signature help request was triggered.

@since 3.15.0

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.SignatureHelpContext{}

Fields

  • trigger_kind: Action that caused signature help to be triggered.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.SignatureHelpContext{
  active_signature_help: GenLSP.Structures.SignatureHelp.t() | nil,
  is_retrigger: boolean(),
  trigger_character: String.t() | nil,
  trigger_kind: GenLSP.Enumerations.SignatureHelpTriggerKind.t()
}

Link to this section Functions

Link to this function

%GenLSP.Structures.SignatureHelpContext{}

View Source (struct)

fields

 Fields

  • trigger_kind: Action that caused signature help to be triggered.

  • trigger_character: Character that caused signature help to be triggered.

    This is undefined when triggerKind !== SignatureHelpTriggerKind.TriggerCharacter

  • is_retrigger: true if signature help was already showing when it was triggered.

    Retriggers occurs when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

  • active_signature_help: The currently active SignatureHelp.

    The activeSignatureHelp has its SignatureHelp.activeSignature field updated based on the user navigating through available signatures.