FORM_HIDE

Hides a form.

void FORM_HIDE(formName);

Parameters

• formName

Return Value

This function does not return any value

Remarks

FORM_HIDE is a macro to simplify the hiding of a form when complete. The preprocessor will convert this to a call to the specified form's Hide() function. If the form was initialized with nFormFlgClearItemsOnly the CForm::Hide function will only clear the form items and not the entire screen.

#define FORM_HIDE(f) form##f.Hide()

Examples

void IDScreen(void)
{
    string strID = "";
    float fVal = 0.0;

    FORM_INIT(ID, EventIDShow, NULL, NULL, NULL, nFormFlgShowHelp);
    FORM_ADD_INPUT(ID, ID, 0, 50, "ID: ", 10, 0, 0, NULL, strID, 0, NULL, "Enter the ID");
    FORM_ADD_INPUT(ID, Val, 0, 80, "Value: ", 10, 0, 9999, NULL, fVal, 0, NULL, "Enter the value");

    FORM_SHOW(ID);
    FORM_RUN(ID);
    FORM_HIDE(ID);

    // strID and fVal now contain the entered data
}

EVENT(IDShow)
{
    ClearLCD();
    DisplayText(0, 0, "ID/Value Screen");
    return 0;
}

See Also

• FORM_SHOW
• FORM_INIT
• FORM_RUN