X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=gui%2Fmenu.h;h=e4a6753c172dfda0a13bc6cbbaa613060f5b1295;hb=36153df3b7f47e9f04c93b22017437700f184e8c;hp=06b90a8b4069f107ff2f6207434c737cdbd7e910;hpb=969f9a6fd4c736973771e39a7516ba56d9453216;p=bertos.git

diff --git a/gui/menu.h b/gui/menu.h
index 06b90a8b..e4a6753c 100755
--- a/gui/menu.h
+++ b/gui/menu.h
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
@@ -16,6 +16,18 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.5  2007/09/19 16:23:27  batt
+ *#* Fix doxygen warnings.
+ *#*
+ *#* Revision 1.4  2006/09/13 13:58:33  bernie
+ *#* Add RenderHook support.
+ *#*
+ *#* Revision 1.3  2006/07/19 12:56:27  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.2  2006/06/03 13:58:02  bernie
+ *#* Fix recursive timeout and add exit status information.
+ *#*
  *#* Revision 1.1  2006/05/15 07:20:54  bernie
  *#* Move menu to gui/.
  *#*
@@ -67,19 +79,22 @@
 struct Bitmap;
 
 /** Menu callback function */
-typedef void (*MenuHook)(iptr_t userdata);
+typedef iptr_t (*MenuHook)(iptr_t userdata);
 
 /**
  * Menu item description.
  */
 typedef struct MenuItem
 {
-	const_iptr_t label;    /*!< Item label (ID or ptr to string, 0 to disable) */
-	int          flags;    /*!< See MIF_#? definitions below */
-	MenuHook     hook;     /*!< Callback function (NULL to terminate item list) */
-	iptr_t       userdata; /*!< User data to be passed back to the hook */
+	const_iptr_t label;    /**< Item label (ID or ptr to string, 0 to disable) */
+	int          flags;    /**< See MIF_#? definitions below */
+	MenuHook     hook;     /**< Callback function (NULL to terminate item list) */
+	iptr_t       userdata; /**< User data to be passed back to the hook */
 } MenuItem;
 
+/** Render hook callback function prototype */
+typedef void (*RenderHook)(struct Bitmap *bitmap, int ypos, bool selected, const struct MenuItem *item);
+
 /**
  * \name Flags for MenuItem.flags.
  * \{
@@ -87,20 +102,21 @@ typedef struct MenuItem
 #define MIF_EXCLUDE_MASK    0x00FF /**< Mask for mutual exclusion map (shared with priority). */
 #define MIF_PRI_MASK        0x00FF /**< Mask for priority value (shared with mutual exclusion). */
 #define MIF_PRI(x)          ((x) & MIF_PRI_MASK) /**< Set menu item priority. */
-#define MIF_EXCLUDE_0       BV(0)  /*!< Exclude item 0 when this item is checked */
-#define MIF_EXCLUDE_1       BV(1)  /*!< Exclude item 1 when this item is checked */
-#define MIF_EXCLUDE_2       BV(2)  /*!< Exclude item 2 when this item is checked */
-#define MIF_EXCLUDE_3       BV(3)  /*!< Exclude item 3 when this item is checked */
-#define MIF_EXCLUDE_4       BV(4)  /*!< Exclude item 4 when this item is checked */
-#define MIF_EXCLUDE_5       BV(5)  /*!< Exclude item 5 when this item is checked */
-#define MIF_EXCLUDE_6       BV(6)  /*!< Exclude item 6 when this item is checked */
-#define MIF_EXCLUDE_7       BV(7)  /*!< Exclude item 7 when this item is checked */
-#define MIF_CHECKED         BV(8)  /*!< Item is currently checked */
-#define MIF_CHECKIT         BV(9)  /*!< Automatically check this item when selected */
-#define MIF_TOGGLE          BV(10) /*!< Toggle MIF_CHECKED when item is selected */
-#define MIF_HIDDEN          BV(11) /*!< This menu item is not visible */
-#define MIF_DISABLED        BV(12) /*!< This menu item is not visible */
-#define MIF_RAMLABEL        BV(13) /*!< Item label is stored in RAM, not in program memory */
+#define MIF_EXCLUDE_0       BV(0)  /**< Exclude item 0 when this item is checked */
+#define MIF_EXCLUDE_1       BV(1)  /**< Exclude item 1 when this item is checked */
+#define MIF_EXCLUDE_2       BV(2)  /**< Exclude item 2 when this item is checked */
+#define MIF_EXCLUDE_3       BV(3)  /**< Exclude item 3 when this item is checked */
+#define MIF_EXCLUDE_4       BV(4)  /**< Exclude item 4 when this item is checked */
+#define MIF_EXCLUDE_5       BV(5)  /**< Exclude item 5 when this item is checked */
+#define MIF_EXCLUDE_6       BV(6)  /**< Exclude item 6 when this item is checked */
+#define MIF_EXCLUDE_7       BV(7)  /**< Exclude item 7 when this item is checked */
+#define MIF_CHECKED         BV(8)  /**< Item is currently checked */
+#define MIF_CHECKIT         BV(9)  /**< Automatically check this item when selected */
+#define MIF_TOGGLE          BV(10) /**< Toggle MIF_CHECKED when item is selected */
+#define MIF_HIDDEN          BV(11) /**< This menu item is not visible */
+#define MIF_DISABLED        BV(12) /**< This menu item is not visible */
+#define MIF_RAMLABEL        BV(13) /**< Item label is stored in RAM, not in program memory */
+#define MIF_RENDERHOOK      BV(14) /**< Menu render function is passed in label field */
 /* \} */
 
 /**
@@ -108,11 +124,11 @@ typedef struct MenuItem
  */
 typedef struct Menu
 {
-	MenuItem        *items;    /*!< Array of items (end with a NULL hook) */
-	const_iptr_t     title;    /*!< Menu title (ID or ptr to string, 0 to disable) */
-	int              flags;    /*!< See MF_#? definitions below */
-	struct Bitmap   *bitmap;   /*!< Bitmap where the menu is rendered */
-	int              selected; /*!< Initial selection (written to if #MF_SAVESEL is set). */
+	MenuItem        *items;    /**< Array of items (end with a NULL hook) */
+	const_iptr_t     title;    /**< Menu title (ID or ptr to string, 0 to disable) */
+	int              flags;    /**< See MF_#? definitions below */
+	struct Bitmap   *bitmap;   /**< Bitmap where the menu is rendered */
+	int              selected; /**< Initial selection (written to if MF_SAVESEL is set). */
 } Menu;
 
 /**
@@ -125,6 +141,17 @@ typedef struct Menu
 #define MF_SAVESEL  BV(3)  /**< Remember the selected item across invocations. */
 /* \} */
 
+/**
+ * \name Special result codes for menu_handle().
+ * \{
+ */
+#define MENU_OK       ((iptr_t)0)
+#define MENU_CANCEL   ((iptr_t)-1)
+#define MENU_TIMEOUT  ((iptr_t)-2)
+#define MENU_ABORT    ((iptr_t)-3)
+#define MENU_DISABLED ((iptr_t)-4)
+/* \} */
+
 /* Function prototypes */
 iptr_t menu_handle(const struct Menu *menu);
 int menu_setFlags(struct Menu *menu, int idx, int flags);