]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/ctrlcmn.cpp
make methods available to all ports
[wxWidgets.git] / src / common / ctrlcmn.cpp
index 3b32359f668223c26b6a322669c4d4d254c96dc9..5130048c9dfb8d900c72f79e57412c0e18b61a38 100644 (file)
     #include "wx/statbmp.h"
     #include "wx/bitmap.h"
     #include "wx/utils.h"       // for wxStripMenuCodes()
+    #include "wx/settings.h"
 #endif
 
+#include "wx/private/markupparser.h"
+
 const char wxControlNameStr[] = "control";
 
 // ============================================================================
@@ -87,13 +90,6 @@ bool wxControlBase::CreateControl(wxWindowBase *parent,
     return true;
 }
 
-/* static */
-wxString wxControlBase::GetLabelText(const wxString& label)
-{
-    // we don't want strip the TABs here, just the mnemonics
-    return wxStripMenuCodes(label, wxStrip_Mnemonics);
-}
-
 void wxControlBase::Command(wxCommandEvent& event)
 {
     (void)GetEventHandler()->ProcessEvent(event);
@@ -101,7 +97,7 @@ void wxControlBase::Command(wxCommandEvent& event)
 
 void wxControlBase::InitCommandEvent(wxCommandEvent& event) const
 {
-    event.SetEventObject((wxControlBase *)this);    // const_cast
+    event.SetEventObject(const_cast<wxControlBase *>(this));
 
     // event.SetId(GetId()); -- this is usuall done in the event ctor
 
@@ -153,9 +149,23 @@ void wxControlBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
 #endif // wxUSE_RADIOBTN
 }
 
+wxSize wxControlBase::DoGetSizeFromTextSize(int WXUNUSED(xlen),
+                                            int WXUNUSED(ylen)) const
+{
+    return wxSize(-1, -1);
+}
+
+/* static */
+wxString wxControlBase::GetLabelText(const wxString& label)
+{
+    // we don't want strip the TABs here, just the mnemonics
+    return wxStripMenuCodes(label, wxStrip_Mnemonics);
+}
+
 /* static */
 wxString wxControlBase::RemoveMnemonics(const wxString& str)
 {
+    // we don't want strip the TABs here, just the mnemonics
     return wxStripMenuCodes(str, wxStrip_Mnemonics);
 }
 
@@ -173,7 +183,7 @@ int wxControlBase::FindAccelIndex(const wxString& label, wxString *labelOnly)
     // the character following MNEMONIC_PREFIX is the accelerator for this
     // control unless it is MNEMONIC_PREFIX too - this allows to insert
     // literal MNEMONIC_PREFIX chars into the label
-    static const wxChar MNEMONIC_PREFIX = _T('&');
+    static const wxChar MNEMONIC_PREFIX = wxT('&');
 
     if ( labelOnly )
     {
@@ -198,7 +208,7 @@ int wxControlBase::FindAccelIndex(const wxString& label, wxString *labelOnly)
                 }
                 else
                 {
-                    wxFAIL_MSG(_T("duplicate accel char in control label"));
+                    wxFAIL_MSG(wxT("duplicate accel char in control label"));
                 }
             }
         }
@@ -217,150 +227,293 @@ wxBorder wxControlBase::GetDefaultBorder() const
     return wxBORDER_THEME;
 }
 
+/* static */ wxVisualAttributes
+wxControlBase::GetCompositeControlsDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    wxVisualAttributes attrs;
+    attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
+    attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
+    attrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
+
+    return attrs;
+}
+
+// ----------------------------------------------------------------------------
+// wxControl markup support
+// ----------------------------------------------------------------------------
+
+#if wxUSE_MARKUP
+
+/* static */
+wxString wxControlBase::RemoveMarkup(const wxString& markup)
+{
+    return wxMarkupParser::Strip(markup);
+}
+
+bool wxControlBase::DoSetLabelMarkup(const wxString& markup)
+{
+    const wxString label = RemoveMarkup(markup);
+    if ( label.empty() && !markup.empty() )
+        return false;
+
+    SetLabel(label);
+
+    return true;
+}
+
+#endif // wxUSE_MARKUP
+
 // ----------------------------------------------------------------------------
 // wxControlBase - ellipsization code
 // ----------------------------------------------------------------------------
 
