Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/univ/toolbar.h b/include/wx/univ/toolbar.h
index 968bf6c26730446ec6239a2cd5d11e5c2d0d1d67..4827311177e5abf862e664653fc99a0181f1b0cb 100644 (file)
--- a/include/wx/univ/toolbar.h
+++ b/include/wx/univ/toolbar.h
@@ -6,19 +6,15 @@
 // Created:     10.09.00
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling
 // Created:     10.09.00
 // RCS-ID:      $Id$
 // Copyright:   (c) Robert Roebling

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_UNIV_TOOLBAR_H_
 #define _WX_UNIV_TOOLBAR_H_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_UNIV_TOOLBAR_H_
 #define _WX_UNIV_TOOLBAR_H_
 

-#ifdef __GNUG__
-    #pragma interface "univtoolbar.h"
-#endif
-

 #include "wx/button.h"      // for wxStdButtonInputHandler
 
 #include "wx/button.h"      // for wxStdButtonInputHandler
 

-class WXDLLEXPORT wxToolBarTool;
+class WXDLLIMPEXP_FWD_CORE wxToolBarTool;

 
 // ----------------------------------------------------------------------------
 // the actions supported by this control
 
 // ----------------------------------------------------------------------------
 // the actions supported by this control


@@ -28,15 +24,15 @@ class WXDLLEXPORT wxToolBarTool;
 #define wxACTION_TOOLBAR_PRESS   wxACTION_BUTTON_PRESS
 #define wxACTION_TOOLBAR_RELEASE wxACTION_BUTTON_RELEASE
 #define wxACTION_TOOLBAR_CLICK   wxACTION_BUTTON_CLICK
 #define wxACTION_TOOLBAR_PRESS   wxACTION_BUTTON_PRESS
 #define wxACTION_TOOLBAR_RELEASE wxACTION_BUTTON_RELEASE
 #define wxACTION_TOOLBAR_CLICK   wxACTION_BUTTON_CLICK

-#define wxACTION_TOOLBAR_ENTER   _T("enter")     // highlight the tool
-#define wxACTION_TOOLBAR_LEAVE   _T("leave")     // unhighlight the tool
+#define wxACTION_TOOLBAR_ENTER   wxT("enter")     // highlight the tool
+#define wxACTION_TOOLBAR_LEAVE   wxT("leave")     // unhighlight the tool

 
 // ----------------------------------------------------------------------------
 // wxToolBar
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxToolBar
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxToolBar : public wxToolBarBase
-{    
+class WXDLLIMPEXP_CORE wxToolBar : public wxToolBarBase
+{

 public:
     // construction/destruction
     wxToolBar() { Init(); }
 public:
     // construction/destruction
     wxToolBar() { Init(); }


@@ -58,15 +54,30 @@ public:
                  const wxSize& size = wxDefaultSize,
                  long style = 0,
                  const wxString& name = wxToolBarNameStr );
                  const wxSize& size = wxDefaultSize,
                  long style = 0,
                  const wxString& name = wxToolBarNameStr );

-                 
+

     virtual ~wxToolBar();
 
     virtual bool Realize();
 
     virtual ~wxToolBar();
 
     virtual bool Realize();
 

+    virtual void SetWindowStyleFlag( long style );
+

     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
 
     virtual void SetToolShortHelp(int id, const wxString& helpString);
 
     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
 
     virtual void SetToolShortHelp(int id, const wxString& helpString);
 

+    virtual void SetMargins(int x, int y);
+    void SetMargins(const wxSize& size)
+        { SetMargins((int) size.x, (int) size.y); }
+
+    virtual bool PerformAction(const wxControlAction& action,
+                               long numArg = -1,
+                               const wxString& strArg = wxEmptyString);
+    static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
+    virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
+    {
+        return GetStdInputHandler(handlerDef);
+    }
+

 protected:
     // common part of all ctors
     void Init();
 protected:
     // common part of all ctors
     void Init();


