MockPlugin.Tasks.FrappuccinoCompositionEditor Class Reference

Provides an editor for the BrewFrappuccino-Task's "Composition" information. More...

Inheritance diagram for MockPlugin.Tasks.FrappuccinoCompositionEditor:

Collaboration diagram for MockPlugin.Tasks.FrappuccinoCompositionEditor:

Public Member Functions
	FrappuccinoCompositionEditor ()
	FrappuccinoCompositionEditor (BrewFrappuccino.CompositionData theData)
	Initialize from a given composition object.

Private Member Functions
void	CopyDataToGui ()
	Let the GUI reflect our data.
void	FrappuccinoCompositionEditor_Shown (object sender, EventArgs e)
	If we set the controls' values from the constructor, sometimes they don't get updated properly.
void	CopyGuItoData ()
	When the user clicked on OK, we want to push the state represented by the GUI into our composition object.
void	btnOK_Click (object sender, EventArgs e)
	Update our data object.

Private Attributes
readonly BrewFrappuccino.CompositionData	mData

Detailed Description

Provides an editor for the BrewFrappuccino-Task's "Composition" information.

Definition at line 9 of file FrappuccinoCompositionEditor.cs.

Constructor & Destructor Documentation

FrappuccinoCompositionEditor() [1/2]

MockPlugin.Tasks.FrappuccinoCompositionEditor.FrappuccinoCompositionEditor

(

)

Definition at line 11 of file FrappuccinoCompositionEditor.cs.

        {
            InitializeComponent();
        }

FrappuccinoCompositionEditor() [2/2]

MockPlugin.Tasks.FrappuccinoCompositionEditor.FrappuccinoCompositionEditor

(

BrewFrappuccino::CompositionData

theData

)

Initialize from a given composition object.

Parameters

theData

Definition at line 19 of file FrappuccinoCompositionEditor.cs.

        {
            InitializeComponent();
            mData = theData;
        }

References MockPlugin.Tasks.FrappuccinoCompositionEditor.mData.

Member Function Documentation

btnOK_Click()

void MockPlugin.Tasks.FrappuccinoCompositionEditor.btnOK_Click ( object  sender, EventArgs  e  )

private

Update our data object.

Parameters

sender
e

Definition at line 113 of file FrappuccinoCompositionEditor.cs.

        {
            CopyGuItoData();
        }

References MockPlugin.Tasks.FrappuccinoCompositionEditor.CopyGuItoData().

CopyDataToGui()

void MockPlugin.Tasks.FrappuccinoCompositionEditor.CopyDataToGui ( )

private

Let the GUI reflect our data.

Definition at line 29 of file FrappuccinoCompositionEditor.cs.

        {
            if (mData.Volume < 200)
            {
                cboSize.SelectedIndex = 0;
            }
            else if (mData.Volume < 400)
            {
                cboSize.SelectedIndex = 1;
            }
            else
            {
                cboSize.SelectedIndex = 2;
            }
            switch (mData.Cream)
            {
                case BrewFrappuccino.CreamType.LowFat:
                    rbLowFat.Checked = true;
                    break;
                case BrewFrappuccino.CreamType.Normal:
                    rbRegularCream.Checked = true;
                    break;
                case BrewFrappuccino.CreamType.Vegan:
                    rbVeganCream.Checked = true;
                    break;
            }
            chkCaffeine.Checked = !mData.DeCaffeinated;
            if (mData.MuchIce)
            {
                rbLotsOfIce.Checked = true;
            }
            else
            {
                rbLowIce.Checked = true;
            }
            lblDevName.Text = mData.DevInEditor?.Name ?? "(not set)";
        }

References MockPlugin.Tasks.FrappuccinoCompositionEditor.mData, and MockPlugin.Tasks.BrewFrappuccino.Volume.

Referenced by MockPlugin.Tasks.FrappuccinoCompositionEditor.FrappuccinoCompositionEditor_Shown().

CopyGuItoData()

void MockPlugin.Tasks.FrappuccinoCompositionEditor.CopyGuItoData ( )

private

When the user clicked on OK, we want to push the state represented by the GUI into our composition object.

Definition at line 79 of file FrappuccinoCompositionEditor.cs.

        {
            switch (cboSize.SelectedIndex)
            {
                case 0:
                    mData.Volume = 150;
                    break;
                case 1:
                    mData.Volume = 250;
                    break;
                default:
                    mData.Volume = 450;
                    break;
            }
            mData.MuchIce = rbLotsOfIce.Checked;
            mData.DeCaffeinated = !chkCaffeine.Checked;
            if (rbVeganCream.Checked)
            {
                mData.Cream = BrewFrappuccino.CreamType.Vegan;
            }
            else if (rbRegularCream.Checked)
            {
                mData.Cream = BrewFrappuccino.CreamType.Normal;
            }
            else
            {
                mData.Cream = BrewFrappuccino.CreamType.LowFat;
            }
        }

Referenced by MockPlugin.Tasks.FrappuccinoCompositionEditor.btnOK_Click().

FrappuccinoCompositionEditor_Shown()

void MockPlugin.Tasks.FrappuccinoCompositionEditor.FrappuccinoCompositionEditor_Shown ( object  sender, EventArgs  e  )

private

If we set the controls' values from the constructor, sometimes they don't get updated properly.

Parameters

sender
e

Definition at line 71 of file FrappuccinoCompositionEditor.cs.

        {
            CopyDataToGui();
        }

References MockPlugin.Tasks.FrappuccinoCompositionEditor.CopyDataToGui().

Member Data Documentation

mData

readonly BrewFrappuccino.CompositionData MockPlugin.Tasks.FrappuccinoCompositionEditor.mData

private

Definition at line 24 of file FrappuccinoCompositionEditor.cs.

Referenced by MockPlugin.Tasks.FrappuccinoCompositionEditor.CopyDataToGui(), and MockPlugin.Tasks.FrappuccinoCompositionEditor.FrappuccinoCompositionEditor().

---

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

• FrappuccinoCompositionEditor.cs