Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / gtk1 / control.h

diff --git a/include/wx/gtk1/control.h b/include/wx/gtk1/control.h
index 5ae7c44043a9344245116db3befa4c6bba48dee0..8815a7e69e706fee5853cd0abe7f6373e4b4dc83 100644 (file)
--- a/include/wx/gtk1/control.h
+++ b/include/wx/gtk1/control.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        control.h
+// Name:        wx/gtk1/control.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -10,10 +10,6 @@
 #ifndef __GTKCONTROLH__
 #define __GTKCONTROLH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/list.h"
@@ -23,32 +19,85 @@
 // classes
 //-----------------------------------------------------------------------------
 
-class wxControl;
+class WXDLLIMPEXP_FWD_CORE wxControl;
+
+typedef struct _GtkLabel GtkLabel;
+typedef struct _GtkFrame GtkFrame;
 
 //-----------------------------------------------------------------------------
 // wxControl
 //-----------------------------------------------------------------------------
 
-class wxControl : public wxControlBase
+// C-linkage function pointer types for GetDefaultAttributesFromGTKWidget
+extern "C" {
+    typedef GtkWidget* (*wxGtkWidgetNew_t)(void);
+    typedef GtkWidget* (*wxGtkWidgetNewFromStr_t)(const char*);
+    typedef GtkWidget* (*wxGtkWidgetNewFromAdj_t)(GtkAdjustment*);
+}
+
+class WXDLLIMPEXP_CORE wxControl : public wxControlBase
 {
 public:
     wxControl();
-    wxControl( wxWindow *parent,
-               wxWindowID id,
-               const wxPoint &pos = wxDefaultPosition,
-               const wxSize &size = wxDefaultSize,
-               long style = 0,
-               const wxString &name = wxPanelNameStr );
-
-    // this function will filter out '&' characters and will put the accelerator
-    // char (the one immediately after '&') into m_chAccel (TODO not yet)
+    wxControl(wxWindow *parent, wxWindowID id,
+             const wxPoint& pos = wxDefaultPosition,
+             const wxSize& size = wxDefaultSize, long style = 0,
+             const wxValidator& validator = wxDefaultValidator,
+             const wxString& name = wxControlNameStr)
+    {
+        Create(parent, id, pos, size, style, validator, name);
+    }
+
+    bool Create(wxWindow *parent, wxWindowID id,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize, long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxControlNameStr);
+
     virtual void SetLabel( const wxString &label );
     virtual wxString GetLabel() const;
 
+    virtual wxVisualAttributes GetDefaultAttributes() const;
+
 protected:
-    wxString   m_label;
-    char       m_chAccel;  // enabled to avoid breaking binary compatibility later on
-    
+    virtual wxSize DoGetBestSize() const;
+    void PostCreation(const wxSize& size);
+
+    // sets the label to the given string and also sets it for the given widget
+    void GTKSetLabelForLabel(GtkLabel *w, const wxString& label);
+
+    // as GTKSetLabelForLabel() but for a GtkFrame widget
+    void GTKSetLabelForFrame(GtkFrame *w, const wxString& label);
+
+    // remove mnemonics ("&"s) from the label
+    static wxString GTKRemoveMnemonics(const wxString& label);
+
+    // These are used by GetDefaultAttributes
+    static wxVisualAttributes
+        GetDefaultAttributesFromGTKWidget(GtkWidget* widget,
+                                          bool useBase = false,
+                                          int state = -1);
+    static wxVisualAttributes
+        GetDefaultAttributesFromGTKWidget(wxGtkWidgetNew_t,
+                                          bool useBase = false,
+                                          int state = -1);
+    static wxVisualAttributes
+        GetDefaultAttributesFromGTKWidget(wxGtkWidgetNewFromStr_t,
+                                          bool useBase = false,
+                                          int state = -1);
+
+    static wxVisualAttributes
+        GetDefaultAttributesFromGTKWidget(wxGtkWidgetNewFromAdj_t,
+                                          bool useBase = false,
+                                          int state = -1);
+
+    // Widgets that use the style->base colour for the BG colour should
+    // override this and return true.
+    virtual bool UseGTKStyleBase() const { return false; }
+
+    // this field contains the label in wx format, i.e. with "&" mnemonics
+    wxString m_label;
+
 private:
     DECLARE_DYNAMIC_CLASS(wxControl)
 };