Changes between Initial Version and Version 1 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/Form/EVENT

Timestamp:

08/23/10 19:37:41 (14 years ago)

Author:

Don Wilson

Comment:

--

Docs/Prog/Manual/ApplicationLibraries/lib825ev/Form/EVENT

@@ +1 @@
+= EVENT =
+Macro to help create event functions
+
+{{{
+int EVENT(CForm* pForm, CFormItem* pFormItem, int nFlag);
+}}}
+
+== Parameters == 
+
+ * pForm - pointer to form that called event.
+ * pFormIten - pointer to form item that activated event such as a button.
+ * nFlag - flag values
+
+== Return Value ==
+
+Event functions return 0 to stay in the form. Any other return value will cause the form to exit. The function that called FORM_SHOW can read the result.
+
+== Remarks ==
+
+== Examples ==
+
+{{{
+void MenuScreen(void)
+{
+    FORM_INIT(Menu, EventMenuShow, NULL, NULL, NULL, nFormFlgShowHelp);
+    FORM_ADD_BUTTON(Menu, SetDateTime, 0, 50, "1. Set Date/Time", '1', EventDateTime, FORM_BUTTON);
+    FORM_ADD_BUTTON(Menu, ViewAccum, 0, 80, "2. View Accumulators", '2', EventViewAccum, FORM_BUTTON);
+
+    FORM_SHOW(Menu);
+    FORM_RUN(Menu);
+    FORM_HIDE(Menu);
+}
+
+EVENT(MenuShow)
+{
+    ClearLCD();
+    DisplayText(0, 0, "Menu Screen");
+    return 0;
+}
+
+EVENT(SetDateTime)
+{
+    // Hide the parent form
+    IN_EVENT_HIDE_FORM;
+
+    DateTimeScreen();
+
+    // Show the parent form
+    IN_EVENT_SHOW_FORM;
+
+    return 0;
+}
+
+EVENT(ViewAccum)
+{
+    // Hide the parent form
+    IN_EVENT_HIDE_FORM;
+
+    ViewAccumScreen();
+
+    // Show the parent form
+    IN_EVENT_SHOW_FORM;
+
+    return 0;
+}
+}}}
+
+
+== See Also ==
+
+ * [http://tech.825spectrum.com/trac/wiki/Docs/Prog/Manual/ApplicationLibraries/lib825ev/Form/FORM_ADD_INPUT FORM_ADD_INPUT]
+ * [http://tech.825spectrum.com/trac/wiki/Docs/Prog/Manual/ApplicationLibraries/lib825ev/Form/FORM_INIT FORM_INIT]
+ * [http://tech.825spectrum.com/trac/wiki/Docs/Prog/Manual/ApplicationLibraries/lib825ev/Form/FORM_SHOW FORM_SHOW]
+ * [http://tech.825spectrum.com/trac/wiki/Docs/Prog/Manual/ApplicationLibraries/lib825ev/Form/FORM_RUN FORM_RUN]