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 d4755612fa1744ba57d25c598c158336cfe58bc8..1f5ad27c9b72329db5da84eb9c1e1e44d989314f 100644 (file)
--- a/include/wx/msw/button.h
+++ b/include/wx/msw/button.h
@@ -1,56 +1,104 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        button.h
+// Name:        wx/msw/button.h
 // Purpose:     wxButton class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __BUTTONH__
-#define __BUTTONH__
+#ifndef _WX_BUTTON_H_
+#define _WX_BUTTON_H_
 
-#ifdef __GNUG__
-#pragma interface "button.h"
-#endif
+// ----------------------------------------------------------------------------
+// Pushbutton
+// ----------------------------------------------------------------------------
 
-#include "wx/control.h"
-#include "wx/gdicmn.h"
+class WXDLLIMPEXP_CORE wxButton : public wxButtonBase
+{
+public:
+    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;
 
-WXDLLEXPORT_DATA(extern const char*) wxButtonNameStr;
+        Create(parent, id, label, pos, size, style, validator, name);
+    }
 
-// Pushbutton
-class WXDLLEXPORT wxButton: public wxControl
-{
-  DECLARE_DYNAMIC_CLASS(wxButton)
- public:
-  inline wxButton(void) {}
-  inline 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)
-  {
-      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);
-
-  virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-  virtual void SetDefault(void);
-  virtual void SetLabel(const wxString& label);
-  virtual wxString GetLabel(void) const ;
-  virtual void Command(wxCommandEvent& event);
-  virtual bool MSWCommand(WXUINT param, WXWORD id);
-  virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-                       WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+    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 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);
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    virtual bool MSWCommand(WXUINT param, WXWORD id);
+
+    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:
+    // send a notification event, return true if processed
+    bool SendClickEvent();
+
+    // 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
-    // __BUTTONH__
+#endif // _WX_BUTTON_H_