doc: Add menu, gfx and text documentation into global index.
[bertos.git] / bertos / gui / menu.h
index d5b516ae9cec6443b94eb660ea5cfd0170ac76fa..b3ada468f2b2cdbe3cc4ff5ed7f38d30e761a94b 100644 (file)
  * All Rights Reserved.
  * -->
  *
+ * \defgroup menu Menu handling module
+ * \ingroup gui
+ * \{
  * \author Bernie Innocenti <bernie@codewiz.org>
  * \author Stefano Fedrigo <aleph@develer.com>
  *
  * \brief Common menu handling API
  *
  * $WIZ$ module_name = "menu"
- * $WIZ$ module_configuration = "bertos/cfg/cfg_menu.h"
  * $WIZ$ module_depends = "text", "gfx", "timer", "kbd"
  */
 
 
 #include <cfg/compiler.h>
 
-/* Fwd decl */
-struct Bitmap;
+#include <gfx/gfx.h>
 
 /** Menu callback function */
 typedef iptr_t (*MenuHook)(iptr_t userdata);
+typedef void (*BlitBitmap)(const Bitmap *bm);
 
 /**
  * Menu item description.
@@ -100,6 +102,7 @@ typedef struct Menu
        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). */
+       BlitBitmap       lcd_blitBitmap; /**< Callback to call to do smooth the display */
 } Menu;
 
 /**
@@ -128,4 +131,5 @@ iptr_t menu_handle(const struct Menu *menu);
 int menu_setFlags(struct Menu *menu, int idx, int flags);
 int menu_clearFlags(struct Menu *menu, int idx, int flags);
 
+/** \} */ //defgroup menu
 #endif /* GUI_MENU_H */