Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/univ/button.h b/include/wx/univ/button.h
index e94e152a8bd6547ff6d0c74d2c88f0c3cb2a0347..542f9579d6d39509bc776324dfc1219c2758c21c 100644 (file)
--- a/include/wx/univ/button.h
+++ b/include/wx/univ/button.h
@@ -6,17 +6,13 @@
 // Created:     15.08.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
 // Created:     15.08.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_UNIV_BUTTON_H_
 #define _WX_UNIV_BUTTON_H_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_UNIV_BUTTON_H_
 #define _WX_UNIV_BUTTON_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "univbutton.h"
-#endif
-
-class WXDLLEXPORT wxInputHandler;
+class WXDLLIMPEXP_FWD_CORE wxInputHandler;

 
 #include "wx/bitmap.h"
 
 
 #include "wx/bitmap.h"
 


@@ -24,23 +20,23 @@ class WXDLLEXPORT wxInputHandler;
 // the actions supported by this control
 // ----------------------------------------------------------------------------
 
 // the actions supported by this control
 // ----------------------------------------------------------------------------
 

-#define wxACTION_BUTTON_TOGGLE  _T("toggle")    // press/release the button
-#define wxACTION_BUTTON_PRESS   _T("press")     // press the button
-#define wxACTION_BUTTON_RELEASE _T("release")   // release the button
-#define wxACTION_BUTTON_CLICK   _T("click")     // generate button click event
+#define wxACTION_BUTTON_TOGGLE  wxT("toggle")    // press/release the button
+#define wxACTION_BUTTON_PRESS   wxT("press")     // press the button
+#define wxACTION_BUTTON_RELEASE wxT("release")   // release the button
+#define wxACTION_BUTTON_CLICK   wxT("click")     // generate button click event

 
 // ----------------------------------------------------------------------------
 // wxButton: a push button
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxButton: a push button
 // ----------------------------------------------------------------------------
 

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

 {
 public:
     wxButton() { Init(); }
     wxButton(wxWindow *parent,
              wxWindowID id,
              const wxBitmap& bitmap,
 {
 public:
     wxButton() { Init(); }
     wxButton(wxWindow *parent,
              wxWindowID id,
              const wxBitmap& bitmap,

-             const wxString& label,
+             const wxString& label = wxEmptyString,

              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,


@@ -54,7 +50,7 @@ public:
 
     wxButton(wxWindow *parent,
              wxWindowID id,
 
     wxButton(wxWindow *parent,
              wxWindowID id,

-             const wxString& label,
+             const wxString& label = wxEmptyString,

              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,


@@ -68,7 +64,7 @@ public:
 
     bool Create(wxWindow *parent,
                 wxWindowID id,
 
     bool Create(wxWindow *parent,
                 wxWindowID id,

-                const wxString& label,
+                const wxString& label = wxEmptyString,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,


@@ -82,7 +78,7 @@ public:
     bool Create(wxWindow *parent,
                 wxWindowID id,
                 const wxBitmap& bitmap,
     bool Create(wxWindow *parent,
                 wxWindowID id,
                 const wxBitmap& bitmap,

-                const wxString& label,
+                const wxString& label = wxEmptyString,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,


@@ -91,29 +87,38 @@ public:
 
     virtual ~wxButton();
 
 
     virtual ~wxButton();
 

-    virtual void SetImageLabel(const wxBitmap& bitmap);
-    virtual void SetImageMargins(wxCoord x, wxCoord y);
-    virtual void SetDefault();
+    virtual wxWindow *SetDefault();

 
     virtual bool IsPressed() const { return m_isPressed; }
     virtual bool IsDefault() const { return m_isDefault; }
 
     // wxButton actions
 
     virtual bool IsPressed() const { return m_isPressed; }
     virtual bool IsDefault() const { return m_isDefault; }
 
     // wxButton actions

-    void Toggle();
+    virtual void Toggle();

     virtual void Press();
     virtual void Release();
     virtual void Click();
 
     virtual void Press();
     virtual void Release();
     virtual void Click();
 

-protected:

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

+
+    virtual bool CanBeHighlighted() const { return true; }
+
+    static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
+    virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
+    {
+        return GetStdInputHandler(handlerDef);
+    }
+
+
+protected:

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

-    
+

     virtual bool DoDrawBackground(wxDC& dc);
     virtual void DoDraw(wxControlRenderer *renderer);
 
     virtual bool DoDrawBackground(wxDC& dc);
     virtual void DoDraw(wxControlRenderer *renderer);
 

-    virtual bool CanBeHighlighted() const { return TRUE; }
+    virtual void DoSetBitmap(const wxBitmap& bitmap, State which);
+    virtual void DoSetBitmapMargins(wxCoord x, wxCoord y);

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


@@ -131,31 +136,5 @@ private:
     DECLARE_DYNAMIC_CLASS(wxButton)
 };
 
     DECLARE_DYNAMIC_CLASS(wxButton)
 };
 

-// ----------------------------------------------------------------------------
-// wxStdButtonInputHandler: translates SPACE and ENTER keys and the left mouse
-// click into button press/release actions
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxStdButtonInputHandler : public wxStdInputHandler
-{
-public:
-    wxStdButtonInputHandler(wxInputHandler *inphand);
-
-    virtual bool HandleKey(wxInputConsumer *consumer,
-                           const wxKeyEvent& event,
-                           bool pressed);
-    virtual bool HandleMouse(wxInputConsumer *consumer,
-                             const wxMouseEvent& event);
-    virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
-    virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
-    virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
-
-private:
-    // the window (button) which has capture or NULL and the flag telling if
-    // the mouse is inside the button which captured it or not
-    wxWindow *m_winCapture;
-    bool      m_winHasMouse;
-};
-

 #endif // _WX_UNIV_BUTTON_H_
 
 #endif // _WX_UNIV_BUTTON_H_