#125 Allow the top level title text to be overridden.

Author: dave

examples/dynamicMenuItems/ThemeCoolBlueTraditional.h

@@ -7,7 +7,7 @@
 
 // tcMenu drawing properties take a 4 color palette for items, titles and actions.
 // this renderer shares the color configuration for items and actions.
-const color_t coolBlueTitlePalette[] = {RGB(0,0,0), RGB(20,132,255), RGB(192,192,192), RGB(0,133,255)};
+const color_t coolBlueTitlePalette[] = {RGB(0,0,0), RGB(20,132,255), RGB(192,192,192), RGB(64, 64, 64)};
 const color_t coolBlueItemPalette[] = {RGB(255, 255, 255), RGB(0,64,135), RGB(20,133,255), RGB(31,100,178)};
 
 void installCoolBlueTraditionalTheme(GraphicsDeviceRenderer& bgr, const MenuFontDef& itemFont, const MenuFontDef& titleFont, bool needEditingIcons) {

examples/dynamicMenuItems/dynamicMenuItems.emf

@@ -405,6 +405,10 @@
     "saveToSrc": false,
     "useCppMain": false,
     "eepromDefinition": "",
-    "authenticatorDefinition": ""
+    "authenticatorDefinition": "",
+    "projectIoExpanders": [
+      "deviceIO:",
+      "pcf8574:io8574:32:0"
+    ]
   }
 }

examples/dynamicMenuItems/dynamicMenuItems.ino

@@ -5,10 +5,10 @@
  */
 
 #include "dynamicMenuItems_menu.h"
+#include <BaseDialog.h>
 #include <IoAbstractionWire.h>
-
-// we declare a reference to an io expander as our encoder is on I2C
-IoAbstractionRef io8574 = ioFrom8574(0x20, 0); // on addr 0x20 and interrupt pin 0
+#include <graphics/RuntimeTitleMenuItem.h>
+#include <tcMenuVersion.h>
 
 // Pizza toppings that we forward referenced in the scroll choice item, when in RAM or EEPROM then they are declared in
 // a flat array based on the item size.
@@ -97,13 +97,34 @@ void prepareOvenMenuAtRuntime() {
     menuMgr.addMenuAfter(&menuBackOven, &menuOvenTempItem);
 }
 
