More interface header reviews by Azriel Fasten, along with a simple item "add" group...

[wxWidgets.git] / interface / defs.h

diff --git a/interface/defs.h b/interface/defs.h
index 47fd6ffaacca2762a93c58f7dffdd23d3e7c29fe..61b05d35999e469b7cdeb7d29440813cdcfcfecf 100644 (file)
--- a/interface/defs.h
+++ b/interface/defs.h
@@ -6,6 +6,49 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    Item kinds for use with wxMenu, wxMenuItem, and wxToolBar.
+    
+    @see wxMenu::Append(), wxMenuItem::wxMenuItem(), wxToolBar::AddTool()
+*/
+enum wxItemKind
+{
+    wxITEM_SEPARATOR = -1,
+
+    /**
+        Normal tool button / menu item.
+
+        @see wxToolBar::AddTool(), wxMenu::AppendItem().
+    */
+    wxITEM_NORMAL,
+
+    /**
+        Check (or toggle) tool button / menu item.
+
+        @see wxToolBar::AddCheckTool(), wxMenu::AppendCheckItem().
+    */
+    wxITEM_CHECK,
+
+    /**
+        Radio tool button / menu item.
+
+        @see wxToolBar::AddRadioTool(), wxMenu::AppendRadioItem().
+    */
+    wxITEM_RADIO,
+
+    /**
+        Normal tool button with a dropdown arrow next to it. Clicking the
+        dropdown arrow sends a @c wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED event and may
+        also display the menu previously associated with the item with
+        wxToolBar::SetDropdownMenu(). Currently this type of tools is supported
+        under MSW and GTK.
+    */
+    wxITEM_DROPDOWN,
+
+    wxITEM_MAX
+};
+
+
 /**
     Paper size types for use with the printing framework.
 
@@ -316,3 +359,4 @@ void wxVaCopy(va_list argptrDst, va_list argptrSrc);
 
 //@}
 
+