Represents options to configure the behavior of showing a {@link TextDocument document} in an {@link TextEditor editor}.
Represents options to configure the behavior of showing a {@link TextDocument document} in an {@link TextEditor editor}.
(preserve-focus? text-document-show-options)
An optional flag that when true
will stop the {@link TextEditor editor} from taking focus.
Returns: boolean | undefined
An optional flag that when `true` will stop the {@link TextEditor editor} from taking focus. **Returns:** `boolean | undefined`
(preview? text-document-show-options)
An optional flag that controls if an {@link TextEditor editor}-tab shows as preview. Preview tabs will be replaced and reused until set to stay - either explicitly or through editing.
Note that the flag is ignored if a user has disabled preview editors in settings.
Returns: boolean | undefined
An optional flag that controls if an {@link TextEditor editor}-tab shows as preview. Preview tabs will be replaced and reused until set to stay - either explicitly or through editing. *Note* that the flag is ignored if a user has disabled preview editors in settings. **Returns:** `boolean | undefined`
(selection text-document-show-options)
An optional selection to apply for the document in the {@link TextEditor editor}.
Returns: Range | undefined
An optional selection to apply for the document in the {@link TextEditor editor}. **Returns:** `Range | undefined`
(set-preserve-focus! text-document-show-options value)
An optional flag that when true
will stop the {@link TextEditor editor} from taking focus.
An optional flag that when `true` will stop the {@link TextEditor editor} from taking focus.
(set-preview! text-document-show-options value)
An optional flag that controls if an {@link TextEditor editor}-tab shows as preview. Preview tabs will be replaced and reused until set to stay - either explicitly or through editing.
Note that the flag is ignored if a user has disabled preview editors in settings.
An optional flag that controls if an {@link TextEditor editor}-tab shows as preview. Preview tabs will be replaced and reused until set to stay - either explicitly or through editing. *Note* that the flag is ignored if a user has disabled preview editors in settings.
(set-selection! text-document-show-options value)
An optional selection to apply for the document in the {@link TextEditor editor}.
An optional selection to apply for the document in the {@link TextEditor editor}.
(set-view-column! text-document-show-options value)
An optional view column in which the {@link TextEditor editor} should be shown. The default is the {@link ViewColumn.Active active}. Columns that do not exist will be created as needed up to the maximum of {@linkcode ViewColumn.Nine }. Use {@linkcode ViewColumn.Beside } to open the editor to the side of the currently active one.
An optional view column in which the {@link TextEditor editor} should be shown. The default is the {@link ViewColumn.Active active}. Columns that do not exist will be created as needed up to the maximum of {@linkcode ViewColumn.Nine }. Use {@linkcode ViewColumn.Beside } to open the editor to the side of the currently active one.
(view-column text-document-show-options)
An optional view column in which the {@link TextEditor editor} should be shown. The default is the {@link ViewColumn.Active active}. Columns that do not exist will be created as needed up to the maximum of {@linkcode ViewColumn.Nine }. Use {@linkcode ViewColumn.Beside } to open the editor to the side of the currently active one.
Returns: ViewColumn | undefined
An optional view column in which the {@link TextEditor editor} should be shown. The default is the {@link ViewColumn.Active active}. Columns that do not exist will be created as needed up to the maximum of {@linkcode ViewColumn.Nine }. Use {@linkcode ViewColumn.Beside } to open the editor to the side of the currently active one. **Returns:** `ViewColumn | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close