Skip to content

PARAMETERS_MODEL.md

Latest commit

 

History

History
62 lines (46 loc) · 1.71 KB

PARAMETERS_MODEL.md

File metadata and controls

62 lines (46 loc) · 1.71 KB

YAML to describe the parameters accepted by the plugin

A YAML model can be used to describe the parameters provided by the plugin.

This model might be used to create a GUI/TUI. The parameters will be passed to the application using the IDs in the model.

Fields "ID", "label" and "type" are always mandatory.

Sample model:

parameters_model:
    - ID: label_1 # identifier of the label
      type: Label
      label: "This is just text"
    
    - ID: host_name # contains text
      label: "Host IP:" 
      type: LineEdit
      default_value: "127.0.0.1"                  # Optional
      description: "ID address must be numerical" # Optional
      regexp_validation: "[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}" # Optional

    - ID: port_number
      label: "Port number:" 
      type: SpinBoxInt
      description: "Port number" # Optional
      default_value: 1888        # Optional
      range: [0, 9999]           # Optional: vector with min/max pair

    - ID: real_value
      label: "Multiplier:" 
      type: SpinBoxDouble
      description: "Multiplier value" # Optional
      default_value: 3.14             # Optional
      range: [0, 10]                  # Optional: vector with min/max pair

    - ID: debug_mode
      type: CheckBox
      default_value: true  # Optional. False if missing
      description: "Enable debug mode" # Optional

    - ID: more_options
      type: ComboBox
      values: "YES;NO;ASK"        # Mandatory: must be semicolon separated
      default_value: "ASK"        # Optional
      description: "Autoconfirm?" # Optional

Example values passed to configure the plugin.

host_name: "127.0.0.1"
port_number: 1888
real_value: 3.14
debug_mode: true
more_options: "ASK"