Private
Public Access
142 lines
3.9 KiB
Plaintext
142 lines
3.9 KiB
Plaintext
.TH "Advanced_Software_Engineering.ErrorWindow" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
Advanced_Software_Engineering.ErrorWindow \- The error window that can show errors, warnings and messages\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
Inherits Form\&.
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBErrorWindow\fP ()"
|
|
.br
|
|
.RI "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\&. "
|
|
.ti -1c
|
|
.RI "\fBErrorWindow\fP (string title, string brief, string desc, int type)"
|
|
.br
|
|
.RI "The error window constructor\&. It is responsible for creating an error form which shows the user information depending on the parameters\&. "
|
|
.ti -1c
|
|
.RI "void \fBSetPicture\fP (int type)"
|
|
.br
|
|
.RI "Sets the picture of the window\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "const int \fBERROR_MESSAGE\fP = 0"
|
|
.br
|
|
.RI "The error message type\&. "
|
|
.ti -1c
|
|
.RI "const int \fBWARNING_MESSAGE\fP = 1"
|
|
.br
|
|
.RI "The warning message type "
|
|
.ti -1c
|
|
.RI "const int \fBINFO_MESSAGE\fP = 2"
|
|
.br
|
|
.RI "The info message type "
|
|
.in -1c
|
|
.SS "Protected Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "override void \fBDispose\fP (bool disposing)"
|
|
.br
|
|
.RI "Clean up any resources being used\&. "
|
|
.in -1c
|
|
.SS "Protected Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "Dictionary< int, Image > \fBIMAGEDIR\fP"
|
|
.br
|
|
.RI "The image directory which links the message types to the image to display\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
The error window that can show errors, warnings and messages\&.
|
|
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "Advanced_Software_Engineering\&.ErrorWindow\&.ErrorWindow ()"
|
|
|
|
.PP
|
|
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\&.
|
|
.SS "Advanced_Software_Engineering\&.ErrorWindow\&.ErrorWindow (string title, string brief, string desc, int type)"
|
|
|
|
.PP
|
|
The error window constructor\&. It is responsible for creating an error form which shows the user information depending on the parameters\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fItitle\fP Title of the window
|
|
.br
|
|
\fIbrief\fP A brief description of the message
|
|
.br
|
|
\fIdesc\fP A detailed description of the message
|
|
.br
|
|
\fItype\fP The type of message (can either be: ERROR_MESSAGE, WARNING_MESSAGE or INFO_MESSAGE
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "override void Advanced_Software_Engineering\&.ErrorWindow\&.Dispose (bool disposing)\fC [protected]\fP"
|
|
|
|
.PP
|
|
Clean up any resources being used\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "void Advanced_Software_Engineering\&.ErrorWindow\&.SetPicture (int type)"
|
|
|
|
.PP
|
|
Sets the picture of the window\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fItype\fP The type of message (can either be: ERROR_MESSAGE, WARNING_MESSAGE or INFO_MESSAGE
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "const int Advanced_Software_Engineering\&.ErrorWindow\&.ERROR_MESSAGE = 0\fC [static]\fP"
|
|
|
|
.PP
|
|
The error message type\&.
|
|
.SS "Dictionary<int, Image> Advanced_Software_Engineering\&.ErrorWindow\&.IMAGEDIR\fC [protected]\fP"
|
|
\fBInitial value:\fP
|
|
.PP
|
|
.nf
|
|
= new Dictionary<int, Image> {
|
|
{ ERROR_MESSAGE, Properties\&.Resources\&.error },
|
|
{ WARNING_MESSAGE, Properties\&.Resources\&.warning },
|
|
{ INFO_MESSAGE, Properties\&.Resources\&.info }
|
|
}
|
|
.fi
|
|
.PP
|
|
The image directory which links the message types to the image to display\&.
|
|
.SS "const int Advanced_Software_Engineering\&.ErrorWindow\&.INFO_MESSAGE = 2\fC [static]\fP"
|
|
|
|
.PP
|
|
The info message type
|
|
.SS "const int Advanced_Software_Engineering\&.ErrorWindow\&.WARNING_MESSAGE = 1\fC [static]\fP"
|
|
|
|
.PP
|
|
The warning message type
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
|