@@ -80,19 +91,20 @@ protected:
     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
 
     virtual wxToolBarToolBase *CreateTool(int id,
     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
 
     virtual wxToolBarToolBase *CreateTool(int id,

-                                          const wxBitmap& bitmap1,
-                                          const wxBitmap& bitmap2,
-                                          bool toggle,
+                                          const wxString& label,
+                                          const wxBitmap& bmpNormal,
+                                          const wxBitmap& bmpDisabled,
+                                          wxItemKind kind,

                                           wxObject *clientData,
                                           wxObject *clientData,

-                                          const wxString& shortHelpString,
-                                          const wxString& longHelpString);
-    virtual wxToolBarToolBase *CreateTool(wxControl *control);
+                                          const wxString& shortHelp,
+                                          const wxString& longHelp);
+    virtual wxToolBarToolBase *CreateTool(wxControl *control,
+                                          const wxString& label);

 
 

-    // implement wxUniversal methods
-    virtual bool PerformAction(const wxControlAction& action,
-                               long numArg = -1,
-                               const wxString& strArg = wxEmptyString);

     virtual wxSize DoGetBestClientSize() const;
     virtual wxSize DoGetBestClientSize() const;

+    virtual void DoSetSize(int x, int y,
+                           int width, int height,
+                           int sizeFlags = wxSIZE_AUTO);

     virtual void DoDraw(wxControlRenderer *renderer);
 
     // get the bounding rect for the given tool
     virtual void DoDraw(wxControlRenderer *renderer);
 
     // get the bounding rect for the given tool


@@ -102,22 +114,13 @@ protected:
     void RefreshTool(wxToolBarToolBase *tool);
 
     // (re)calculate the tool positions, should only be called if it is
     void RefreshTool(wxToolBarToolBase *tool);
 
     // (re)calculate the tool positions, should only be called if it is

-    // necessary to do it, i.e. m_needsLayout == TRUE
+    // necessary to do it, i.e. m_needsLayout == true

     void DoLayout();
     void DoLayout();

-    
+

     // get the rect limits depending on the orientation: top/bottom for a
     // vertical toolbar, left/right for a horizontal one
     void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
 
     // get the rect limits depending on the orientation: top/bottom for a
     // vertical toolbar, left/right for a horizontal one
     void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
 

-    // wxButton actions: all these use m_toolPressed and can only be called if
-    // we have one
-    void Toggle();
-    void Press();
-    void Release();
-
-    // this one used m_toolCurrent
-    void Click();
-

 private:
     // have we calculated the positions of our tools?
     bool m_needsLayout;
 private:
     // have we calculated the positions of our tools?
     bool m_needsLayout;


@@ -128,33 +131,9 @@ private:
     // the total size of all toolbar elements
     wxCoord m_maxWidth,
             m_maxHeight;
     // the total size of all toolbar elements
     wxCoord m_maxWidth,
             m_maxHeight;

-    
-    // the tool over which the mouse currently is or NULL
-    wxToolBarToolBase *m_toolCurrent;
-
-    // the tool which currently has the mouse capture (i.e. the one user is
-    // pressing) or NULL
-    wxToolBarTool *m_toolPressed;

 
 

+private:

     DECLARE_DYNAMIC_CLASS(wxToolBar)
 };
 
     DECLARE_DYNAMIC_CLASS(wxToolBar)
 };
 

-// ----------------------------------------------------------------------------
-// wxStdToolbarInputHandler: translates SPACE and ENTER keys and the left mouse
-// click into button press/release actions
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxStdToolbarInputHandler : public wxStdButtonInputHandler
-{
-public:
-    wxStdToolbarInputHandler(wxInputHandler *inphand);
-
-    virtual bool HandleKey(wxInputConsumer *consumer,
-                           const wxKeyEvent& event,
-                           bool pressed);
-    virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
-    virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
-    virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
-};
-

 #endif // _WX_UNIV_TOOLBAR_H_
 #endif // _WX_UNIV_TOOLBAR_H_