dialog_ui

Documentation

Index

• Constants
• type DialogUi
  • func NewDialogUi() *DialogUi
  • func (ui *DialogUi) GetFromInput(title, defaultInput, helpButtonLabel, extraButtonLabel string) (string, error)
  • func (ui *DialogUi) GetIpFromInput(title, helpButtonLabel, extraButtonLabel string) (string, error)
  • func (ui *DialogUi) GetPasswordFromInput(host, user, helpButtonLabel, extraButtonLabel string, confirm bool) (passwd1 string, err error)
  • func (ui *DialogUi) GetPathToDirFromInput(title, defaultDir, helpButtonLabel, extraButtonLabel string) (string, error)
  • func (ui *DialogUi) GetPathToFileFromInput(title, helpButtonLabel, extraButtonLabel string) (string, error)
  • func (ui *DialogUi) Output(ntype string, msgs ...string)
  • func (ui *DialogUi) Progress(title, pbMsg string, duration time.Duration, step int, done chan error) error
  • func (ui *DialogUi) Wait(msg string, pause, timeOut time.Duration, done chan error) error
• type Pb
  • func (p *Pb) DecreaseStep(s int)
  • func (p *Pb) IncreaseSleep(s string) error
  • func (p *Pb) IncreaseStep(s int)
  • func (p *Pb) SetSleep(s string) (err error)
  • func (p *Pb) SetStep(s int)
  • func (p *Pb) Sleep() time.Duration
  • func (p *Pb) Step() int

Constants

const (
	DialogExit     = "exit status 1"
	DialogMoveBack = "exit status 2"
	DialogNext     = "exit status 3"
)

const (
	Success      = "Success"
	Error        = "Failure"
	Warning      = "Warning"
	Notification = "Notification"
	None         = ""
)

Types

type DialogUi

type DialogUi struct {
	*Dialog
	Pb *Pb
}

func NewDialogUi

func NewDialogUi() *DialogUi

func (*DialogUi) GetFromInput

func (ui *DialogUi) GetFromInput(title, defaultInput, helpButtonLabel, extraButtonLabel string) (string, error)

GetFromInput uses a dialog session for reading from stdin Returns user input

func (*DialogUi) GetIpFromInput

func (ui *DialogUi) GetIpFromInput(title, helpButtonLabel, extraButtonLabel string) (string, error)

GetIpFromInput uses a dialog session for reading IP from user input Returns host IP (remote or local)

func (*DialogUi) GetPasswordFromInput

func (ui *DialogUi) GetPasswordFromInput(host, user, helpButtonLabel, extraButtonLabel string, confirm bool) (passwd1 string, err error)

GetPasswordFromInput uses a dialog session for reading user password from user input Returns password string

func (*DialogUi) GetPathToDirFromInput

func (ui *DialogUi) GetPathToDirFromInput(title, defaultDir, helpButtonLabel, extraButtonLabel string) (string, error)

GetPathToDirFromInput uses a dialog session for getting path to a directory to upload

func (*DialogUi) GetPathToFileFromInput

func (ui *DialogUi) GetPathToFileFromInput(title, helpButtonLabel, extraButtonLabel string) (string, error)

GetPathToFileFromInput uses a dialog session for getting path to a file

func (*DialogUi) Output

func (ui *DialogUi) Output(ntype string, msgs ...string)

Output gets dialog session , height/width and slice of strings Prints out appropriate message

func (*DialogUi) Progress

func (ui *DialogUi) Progress(title, pbMsg string, duration time.Duration, step int, done chan error) error

Progress implements a progress bar Returns error or nil

func (*DialogUi) Wait

func (ui *DialogUi) Wait(msg string, pause, timeOut time.Duration, done chan error) error

Wait communicates with a progress bar while a given function is executed Returns error or nil

type Pb

type Pb struct {
	// contains filtered or unexported fields
}

func (*Pb) DecreaseStep

func (p *Pb) DecreaseStep(s int)

func (*Pb) IncreaseSleep

func (p *Pb) IncreaseSleep(s string) error

func (*Pb) IncreaseStep

func (p *Pb) IncreaseStep(s int)

func (*Pb) SetSleep

func (p *Pb) SetSleep(s string) (err error)

func (*Pb) SetStep

func (p *Pb) SetStep(s int)

func (*Pb) Sleep

func (p *Pb) Sleep() time.Duration

func (*Pb) Step

func (p *Pb) Step() int