IGLib
1.7.2
The IGLib base library for development of numerical, technical and business applications.
|
Public Member Functions | |
IndicatorLight () | |
void | SetProperties () |
bool | SetOff () |
Sets indicator to off, returns true if successful and false if not (which can be vecause the indictor does not have this state). More... | |
bool | UnsetOff () |
Unsets the Off state, if set. Switches to a suitable other state available. More... | |
bool | SetOk () |
Sets indicator to OK, returns true if successful and false if not (which can be vecause the indictor does not have this state). More... | |
bool | UnsetOk () |
Unsets the OK state, if set. Switches to a suitable other state available. More... | |
bool | SetBusy () |
Sets indicator to Busy, returns true if successful and false if not (which can be vecause the indictor does not have this state). More... | |
bool | UnsetBusy () |
Unsets the Busy state, if set. Switches to a suitable other state available. More... | |
bool | SetError () |
Sets indicator to Error, returns true if successful and false if not (which can be vecause the indictor does not have this state). More... | |
bool | UnsetError () |
Unsets the Error state, if set. Switches to a suitable other state available. More... | |
void | Blink (int numTimes=2) |
Blninks indicator light in the currently active color for the specified number of times. More... | |
void | BlinkSpecial (Color blinkColor, int numTimes=2) |
Blinks the indicator link in chosen color, for a specified number of times. More... | |
void | BlinkOk (int numTimes=2) |
Blinks the indicator light in the color indicating teh OK state, for the specified numberr of times. This is done independently of the current active color of the indicator light. More... | |
void | BlinkBusy (int numTimes=2) |
Blinks the indicator light in the color indicating teh Busy state, for the specified numberr of times. This is done independently of the current active color of the indicator light. More... | |
void | BlinkError (int numTimes=2) |
Blinks the indicator light in the color indicating teh Error state, for the specified numberr of times. This is done independently of the current active color of the indicator light. More... | |
Protected Member Functions | |
void | ClearAll () |
Auxiliary, clears all flags withoud side effects. More... | |
bool | IsAny () |
Auxiliary, returns a flag indicating whether any mode is active. More... | |
void | SetFirstAvailable () |
Switch on the first available indicator light if none is currently switched on. More... | |
void | StartBlinking () |
Starts blinking the indicator light. More... | |
void | StopBlinking () |
Stops blinking the indicator light. More... | |
void | OnStateChanged () |
This method is executed when state changes. It fires the StateChanged event. More... | |
override void | Dispose (bool disposing) |
Clean up any resources being used. More... | |
Protected Attributes | |
bool | _isOff = true |
bool | _isOk = false |
bool | _isBusy = false |
bool | _isError = false |
int | _numRemainingSpecialBlinks = 0 |
Color | _specialBlinkColor = Color.Yellow |
Properties | |
Color | LightColor [get, set] |
Color | ActiveColor [get] |
Gets current active color for the light indicator. More... | |
bool | IsOff [get, protected set] |
Flag indicating whether the indicator is off. More... | |
bool | IsOk [get, protected set] |
Flag indicating whether the indicator state is OK. More... | |
bool | IsBusy [get, protected set] |
Flag indicating whether the indicator state is Busy. More... | |
bool | IsError [get, protected set] |
Flag indicating whether the indicator state is Busy. More... | |
int | NumRemainingBlinks [get, protected set] |
int | NumRemainingSpecialBlinks [get, protected set] |
Color | SpecialBlinkColor [get, protected set] |
bool | IsBlinkOn [get, set] |
Specifies, when the indicator light is blinking, whether the blinking color is currently on or it is off. This flag is toggled by the timer when blinking is on, and the consequence is that the light color changes. More... | |
bool | IsBlinking [get, set] |
Gets or sets the flag indicating whetherr the indicator light is continuously blinking in its active color. More... | |
int | BlinkIntervalMilliSeconds [get, set] |
bool | ThrowOnInvalidSwitch [get, set] |
Gets or sets a flag indicating whether exception is thrown when an invalid switch is attempted (i.e. one that is not available). More... | |
bool | HasOff [get, set] |
Gets or sets a flag indicating whether the indicator light has an Off state. More... | |
bool | HasOk [get, set] |
Gets or sets a flag indicating whether the indicator light has an OK state. More... | |
bool | HasBusy [get, set] |
Gets or sets a flag indicating whether the indicator light has a Busy state. More... | |
bool | HasError [get, set] |
Gets or sets a flag indicating whether the indicator light has an Error state. More... | |
FlowDirection | FlowDirection [get, set] |
Directional arrangemnt of the contained light (a pannel) and label within the containing outer flow layout panel. More... | |
string | LabelText [get, set] |
Text on the label besid the light (can be null). More... | |
Font | LabelFont [get, set] |
Color | ColorLabel [get, set] |
Color | ColorOff [get, protected set] |
Color | ColorOk [get, protected set] |
Color | ColorError [get, protected set] |
Color | ColorBusy [get, protected set] |
bool | BorderOut [get, set] |
Whether there is a border around control (more precisely, around its outer panel). More... | |
bool | BorderLabel [get, set] |
Whether label has a border. More... | |
int | MarginOut [get, set] |
Margin of teh outer panel. More... | |
int | PaddingOut [get, set] |
Padding of the outer panel. More... | |
int | MarginLabel [get, set] |
Margin of the label. More... | |
int | PaddingLabel [get, set] |
Padding of the label. More... | |
static int | DefaultBlinkIntervalMilliSeconds [get, set] |
static Color | DefaultColorLabel [get, protected set] |
static Color | DefaultColorOff [get, protected set] |
static Color | DefaultColorOk [get, protected set] |
static Color | DefaultColorError [get, protected set] |
static Color | DefaultColorBusy [get, protected set] |
static bool | DefaultBorderOut [get, set] |
static bool | DefaultBorderLabel [get, set] |
static int | DefaultMarginOut [get, set] |
static int | DefaultPaddingOut [get, set] |
static int | DefaultMarginLabel [get, set] |
static int | DefaultPaddingLabel [get, set] |
Events | |
EventHandler | StateChanged |
Event that is fired whenever the selected file changes. More... | |
Private Member Functions | |
void | timer1_Tick (object sender, EventArgs e) |
void | InitializeComponent () |
Required method for Designer support - do not modify the contents of this method with the code editor. More... | |
Static Private Attributes | |
static int | _defaultBlinkIntervalMilliseconds = 500 |
static Color | _defaultColorLabel = Color.Black |
static Color | _defaultColorLightOff = Color.DarkSlateGray |
static Color | _defaultColorLightOk = Color.LimeGreen |
static Color | _defaultColorLightBusy = Color.DarkRed |
static Color | _defaultColorLightError = Color.Red |
static bool | _defaultBorderOut = false |
static bool | _defaultBorderLabel = false |
static int | _defaultMarginOut = 2 |
static int | _defaultPaddingOut = 2 |
static int | _defaultMarginLabel = 2 |
static int | _defaultPaddingLabel = 2 |
|
inline |
|
inline |
|
inlineprotected |
Auxiliary, clears all flags withoud side effects.
|
inlineprotected |
Auxiliary, returns a flag indicating whether any mode is active.
|
inlineprotected |
Switch on the first available indicator light if none is currently switched on.
This helps ensure that at least one indicator is on when availability of different types of lights changes (and the indicator that was on becomes unavailable).
|
inline |
Sets indicator to off, returns true if successful and false if not (which can be vecause the indictor does not have this state).
|
inline |
Unsets the Off state, if set. Switches to a suitable other state available.
|
inline |
Sets indicator to OK, returns true if successful and false if not (which can be vecause the indictor does not have this state).
|
inline |
Unsets the OK state, if set. Switches to a suitable other state available.
|
inline |
Sets indicator to Busy, returns true if successful and false if not (which can be vecause the indictor does not have this state).
|
inline |
Unsets the Busy state, if set. Switches to a suitable other state available.
|
inline |
Sets indicator to Error, returns true if successful and false if not (which can be vecause the indictor does not have this state).
|
inline |
Unsets the Error state, if set. Switches to a suitable other state available.
|
inlineprotected |
Starts blinking the indicator light.
|
inlineprotected |
Stops blinking the indicator light.
|
inline |
Blninks indicator light in the currently active color for the specified number of times.
numTimes | The number of times indicator blinks, default is 2. |
|
inline |
Blinks the indicator link in chosen color, for a specified number of times.
blinkColor | Color in which light blinks. |
numTimes | Number of times the indictor blinks. Default is 2. |
|
inline |
Blinks the indicator light in the color indicating teh OK state, for the specified numberr of times. This is done independently of the current active color of the indicator light.
numTimes | Number of time the light blinks. Default is 2. |
|
inline |
Blinks the indicator light in the color indicating teh Busy state, for the specified numberr of times. This is done independently of the current active color of the indicator light.
numTimes | Number of time the light blinks. Default is 2. |
|
inline |
Blinks the indicator light in the color indicating teh Error state, for the specified numberr of times. This is done independently of the current active color of the indicator light.
numTimes | Number of time the light blinks. Default is 2. |
|
inlineprotected |
This method is executed when state changes. It fires the StateChanged event.
|
inlineprivate |
|
inlineprotected |
Clean up any resources being used.
disposing | true if managed resources should be disposed; otherwise, false. |
|
inlineprivate |
Required method for Designer support - do not modify the contents of this method with the code editor.
|
private |
|
protected |
|
protected |
|
protected |
|
protected |
|
private |
|
protected |
|
protected |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
private |
Required designer variable.
|
private |
|
private |
|
private |
|
private |
|
getsetprotected |
|
getprotected |
Gets current active color for the light indicator.
|
getprotected set |
Flag indicating whether the indicator is off.
|
getprotected set |
Flag indicating whether the indicator state is OK.
|
getprotected set |
Flag indicating whether the indicator state is Busy.
|
getprotected set |
Flag indicating whether the indicator state is Busy.
|
getprotected set |
|
getprotected set |
|
getprotected set |
|
getsetprotected |
Specifies, when the indicator light is blinking, whether the blinking color is currently on or it is off. This flag is toggled by the timer when blinking is on, and the consequence is that the light color changes.
|
getset |
Gets or sets the flag indicating whetherr the indicator light is continuously blinking in its active color.
|
getset |
|
getset |
Gets or sets a flag indicating whether exception is thrown when an invalid switch is attempted (i.e. one that is not available).
|
getset |
Gets or sets a flag indicating whether the indicator light has an Off state.
|
getset |
Gets or sets a flag indicating whether the indicator light has an OK state.
|
getset |
Gets or sets a flag indicating whether the indicator light has a Busy state.
|
getset |
Gets or sets a flag indicating whether the indicator light has an Error state.
|
getset |
Directional arrangemnt of the contained light (a pannel) and label within the containing outer flow layout panel.
|
getset |
Text on the label besid the light (can be null).
|
getset |
|
getset |
|
getprotected set |
|
getprotected set |
|
getprotected set |
|
getprotected set |
|
getset |
Whether there is a border around control (more precisely, around its outer panel).
|
getset |
Whether label has a border.
|
getset |
Margin of teh outer panel.
|
getset |
Padding of the outer panel.
|
getset |
Margin of the label.
|
getset |
Padding of the label.
|
staticgetset |
|
staticgetprotected set |
|
staticgetprotected set |
|
staticgetprotected set |
|
staticgetprotected set |
|
staticgetprotected set |
|
staticgetset |
|
staticgetset |
|
staticgetset |
|
staticgetset |
|
staticgetset |
|
staticgetset |
EventHandler IG.Forms.IndicatorLight.StateChanged |
Event that is fired whenever the selected file changes.