improved the doxygen documentation

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@4 0fc631ac-6414-0410-93d0-97cfa31319b6

src/gui/icon_menu.hpp

@@ -0,0 +1,35 @@
+//+----------------------------------------------------------------------------+
+//| Description:  Magic Set Editor - Program to make Magic (tm) cards          |
+//| Copyright:    (C) 2001 - 2006 Twan van Laarhoven                           |
+//| License:      GNU General Public License 2 or later (see file COPYING)     |
+//+----------------------------------------------------------------------------+
+
+#ifndef HEADER_GUI_ICON_MENU
+#define HEADER_GUI_ICON_MENU
+
+// ----------------------------------------------------------------------------- : Includes
+
+#include "../util/prec.hpp"
+
+// ----------------------------------------------------------------------------- : IconMenu
+
+/// Helper class for menus with icons
+/** This class functions just like a normal wxMenu.
+ *  The difference is that Append takes an extra parameter:
+ *    the resource name of the bitmap to use.
+ *  Bitmaps are resized (cut) to 16x16 pixels.
+ */
+class IconMenu : public wxMenu {
+  public:
+	/// Append a menu item, with an image (loaded from a resource)
+	void Append(int id, const String& resource, const String& text, const String& help, int style = wxITEM_NORMAL, wxMenu* submenu = nullptr);
+	/// Append a menu item, without an image
+	void Append(int id, const String& text, const String& help);
+	/// Append a menu item, without an image
+	void Append(int id, const String& text, wxMenu* submenu, const String& help);
+	/// Insert a menu item, without an image
+	void Insert(size_t pos, int id, const String& text, const String& help);
+};
+
+// ----------------------------------------------------------------------------- : EOF
+#endif