Doc fixes A-M edition. Thanks to Arnout for pointing these out. Also I fixed some...

[wxWidgets.git] / include / wx / toolbar.h

diff --git a/include/wx/toolbar.h b/include/wx/toolbar.h
index 25f71277cb145157e7069d78a2c1351a17c39c96..d8ab15b83164d5da519eeae970eda16d63f3565c 100644 (file)
--- a/include/wx/toolbar.h
+++ b/include/wx/toolbar.h
@@ -5,17 +5,59 @@
 // Modified by:
 // Created:     20.11.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     20.11.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TOOLBAR_H_BASE_
 #define _WX_TOOLBAR_H_BASE_
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TOOLBAR_H_BASE_
 #define _WX_TOOLBAR_H_BASE_
 

-#include "wx/tbarbase.h"     // the base class for all toolbars
+#include "wx/defs.h"
+
+// ----------------------------------------------------------------------------
+// wxToolBar style flags
+// ----------------------------------------------------------------------------
+
+enum
+{
+    // lay out the toolbar horizontally
+    wxTB_HORIZONTAL  = wxHORIZONTAL,    // == 0x0004
+
+    // lay out the toolbar vertically
+    wxTB_VERTICAL    = wxVERTICAL,      // == 0x0008
+
+    // show 3D buttons (wxToolBarSimple only)
+    wxTB_3DBUTTONS   = 0x0010,
+
+    // "flat" buttons (Win32/GTK only)
+    wxTB_FLAT        = 0x0020,
+
+    // dockable toolbar (GTK only)
+    wxTB_DOCKABLE    = 0x0040,
+
+    // don't show the icons (they're shown by default)
+    wxTB_NOICONS     = 0x0080,
+
+    // show the text (not shown by default)
+    wxTB_TEXT        = 0x0100,
+
+    // don't show the divider between toolbar and the window (Win32 only)
+    wxTB_NODIVIDER   = 0x0200,
+
+    // no automatic alignment (Win32 only, useless)
+    wxTB_NOALIGN     = 0x0400,
+
+    // show the text and the icons alongside, not vertically stacked (Win32/GTK)
+    wxTB_HORZ_LAYOUT = 0x0800,
+    wxTB_HORZ_TEXT   = wxTB_HORZ_LAYOUT | wxTB_TEXT
+};

 
 #if wxUSE_TOOLBAR
 
 #if wxUSE_TOOLBAR

-    #if !wxUSE_TOOLBAR_NATIVE || defined(__WXUNIVERSAL__)
+    #include "wx/tbarbase.h"     // the base class for all toolbars
+
+    // Simple toolbar no longer available, so we will need to have
+    // a generic toolbar at some point (perhaps the wxUniv toolbar)
+    #if 0 // !wxUSE_TOOLBAR_NATIVE && !defined(__WXUNIVERSAL__)

         #include "wx/tbarsmpl.h"
 
         class WXDLLEXPORT wxToolBar : public wxToolBarSimple
         #include "wx/tbarsmpl.h"
 
         class WXDLLEXPORT wxToolBar : public wxToolBarSimple


@@ -24,33 +66,81 @@
             wxToolBar() { }
 
             wxToolBar(wxWindow *parent,
             wxToolBar() { }
 
             wxToolBar(wxWindow *parent,

-                      wxWindowID id,
+                      wxWindowID winid,

                       const wxPoint& pos = wxDefaultPosition,
                       const wxSize& size = wxDefaultSize,
                       long style = wxNO_BORDER | wxTB_HORIZONTAL,
                       const wxString& name = wxToolBarNameStr)
                       const wxPoint& pos = wxDefaultPosition,
                       const wxSize& size = wxDefaultSize,
                       long style = wxNO_BORDER | wxTB_HORIZONTAL,
                       const wxString& name = wxToolBarNameStr)

