gui

Documentation

Index

• func New(p params.Params, tcr engine.TcrInterface) ui.UserInterface
• type ActionBar
  • func NewActionBar() ActionBar
• type ActionBarButtonPanel
  • func NewMobActionBarButtonPanel() ActionBarButtonPanel
  • func NewSoloActionBarButtonPanel() ActionBarButtonPanel
• type BaseDirSelectionDialog
  • func NewBaseDirSelectionDialog(cbAction func(baseDir string), parent fyne.Window) BaseDirSelectionDialog
• type DeferredConfirmDialog
  • func NewDeferredConfirmDialog(message string, defaultSelected bool, cbAction func(info string), ...) DeferredConfirmDialog
• type GUI
  • func (gui *GUI) BuildMainMenu()
  • func (gui *GUI) Confirm(message string, def bool) bool
  • func (gui *GUI) MuteDesktopNotifications(muted bool)
  • func (gui *GUI) NewAboutDialog() dialog.Dialog
  • func (gui *GUI) NewSessionPanel() *SessionPanel
  • func (gui *GUI) NotifyRoleEnding(r role.Role)
  • func (gui *GUI) NotifyRoleStarting(r role.Role)
  • func (gui *GUI) ReportError(emphasis bool, a ...interface{})
  • func (gui *GUI) ReportInfo(_ bool, a ...interface{})
  • func (gui *GUI) ReportSimple(_ bool, a ...interface{})
  • func (gui *GUI) ReportSuccess(emphasis bool, a ...interface{})
  • func (gui *GUI) ReportTimer(emphasis bool, a ...interface{})
  • func (gui *GUI) ReportTitle(_ bool, a ...interface{})
  • func (gui *GUI) ReportWarning(emphasis bool, a ...interface{})
  • func (gui *GUI) ShowRunningMode(mode runmode.RunMode)
  • func (gui *GUI) ShowSessionInfo()
  • func (gui *GUI) Start()
  • func (gui *GUI) StartReporting()
  • func (gui *GUI) StopReporting()
• type MobActionBarButtonPanel
• type SessionPanel
• type SoloActionBarButtonPanel
• type TraceArea
  • func NewTraceArea() *TraceArea

Functions

func New

func New(p params.Params, tcr engine.TcrInterface) ui.UserInterface

New creates a new instance of graphical user interface

Types

type ActionBar

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

ActionBar is the area containing the buttons that the user can use to start/stop TCR engine. The content of the action bar can change depending on the current run mode

func NewActionBar

func NewActionBar() ActionBar

NewActionBar creates an action bar panel containing the action buttons

type ActionBarButtonPanel

type ActionBarButtonPanel interface {
	// contains filtered or unexported methods
}

ActionBarButtonPanel provides the interface that any action bar button panel must implement so that it can be used inside the action bar

func NewMobActionBarButtonPanel

func NewMobActionBarButtonPanel() ActionBarButtonPanel

NewMobActionBarButtonPanel creates the action bar panel containing the buttons when running in mob

func NewSoloActionBarButtonPanel

func NewSoloActionBarButtonPanel() ActionBarButtonPanel

NewSoloActionBarButtonPanel creates the action bar panel containing the buttons when running in solo

type BaseDirSelectionDialog

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

BaseDirSelectionDialog allows selecting base directory. The dialog shows only when there is no valid directory defined at startup

func NewBaseDirSelectionDialog

func NewBaseDirSelectionDialog(cbAction func(baseDir string), parent fyne.Window) BaseDirSelectionDialog

NewBaseDirSelectionDialog crates an instance of base dir selection dialog

type DeferredConfirmDialog

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

DeferredConfirmDialog is a customized ConfirmDialog for which display is deferred until the application main window is displayed on the screen. It also adds the possibility to indicate the button to be selected by default in the dialog window

func NewDeferredConfirmDialog

func NewDeferredConfirmDialog(
	message string,
	defaultSelected bool,
	cbAction func(info string),
	parent fyne.Window) DeferredConfirmDialog

NewDeferredConfirmDialog creates a new instance of deferred confirmation dialog

type GUI

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

GUI is the user interface implementation when using the TCR with its graphical user interface

func (*GUI) BuildMainMenu

func (gui *GUI) BuildMainMenu()

BuildMainMenu creates the application's main menu

func (*GUI) Confirm

func (gui *GUI) Confirm(message string, def bool) bool

Confirm asks the user for confirmation through a popup confirmation window

func (*GUI) MuteDesktopNotifications

func (gui *GUI) MuteDesktopNotifications(muted bool)

MuteDesktopNotifications allows preventing desktop Notification popups from being displayed. Used for test automation at the moment. Could be turned into a feature later if there is need for it.

func (*GUI) NewAboutDialog

func (gui *GUI) NewAboutDialog() dialog.Dialog

NewAboutDialog creates a dialog window with "About TCR" contents

func (*GUI) NewSessionPanel

func (gui *GUI) NewSessionPanel() *SessionPanel

NewSessionPanel creates a new instance of session information panel

func (*GUI) NotifyRoleEnding

func (gui *GUI) NotifyRoleEnding(r role.Role)

NotifyRoleEnding tells the user that TCR gui.tcr is ending the provided role

func (*GUI) NotifyRoleStarting

func (gui *GUI) NotifyRoleStarting(r role.Role)

NotifyRoleStarting tells the user that TCR engine is starting with the provided role

func (*GUI) ReportError

func (gui *GUI) ReportError(emphasis bool, a ...interface{})

ReportError reports error messages

func (*GUI) ReportInfo

func (gui *GUI) ReportInfo(_ bool, a ...interface{})

ReportInfo reports info messages

func (*GUI) ReportSimple

func (gui *GUI) ReportSimple(_ bool, a ...interface{})

ReportSimple reports simple messages

func (*GUI) ReportSuccess

func (gui *GUI) ReportSuccess(emphasis bool, a ...interface{})

ReportSuccess reports success messages

func (*GUI) ReportTimer

func (gui *GUI) ReportTimer(emphasis bool, a ...interface{})

ReportTimer reports timer messages

func (*GUI) ReportTitle

func (gui *GUI) ReportTitle(_ bool, a ...interface{})

ReportTitle reports title messages

func (*GUI) ReportWarning

func (gui *GUI) ReportWarning(emphasis bool, a ...interface{})

ReportWarning reports warning messages

func (*GUI) ShowRunningMode

func (gui *GUI) ShowRunningMode(mode runmode.RunMode)

ShowRunningMode shows the current running mode

func (*GUI) ShowSessionInfo

func (gui *GUI) ShowSessionInfo()

ShowSessionInfo shows main information related to the current TCR session

func (*GUI) Start

func (gui *GUI) Start()

Start runs the GUI session

func (*GUI) StartReporting

func (gui *GUI) StartReporting()

StartReporting tells the GUI to start reporting information

func (*GUI) StopReporting

func (gui *GUI) StopReporting()

StopReporting tells the GUI to stop reporting information

type MobActionBarButtonPanel

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

MobActionBarButtonPanel is the action bar panel containing the buttons when running in mob

type SessionPanel

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

SessionPanel is the panel showing all information related to the current TCR session

type SoloActionBarButtonPanel

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

SoloActionBarButtonPanel is the action bar panel containing the buttons when running in solo

type TraceArea

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

TraceArea is the area of the GUI in charge of printing traces

func NewTraceArea

func NewTraceArea() *TraceArea

NewTraceArea initializes the trace area widget