-#define wxELLIPSE_REPLACEMENT       wxT("...")
+#define wxELLIPSE_REPLACEMENT       wxS("...")
+
+namespace
+{
+
+struct EllipsizeCalculator
+{
+    EllipsizeCalculator(const wxString& s, const wxDC& dc,
+                        int maxFinalWidthPx, int replacementWidthPx)
+        : 
+          m_initialCharToRemove(0),
+          m_nCharsToRemove(0),
+          m_outputNeedsUpdate(true),
+          m_str(s),
+          m_dc(dc),
+          m_maxFinalWidthPx(maxFinalWidthPx),
+          m_replacementWidthPx(replacementWidthPx)
+    {
+        m_isOk = dc.GetPartialTextExtents(s, m_charOffsetsPx);
+        wxASSERT( m_charOffsetsPx.GetCount() == s.length() );
+    }
+
+    bool IsOk() const { return m_isOk; }
+
+    bool EllipsizationNotNeeded() const
+    {
+        // NOTE: charOffsetsPx[n] is the width in pixels of the first n characters (with the last one INCLUDED)
+        //       thus charOffsetsPx[len-1] is the total width of the string
+        return m_charOffsetsPx.Last() <= m_maxFinalWidthPx;
+    }
+
+    void Init(size_t initialCharToRemove, size_t nCharsToRemove)
+    {
+        m_initialCharToRemove = initialCharToRemove;
+        m_nCharsToRemove = nCharsToRemove;
+    }
+
+    void RemoveFromEnd()
+    {
+        m_nCharsToRemove++;
+    }
+
+    void RemoveFromStart()
+    {
+        m_initialCharToRemove--;
+        m_nCharsToRemove++;
+    }
+
+    size_t GetFirstRemoved() const { return m_initialCharToRemove; }
+    size_t GetLastRemoved() const { return m_initialCharToRemove + m_nCharsToRemove - 1; }
+
+    const wxString& GetEllipsizedText()
+    {
+        if ( m_outputNeedsUpdate )
+        {
+            wxASSERT(m_initialCharToRemove <= m_str.length() - 1);  // see valid range for initialCharToRemove above
+            wxASSERT(m_nCharsToRemove >= 1 && m_nCharsToRemove <= m_str.length() - m_initialCharToRemove);  // see valid range for nCharsToRemove above
+
+            // erase m_nCharsToRemove characters after m_initialCharToRemove (included);
+            // e.g. if we have the string "foobar" (len = 6)
+            //                               ^
+            //                               \--- m_initialCharToRemove = 2
+            //      and m_nCharsToRemove = 2, then we get "foar"
+            m_output = m_str;
+            m_output.replace(m_initialCharToRemove, m_nCharsToRemove, wxELLIPSE_REPLACEMENT);
+        }
+
+        return m_output;
+    }
+
+    bool IsShortEnough()
+    {
+        if ( m_nCharsToRemove == m_str.length() )
+            return true; // that's the best we could do
+
+        // Width calculation using partial extents is just an inaccurate
+        // estimate: partial extents have sub-pixel precision and are rounded
+        // by GetPartialTextExtents(); replacing part of the string with "..."
+        // may change them too thanks to changes in ligatures, kerning etc.
+        //
+        // The correct algorithm would be to call GetTextExtent() in every step
+        // of ellipsization, but that would be too expensive, especially when
+        // the difference is just a few pixels. So we use partial extents to
+        // estimate string width and only verify it with GetTextExtent() when
+        // it looks good.
+
+        int estimatedWidth = m_replacementWidthPx; // length of "..."
+
+        // length of text before the removed part:
+        if ( m_initialCharToRemove > 0 )
+            estimatedWidth += m_charOffsetsPx[m_initialCharToRemove - 1];
+
+        // length of text after the removed part:
+
+        if ( GetLastRemoved() < m_str.length() )
+           estimatedWidth += m_charOffsetsPx.Last() - m_charOffsetsPx[GetLastRemoved()];
+
+        if ( estimatedWidth > m_maxFinalWidthPx )
+            return false;
+
+        return m_dc.GetTextExtent(GetEllipsizedText()).GetWidth() <= m_maxFinalWidthPx;
+    }
+
+    // calculation state:
+
+    // REMEMBER: indexes inside the string have a valid range of [0;len-1] if not otherwise constrained
+    //           lengths/counts of characters (e.g. nCharsToRemove) have a
+    //           valid range of [0;len] if not otherwise constrained
+    // NOTE: since this point we know we have for sure a non-empty string from which we need
+    //       to remove _at least_ one character (thus nCharsToRemove below is constrained to be >= 1)
+
+    // index of first character to erase, valid range is [0;len-1]:
+    size_t m_initialCharToRemove;
+    // how many chars do we need to erase? valid range is [0;len-m_initialCharToRemove]
+    size_t m_nCharsToRemove;
+
+    wxString m_output;
+    bool m_outputNeedsUpdate;
+
+    // inputs:
+    wxString m_str;
+    const wxDC& m_dc;
+    int m_maxFinalWidthPx;
+    int m_replacementWidthPx;
+    wxArrayInt m_charOffsetsPx;
+
+    bool m_isOk;
+};
+
+} // anonymous namespace
 
 /* static and protected */
 wxString wxControlBase::DoEllipsizeSingleLine(const wxString& curLine, const wxDC& dc,
-                                              wxEllipsizeMode mode, int maxFinalWidth,
-                                              int replacementWidth, int marginWidth)
+                                              wxEllipsizeMode mode, int maxFinalWidthPx,
+                                              int replacementWidthPx)
 {
-    wxASSERT_MSG(replacementWidth > 0 && marginWidth > 0,
-                 "Invalid parameters");
-    wxASSERT_MSG(!curLine.Contains('\n'),
-                 "Use Ellipsize() instead!");
+    wxASSERT_MSG(replacementWidthPx > 0, "Invalid parameters");
+    wxASSERT_LEVEL_2_MSG(!curLine.Contains('\n'),
+                         "Use Ellipsize() instead!");
+
+    wxASSERT_MSG( mode != wxELLIPSIZE_NONE, "shouldn't be called at all then" );
 
     // NOTE: this function assumes that any mnemonic/tab character has already
     //       been handled if it was necessary to handle them (see Ellipsize())
 
-    if (maxFinalWidth <= 0)
+    if (maxFinalWidthPx <= 0)
         return wxEmptyString;
 
-    wxArrayInt charOffsets;
     size_t len = curLine.length();
-    if (len == 0 ||
-        !dc.GetPartialTextExtents(curLine, charOffsets))
+    if (len <= 1 )
         return curLine;
 
-    wxASSERT(charOffsets.GetCount() == len);
+    EllipsizeCalculator calc(curLine, dc, maxFinalWidthPx, replacementWidthPx);
 
-    size_t totalWidth = charOffsets.Last();
-    if ( totalWidth <= (size_t)maxFinalWidth )
-        return curLine;     // we don't need to do any ellipsization!
-
-    int excessPixels = totalWidth - maxFinalWidth +
-                       replacementWidth +
-                       marginWidth;     // security margin (NEEDED!)
+    if ( !calc.IsOk() )
+        return curLine;
 
-    // remove characters in excess
-    size_t initialChar,     // index of first char to erase
-           nChars;          // how many chars do we need to erase?
+    if ( calc.EllipsizationNotNeeded() )
+        return curLine;
 
+    // let's compute the range of characters to remove depending on the ellipsization mode:
     switch (mode)
     {
-    case wxELLIPSIZE_START:
-        initialChar = 0;
-        for (nChars=0;
-             nChars < len && charOffsets[nChars] < excessPixels;
-             nChars++)
-            ;
-        break;
+        case wxELLIPSIZE_START:
+            {
+                calc.Init(0, 1);
+                while ( !calc.IsShortEnough() )
+                    calc.RemoveFromEnd();
 
-    case wxELLIPSIZE_MIDDLE:
-        {
-            // the start & end of the removed span of chars
-            initialChar = len/2;
-            size_t endChar = len/2;
+                // always show at least one character of the string:
+                if ( calc.m_nCharsToRemove == len )
+                    return wxString(wxELLIPSE_REPLACEMENT) + curLine[len-1];
 
-            int removed = 0;
-            for ( ; removed < excessPixels; )
+                break;
+            }
+
+        case wxELLIPSIZE_MIDDLE:
             {
-                if (initialChar > 0)
-                {
-                    // width of the initialChar-th character
-                    int width = charOffsets[initialChar] -
-                                charOffsets[initialChar-1];
+                // NOTE: the following piece of code works also when len == 1
 
-                    // remove the initialChar-th character
-                    removed += width;
-                    initialChar--;
-                }
+                // start the removal process from the middle of the string
+                // i.e. separe the string in three parts:
+                // - the first one to preserve, valid range [0;initialCharToRemove-1] or the empty range if initialCharToRemove==0
+                // - the second one to remove, valid range [initialCharToRemove;endCharToRemove]
+                // - the third one to preserve, valid range [endCharToRemove+1;len-1] or the empty range if endCharToRemove==len-1
+                // NOTE: empty range != range [0;0] since the range [0;0] contains 1 character (the zero-th one)!
 
-                if (endChar < len - 1 &&
-                    removed < excessPixels)
-                {
-                    // width of the (endChar+1)-th character
-                    int width = charOffsets[endChar+1] -
-                                charOffsets[endChar];
+                calc.Init(len/2, 0);
+
+                bool removeFromStart = true;
 
-                    // remove the endChar-th character
-                    removed += width;
-                    endChar++;
+                while ( !calc.IsShortEnough() )
+                {
+                    const bool canRemoveFromStart = calc.GetFirstRemoved() > 0;
+                    const bool canRemoveFromEnd = calc.GetLastRemoved() < len - 1;
+
+                    if ( !canRemoveFromStart && !canRemoveFromEnd )
+                    {
+                        // we need to remove all the characters of the string!
+                        break;
+                    }
+
+                    // Remove from the beginning in even steps and from the end
+                    // in odd steps, unless we exhausted one side already:
+                    removeFromStart = !removeFromStart;
+                    if ( removeFromStart && !canRemoveFromStart )
+                        removeFromStart = false;
+                    else if ( !removeFromStart && !canRemoveFromEnd )
+                        removeFromStart = true;
+
+                    if ( removeFromStart )
+                        calc.RemoveFromStart();
+                    else
+                        calc.RemoveFromEnd();
                 }
 
-                if (initialChar == 0 && endChar == len-1)
+                // Always show at least one character of the string.
+                // Additionally, if there's only one character left, prefer
+                // "a..." to "...a":
+                if ( calc.m_nCharsToRemove == len ||
+                     calc.m_nCharsToRemove == len - 1 )
                 {
-                    nChars = len+1;
-                    break;
+                    return curLine[0] + wxString(wxELLIPSE_REPLACEMENT);
                 }
             }
+            break;
 
-            initialChar++;
-            nChars = endChar - initialChar + 1;
-        }
-        break;
-
-    case wxELLIPSIZE_END:
-        {
-            wxASSERT(len > 0);
-
-            int maxWidth = totalWidth - excessPixels;
-            for (initialChar=0;
-                 initialChar < len &&
-                 charOffsets[initialChar] < maxWidth;
-                 initialChar++)
-                ;
-
-            if (initialChar == 0)
-            {
-                nChars = len;
-            }
-            else
+        case wxELLIPSIZE_END:
             {
-                //initialChar--;      // go back one character
-                nChars = len - initialChar;
-            }
-        }
-        break;
+                calc.Init(len - 1, 1);
+                while ( !calc.IsShortEnough() )
+                    calc.RemoveFromStart();
 
-    default:
-        wxFAIL_MSG("invalid ellipsize mode");
-    }
+                // always show at least one character of the string:
+                if ( calc.m_nCharsToRemove == len )
+                    return curLine[0] + wxString(wxELLIPSE_REPLACEMENT);
 
-    wxString ret(curLine);
-    if (nChars >= len)
-    {
-        // need to remove the entire row!
-        ret.clear();
-    }
-    else
-    {
-        // erase nChars characters after initialChar (included):
-        ret.erase(initialChar, nChars+1);
+                break;
+            }
 
-        // if there is space for the replacement dots, add them
-        if (maxFinalWidth > replacementWidth)
-            ret.append(wxELLIPSE_REPLACEMENT);//.insert(initialChar, wxELLIPSE_REPLACEMENT);
+        case wxELLIPSIZE_NONE:
+        default:
+            wxFAIL_MSG("invalid ellipsize mode");
+            return curLine;
     }
 
-    // if everything was ok, we should have shortened this line
-    // enough to make it fit in maxFinalWidth:
-    wxASSERT(dc.GetTextExtent(ret).GetWidth() < maxFinalWidth);
-
-    return ret;
+    return calc.GetEllipsizedText();
 }
 
 /* static */
