]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/ctrlcmn.cpp
Forgot header with OSX prefix
[wxWidgets.git] / src / common / ctrlcmn.cpp
index 916a4e578ddadc0eb38f0d70238f115fb0c75f3e..8cb01a3adb253be0c0b5fdc94ad2a85257e01f6d 100644 (file)
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        ctrlcmn.cpp
+// Name:        src/common/ctrlcmn.cpp
 // Purpose:     wxControl common interface
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     26.07.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma implementation "ctrlcmn.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
     #pragma hdrstop
 #endif
 
+#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
 
+const char wxControlNameStr[] = "control";
+
 // ============================================================================
 // implementation
 // ============================================================================
 
+wxControlBase::~wxControlBase()
+{
+    // this destructor is required for Darwin
+}
+
+bool wxControlBase::Create(wxWindow *parent,
+                           wxWindowID id,
+                           const wxPoint &pos,
+                           const wxSize &size,
+                           long style,
+                           const wxValidator& wxVALIDATOR_PARAM(validator),
+                           const wxString &name)
+{
+    bool ret = wxWindow::Create(parent, id, pos, size, style, name);
+
+#if wxUSE_VALIDATORS
+    if ( ret )
+        SetValidator(validator);
+#endif // wxUSE_VALIDATORS
+
+    return ret;
+}
+
 bool wxControlBase::CreateControl(wxWindowBase *parent,
                                   wxWindowID id,
                                   const wxPoint& pos,
@@ -48,25 +77,343 @@ bool wxControlBase::CreateControl(wxWindowBase *parent,
     // even if it's possible to create controls without parents in some port,
     // it should surely be discouraged because it doesn't work at all under
     // Windows
-    wxCHECK_MSG( parent, FALSE, wxT("all controls must have parents") );
+    wxCHECK_MSG( parent, false, wxT("all controls must have parents") );
 
     if ( !CreateBase(parent, id, pos, size, style, validator, name) )
-        return FALSE;
+        return false;
 
     parent->AddChild(this);
 
-    return TRUE;
+    return true;
 }
 
-// inherit colour and font settings from the parent window
-void wxControlBase::InheritAttributes()
+/* static */
+wxString wxControlBase::GetLabelText(const wxString& label)
 {
-    SetBackgroundColour(GetParent()->GetBackgroundColour());
-    SetForegroundColour(GetParent()->GetForegroundColour());
-    SetFont(GetParent()->GetFont());
+    // we don't want strip the TABs here, just the mnemonics
+    return wxStripMenuCodes(label, wxStrip_Mnemonics);
 }
 
 void wxControlBase::Command(wxCommandEvent& event)
 {
-    (void)ProcessEvent(event);
+    (void)GetEventHandler()->ProcessEvent(event);
+}
+
+void wxControlBase::InitCommandEvent(wxCommandEvent& event) const
+{
+    event.SetEventObject((wxControlBase *)this);    // const_cast
+
+    // event.SetId(GetId()); -- this is usuall done in the event ctor
+
+    switch ( m_clientDataType )
+    {
+        case wxClientData_Void:
+            event.SetClientData(GetClientData());
+            break;
+
+        case wxClientData_Object:
+            event.SetClientObject(GetClientObject());
+            break;
+
+        case wxClientData_None:
+            // nothing to do
+            ;
+    }
+}
+
+bool wxControlBase::SetFont(const wxFont& font)
+{
+    InvalidateBestSize();
+    return wxWindow::SetFont(font);
+}
+
+// wxControl-specific processing after processing the update event
+void wxControlBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
+{
+    // 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;
+}
+
+#define wxELLIPSE_REPLACEMENT       wxT("...")
+
+/* static */
+wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
+                                  wxEllipsizeMode mode, int maxFinalWidth)
+{
+    wxArrayInt charOffsets;
+    wxString ret;
+
+    // these cannot be cached as they can change because of e.g. a font change
+    int replacementWidth = dc.GetTextExtent(wxELLIPSE_REPLACEMENT).GetWidth();
+    int marginWidth = dc.GetCharWidth()*2;
+
+    // NB: we must handle correctly labels with newlines:
+    wxString curLine;
+    wxSize reqsize;
+    size_t len;
+    for ( wxString::const_iterator pc = label.begin(); ; ++pc )
+    {
+        if ( pc == label.end() || *pc == _T('\n') )
+        {
+            len = curLine.length();
+            if (len > 0 &&
+                dc.GetPartialTextExtents(curLine, charOffsets))
+            {
+                wxASSERT(charOffsets.GetCount() == len);
+
+                size_t totalWidth = charOffsets.Last();
+                if ( totalWidth > (size_t)maxFinalWidth )
+                {
+                    // we need to ellipsize this row
+                    int excessPixels = totalWidth - maxFinalWidth +
+                                       replacementWidth +
+                                       marginWidth;     // security margin (NEEDED!)
+
+                    // remove characters in excess
+                    size_t initialChar,     // index of first char to erase
+                           nChars;          // how many chars do we need to erase?
+                    if (mode == wxELLIPSIZE_START)
+                    {
+                        initialChar = 0;
+                        for (nChars=0;
+                             nChars < len && charOffsets[nChars] < excessPixels;
+                             nChars++)
+                            ;
+                    }
+                    else if (mode == 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;
+                    }
+                    else
+                    {
+                        wxASSERT(mode == 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;
+                        }
+                    }
+
+                    if (nChars > len)
+                    {
+                        // need to remove the entire row!
+                        curLine.clear();
+                    }
+                    else
+                    {
+                        // erase nChars characters after initialChar (included):
+                        curLine.erase(initialChar, nChars+1);
+
+                        // if there is space for the replacement dots, add them
+                        if (maxFinalWidth > replacementWidth)
+                            curLine.insert(initialChar, wxELLIPSE_REPLACEMENT);
+                    }
+
+                    // if everything was ok, we should have shortened this line
+                    // enough to make it fit in maxFinalWidth:
+                    wxASSERT(dc.GetTextExtent(curLine).GetWidth() < maxFinalWidth);
+                }
+            }
+
+            // 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 == _T('&') )
+        {
+            // pc+1 is safe: at worst we'll be at end()
+            wxString::const_iterator next = pc + 1;
+            if ( next != label.end() && *next == _T('&') )
+                curLine += _T('&');          // && becomes &
+            //else: remove this ampersand
+        }
+        // we need also to expand tabs to properly calc their size
+        else if ( *pc == _T('\t') )
+        {
+            // Windows natively expands the TABs to 6 spaces. Do the same:
+            curLine += wxT("      ");
+        }
+        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;
+}
+
+wxBorder wxControlBase::GetDefaultBorder() const
+{
+    return wxBORDER_THEME;
 }
+
+
+// ----------------------------------------------------------------------------
+// wxStaticBitmap
+// ----------------------------------------------------------------------------
+
+#if wxUSE_STATBMP
+
+wxStaticBitmapBase::~wxStaticBitmapBase()
+{
+    // this destructor is required for Darwin
+}
+
+wxSize wxStaticBitmapBase::DoGetBestSize() const
+{
+    wxSize best;
+    wxBitmap bmp = GetBitmap();
+    if ( bmp.Ok() )
+        best = wxSize(bmp.GetWidth(), bmp.GetHeight());
+    else
+        // this is completely arbitrary
+        best = wxSize(16, 16);
+    CacheBestSize(best);
+    return best;
+}
+
+#endif // wxUSE_STATBMP
+
+#endif // wxUSE_CONTROLS