Class ScmInputBoxImpl

constructor

• new ScmInputBoxImpl(
      plugin: Plugin,
      proxy: ScmMain,
      sourceControlHandle: number,
  ): ScmInputBoxImpl

  Parameters

  • plugin: Plugin
  • proxy: ScmMain
  • sourceControlHandle: number

  Returns ScmInputBoxImpl

apiObject

enabled

• get enabled(): boolean

  Controls whether the input box is enabled (default is true).

  Returns boolean

• set enabled(enabled: boolean): void

  Controls whether the input box is enabled (default is true).

  Parameters

  • enabled: boolean

  Returns void

onDidChange

• get onDidChange(): Event<string>

  Returns Event<string>

placeholder

• get placeholder(): string

  A string to show as place holder in the input box to guide the user.

  Returns string

• set placeholder(placeholder: string): void

  A string to show as place holder in the input box to guide the user.

  Parameters

  • placeholder: string

  Returns void

validateInput

• get validateInput(): undefined | ValidateInput

  A validation function for the input box. It's possible to change the validation provider simply by setting this property to a different function.

  Returns undefined | ValidateInput

• set validateInput(fn: undefined | ValidateInput): void

  A validation function for the input box. It's possible to change the validation provider simply by setting this property to a different function.

  Parameters

  • fn: undefined | ValidateInput

  Returns void

value

• get value(): string

  Setter and getter for the contents of the input box.

  Returns string

• set value(value: string): void

  Setter and getter for the contents of the input box.

  Parameters

  • value: string

  Returns void

visible

• get visible(): boolean

  Controls whether the input box is visible (default is true).

  Returns boolean

• set visible(visible: boolean): void

  Controls whether the input box is visible (default is true).

  Parameters

  • visible: boolean

  Returns void

onInputBoxValueChange

• onInputBoxValueChange(value: string): void

  Parameters

  • value: string

  Returns void