SimpleControls.DoingStuff Class Reference

The DoingStuff control, which very simply shows a small, rotating throbber. More...

List of all members.

Public Member Functions
	DoingStuff ()
	Constructor for the DoingStuff control, as required by the Designer.
void	Begin ()
	Show the control and start the animation.
void	End ()
	Hide the control and stop the animation.
Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used.
Properties
[TypeConverter(typeof(PleaseWait)), Category("Appearance"), Description("Wether or not you wish the animation to be enabled")] bool	DoStuff [get, set]
	Wether or not you wish the animation to be enabled. Defaults to false, meaning no animation.
Private Member Functions
void	timAnimator_Tick (object sender, EventArgs e)
	Fired by the timer, which animates the control. This is set to 50ms, which ensures a smooth animation.
void	InitializeComponent ()
	Required method for Designer support - do not modify the contents of this method with the code editor.
Private Attributes
int	position = 0
	Remembers the current position of the animation, from 0 to 15.
System.ComponentModel.IContainer	components = null
	Required designer variable.
System.Windows.Forms.PictureBox	picAnim
System.Windows.Forms.Timer	timAnimator

---

Detailed Description

The DoingStuff control, which very simply shows a small, rotating throbber.

Definition at line 14 of file DoingStuff.cs.

---

Constructor & Destructor Documentation

SimpleControls.DoingStuff.DoingStuff

(

)

Constructor for the DoingStuff control, as required by the Designer.

Definition at line 22 of file DoingStuff.cs.

References SimpleControls.DoingStuff.InitializeComponent().

Here is the call graph for this function:

---

Member Function Documentation

void SimpleControls.DoingStuff.Begin

(

)

Show the control and start the animation.

Definition at line 44 of file DoingStuff.cs.

References SimpleControls.DoingStuff.timAnimator.

Referenced by SimpleControls.PleaseWait.Begin().

Here is the caller graph for this function:

void SimpleControls.DoingStuff.End

(

)

Hide the control and stop the animation.

Definition at line 53 of file DoingStuff.cs.

References SimpleControls.DoingStuff.timAnimator.

Referenced by SimpleControls.PleaseWait.End().

Here is the caller graph for this function:

void SimpleControls.DoingStuff.timAnimator_Tick	(	object	sender,
		EventArgs	e
	)			[private]

Fired by the timer, which animates the control. This is set to 50ms, which ensures a smooth animation.

Parameters:

	sender	Who is sending the event?
	e	What type of event is this?

Definition at line 64 of file DoingStuff.cs.

References SimpleControls.DoingStuff.picAnim, and SimpleControls.DoingStuff.position.

Referenced by SimpleControls.DoingStuff.InitializeComponent().

Here is the caller graph for this function:

override void SimpleControls.DoingStuff.Dispose

(

bool

disposing

)

[protected]

Clean up any resources being used.

Parameters:

disposing

true if managed resources should be disposed; otherwise, false.

Definition at line 14 of file DoingStuff.Designer.cs.

References SimpleControls.DoingStuff.components.

void SimpleControls.DoingStuff.InitializeComponent

(

)

[private]

Required method for Designer support - do not modify the contents of this method with the code editor.

Definition at line 29 of file DoingStuff.Designer.cs.

References SimpleControls.DoingStuff.components, SimpleControls.DoingStuff.picAnim, and SimpleControls.DoingStuff.timAnimator_Tick().

Referenced by SimpleControls.DoingStuff.DoingStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

int SimpleControls.DoingStuff.position = 0 [private]

Remembers the current position of the animation, from 0 to 15.

Definition at line 17 of file DoingStuff.cs.

Referenced by SimpleControls.DoingStuff.timAnimator_Tick().

System.ComponentModel.IContainer SimpleControls.DoingStuff.components = null [private]

Required designer variable.

Definition at line 8 of file DoingStuff.Designer.cs.

Referenced by SimpleControls.DoingStuff.Dispose(), and SimpleControls.DoingStuff.InitializeComponent().

---

Property Documentation

[ TypeConverter(typeof(PleaseWait)), Category("Appearance"), Description("Wether or not you wish the animation to be enabled") ] bool SimpleControls.DoingStuff.DoStuff [get, set]

Wether or not you wish the animation to be enabled. Defaults to false, meaning no animation.

Definition at line 36 of file DoingStuff.cs.

---

The documentation for this class was generated from the following files:

• SimpleControls/DoingStuff.cs
• SimpleControls/DoingStuff.Designer.cs

---