src/common/stattextcmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/stattextcmn.cpp
   3 // Purpose:     common (to all ports) wxStaticText functions
   4 // Author:      Vadim Zeitlin, Francesco Montorsi
   5 // Created:     2007-01-07 (extracted from dlgcmn.cpp)
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 1999-2006 Vadim Zeitlin
   8 //              (c) 2007 Francesco Montorsi
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #include "wx/private/stattext.h"
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/button.h"
  31     #include "wx/dcclient.h"
  32     #include "wx/intl.h"
  33     #include "wx/log.h"
  34     #include "wx/settings.h"
  35     #include "wx/stattext.h"
  36     #include "wx/sizer.h"
  37     #include "wx/containr.h"
  38 #endif
  39
  40 const wxChar *wxMarkupEntities[][wxMARKUP_ENTITY_MAX] =
  41 {
  42     // the entities handled by SetLabel() when wxST_MARKUP is used and their referenced string
  43
  44     { wxT("&amp;"), wxT("&lt;"), wxT("&gt;"), wxT("&apos;"), wxT("&quot;") },
  45     { wxT("&"),     wxT("<"),    wxT(">"),    wxT("'"),      wxT("\"")     }
  46 };
  47
  48 #if wxUSE_STATTEXT
  49
  50 // ----------------------------------------------------------------------------
  51 // wxTextWrapper
  52 // ----------------------------------------------------------------------------
  53
  54 void wxTextWrapper::Wrap(wxWindow *win, const wxString& text, int widthMax)
  55 {
  56     wxString line;
  57
  58     wxString::const_iterator lastSpace = text.end();
  59     wxString::const_iterator lineStart = text.begin();
  60     for ( wxString::const_iterator p = lineStart; ; ++p )
  61     {
  62         if ( IsStartOfNewLine() )
  63         {
  64             OnNewLine();
  65
  66             lastSpace = text.end();
  67             line.clear();
  68             lineStart = p;
  69         }
  70
  71         if ( p == text.end() || *p == _T('\n') )
  72         {
  73             DoOutputLine(line);
  74
  75             if ( p == text.end() )
  76                 break;
  77         }
  78         else // not EOL
  79         {
  80             if ( *p == _T(' ') )
  81                 lastSpace = p;
  82
  83             line += *p;
  84
  85             if ( widthMax >= 0 && lastSpace != text.end() )
  86             {
  87                 int width;
  88                 win->GetTextExtent(line, &width, NULL);
  89
  90                 if ( width > widthMax )
  91                 {
  92                     // remove the last word from this line
  93                     line.erase(lastSpace - lineStart, p + 1 - lineStart);
  94                     DoOutputLine(line);
  95
  96                     // go back to the last word of this line which we didn't
  97                     // output yet
  98                     p = lastSpace;
  99                 }
 100             }
 101             //else: no wrapping at all or impossible to wrap
 102         }
 103     }
 104 }
 105
 106
 107 // ----------------------------------------------------------------------------
 108 // wxLabelWrapper: helper class for wxStaticTextBase::Wrap()
 109 // ----------------------------------------------------------------------------
 110
 111 class wxLabelWrapper : public wxTextWrapper
 112 {
 113 public:
 114     void WrapLabel(wxWindow *text, int widthMax)
 115     {
 116         m_text.clear();
 117         Wrap(text, text->GetLabel(), widthMax);
 118         text->SetLabel(m_text);
 119     }
 120
 121 protected:
 122     virtual void OnOutputLine(const wxString& line)
 123     {
 124         m_text += line;
 125     }
 126
 127     virtual void OnNewLine()
 128     {
 129         m_text += _T('\n');
 130     }
 131
 132 private:
 133     wxString m_text;
 134 };
 135
 136
 137 // ----------------------------------------------------------------------------
 138 // wxStaticTextBase
 139 // ----------------------------------------------------------------------------
 140
 141 void wxStaticTextBase::Wrap(int width)
 142 {
 143     wxLabelWrapper wrapper;
 144     wrapper.WrapLabel(this, width);
 145 }
 146
 147 wxString wxStaticTextBase::GetLabelText() const
 148 {
 149     wxString ret(GetLabel());
 150
 151     if (HasFlag(wxST_MARKUP))
 152         ret = RemoveMarkup(ret);
 153     return RemoveMnemonics(ret);
 154 }
 155
 156 /*static*/
 157 wxString wxStaticTextBase::GetLabelText(const wxString& label)
 158 {
 159     // remove markup
 160     wxString ret = RemoveMarkup(label);
 161     return RemoveMnemonics(ret);
 162 }
 163
 164 /*static*/
 165 wxString wxStaticTextBase::RemoveMarkup(const wxString& text)
 166 {
 167     // strip out of "text" the markup for platforms which don't support it natively
 168     bool inside_tag = false;
 169
 170     wxString label;
 171     for ( wxString::const_iterator source = text.begin();
 172           source != text.end(); ++source )
 173     {
 174         switch ( (*source).GetValue() )
 175         {
 176             case wxT('<'):
 177                 if (inside_tag)
 178                 {
 179                     wxLogDebug(wxT("Invalid markup !"));
 180                     return wxEmptyString;
 181                 }
 182                 inside_tag = true;
 183                 break;
 184
 185             case wxT('>'):
 186                 if (!inside_tag)
 187                 {
 188                     wxLogDebug(wxT("Invalid markup !"));
 189                     return wxEmptyString;
 190                 }
 191                 inside_tag = false;
 192                 break;
 193
 194             case wxT('&'):
 195                 {
 196                     if ( source+1 == text.end() )
 197                     {
 198                         wxLogDebug(wxT("Cannot use & as last character of the string '%s'"),
 199                                    text.c_str());
 200                         return wxEmptyString;
 201                     }
 202
 203                     // is this ampersand introducing a mnemonic or rather an entity?
 204                     bool isMnemonic = true;
 205                     size_t distanceFromEnd = text.end() - source;
 206                     for (size_t j=0; j < wxMARKUP_ENTITY_MAX; j++)
 207                     {
 208                         const wxChar *entity = wxMarkupEntities[wxMARKUP_ELEMENT_NAME][j];
 209                         size_t entityLen = wxStrlen(entity);
 210
 211                         if (distanceFromEnd >= entityLen &&
 212                             wxString(source, source + entityLen) == entity)
 213                         {
 214                             // replace the &entity; string with the entity reference
 215                             label << wxMarkupEntities[wxMARKUP_ELEMENT_VALUE][j];
 216                             // little exception: when the entity reference is
 217                             // "&" (i.e. when entity is "&amp;"), substitute it
 218                             // with && instead of a single ampersand:
 219                             if (*wxMarkupEntities[wxMARKUP_ELEMENT_VALUE][j] == wxT('&'))
 220                                 label << wxT('&');
 221                             // the -1 is because main for() loop already
 222                             // increments i:
 223                             source += entityLen - 1;
 224                             isMnemonic = false;
 225                             break;
 226                         }
 227                     }
 228
 229                     if (isMnemonic)
 230                         label << *source;
 231                 }
 232                 break;
 233
 234
 235             default:
 236                 if (!inside_tag)
 237                     label << *source;
 238         }
 239     }
 240
 241     return label;
 242 }
 243
 244 /* static */
 245 wxString wxStaticTextBase::EscapeMarkup(const wxString& text)
 246 {
 247     wxString ret;
 248
 249     for (wxString::const_iterator source = text.begin();
 250          source != text.end(); ++source)
 251     {
 252         bool isEntity = false;
 253
 254         // search in the list of the entities and eventually escape this character
 255         for (size_t j=0; j < wxMARKUP_ENTITY_MAX; j++)
 256         {
 257             if (*source == *wxMarkupEntities[wxMARKUP_ELEMENT_VALUE][j])
 258             {
 259                 ret << wxMarkupEntities[wxMARKUP_ELEMENT_NAME][j];
 260                 isEntity = true;
 261                 break;
 262             }
 263         }
 264
 265         if (!isEntity)
 266             ret << *source;     // this character does not need to be escaped
 267     }
 268
 269     return ret;
 270 }
 271
 272
 273 // ----------------------------------------------------------------------------
 274 // wxStaticTextBase - generic implementation for wxST_ELLIPSIZE_* support
 275 // ----------------------------------------------------------------------------
 276
 277 void wxStaticTextBase::UpdateLabel()
 278 {
 279     if (!IsEllipsized())
 280         return;
 281
 282     wxString newlabel = GetEllipsizedLabelWithoutMarkup();
 283
 284     // we need to touch the "real" label (i.e. the text set inside the control,
 285     // using port-specific functions) instead of the string returned by GetLabel().
 286     //
 287     // In fact, we must be careful not to touch the original label passed to
 288     // SetLabel() otherwise GetLabel() will behave in a strange way to the user
 289     // (e.g. returning a "Ver...ing" instead of "Very long string") !
 290     if (newlabel == DoGetLabel())
 291         return;
 292     DoSetLabel(newlabel);
 293 }
 294
 295 wxString wxStaticTextBase::GetEllipsizedLabelWithoutMarkup() const
 296 {
 297     // this function should be used only by ports which do not support
 298     // ellipsis in static texts: we first remove markup (which cannot
 299     // be handled safely by Ellipsize()) and then ellipsize the result.
 300
 301     wxString ret(m_labelOrig);
 302
 303     // the order of the following two blocks is important!
 304
 305     if (HasFlag(wxST_MARKUP))
 306         ret = RemoveMarkup(ret);
 307
 308     if (IsEllipsized())
 309         ret = Ellipsize(ret);
 310
 311     return ret;
 312 }
 313
 314 wxString wxStaticTextBase::Ellipsize(const wxString& label) const
 315 {
 316     wxSize sz(GetSize());
 317     if (sz.GetWidth() < 2 || sz.GetHeight() < 2)
 318     {
 319         // the size of this window is not valid (yet)
 320         return label;
 321     }
 322
 323     wxClientDC dc(const_cast<wxStaticTextBase*>(this));
 324     dc.SetFont(GetFont());
 325
 326     wxEllipsizeMode mode;
 327     if ( HasFlag(wxST_ELLIPSIZE_START) )
 328         mode = wxELLIPSIZE_START;
 329     else if ( HasFlag(wxST_ELLIPSIZE_MIDDLE) )
 330         mode = wxELLIPSIZE_MIDDLE;
 331     else if ( HasFlag(wxST_ELLIPSIZE_END) )
 332         mode = wxELLIPSIZE_END;
 333     else
 334     {
 335         wxFAIL_MSG( "should only be called if have one of wxST_ELLIPSIZE_XXX" );
 336
 337         return label;
 338     }
 339
 340     return wxControl::Ellipsize(label, dc, mode, sz.GetWidth());
 341 }
 342
 343 #endif // wxUSE_STATTEXT