Advanced Software Engineering
Advanced_Software_Engineering.ErrorWindow Class Reference

The error window that can show errors, warnings and messages. More...

Inheritance diagram for Advanced_Software_Engineering.ErrorWindow:

Public Member Functions

 ErrorWindow ()
 The default error window constructor. Creates an error window with the title "Error", short description "An error has occured", a long description of "None" and message type of ERROR. More...
 
 ErrorWindow (string title, string brief, string desc, int type)
 The error window constructor. It is responsible for creating an error form which shows the user information depending on the parameters. More...
 
void SetPicture (int type)
 Sets the picture of the window. More...
 

Static Public Attributes

const int ERROR_MESSAGE = 0
 The error message type. More...
 
const int WARNING_MESSAGE = 1
 The warning message type More...
 
const int INFO_MESSAGE = 2
 The info message type More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Protected Attributes

Dictionary< int, Image > IMAGEDIR
 The image directory which links the message types to the image to display. More...
 

Detailed Description

The error window that can show errors, warnings and messages.

Constructor & Destructor Documentation

◆ ErrorWindow() [1/2]

Advanced_Software_Engineering.ErrorWindow.ErrorWindow ( )

The default error window constructor. Creates an error window with the title "Error", short description "An error has occured", a long description of "None" and message type of ERROR.

◆ ErrorWindow() [2/2]

Advanced_Software_Engineering.ErrorWindow.ErrorWindow ( string  title,
string  brief,
string  desc,
int  type 
)

The error window constructor. It is responsible for creating an error form which shows the user information depending on the parameters.

Parameters
titleTitle of the window
briefA brief description of the message
descA detailed description of the message
typeThe type of message (can either be: ERROR_MESSAGE, WARNING_MESSAGE or INFO_MESSAGE

Member Function Documentation

◆ Dispose()

override void Advanced_Software_Engineering.ErrorWindow.Dispose ( bool  disposing)
protected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

◆ SetPicture()

void Advanced_Software_Engineering.ErrorWindow.SetPicture ( int  type)

Sets the picture of the window.

Parameters
typeThe type of message (can either be: ERROR_MESSAGE, WARNING_MESSAGE or INFO_MESSAGE

Member Data Documentation

◆ ERROR_MESSAGE

const int Advanced_Software_Engineering.ErrorWindow.ERROR_MESSAGE = 0
static

The error message type.

◆ IMAGEDIR

Dictionary<int, Image> Advanced_Software_Engineering.ErrorWindow.IMAGEDIR
protected
Initial value:
= new Dictionary<int, Image> {
{ ERROR_MESSAGE, Properties.Resources.error },
{ WARNING_MESSAGE, Properties.Resources.warning },
{ INFO_MESSAGE, Properties.Resources.info }
}

The image directory which links the message types to the image to display.

◆ INFO_MESSAGE

const int Advanced_Software_Engineering.ErrorWindow.INFO_MESSAGE = 2
static

The info message type

◆ WARNING_MESSAGE

const int Advanced_Software_Engineering.ErrorWindow.WARNING_MESSAGE = 1
static

The warning message type


The documentation for this class was generated from the following files:
Advanced_Software_Engineering.ErrorWindow.INFO_MESSAGE
const int INFO_MESSAGE
The info message type
Definition: ErrorWindow.cs:27
Advanced_Software_Engineering.ErrorWindow.WARNING_MESSAGE
const int WARNING_MESSAGE
The warning message type
Definition: ErrorWindow.cs:22
Advanced_Software_Engineering.ErrorWindow.ERROR_MESSAGE
const int ERROR_MESSAGE
The error message type.
Definition: ErrorWindow.cs:17