]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/ctrlcmn.cpp
special casing mac code
[wxWidgets.git] / src / common / ctrlcmn.cpp
index 36a45a6c15d564e24674f7df5bf567cf56fae4e6..5e8b9ef8b31c3ed7dc40a54af80f094ddd51b5ae 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        ctrlcmn.cpp
+// Name:        src/common/ctrlcmn.cpp
 // Purpose:     wxControl common interface
 // Author:      Vadim Zeitlin
 // Modified by:
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "controlbase.h"
-    #pragma implementation "statbmpbase.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 
 #if wxUSE_CONTROLS
 
+#include "wx/control.h"
+
 #ifndef WX_PRECOMP
-    #include "wx/control.h"
+    #include "wx/dc.h"
     #include "wx/log.h"
+    #include "wx/radiobut.h"
+    #include "wx/statbmp.h"
+    #include "wx/bitmap.h"
+    #include "wx/utils.h"       // for wxStripMenuCodes()
 #endif
 
-#if wxUSE_STATBMP
-    #include "wx/bitmap.h"
-    #include "wx/statbmp.h"
-#endif // wxUSE_STATBMP
+const char wxControlNameStr[] = "control";
 
 // ============================================================================
 // implementation
@@ -89,6 +87,13 @@ 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);
@@ -116,19 +121,313 @@ void wxControlBase::InitCommandEvent(wxCommandEvent& event) const
     }
 }
 
-
-void wxControlBase::SetLabel( const wxString &label )
+bool wxControlBase::SetFont(const wxFont& font)
 {
     InvalidateBestSize();
-    wxWindow::SetLabel(label);
+    return wxWindow::SetFont(font);
 }
 
-bool wxControlBase::SetFont(const wxFont& font)
+// wxControl-specific processing after processing the update event
+void wxControlBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
 {
-    InvalidateBestSize();
-    return wxWindow::SetFont(font);
+    // call inherited
+    wxWindowBase::DoUpdateWindowUI(event);
+
+    // update label
+    if ( event.GetSetText() )
+    {
+        if ( event.GetText() != GetLabel() )
+            SetLabel(event.GetText());
+    }
+
+    // Unfortunately we don't yet have common base class for
+    // wxRadioButton, so we handle updates of radiobuttons here.
+    // TODO: If once wxRadioButtonBase will exist, move this code there.
+#if wxUSE_RADIOBTN
+    if ( event.GetSetChecked() )
+    {
+        wxRadioButton *radiobtn = wxDynamicCastThis(wxRadioButton);
+        if ( radiobtn )
+            radiobtn->SetValue(event.GetChecked());
+    }
+#endif // wxUSE_RADIOBTN
+}
+
+/* static */
+wxString wxControlBase::RemoveMnemonics(const wxString& str)
+{
+    return wxStripMenuCodes(str, wxStrip_Mnemonics);
+}
+
+/* static */
+wxString wxControlBase::EscapeMnemonics(const wxString& text)
+{
+    wxString label(text);
+    label.Replace("&", "&&");
+    return label;
+}
+
+/* static */
+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('&');
+
+    if ( labelOnly )
+    {
+        labelOnly->Empty();
+        labelOnly->Alloc(label.length());
+    }
+
+    int indexAccel = -1;
+    for ( wxString::const_iterator pc = label.begin(); pc != label.end(); ++pc )
+    {
+        if ( *pc == MNEMONIC_PREFIX )
+        {
+            ++pc; // skip it
+            if ( pc == label.end() )
+                break;
+            else if ( *pc != MNEMONIC_PREFIX )
+            {
+                if ( indexAccel == -1 )
+                {
+                    // remember it (-1 is for MNEMONIC_PREFIX itself
+                    indexAccel = pc - label.begin() - 1;
+                }
+                else
+                {
+                    wxFAIL_MSG(_T("duplicate accel char in control label"));
+                }
+            }
+        }
+
+        if ( labelOnly )
+        {
+            *labelOnly += *pc;
+        }
+    }
+
+    return indexAccel;
 }
 
