C# Class Bari.Core.UI.IUserOutputContracts

Inheritance: IUserOutput
Show file Open project: vigoo/bari

Public Methods

Method Description
Describe ( string target, string description ) : void

Describe an item with a description for the user.
Error ( string message ) : void

Shows an error message
Indent ( ) : void
Message ( string message ) : void

Outputs a message to the user. The message can be single or multiline.

The following formatting options must be supported: *Emphasis* `command line or code example` =Heading=

Unindent ( ) : void
Warning ( string message, string hints = null ) : void

Shows a warning message

Method Details

Describe() public method

Describe an item with a description for the user.
public Describe ( string target, string description ) : void
target string The concept to describe
description string The description
return void

Error() public method

Shows an error message
public Error ( string message ) : void
message string Error message
return void

Indent() public abstract method

public abstract Indent ( ) : void
return void

Message() public method

Outputs a message to the user. The message can be single or multiline.

The following formatting options must be supported: *Emphasis* `command line or code example` =Heading=

public Message ( string message ) : void
message string The message to be shown
return void

Unindent() public abstract method

public abstract Unindent ( ) : void
return void

Warning() public method

Shows a warning message
public Warning ( string message, string hints = null ) : void
message string The message to be shown
hints string Optional hints about the warning
return void