Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/control.h b/include/wx/gtk/control.h
index ad8ea7abeaded40c71c74870d3a015ae079ce750..a68832acf493a6c203f42a4c21c72818f5f8eb8c 100644 (file)
--- a/include/wx/gtk/control.h
+++ b/include/wx/gtk/control.h
@@ -1,51 +1,94 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        control.h
+// Name:        wx/gtk/control.h

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // 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, Julian Smart
+// Licence:     wxWindows licence

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

+#ifndef _WX_GTK_CONTROL_H_
+#define _WX_GTK_CONTROL_H_

 
 

-#ifndef __GTKCONTROLH__
-#define __GTKCONTROLH__
+typedef struct _GtkLabel GtkLabel;
+typedef struct _GtkFrame GtkFrame;
+typedef struct _GtkEntry GtkEntry;

 
 

-#ifdef __GNUG__
-#pragma interface
+//-----------------------------------------------------------------------------
+// wxControl
+//-----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxControl : public wxControlBase
+{
+    typedef wxControlBase base_type;
+public:
+    wxControl();
+    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 wxVisualAttributes GetDefaultAttributes() const;
+#ifdef __WXGTK3__
+    virtual bool SetFont(const wxFont& font);

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/window.h"
+protected:
+    virtual wxSize DoGetBestSize() const;
+    void PostCreation(const wxSize& size);

 
 

-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+    // sets the label to the given string and also sets it for the given widget
+    void GTKSetLabelForLabel(GtkLabel *w, const wxString& label);
+#if wxUSE_MARKUP
+    void GTKSetLabelWithMarkupForLabel(GtkLabel *w, const wxString& label);
+#endif // wxUSE_MARKUP

 
 

-class wxControl;
+    // GtkFrame helpers
+    GtkWidget* GTKCreateFrame(const wxString& label);
+    void GTKSetLabelForFrame(GtkFrame *w, const wxString& label);
+    void GTKFrameApplyWidgetStyle(GtkFrame* w, GtkRcStyle* rc);
+    void GTKFrameSetMnemonicWidget(GtkFrame* w, GtkWidget* widget);

 
 

-//-----------------------------------------------------------------------------
-// wxControl
-//-----------------------------------------------------------------------------
+    // remove mnemonics ("&"s) from the label
+    static wxString GTKRemoveMnemonics(const wxString& label);

 
 

-class wxControl: public wxWindow
-{
-  DECLARE_DYNAMIC_CLASS(wxControl)
-
-  public:
-
-    wxControl(void);
-    wxControl( wxWindow *parent, wxWindowID id, 
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, 
-      const long style = 0, const wxString &name = wxPanelNameStr  );
-    virtual void Command( wxCommandEvent &event );
-    virtual void SetLabel( const wxString &label );
-    virtual wxString GetLabel(void) const;
-    
-    wxString   m_label;
+    // converts wx label to GTK+ label, i.e. basically replace "&"s with "_"s
+    static wxString GTKConvertMnemonics(const wxString &label);
+
+    // converts wx label to GTK+ labels preserving Pango markup
+    static wxString GTKConvertMnemonicsWithMarkup(const wxString& label);
+
+    // These are used by GetDefaultAttributes
+    static wxVisualAttributes
+        GetDefaultAttributesFromGTKWidget(GtkWidget* widget,
+                                          bool useBase = false,
+                                          int state = 0);
+
+    // Widgets that use the style->base colour for the BG colour should
+    // override this and return true.
+    virtual bool UseGTKStyleBase() const { return false; }
+
+    // Fix sensitivity due to bug in GTK+ < 2.14
+    void GTKFixSensitivity(bool onlyIfUnderMouse = true);
+
+    // Ask GTK+ for preferred size. Use it after setting the font.
+    wxSize GTKGetPreferredSize(GtkWidget* widget) const;
+
+    // Inner margins in a GtkEntry
+    wxPoint GTKGetEntryMargins(GtkEntry* entry) const;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxControl)

 };
 
 };
 

-#endif // __GTKCONTROLH__
+#endif // _WX_GTK_CONTROL_H_