+//
+// We register a handler that will be called when the title menu item is selected, see setup where we set the callback
+//
+void onTitlePressed(int /*id*/) {
+    withMenuDialogIfAvailable([] (MenuBasedDialog* dlg) {
+        dlg->setButtons(BTNTYPE_CLOSE, BTNTYPE_NONE);
+        dlg->showRam("Title clicked", false);
+        char szVer[10];
+        tccore::copyTcMenuVersion(szVer, sizeof szVer);
+        dlg->copyIntoBuffer(szVer);
+    });
+}
+
 void setup() {
+    // If we use wire or serial, it's our responsibility to prepare it.
     Serial.begin(115200);
     Wire.begin();
     setupMenu();
+
+    // Here we add a menu observer that is notified as events take place on the menu.
     menuMgr.addChangeNotification(&myMgrObserver);
+
+    // Now we set up the runtime parameters of various menu items
     prepareOvenMenuAtRuntime();
     menuList.setNumberOfRows(numListItems);
+
+    // and lastly we add the title callback that is notified of the title being selected
+    appTitleMenuItem.setCallback(onTitlePressed);
 }
 
 void loop() {
@@ -152,17 +173,24 @@ void CALLBACK_FUNCTION onDialogInfo(int id) {
 }
 
 //
-// Shows a question dialog that gets the title from const/program memory. Notice that in this case we have a completion handler
-// that accepts the final value, so that we could do something with the result.
+// Shows a question dialog that gets the title from const/program memory. Notice that in this case we have a completion
+// handler that accepts the final value, so that we could do something with the result.
 //
-const char pgmQuestionHeader[] PROGMEM = {"Question.."};
+const char pgmQuestionHeader[] PROGMEM = {"Override the title?"};
+const char pgmTitleOverride[] PROGMEM = {"Title Overridden"};
 taskid_t questionTask = TASKMGR_INVALIDID;
 void CALLBACK_FUNCTION onDialogQuestion(int id) {
     withMenuDialogIfAvailable([] (MenuBasedDialog* dlg) {
-        dlg->setButtons(BTNTYPE_ACCEPT, BTNTYPE_CANCEL);
+        dlg->setButtons(BTNTYPE_OK, BTNTYPE_CANCEL);
         dlg->show(pgmQuestionHeader, true, [](ButtonType btn, void* data) {
             // this is the completion task that runs when the dialog is dismissed.
             Serial.print("Question result was "); Serial.println(btn);
+            if(btn == BTNTYPE_OK) {
+                appTitleMenuItem.setTitleOverridePgm(pgmTitleOverride);
+            }
+            else {
+                appTitleMenuItem.clearTitleOverride();
+            }
             taskManager.cancelTask(questionTask);
         });
 
@@ -179,7 +207,6 @@ void CALLBACK_FUNCTION onDialogQuestion(int id) {
 // In this case we create a controller based dialog that increments and decrements a number that is stored within
 // an Analog item. We add the analog item and also an extra button to the dialog.
 //
-
 class MyDialogController : public BaseDialogController {
 private:
     // create an extra button (buttonNum = 2)

examples/dynamicMenuItems/dynamicMenuItems_menu.cpp

@@ -14,7 +14,7 @@
 
 // Global variable declarations
 const  ConnectorLocalInfo applicationInfo = { "Dynamic Menus", "5f22995e-8da2-49c4-9ec8-d055901003af" };
-
+IoAbstractionRef ioexp_io8574 = ioFrom8574(0x20, 0);
 Adafruit_ST7735 gfx(6, 7, 3);
 AdafruitDrawable gfxDrawable(&gfx);
 GraphicsDeviceRenderer renderer(30, applicationInfo.name, &gfxDrawable);
@@ -72,7 +72,7 @@ void setupMenu() {
     gfx.initR(INITR_BLACKTAB);
     gfx.setRotation(0);
     renderer.setUpdatesPerSecond(5);
-    switches.initialiseInterrupt(io8574, true);
+    switches.initialiseInterrupt(ioexp_io8574, true);
     menuMgr.initForEncoder(&renderer, &menuMainPower, 7, 6, 5);
     renderer.setTitleMode(BaseGraphicalRenderer::TITLE_FIRST_ROW);
     renderer.setUseSliderForAnalog(true);

examples/dynamicMenuItems/dynamicMenuItems_menu.h

@@ -16,13 +16,17 @@
 #include "tcMenuAdaFruitGfx.h"
 #include <RuntimeMenuItem.h>
 #include <ScrollChoiceMenuItem.h>
+#include <IoAbstraction.h>
+#include <IoAbstractionWire.h>
 
 // variables we declare that you may need to access
 extern const PROGMEM ConnectorLocalInfo applicationInfo;
 extern Adafruit_ST7735 gfx;
 extern AdafruitDrawable gfxDrawable;
 extern GraphicsDeviceRenderer renderer;
-extern IoAbstractionRef io8574;
+
+// Any externals needed by IO expanders, EEPROMs etc
+extern IoAbstractionRef ioexp_io8574;
 
 // Global Menu Item exports
 extern ListRuntimeMenuItem menuList;

library.json

@@ -22,7 +22,7 @@
         "authors": "DaveTCC"
       }
     ],
-    "version": "2.2.3",
+    "version": "2.2.4",
     "license": "Apache-2.0",
     "frameworks": "arduino, mbed",
     "platforms": "*"

library.properties

@@ -4,7 +4,7 @@
 #
 
 name=tcMenu
-version=2.2.3
+version=2.2.4
 maintainer=www.thecoderscorner.com
 author=davetcc
 category=Other

src/graphics/RuntimeTitleMenuItem.cpp

@@ -5,6 +5,7 @@
 
 #include "PlatformDetermination.h"
 #include "RuntimeTitleMenuItem.h"
+
 namespace tcgfx {
 
     RuntimeTitleMenuItem appTitleMenuItem(0, nullptr);

src/graphics/RuntimeTitleMenuItem.h

@@ -26,25 +26,57 @@ namespace tcgfx {
 
     /**
      * This menu item extension class handles the title row, for the root menu. It stores a header in program memory
-     * and a possible callback function for when it is actioned.
+     * and a possible callback function for when it is actioned. This menu item also allows the header text to be
+     * overridden too.
      */
     class RuntimeTitleMenuItem : public RuntimeMenuItem {
     private:
         const char *titleHeaderPgm;
+        const char *titleOverridePgm;
         MenuCallbackFn callback;
     public:
+        /**
+         * There should only be one instance of this class, it is constructed globally by the library, you can access
+         * this instance as
+         * @param id
+         * @param next
+         */
         RuntimeTitleMenuItem(uint16_t id, MenuItem *next) : RuntimeMenuItem(MENUTYPE_TITLE_ITEM, id,
                                                                             appTitleRenderingFn, 0, 1, next) {
             titleHeaderPgm = nullptr;
+            titleOverridePgm = nullptr;
             callback = nullptr;
         }
 
+        /**
+         * This should only be called by the menu library, to override what's displayed on the title you use
+         * the `setTitleOverridePgm` instead.
+         * @param header the new header text
+         */
         void setTitleHeaderPgm(const char *header) {
             titleHeaderPgm = header;
+            setChanged(true);
+        }
+
+        /**
+         * In order to override the title with user specific text that overrides the regular title set use this method.
+         * @param overrideTitle the text to override
+         */
+        void setTitleOverridePgm(const char* overrideTitle) {
+            titleOverridePgm = overrideTitle;
+            setChanged(true);
+        }
+
+        /**
+         * Call this to clear an override that was previously set, so that the regular header text is displayed instead.
+         */
+        void clearTitleOverride() {
+            titleOverridePgm = nullptr;
+            setChanged(true);
         }
 
         const char *getTitleHeaderPgm() {
-            return titleHeaderPgm;
+            return (titleOverridePgm != nullptr) ? titleOverridePgm : titleHeaderPgm;
         }
 
         void setCallback(MenuCallbackFn titleCb) {

src/tcMenuVersion.h

@@ -17,7 +17,7 @@ namespace tccore {
 // here we define the version as both a string and separate field
 #define TCMENU_MAJOR 2
 #define TCMENU_MINOR 2
-#define TCMENU_PATCH 3
+#define TCMENU_PATCH 4
 
 /**
  * A helper to generate the major minor version numbers used in the protocol