Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk1/gauge.h b/include/wx/gtk1/gauge.h
index 49e031fea2094678178c91813c3dee6b6da9c279..41531b05d1766e54f78a1e388cd76541f1d3c6ae 100644 (file)
--- a/include/wx/gtk1/gauge.h
+++ b/include/wx/gtk1/gauge.h
@@ -1,34 +1,81 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        gauge.h
+// Name:        wx/gtk1/gauge.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
+// Licence:     wxWindows licence

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

-

 #ifndef __GTKGAUGEH__
 #define __GTKGAUGEH__
 
 #ifndef __GTKGAUGEH__
 #define __GTKGAUGEH__
 

-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"
-

 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------

-// classes
+// wxGaugeBox

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxGauge;
+class WXDLLIMPEXP_CORE wxGauge: public wxGaugeBase
+{
+public:
+    wxGauge() { Init(); }

 
 

-//-----------------------------------------------------------------------------
-// wxGaugeBox
-//-----------------------------------------------------------------------------
+    wxGauge( wxWindow *parent,
+             wxWindowID id,
+             int range,
+             const wxPoint& pos = wxDefaultPosition,
+             const wxSize& size = wxDefaultSize,
+             long style = wxGA_HORIZONTAL,
+             const wxValidator& validator = wxDefaultValidator,
+             const wxString& name = wxGaugeNameStr )
+    {
+        Init();
+
+        Create(parent, id, range, pos, size, style, validator, name);
+    }
+
+    bool Create( wxWindow *parent,
+                 wxWindowID id, int range,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = wxGA_HORIZONTAL,
+                 const wxValidator& validator = wxDefaultValidator,
+                 const wxString& name = wxGaugeNameStr );
+
+    void SetShadowWidth( int WXUNUSED(w) ) { }
+    void SetBezelFace( int WXUNUSED(w) ) { }
+    void SetRange( int r );
+    void SetValue( int pos );
+    int GetShadowWidth() const { return 0; }
+    int GetBezelFace() const { return 0; }
+    int GetRange() const;
+    int GetValue() const;

 
 

-#endif // __GTKGAUGEH__
+    bool IsVertical() const { return HasFlag(wxGA_VERTICAL); }
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+    // implementation
+    // -------------
+
+    // the max and current gauge values
+    int m_rangeMax,
+        m_gaugePos;
+
+protected:
+    // common part of all ctors
+    void Init() { m_rangeMax = m_gaugePos = 0; }
+
+    // set the gauge value to the value of m_gaugePos
+    void DoSetGauge();
+
+    virtual wxSize DoGetBestSize() const;
+
+    virtual wxVisualAttributes GetDefaultAttributes() const;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxGauge)
+};
+
+#endif
+    // __GTKGAUGEH__