Bring AddActionTrigger() doc string up to date with the interface

[wxWidgets.git] / include / wx / msw / button.h

diff --git a/include/wx/msw/button.h b/include/wx/msw/button.h
index 4d78ab2d4013e3290bcb529e17465c1828fa82e4..1f5ad27c9b72329db5da84eb9c1e1e44d989314f 100644 (file)
--- a/include/wx/msw/button.h
+++ b/include/wx/msw/button.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        button.h
+// Name:        wx/msw/button.h

 // Purpose:     wxButton class
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxButton class
 // Author:      Julian Smart
 // Modified by:


@@ -12,59 +12,93 @@
 #ifndef _WX_BUTTON_H_
 #define _WX_BUTTON_H_
 
 #ifndef _WX_BUTTON_H_
 #define _WX_BUTTON_H_
 

-#ifdef __GNUG__
-#pragma interface "button.h"
-#endif
-
-#include "wx/control.h"
-
-WXDLLEXPORT_DATA(extern const wxChar*) wxButtonNameStr;
-

 // ----------------------------------------------------------------------------
 // Pushbutton
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Pushbutton
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxButton : public wxControl
+class WXDLLIMPEXP_CORE wxButton : public wxButtonBase

 {
 {

-DECLARE_DYNAMIC_CLASS(wxButton)
-

 public:
 public:

-    wxButton() { }
-    wxButton(wxWindow *parent, wxWindowID id, const wxString& label,
-            const wxPoint& pos = wxDefaultPosition,
-            const wxSize& size = wxDefaultSize, long style = 0,
-            const wxValidator& validator = wxDefaultValidator,
-            const wxString& name = wxButtonNameStr)
+    wxButton() { m_imageData = NULL; }
+    wxButton(wxWindow *parent,
+             wxWindowID id,
+             const wxString& label = wxEmptyString,
+             const wxPoint& pos = wxDefaultPosition,
+             const wxSize& size = wxDefaultSize,
+             long style = 0,
+             const wxValidator& validator = wxDefaultValidator,
+             const wxString& name = wxButtonNameStr)

     {
     {

+        m_imageData = NULL;
+

         Create(parent, id, label, pos, size, style, validator, name);
     }
 
         Create(parent, id, label, pos, size, style, validator, name);
     }
 

-    bool Create(wxWindow *parent, wxWindowID id, const wxString& label,
-            const wxPoint& pos = wxDefaultPosition,
-            const wxSize& size = wxDefaultSize, long style = 0,
-            const wxValidator& validator = wxDefaultValidator,
-            const wxString& name = wxButtonNameStr);
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& label = wxEmptyString,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxButtonNameStr);

 
     virtual ~wxButton();
 
 
     virtual ~wxButton();
 

-    virtual void SetDefault();
+    virtual wxWindow *SetDefault();
+
+    // overridden base class methods
+    virtual void SetLabel(const wxString& label);
+    virtual bool SetBackgroundColour(const wxColour &colour);
+    virtual bool SetForegroundColour(const wxColour &colour);

 
     // implementation from now on
     virtual void Command(wxCommandEvent& event);
 
     // implementation from now on
     virtual void Command(wxCommandEvent& event);

+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

     virtual bool MSWCommand(WXUINT param, WXWORD id);
     virtual bool MSWCommand(WXUINT param, WXWORD id);

-    virtual WXHBRUSH OnCtlColor(WXHDC pDC,
-                                WXHWND pWnd,
-                                WXUINT nCtlColor,
-                                WXUINT message,
-                                WXWPARAM wParam,
-                                WXLPARAM lParam);
+
+    virtual bool MSWOnDraw(WXDRAWITEMSTRUCT *item);
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+    // returns true if the platform should explicitly apply a theme border
+    virtual bool CanApplyThemeBorder() const { return false; }
+
+private:
+    void MakeOwnerDrawn();

 
 protected:
 
 protected:

-    // send a notification event, return TRUE if processed
+    // send a notification event, return true if processed

     bool SendClickEvent();
 
     bool SendClickEvent();
 

-    virtual wxSize DoGetBestSize();
+    // default button handling
+    void SetTmpDefault();
+    void UnsetTmpDefault();
+
+    // set or unset BS_DEFPUSHBUTTON style
+    static void SetDefaultStyle(wxButton *btn, bool on);
+
+    // usually overridden base class virtuals
+    virtual wxSize DoGetBestSize() const;
+
+    virtual bool DoGetAuthNeeded() const;
+    virtual void DoSetAuthNeeded(bool show);
+    virtual wxBitmap DoGetBitmap(State which) const;
+    virtual void DoSetBitmap(const wxBitmap& bitmap, State which);
+    virtual wxSize DoGetBitmapMargins() const;
+    virtual void DoSetBitmapMargins(wxCoord x, wxCoord y);
+    virtual void DoSetBitmapPosition(wxDirection dir);
+
+    // Increases the passed in size if necessary to account for the
+    // button image, if any
+    void AdjustForBitmapSize(wxSize& size) const;
+
+    class wxButtonImageData *m_imageData;
+
+    // true if the UAC symbol is shown
+    bool m_authNeeded;
+
+private:
+    wxDECLARE_DYNAMIC_CLASS_NO_COPY(wxButton);

 };
 
 };
 

-#endif
-    // _WX_BUTTON_H_
+#endif // _WX_BUTTON_H_