-                : wxToolBarSimple(parent, id, pos, size, style, name) { }
+                : wxToolBarSimple(parent, winid, pos, size, style, name) { }
+
+            // the most commonly used version of AddTool()
+            wxToolBarToolBase *AddTool(int toolid,
+                               const wxBitmap& bitmap,
+                               const wxString& shortHelpString = wxEmptyString,
+                               const wxString& longHelpString = wxEmptyString)
+            {
+                return wxToolBarSimple::AddTool(toolid, bitmap, wxNullBitmap, false, wxDefaultCoord, wxDefaultCoord, NULL,
+                       shortHelpString, longHelpString);
+            }
+
+            // old form
+            wxToolBarToolBase *AddTool
+                               (
+                                   int toolid,
+                                   const wxBitmap& bitmap,
+                                   const wxBitmap& pushedBitmap,
+                                   bool toggle,
+                                   wxObject *clientData = NULL,
+                                   const wxString& shortHelpString = wxEmptyString,
+                                   const wxString& longHelpString = wxEmptyString
+                               )
+            {
+                return wxToolBarSimple::AddTool(toolid, bitmap, pushedBitmap, toggle, wxDefaultCoord, wxDefaultCoord, clientData,
+                       shortHelpString, longHelpString);
+            }
+
+            // virtual overridden
+            virtual wxToolBarToolBase *AddTool
+                               (
+                                   int toolid,
+                                   const wxBitmap& bitmap,
+                                   const wxBitmap& pushedBitmap,
+                                   bool toggle,
+                                   wxCoord xPos,
+                                   wxCoord yPos = wxDefaultCoord,
+                                   wxObject *clientData = NULL,
+                                   const wxString& shortHelpString = wxEmptyString,
+                                   const wxString& longHelpString = wxEmptyString
+                               )
+            {
+                return wxToolBarSimple::AddTool(toolid, bitmap, pushedBitmap, toggle, xPos, yPos, clientData,
+                       shortHelpString, longHelpString);
+            }

 
         private:
             DECLARE_DYNAMIC_CLASS(wxToolBar)
         };
     #else // wxUSE_TOOLBAR_NATIVE
 
         private:
             DECLARE_DYNAMIC_CLASS(wxToolBar)
         };
     #else // wxUSE_TOOLBAR_NATIVE

-        #if defined(__WXMSW__) && defined(__WIN95__)
+        #if defined(__WXUNIVERSAL__)
+           #include "wx/univ/toolbar.h"
+        #elif defined(__WXPALMOS__)
+           #include "wx/palmos/toolbar.h"
+        #elif defined(__WXMSW__) && (!defined(_WIN32_WCE) || (_WIN32_WCE >= 400 && !defined(__POCKETPC__) && !defined(__SMARTPHONE__)))

            #include "wx/msw/tbar95.h"
            #include "wx/msw/tbar95.h"

+        #elif defined(__WXWINCE__)
+           #include "wx/msw/wince/tbarwce.h"

         #elif defined(__WXMSW__)
            #include "wx/msw/tbarmsw.h"
         #elif defined(__WXMOTIF__)
            #include "wx/motif/toolbar.h"
         #elif defined(__WXGTK__)
            #include "wx/gtk/tbargtk.h"
         #elif defined(__WXMSW__)
            #include "wx/msw/tbarmsw.h"
         #elif defined(__WXMOTIF__)
            #include "wx/motif/toolbar.h"
         #elif defined(__WXGTK__)
            #include "wx/gtk/tbargtk.h"

-        #elif defined(__WXX11__)
-           #include "wx/x11/toolbar.h"

         #elif defined(__WXMAC__)
            #include "wx/mac/toolbar.h"
         #elif defined(__WXMAC__)
            #include "wx/mac/toolbar.h"

+        #elif defined(__WXCOCOA__)
+           #include "wx/cocoa/toolbar.h"

         #elif defined(__WXPM__)
            #include "wx/os2/toolbar.h"
         #elif defined(__WXPM__)
            #include "wx/os2/toolbar.h"

-        #elif defined(__WXSTUBS__)
-           #include "wx/stubs/toolbar.h"

         #endif
     #endif // !wxUSE_TOOLBAR_NATIVE/wxUSE_TOOLBAR_NATIVE
 #endif // wxUSE_TOOLBAR
         #endif
     #endif // !wxUSE_TOOLBAR_NATIVE/wxUSE_TOOLBAR_NATIVE
 #endif // wxUSE_TOOLBAR