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 a395a617ca8e34a25264092482778af38240e64f..2c0779aefffbc3a4c1ec6912f2768d0a49dbc5c3 100644 (file)
--- a/include/wx/gtk/button.h
+++ b/include/wx/gtk/button.h
@@ -1,40 +1,23 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/gtk/button.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/gtk/button.h

-// Purpose:
+// Purpose:     wxGTK wxButton class declaration

 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __GTKBUTTONH__
-#define __GTKBUTTONH__
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class WXDLLIMPEXP_CORE wxButton;
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
-
-extern WXDLLIMPEXP_CORE const wxChar wxButtonNameStr[];
+#ifndef _WX_GTK_BUTTON_H_
+#define _WX_GTK_BUTTON_H_

 
 //-----------------------------------------------------------------------------
 // wxButton
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxButton
 //-----------------------------------------------------------------------------
 

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

 {
 public:
 {
 public:

-    wxButton();
+    wxButton() {}

     wxButton(wxWindow *parent, wxWindowID id,
            const wxString& label = wxEmptyString,
            const wxPoint& pos = wxDefaultPosition,
     wxButton(wxWindow *parent, wxWindowID id,
            const wxString& label = wxEmptyString,
            const wxPoint& pos = wxDefaultPosition,


@@ -45,8 +28,6 @@ public:
         Create(parent, id, label, pos, size, style, validator, name);
     }
 
         Create(parent, id, label, pos, size, style, validator, name);
     }
 

-    virtual ~wxButton();
-

     bool Create(wxWindow *parent, wxWindowID id,
            const wxString& label = wxEmptyString,
            const wxPoint& pos = wxDefaultPosition,
     bool Create(wxWindow *parent, wxWindowID id,
            const wxString& label = wxEmptyString,
            const wxPoint& pos = wxDefaultPosition,


@@ -54,31 +35,40 @@ public:
            const wxValidator& validator = wxDefaultValidator,
            const wxString& name = wxButtonNameStr);
 
            const wxValidator& validator = wxDefaultValidator,
            const wxString& name = wxButtonNameStr);
 

-    virtual void SetDefault();
+    virtual wxWindow *SetDefault();

     virtual void SetLabel( const wxString &label );
     virtual void SetLabel( const wxString &label );

-    virtual bool Enable( bool enable = TRUE );

 
     // implementation
     // --------------
 
 
     // implementation
     // --------------
 

-    bool IsOwnGtkWindow( GdkWindow *window );
-
-    // Since this wxButton doesn't derive from wxButtonBase (why?) we need
-    // to override this here too...
-    virtual bool ShouldInheritColours() const { return false; }
-    

     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     // 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); }
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     // 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); }
 

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

 protected:
     virtual wxSize DoGetBestSize() const;
 protected:
     virtual wxSize DoGetBestSize() const;

-    void DoApplyWidgetStyle(GtkRcStyle *style);
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+
+#if wxUSE_MARKUP
+    virtual bool DoSetLabelMarkup(const wxString& markup);
+#endif // wxUSE_MARKUP

 
 private:
 
 private:

+    typedef wxButtonBase base_type;
+
+    // Return the GtkLabel used by this button.
+    GtkLabel *GTKGetLabel() const;
+

     DECLARE_DYNAMIC_CLASS(wxButton)
 };
 
     DECLARE_DYNAMIC_CLASS(wxButton)
 };
 

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