+wxBorder wxControlBase::GetDefaultBorder() const
+{
+    return wxBORDER_THEME;
+}
+
+// ----------------------------------------------------------------------------
+// wxControlBase - ellipsization code
+// ----------------------------------------------------------------------------
+
+#define wxELLIPSE_REPLACEMENT       wxT("...")
+
+/* static and protected */
+wxString wxControlBase::DoEllipsizeSingleLine(const wxString& curLine, const wxDC& dc,
+                                              wxEllipsizeMode mode, int maxFinalWidth,
+                                              int replacementWidth, int marginWidth)
+{
+    wxASSERT_MSG(replacementWidth > 0 && marginWidth > 0,
+                 "Invalid parameters");
+    wxASSERT_MSG(!curLine.Contains('\n'),
+                 "Use Ellipsize() instead!");
+
+    // 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)
+        return wxEmptyString;
+
+    wxArrayInt charOffsets;
+    size_t len = curLine.length();
+    if (len == 0 ||
+        !dc.GetPartialTextExtents(curLine, charOffsets))
+        return curLine;
+
+    wxASSERT(charOffsets.GetCount() == len);
+
+    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!)
+    wxASSERT(excessPixels>0);
+
+    // remove characters in excess
+    size_t initialChar,     // index of first char to erase
+           nChars;          // how many chars do we need to erase?
+
+    switch (mode)
+    {
+        case wxELLIPSIZE_START:
+            initialChar = 0;
+            for ( nChars=0;
+                  nChars < len && charOffsets[nChars] < excessPixels;
+                  nChars++ )
+                ;
+            break;
+
+        case wxELLIPSIZE_MIDDLE:
+            {
+                // the start & end of the removed span of chars
+                initialChar = len/2;
+                size_t endChar = len/2;
+
+                int removed = 0;
+                for ( ; removed < excessPixels; )
+                {
+                    if (initialChar > 0)
+                    {
+                        // width of the initialChar-th character
+                        int width = charOffsets[initialChar] -
+                                    charOffsets[initialChar-1];
+
+                        // remove the initialChar-th character
+                        removed += width;
+                        initialChar--;
+                    }
+
+                    if (endChar < len - 1 &&
+                        removed < excessPixels)
+                    {
+                        // width of the (endChar+1)-th character
+                        int width = charOffsets[endChar+1] -
+                                    charOffsets[endChar];
+
+                        // remove the endChar-th character
+                        removed += width;
+                        endChar++;
+                    }
+
+                    if (initialChar == 0 && endChar == len-1)
+                    {
+                        nChars = len+1;
+                        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
+                {
+                    //initialChar--;      // go back one character
+                    nChars = len - initialChar;
+                }
+            }
+            break;
+
+        default:
+            wxFAIL_MSG("invalid ellipsize mode");
+            return curLine;
+    }
+
+    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);
+
+        // if there is space for the replacement dots, add them
+        if (maxFinalWidth > replacementWidth)
+            ret.insert(initialChar, wxELLIPSE_REPLACEMENT);
+    }
+
+    // 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;
+}
+
+/* static */
+wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
+                                  wxEllipsizeMode mode, int maxFinalWidth,
+                                  int flags)
+{
+    wxString ret;
+
+    // these cannot be cached between different Ellipsize() calls as they can
+    // 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;
+    for ( wxString::const_iterator pc = label.begin(); ; ++pc )
+    {
+        if ( pc == label.end() || *pc == wxS('\n') )
+        {
+            curLine = DoEllipsizeSingleLine(curLine, dc, mode, maxFinalWidth,
+                                            replacementWidth, marginWidth);
+
+            // 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();
+            }
+        }
+        // we need to remove mnemonics from the label for correct calculations
+        else if ( *pc == wxS('&') && (flags & wxELLIPSIZE_PROCESS_MNEMONICS) != 0 )
+        {
+            // pc+1 is safe: at worst we'll be at end()
+            wxString::const_iterator next = pc + 1;
+            if ( next != label.end() && *next == wxS('&') )
+                curLine += wxS('&');          // && becomes &
+            //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 )
+        {
+            // Windows natively expands the TABs to 6 spaces. Do the same:
+            curLine += wxS("      ");
+        }
+        else
+        {
+            curLine += *pc;
+        }
+    }
+
+    // this return would generate a
+    //  warning C4702: unreachable code
+    // with MSVC since the function always exits from inside the loop
+    //return ret;
+}
+
+
+
 // ----------------------------------------------------------------------------
 // wxStaticBitmap
 // ----------------------------------------------------------------------------
@@ -156,4 +455,3 @@ wxSize wxStaticBitmapBase::DoGetBestSize() const
 #endif // wxUSE_STATBMP
 
 #endif // wxUSE_CONTROLS
-