Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / generic / statusbr.h

diff --git a/include/wx/generic/statusbr.h b/include/wx/generic/statusbr.h
index e7aca327b121502890a9e9f3470aacc38a49d835..a27eaf6dad9c2b94938b3d370260845b2e4dada9 100644 (file)
--- a/include/wx/generic/statusbr.h
+++ b/include/wx/generic/statusbr.h
@@ -17,31 +17,21 @@
 #if wxUSE_STATUSBAR
 
 #include "wx/pen.h"
-#include "wx/font.h"
-#include "wx/statusbr.h"
 #include "wx/arrstr.h"
 
-extern WXDLLEXPORT_DATA(const wxChar) wxPanelNameStr[];
 
-class WXDLLEXPORT wxStatusBarGeneric : public wxStatusBarBase
+// ----------------------------------------------------------------------------
+// wxStatusBarGeneric
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxStatusBarGeneric : public wxStatusBarBase
 {
 public:
     wxStatusBarGeneric() { Init(); }
     wxStatusBarGeneric(wxWindow *parent,
-                       wxWindowID winid,
-                       const wxPoint& pos = wxDefaultPosition,
-                       const wxSize& size = wxDefaultSize,
-                       long style = wxFULL_REPAINT_ON_RESIZE,
-                       const wxString& name = wxPanelNameStr)
-    {
-        Init();
-
-        Create(parent, winid, pos, size, style, name);
-    }
-    wxStatusBarGeneric(wxWindow *parent,
-                       wxWindowID winid,
-                       long style,
-                       const wxString& name = wxPanelNameStr)
+                       wxWindowID winid = wxID_ANY,
+                       long style = wxSTB_DEFAULT_STYLE,
+                       const wxString& name = wxStatusBarNameStr)
     {
         Init();
 
@@ -50,77 +40,76 @@ public:
 
     virtual ~wxStatusBarGeneric();
 
-    bool Create(wxWindow *parent, wxWindowID winid,
-                const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
-                const wxSize& WXUNUSED(size) = wxDefaultSize,
-                long style = wxFULL_REPAINT_ON_RESIZE,
-                const wxString& name = wxPanelNameStr)
-    {
-        return Create(parent, winid, style, name);
-    }
+    bool Create(wxWindow *parent, wxWindowID winid = wxID_ANY,
+                long style = wxSTB_DEFAULT_STYLE,
+                const wxString& name = wxStatusBarNameStr);
 
-    bool Create(wxWindow *parent, wxWindowID winid,
-                long style,
-                const wxString& name = wxPanelNameStr);
-
-    // Create status line
-    virtual void SetFieldsCount(int number = 1,
-                                const int *widths = (const int *) NULL);
-
-    // Set status line text
-    virtual void SetStatusText(const wxString& text, int number = 0);
-    virtual wxString GetStatusText(int number = 0) const;
-
-    // Set status line widths
+    // implement base class methods
     virtual void SetStatusWidths(int n, const int widths_field[]);
-
-    // Get the position and size of the field's internal bounding rectangle
     virtual bool GetFieldRect(int i, wxRect& rect) const;
-
-    // sets the minimal vertical size of the status bar
     virtual void SetMinHeight(int height);
 
     virtual int GetBorderX() const { return m_borderX; }
     virtual int GetBorderY() const { return m_borderY; }
 
-    ////////////////////////////////////////////////////////////////////////
-    // Implementation
 
-    virtual void DrawFieldText(wxDC& dc, int i);
-    virtual void DrawField(wxDC& dc, int i);
+    // implementation only (not part of wxStatusBar public API):
 
-    void SetBorderX(int x);
-    void SetBorderY(int y);
+    int GetFieldFromPoint(const wxPoint& point) const;
 
+protected:
+    virtual void DoUpdateStatusText(int number);
+
+    // event handlers
     void OnPaint(wxPaintEvent& event);
+    void OnSize(wxSizeEvent& event);
 
     void OnLeftDown(wxMouseEvent& event);
     void OnRightDown(wxMouseEvent& event);
 
-    virtual void InitColours();
-
     // Responds to colour changes
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
 protected:
+
+    virtual void DrawFieldText(wxDC& dc, const wxRect& rc, int i, int textHeight);
+    virtual void DrawField(wxDC& dc, int i, int textHeight);
+
+    void SetBorderX(int x);
+    void SetBorderY(int y);
+
+    virtual void InitColours();
+
+    // true if the status bar shows the size grip: for this it must have
+    // wxSTB_SIZEGRIP style and the window it is attached to must be resizable
+    // and not maximized
+    bool ShowsSizeGrip() const;
+
+    // returns the position and the size of the size grip
+    wxRect GetSizeGripRect() const;
+
     // common part of all ctors
     void Init();
 
-    wxArrayString     m_statusStrings;
+    // the last known size, fields widths must be updated whenever it's out of
+    // date
+    wxSize m_lastClientSize;
 
-    // the last known width of the client rect (used to rebuild cache)
-    int               m_lastClientWidth;
-    // the widths of the status bar panes in pixels
+    // the absolute widths of the status bar panes in pixels
     wxArrayInt        m_widthsAbs;
 
     int               m_borderX;
     int               m_borderY;
+
     wxPen             m_mediumShadowPen;
     wxPen             m_hilightPen;
 
     virtual wxSize DoGetBestSize() const;
 
 private:
+    // Update m_lastClientSize and m_widthsAbs from the current size.
+    void DoUpdateFieldWidths();
+
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxStatusBarGeneric)
 };