Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/button.h b/include/wx/gtk/button.h
index 6932755578dde8e3e353b605081cb26f2594b661..2c0779aefffbc3a4c1ec6912f2768d0a49dbc5c3 100644 (file)
--- a/include/wx/gtk/button.h
+++ b/include/wx/gtk/button.h
@@ -1,58 +1,74 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        button.h
-// Purpose:
+// Name:        wx/gtk/button.h
+// Purpose:     wxGTK wxButton class declaration

 // Author:      Robert Roebling
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_BUTTON_H_
+#define _WX_GTK_BUTTON_H_

 
 

-#ifndef __GTKBUTTONH__
-#define __GTKBUTTONH__
+//-----------------------------------------------------------------------------
+// wxButton
+//-----------------------------------------------------------------------------

 
 

-#ifdef __GNUG__
-#pragma interface
-#endif
+class WXDLLIMPEXP_CORE wxButton : public wxButtonBase
+{
+public:
+    wxButton() {}
+    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)
+    {
+        Create(parent, id, label, pos, size, style, validator, name);
+    }

 
 

-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"
+    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);

 
 

-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+    virtual wxWindow *SetDefault();
+    virtual void SetLabel( const wxString &label );

 
 

-class wxButton;
+    // implementation
+    // --------------

 
 

-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

 
 

-extern const char *wxButtonNameStr;
+    // helper to allow access to protected member from GTK callback
+    void MoveWindow(int x, int y, int width, int height) { DoMoveWindow(x, y, width, height); }

 
 

-//-----------------------------------------------------------------------------
-// wxButton
-//-----------------------------------------------------------------------------
+    // called from GTK callbacks: they update the button state and call
+    // GTKUpdateBitmap()
+    void GTKMouseEnters();
+    void GTKMouseLeaves();
+    void GTKPressed();
+    void GTKReleased();

 
 

-class wxButton: public wxControl
-{
-  DECLARE_DYNAMIC_CLASS(wxButton)
-
-  public:
-
-    wxButton(void);
-    wxButton( wxWindow *parent, wxWindowID id, const wxString &label,
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, 
-      long style = 0, const wxString &name = wxButtonNameStr  );
-    bool Create(  wxWindow *parent, wxWindowID id, const wxString &label,
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, 
-      long style = 0, const wxString &name = wxButtonNameStr  );
-    void SetDefault(void);
-    void SetLabel( const wxString &label );
-    wxString GetLabel(void) const;
+protected:
+    virtual wxSize DoGetBestSize() const;
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+
+#if wxUSE_MARKUP
+    virtual bool DoSetLabelMarkup(const wxString& markup);
+#endif // wxUSE_MARKUP
+
+private:
+    typedef wxButtonBase base_type;
+
+    // Return the GtkLabel used by this button.
+    GtkLabel *GTKGetLabel() const;
+
+    DECLARE_DYNAMIC_CLASS(wxButton)

 };
 
 };
 

-#endif // __GTKBUTTONH__
+#endif // _WX_GTK_BUTTON_H_