Support using GetTextExtent() with empty string to get descent in wxOSX.

[wxWidgets.git] / include / wx / stattext.h

diff --git a/include/wx/stattext.h b/include/wx/stattext.h
index 0cf342680b8da237c2b892bb6e8f444b71f12815..fa0ea259c91ae8d63d8e7539197fe31fbd5e2327 100644 (file)
--- a/include/wx/stattext.h
+++ b/include/wx/stattext.h
@@ -1,13 +1,111 @@
-#ifndef __STATTEXTH_BASE__
-#define __STATTEXTH_BASE_
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/stattext.h
+// Purpose:     wxStaticText base header
+// Author:      Julian Smart
+// Modified by:
+// Created:
+// Copyright:   (c) Julian Smart
+// RCS-ID:      $Id$
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
 
-#if defined(__WXMSW__)
-#include "wx/msw/stattext.h"
+#ifndef _WX_STATTEXT_H_BASE_
+#define _WX_STATTEXT_H_BASE_
+
+#include "wx/defs.h"
+
+#if wxUSE_STATTEXT
+
+#include "wx/control.h"
+
+/*
+ * wxStaticText flags
+ */
+#define wxST_NO_AUTORESIZE         0x0001
+// free 0x0002 bit
+#define wxST_ELLIPSIZE_START       0x0004
+#define wxST_ELLIPSIZE_MIDDLE      0x0008
+#define wxST_ELLIPSIZE_END         0x0010
+
+extern WXDLLIMPEXP_DATA_CORE(const char) wxStaticTextNameStr[];
+
+class WXDLLIMPEXP_CORE wxStaticTextBase : public wxControl
+{
+public:
+    wxStaticTextBase() { }
+
+    // wrap the text of the control so that no line is longer than the given
+    // width (if possible: this function won't break words)
+    // This function will modify the value returned by GetLabel()!
+    void Wrap(int width);
+
+    // overridden base virtuals
+    virtual bool AcceptsFocus() const { return false; }
+    virtual bool HasTransparentBackground() { return true; }
+
+    bool IsEllipsized() const
+    {
+        return HasFlag(wxST_ELLIPSIZE_START) ||
+               HasFlag(wxST_ELLIPSIZE_MIDDLE) ||
+               HasFlag(wxST_ELLIPSIZE_END);
+    }
+
+protected:      // functions required for wxST_ELLIPSIZE_* support
+
+    // choose the default border for this window
+    virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
+
+    // Calls Ellipsize() on the real label if necessary. Unlike GetLabelText(),
+    // keeps the mnemonics instead of removing them.
+    virtual wxString GetEllipsizedLabel() const;
+
+    // Replaces parts of the string with ellipsis according to the ellipsize
+    // style. Shouldn't be called if we don't have any.
+    wxString Ellipsize(const wxString& label) const;
+
+    // to be called when updating the size of the static text:
+    // updates the label redoing ellipsization calculations
+    void UpdateLabel();
+
+    // These functions are platform-specific and must be overridden in ports
+    // which do not natively support ellipsization and they must be implemented
+    // in a way so that the m_labelOrig member of wxControl is not touched:
+
+    // returns the real label currently displayed inside the control.
+    virtual wxString DoGetLabel() const { return wxEmptyString; }
+
+    // sets the real label currently displayed inside the control,
+    // _without_ invalidating the size. The text passed is always markup-free
+    // but may contain the mnemonic characters.
+    virtual void DoSetLabel(const wxString& WXUNUSED(str)) { }
+
+private:
+    wxDECLARE_NO_COPY_CLASS(wxStaticTextBase);
+};
+
+// see wx/generic/stattextg.h for the explanation
+#ifndef wxNO_PORT_STATTEXT_INCLUDE
+
+#if defined(__WXUNIVERSAL__)
+    #include "wx/univ/stattext.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/stattext.h"
 #elif defined(__WXMOTIF__)
-#include "wx/xt/stattext.h"
+    #include "wx/motif/stattext.h"
+#elif defined(__WXGTK20__)
+    #include "wx/gtk/stattext.h"
 #elif defined(__WXGTK__)
-#include "wx/gtk/stattext.h"
+    #include "wx/gtk1/stattext.h"
+#elif defined(__WXMAC__)
+    #include "wx/osx/stattext.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/stattext.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/stattext.h"
 #endif
 
-#endif
-    // __STATTEXTH_BASE__
+#endif // !wxNO_PORT_STATTEXT_INCLUDE
+
+#endif // wxUSE_STATTEXT
+
+#endif // _WX_STATTEXT_H_BASE_