@@ -374,7 +527,6 @@ wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
     // change because of e.g. a font change; however we calculate them only once
     // when ellipsizing multiline labels:
     int replacementWidth = dc.GetTextExtent(wxELLIPSE_REPLACEMENT).GetWidth();
-    int marginWidth = dc.GetCharWidth();
 
     // NB: we must handle correctly labels with newlines:
     wxString curLine;
@@ -383,23 +535,18 @@ wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
         if ( pc == label.end() || *pc == wxS('\n') )
         {
             curLine = DoEllipsizeSingleLine(curLine, dc, mode, maxFinalWidth,
-                                            replacementWidth, marginWidth);
+                                            replacementWidth);
 
             // add this (ellipsized) row to the rest of the label
             ret << curLine;
             if ( pc == label.end() )
-            {
-                // NOTE: this is the return which always exits the function
-                return ret;
-            }
-            else
-            {
-                ret << *pc;
-                curLine.clear();
-            }
+                break;
+
+            ret << *pc;
+            curLine.clear();
         }
         // we need to remove mnemonics from the label for correct calculations
-        else if ( *pc == wxS('&') && (flags & wxELLIPSIZE_PROCESS_MNEMONICS) != 0 )
+        else if ( *pc == wxS('&') && (flags & wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS) )
         {
             // pc+1 is safe: at worst we'll be at end()
             wxString::const_iterator next = pc + 1;
@@ -408,7 +555,7 @@ wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
             //else: remove this ampersand
         }
         // we need also to expand tabs to properly calc their size
-        else if ( *pc == wxS('\t') && (flags & wxELLIPSIZE_EXPAND_TAB) != 0 )
+        else if ( *pc == wxS('\t') && (flags & wxELLIPSIZE_FLAGS_EXPAND_TABS) )
         {
             // Windows natively expands the TABs to 6 spaces. Do the same:
             curLine += wxS("      ");
@@ -419,14 +566,9 @@ wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
         }
     }
 
-    // this return would generate a
-    //  warning C4702: unreachable code
-    // with MSVC since the function always exits from inside the loop
-    //return ret;
+    return ret;
 }
 
-
-
 // ----------------------------------------------------------------------------
 // wxStaticBitmap
 // ----------------------------------------------------------------------------
@@ -442,7 +584,7 @@ wxSize wxStaticBitmapBase::DoGetBestSize() const
 {
     wxSize best;
     wxBitmap bmp = GetBitmap();
-    if ( bmp.Ok() )
+    if ( bmp.IsOk() )
         best = wxSize(bmp.GetWidth(), bmp.GetHeight());
     else
         // this is completely arbitrary