Implement and document wxDataViewTreeCtrl::IsContainer(), use it in the sample to...

[wxWidgets.git] / src / common / ctrlcmn.cpp

diff --git a/src/common/ctrlcmn.cpp b/src/common/ctrlcmn.cpp
index 1897047aa0cc9d72824a898d5183eda93fede60c..f7145a78a59abe4ec1d63d1054386193c3f8ff11 100644 (file)
--- a/src/common/ctrlcmn.cpp
+++ b/src/common/ctrlcmn.cpp
@@ -35,6 +35,7 @@
     #include "wx/statbmp.h"
     #include "wx/bitmap.h"
     #include "wx/utils.h"       // for wxStripMenuCodes()
     #include "wx/statbmp.h"
     #include "wx/bitmap.h"
     #include "wx/utils.h"       // for wxStripMenuCodes()

+    #include "wx/settings.h"

 #endif
 
 const char wxControlNameStr[] = "control";
 #endif
 
 const char wxControlNameStr[] = "control";


@@ -159,13 +160,21 @@ wxString wxControlBase::RemoveMnemonics(const wxString& str)
     return wxStripMenuCodes(str, wxStrip_Mnemonics);
 }
 
     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 */
 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 )
     {
 
     if ( labelOnly )
     {


@@ -190,7 +199,7 @@ int wxControlBase::FindAccelIndex(const wxString& label, wxString *labelOnly)
                 }
                 else
                 {
                 }
                 else
                 {

-                    wxFAIL_MSG(_T("duplicate accel char in control label"));
+                    wxFAIL_MSG(wxT("duplicate accel char in control label"));

                 }
             }
         }
                 }
             }
         }


@@ -204,137 +213,193 @@ int wxControlBase::FindAccelIndex(const wxString& label, wxString *labelOnly)
     return indexAccel;
 }
 
     return indexAccel;
 }
 

+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;
+}
+
+// ----------------------------------------------------------------------------
+// wxControlBase - ellipsization code
+// ----------------------------------------------------------------------------
+

 #define wxELLIPSE_REPLACEMENT       wxT("...")
 
 #define wxELLIPSE_REPLACEMENT       wxT("...")
 

-/* static */
-wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
-                                  wxEllipsizeMode mode, int maxFinalWidth)
+/* 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!");
+
+    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)
+        return wxEmptyString;
+

     wxArrayInt charOffsets;
     wxArrayInt charOffsets;

-    wxString ret;
+    size_t len = curLine.length();
+    if (len == 0 ||
+        !dc.GetPartialTextExtents(curLine, charOffsets))
+        return curLine;

 
 

-    // 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;
+    wxASSERT(charOffsets.GetCount() == len);

 
 

-    // NB: we must handle correctly labels with newlines:
-    wxString curLine;
-    wxSize reqsize;
-    size_t len;
-    for ( wxString::const_iterator pc = label.begin(); ; ++pc )
+    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)

     {
     {

-        if ( pc == label.end() || *pc == _T('\n') )
-        {
-            len = curLine.length();
-            if (len > 0 &&
-                dc.GetPartialTextExtents(curLine, charOffsets))
+        case wxELLIPSIZE_START:
+            initialChar = 0;
+            for ( nChars=0;
+                  nChars < len && charOffsets[nChars] < excessPixels;
+                  nChars++ )
+                ;
+            break;
+
+        case wxELLIPSIZE_MIDDLE:

             {
             {

-                wxASSERT(charOffsets.GetCount() == len);
+                // the start & end of the removed span of chars
+                initialChar = len/2;
+                size_t endChar = len/2;

 
 

-                size_t totalWidth = charOffsets.Last();
-                if ( totalWidth > (size_t)maxFinalWidth )
+                int removed = 0;
+                for ( ; removed < excessPixels; )

                 {
                 {

-                    // 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)
+                    if (initialChar > 0)

                     {
                     {

-                        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;
+                        // width of the initialChar-th character
+                        int width = charOffsets[initialChar] -
+                                    charOffsets[initialChar-1];
+
+                        // remove the initialChar-th character
+                        removed += width;
+                        initialChar--;

                     }
                     }

-                    else
+
+                    if (endChar < len - 1 &&
+                        removed < excessPixels)

                     {
                     {

-                        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;
-                        }
+                        // width of the (endChar+1)-th character
+                        int width = charOffsets[endChar+1] -
+                                    charOffsets[endChar];
+
+                        // remove the endChar-th character
+                        removed += width;
+                        endChar++;

                     }
 
                     }
 

-                    if (nChars > len)
+                    if (initialChar == 0 && endChar == len-1)

                     {
                     {

-                        // need to remove the entire row!
-                        curLine.clear();
+                        nChars = len+1;
+                        break;

                     }
                     }

-                    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);
-                    }
+                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 everything was ok, we should have shortened this line
-                    // enough to make it fit in maxFinalWidth:
-                    wxASSERT(dc.GetTextExtent(curLine).GetWidth() < maxFinalWidth);
+                if (initialChar == 0)
+                {
+                    nChars = len;
+                }
+                else
+                {
+                    //initialChar--;      // go back one character
+                    nChars = len - initialChar;

                 }
             }
                 }
             }

+            break;
+
+        case wxELLIPSIZE_NONE:
+        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;
 
             // add this (ellipsized) row to the rest of the label
             ret << curLine;


@@ -350,19 +415,19 @@ wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
             }
         }
         // we need to remove mnemonics from the label for correct calculations
             }
         }
         // we need to remove mnemonics from the label for correct calculations

-        else if ( *pc == _T('&') )
+        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;
         {
             // 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 &
+            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: remove this ampersand
         }
         // we need also to expand tabs to properly calc their size

-        else if ( *pc == _T('\t') )
+        else if ( *pc == wxS('\t') && (flags & wxELLIPSIZE_FLAGS_EXPAND_TABS) )

         {
             // Windows natively expands the TABs to 6 spaces. Do the same:
         {
             // Windows natively expands the TABs to 6 spaces. Do the same:

-            curLine += wxT("      ");
+            curLine += wxS("      ");

         }
         else
         {
         }
         else
         {


@@ -376,10 +441,6 @@ wxString wxControlBase::Ellipsize(const wxString& label, const wxDC& dc,
     //return ret;
 }
 
     //return ret;
 }
 

-wxBorder wxControlBase::GetDefaultBorder() const
-{
-    return wxBORDER_THEME;
-}

 
 
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------