#45 #46 providing support for visible flag on menu items, prepare for 1.4.0

davetcc · davetcc · commit 60829dde2b25 · 2020-03-26T07:13:38.000Z
diff --git a/examples/colorTftEthernet32/colorTftEthernet.emf b/examples/colorTftEthernet32/colorTftEthernet.emf
@@ -1,6 +1,6 @@
 {
   "lastEdited": {
-    "seconds": 1584888681,
+    "seconds": 1585206207,
     "nanos": 0
   },
   "codeOptions": {
@@ -50,7 +50,7 @@
       },
       {
         "name": "DISPLAY_TYPE",
-        "latestValue": "Adafruit_ILI9341",
+        "latestValue": "Adafruit_ST7735",
         "subsystem": "DISPLAY"
       },
       {
@@ -195,6 +195,18 @@
         "naming": "ON_OFF"
       }
     },
+    {
+      "parentId": 11,
+      "type": "actionMenu",
+      "item": {
+        "name": "Hidden item",
+        "eepromAddress": -1,
+        "id": 16,
+        "readOnly": false,
+        "localOnly": false,
+        "visible": true
+      }
+    },
     {
       "parentId": 11,
       "type": "boolItem",
diff --git a/examples/colorTftEthernet32/colorTftEthernet32.ino b/examples/colorTftEthernet32/colorTftEthernet32.ino
@@ -122,6 +122,12 @@ void setup() {
     // before calling setupMenu..
     prepareCustomConfiguration();
 
+    // here we make the menuitem "hidden item" invisible. It will not be displayed.
+    // here it is done before setupMenu is called, so there's no need to refresh the
+    // display. If it's done after initialisation, the menu must be reset by calling
+    // menuMgr.setCurrentMenu(getRoot());
+    menuHiddenItem.setVisible(false);
+
     // set up the menu
     setupMenu();
 
diff --git a/examples/colorTftEthernet32/colorTftEthernet32_menu.cpp b/examples/colorTftEthernet32/colorTftEthernet32_menu.cpp
@@ -35,8 +35,10 @@ BackMenuItem menuBackStatus(fnStatusRtCall, &menuVoltA0);
 SubMenuItem menuStatus(&minfoStatus, &menuBackStatus, &menuConnectivity);
 const BooleanMenuInfo minfoTempCheck = { "Temp Check", 13, 9, 1, NO_CALLBACK, NAMING_ON_OFF };
 BooleanMenuItem menuTempCheck(&minfoTempCheck, false, NULL);
+const AnyMenuInfo minfoHiddenItem = { "Hidden item", 16, 0xFFFF, 0, NO_CALLBACK };
+ActionMenuItem menuHiddenItem(&minfoHiddenItem, &menuTempCheck);
 const BooleanMenuInfo minfoSCircuitProtect = { "S-Circuit Protect", 12, 8, 1, NO_CALLBACK, NAMING_ON_OFF };
-BooleanMenuItem menuSCircuitProtect(&minfoSCircuitProtect, false, &menuTempCheck);
+BooleanMenuItem menuSCircuitProtect(&minfoSCircuitProtect, false, &menuHiddenItem);
 const SubMenuInfo minfoAdvanced = { "Advanced", 11, 0xFFFF, 0, NO_CALLBACK };
 RENDERING_CALLBACK_NAME_INVOKE(fnAdvancedRtCall, backSubItemRenderFn, "Advanced", -1, NO_CALLBACK)
 BackMenuItem menuBackAdvanced(fnAdvancedRtCall, &menuSCircuitProtect);
@@ -63,10 +65,10 @@ AnalogMenuItem menuVoltage(&minfoVoltage, 0, &menuCurrent);
 // Set up code
 
 void setupMenu() {
+
+
     renderer.setGraphicsDevice(&gfx, &colorConfig);
     switches.initialise(io8574, true);
     menuMgr.initForEncoder(&renderer, &menuVoltage, 7, 6, 5);
     remoteServer.begin(&server, &applicationInfo);
-
-
 }
diff --git a/examples/colorTftEthernet32/colorTftEthernet32_menu.h b/examples/colorTftEthernet32/colorTftEthernet32_menu.h
@@ -41,6 +41,7 @@ extern FloatMenuItem menuVoltA1;
 extern FloatMenuItem menuVoltA0;
 extern SubMenuItem menuStatus;
 extern BooleanMenuItem menuTempCheck;
+extern ActionMenuItem menuHiddenItem;
 extern BooleanMenuItem menuSCircuitProtect;
 extern SubMenuItem menuAdvanced;
 void CALLBACK_FUNCTION onSaveRom(int id);
diff --git a/examples/keyboardEthernetShield/keyboardEthernetShield.emf b/examples/keyboardEthernetShield/keyboardEthernetShield.emf
@@ -1,6 +1,6 @@
 {
   "lastEdited": {
-    "seconds": 1584198922,
+    "seconds": 1585206203,
     "nanos": 0
   },
   "codeOptions": {
@@ -145,6 +145,19 @@
         "unitName": "dB"
       }
     },
+    {
+      "parentId": 0,
+      "type": "boolItem",
+      "item": {
+        "name": "Hidden item",
+        "eepromAddress": -1,
+        "id": 13,
+        "readOnly": false,
+        "localOnly": false,
+        "visible": false,
+        "naming": "TRUE_FALSE"
+      }
+    },
     {
       "parentId": 0,
       "type": "analogItem",
diff --git a/examples/keyboardEthernetShield/keyboardEthernetShield_menu.cpp b/examples/keyboardEthernetShield/keyboardEthernetShield_menu.cpp
@@ -48,21 +48,24 @@ const AnalogMenuInfo PROGMEM minfoDecimalTens = { "DecimalTens", 4, 28, 1000, NO
 AnalogMenuItem menuDecimalTens(&minfoDecimalTens, 0, &menuLargeNum);
 const AnalogMenuInfo PROGMEM minfoInteger = { "Integer", 3, 4, 1000, onInteger, 100, 1, "" };
 AnalogMenuItem menuInteger(&minfoInteger, 0, &menuDecimalTens);
+const BooleanMenuInfo PROGMEM minfoHiddenItem = { "Hidden item", 13, 0xFFFF, 1, NO_CALLBACK, NAMING_TRUE_FALSE };
+BooleanMenuItem menuHiddenItem(&minfoHiddenItem, false, &menuInteger);
 const AnalogMenuInfo PROGMEM minfoAnalog1 = { "Analog1", 2, 2, 255, onAnalog1, -180, 2, "dB" };
-AnalogMenuItem menuAnalog1(&minfoAnalog1, 0, &menuInteger);
+AnalogMenuItem menuAnalog1(&minfoAnalog1, 0, &menuHiddenItem);
 RENDERING_CALLBACK_NAME_INVOKE(fnTimeRtCall, timeItemRenderFn, "Time", 8, NO_CALLBACK)
 TimeFormattedMenuItem menuTime(fnTimeRtCall, 1, (MultiEditWireType)EDITMODE_TIME_12H, &menuAnalog1);
 
 
 // Set up code
 
 void setupMenu() {
+    menuHiddenItem.setVisible(false);
+    menuConnectivity.setSecured(true);
+    menuConnectivity.setLocalOnly(true);
+
     lcd.setIoAbstraction(io23017);
     lcd.begin(20, 4);
     switches.initialise(io23017, true);
     menuMgr.initForEncoder(&renderer, &menuTime, 6, 7, 5);
     remoteServer.begin(&server, &applicationInfo);
-
-    menuConnectivity.setSecured(true);
-    menuConnectivity.setLocalOnly(true);
 }
diff --git a/examples/keyboardEthernetShield/keyboardEthernetShield_menu.h b/examples/keyboardEthernetShield/keyboardEthernetShield_menu.h
@@ -49,6 +49,7 @@ extern EditableLargeNumberMenuItem menuLargeNum;
 extern AnalogMenuItem menuDecimalTens;
 void CALLBACK_FUNCTION onInteger(int id);
 extern AnalogMenuItem menuInteger;
+extern BooleanMenuItem menuHiddenItem;
 void CALLBACK_FUNCTION onAnalog1(int id);
 extern AnalogMenuItem menuAnalog1;
 extern TimeFormattedMenuItem menuTime;
diff --git a/examples/keyboardEthernetShield/tcMenuLiquidCrystal.cpp b/examples/keyboardEthernetShield/tcMenuLiquidCrystal.cpp
@@ -148,7 +148,8 @@ void LiquidCrystalRenderer::render() {
 			if (lastOffset != toOffsetBy) locRedrawMode = MENUDRAW_COMPLETE_REDRAW;
 			lastOffset = toOffsetBy;
 
-			while (item != NULL && toOffsetBy--) {
+			while (item != NULL && toOffsetBy) {
+                if(item->isVisible()) toOffsetBy = toOffsetBy - 1;
 				item = item->getNext();
 			}
 		}
@@ -159,10 +160,13 @@ void LiquidCrystalRenderer::render() {
 
 		// and then we start drawing items until we run out of screen or items
 		while (item && cnt < dimY) {
-			if (locRedrawMode != MENUDRAW_NO_CHANGE || item->isChanged()) {
-				renderMenuItem(cnt, item);
-			}
-			++cnt;
+            if(item->isVisible())
+            {
+                if (locRedrawMode != MENUDRAW_NO_CHANGE || item->isChanged()) {
+                    renderMenuItem(cnt, item);
+                }
+                ++cnt;
+            }
 			item = item->getNext();
 		}
 	}
diff --git a/library.properties b/library.properties
@@ -4,7 +4,7 @@
 #
 
 name=tcMenu
-version=1.3.6
+version=1.4.0
 maintainer=www.thecoderscorner.com
 author=davetcc
 category=Other
diff --git a/src/BaseRenderers.h b/src/BaseRenderers.h
@@ -359,7 +359,5 @@ class BaseMenuRenderer : public MenuRenderer, Executable {
 	void menuValueFloat(FloatMenuItem* item, MenuDrawJustification justification);
 };
 
-/** Counts the number of items from this menu item to the end of the list */
-uint8_t itemCount(MenuItem* item);
 
 #endif
diff --git a/src/MenuIterator.cpp b/src/MenuIterator.cpp
@@ -147,10 +147,13 @@ MenuItem* getItemAtPosition(MenuItem* root, uint8_t pos) {
 	MenuItem* itm = root;
 
 	while (itm != NULL) {
-		if (i == pos) {
-			return itm;
-		}
-		i++;
+        if(itm->isVisible())
+        {
+            if (i == pos) {
+                return itm;
+            }
+            i++;
+        }
 		itm = itm->getNext();
 	}
 
@@ -161,12 +164,23 @@ int offsetOfCurrentActive(MenuItem* root) {
 	uint8_t i = 0;
 	MenuItem* itm = root;
 	while (itm != NULL) {
-		if (itm->isActive() || itm->isEditing()) {
-			return i;
-		}
-		i++;
+        if(itm->isVisible()) {
+            if (itm->isActive() || itm->isEditing()) {
+                return i;
+            }
+            i++;
+        }
 		itm = itm->getNext();
 	}
 
 	return 0;
 }
+
+uint8_t itemCount(MenuItem* item, bool includeNonVisible) {
+	uint8_t count = 0;
+	while (item) {
+        if(includeNonVisible || item->isVisible()) ++count;
+		item = item->getNext();
+	}
+	return count;
+}
diff --git a/src/MenuIterator.h b/src/MenuIterator.h
@@ -67,6 +67,15 @@ MenuItem* getItemAtPosition(MenuItem* root, uint8_t pos);
  */
 int offsetOfCurrentActive(MenuItem* root);
 
+/**
+ * returns the number of items in the current menu described by itemCount
+ * @param item the root item of the menu to be counted.
+ * @param includeNonVisble include menu items that are not marked visible
+ * @return the number of items, may include only visible ones depending on flag
+ */
+uint8_t itemCount(MenuItem* item,  bool includeNonVisble = false);
+
+
 /**
  * A predicate that can match upon a menu item, the match is generally performed by calling the
  * match method, which returns true for a match.
diff --git a/src/RemoteConnector.cpp b/src/RemoteConnector.cpp
@@ -386,6 +386,7 @@ void TagValueRemoteConnector::encodeBaseMenuFields(int parentId, MenuItem* item)
     transport->writeFieldInt(FIELD_ID, item->getId());
     transport->writeFieldInt(FIELD_EEPROM, item->getEepromPosition());
     transport->writeFieldInt(FIELD_READONLY, item->isReadOnly());
+    transport->writeFieldInt(FIELD_VISIBLE, item->isVisible());
     char sz[20];
     item->copyNameToBuffer(sz, sizeof(sz));
     transport->writeField(FIELD_MSG_NAME, sz);
diff --git a/src/RemoteTypes.h b/src/RemoteTypes.h
@@ -102,6 +102,7 @@ enum AckResponseStatus {
 #define FIELD_ID          msgFieldToWord('I', 'D')
 #define FIELD_EEPROM      msgFieldToWord('I', 'E')
 #define FIELD_READONLY    msgFieldToWord('R', 'O')
+#define FIELD_VISIBLE     msgFieldToWord('V', 'I')
 #define FIELD_PARENT      msgFieldToWord('P', 'I')
 #define FIELD_ANALOG_MAX  msgFieldToWord('A', 'M')
 #define FIELD_ANALOG_OFF  msgFieldToWord('A', 'O')
diff --git a/src/tcUtil.cpp b/src/tcUtil.cpp
@@ -71,15 +71,6 @@ void fastltoa_mv(char* str, long val, long divisor, char padChar, int len) {
     str[i] = (char)0;
 }
 
-uint8_t itemCount(MenuItem* item) {
-	uint8_t count = 0;
-	while (item) {
-		++count;
-		item = item->getNext();
-	}
-	return count;
-}
-
 #if defined __AVR__ || defined ESP_H
 char szGlobalBuffer[16];
 #endif
diff --git a/src/tcUtil.h b/src/tcUtil.h
@@ -81,11 +81,6 @@ void fastltoa_mv(char* str, long val, long divisor, char padChar, int len);
  */
 void fastltoa(char* str, long val, uint8_t dp, char padChar, int len);
 
-/**
- * returns the number of items in the current menu described by itemCount
- */
-uint8_t itemCount(MenuItem* item);
-
 /**
  * converts decimal places into a suitable divisor, eg: 2 -> 100, 4 -> 10000
  */

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`#`
`5`	`5`
`6`	`6`	`name=tcMenu`
`7`		`-version=1.3.6`
	`7`	`+version=1.4.0`
`8`	`8`	`maintainer=www.thecoderscorner.com`
`9`	`9`	`author=davetcc`
`10`	`10`	`category=Other`