src/msw/stattext.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/stattext.cpp
   3 // Purpose:     wxStaticText
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16 #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_STATTEXT
  20
  21 #include "wx/stattext.h"
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/event.h"
  25     #include "wx/app.h"
  26     #include "wx/brush.h"
  27     #include "wx/dcclient.h"
  28     #include "wx/settings.h"
  29 #endif
  30
  31 #include "wx/msw/private.h"
  32
  33 #if wxUSE_EXTENDED_RTTI
  34 WX_DEFINE_FLAGS( wxStaticTextStyle )
  35
  36 wxBEGIN_FLAGS( wxStaticTextStyle )
  37     // new style border flags, we put them first to
  38     // use them for streaming out
  39     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  40     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  41     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  42     wxFLAGS_MEMBER(wxBORDER_RAISED)
  43     wxFLAGS_MEMBER(wxBORDER_STATIC)
  44     wxFLAGS_MEMBER(wxBORDER_NONE)
  45
  46     // old style border flags
  47     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  48     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  49     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  50     wxFLAGS_MEMBER(wxRAISED_BORDER)
  51     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  52     wxFLAGS_MEMBER(wxBORDER)
  53
  54     // standard window styles
  55     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  56     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  57     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  58     wxFLAGS_MEMBER(wxWANTS_CHARS)
  59     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  60     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  61     wxFLAGS_MEMBER(wxVSCROLL)
  62     wxFLAGS_MEMBER(wxHSCROLL)
  63
  64     wxFLAGS_MEMBER(wxST_NO_AUTORESIZE)
  65     wxFLAGS_MEMBER(wxALIGN_LEFT)
  66     wxFLAGS_MEMBER(wxALIGN_RIGHT)
  67     wxFLAGS_MEMBER(wxALIGN_CENTRE)
  68
  69 wxEND_FLAGS( wxStaticTextStyle )
  70
  71 IMPLEMENT_DYNAMIC_CLASS_XTI(wxStaticText, wxControl,"wx/stattext.h")
  72
  73 wxBEGIN_PROPERTIES_TABLE(wxStaticText)
  74     wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  75     wxPROPERTY_FLAGS( WindowStyle , wxStaticTextStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  76 wxEND_PROPERTIES_TABLE()
  77
  78 wxBEGIN_HANDLERS_TABLE(wxStaticText)
  79 wxEND_HANDLERS_TABLE()
  80
  81 wxCONSTRUCTOR_6( wxStaticText , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
  82 #else
  83 IMPLEMENT_DYNAMIC_CLASS(wxStaticText, wxControl)
  84 #endif
  85
  86 bool wxStaticText::Create(wxWindow *parent,
  87                           wxWindowID id,
  88                           const wxString& label,
  89                           const wxPoint& pos,
  90                           const wxSize& size,
  91                           long style,
  92                           const wxString& name)
  93 {
  94     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
  95         return false;
  96
  97     if ( !MSWCreateControl(wxT("STATIC"), label, pos, size) )
  98         return false;
  99
 100     return true;
 101 }
 102
 103 wxBorder wxStaticText::GetDefaultBorder() const
 104 {
 105     return wxBORDER_NONE;
 106 }
 107
 108 WXDWORD wxStaticText::MSWGetStyle(long style, WXDWORD *exstyle) const
 109 {
 110     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 111
 112     // translate the alignment flags to the Windows ones
 113     //
 114     // note that both wxALIGN_LEFT and SS_LEFT are equal to 0 so we shouldn't
 115     // test for them using & operator
 116     if ( style & wxALIGN_CENTRE )
 117         msStyle |= SS_CENTER;
 118     else if ( style & wxALIGN_RIGHT )
 119         msStyle |= SS_RIGHT;
 120     else
 121         msStyle |= SS_LEFT;
 122
 123 #ifdef SS_ENDELLIPSIS
 124     // this style is necessary to receive mouse events
 125     // Win NT and later have the SS_ENDELLIPSIS style which is useful to us:
 126     if (wxGetOsVersion() == wxOS_WINDOWS_NT)
 127     {
 128         // for now, add the SS_ENDELLIPSIS style if wxST_ELLIPSIZE_END is given;
 129         // we may need to remove it later in ::SetLabel() if the given label
 130         // has newlines
 131         if ( style & wxST_ELLIPSIZE_END )
 132             msStyle |= SS_ENDELLIPSIS;
 133     }
 134 #endif // SS_ENDELLIPSIS
 135
 136     msStyle |= SS_NOTIFY;
 137
 138     return msStyle;
 139 }
 140
 141 wxSize wxStaticText::DoGetBestSize() const
 142 {
 143     wxClientDC dc(wx_const_cast(wxStaticText *, this));
 144     wxFont font(GetFont());
 145     if (!font.Ok())
 146         font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 147
 148     dc.SetFont(font);
 149
 150     wxCoord widthTextMax, heightTextTotal;
 151     dc.GetMultiLineTextExtent(GetLabelText(), &widthTextMax, &heightTextTotal);
 152
 153 #ifdef __WXWINCE__
 154     if ( widthTextMax )
 155         widthTextMax += 2;
 156 #endif // __WXWINCE__
 157
 158     // border takes extra space
 159     //
 160     // TODO: this is probably not wxStaticText-specific and should be moved
 161     wxCoord border;
 162     switch ( GetBorder() )
 163     {
 164         case wxBORDER_STATIC:
 165         case wxBORDER_SIMPLE:
 166             border = 1;
 167             break;
 168
 169         case wxBORDER_SUNKEN:
 170             border = 2;
 171             break;
 172
 173         case wxBORDER_RAISED:
 174         case wxBORDER_DOUBLE:
 175             border = 3;
 176             break;
 177
 178         default:
 179             wxFAIL_MSG( _T("unknown border style") );
 180             // fall through
 181
 182         case wxBORDER_NONE:
 183             border = 0;
 184     }
 185
 186     widthTextMax += 2*border;
 187     heightTextTotal += 2*border;
 188
 189     wxSize best(widthTextMax, heightTextTotal);
 190     CacheBestSize(best);
 191     return best;
 192 }
 193
 194 void wxStaticText::DoSetSize(int x, int y, int w, int h, int sizeFlags)
 195 {
 196     // note: we first need to set the size and _then_ call UpdateLabel
 197     wxStaticTextBase::DoSetSize(x, y, w, h, sizeFlags);
 198
 199 #ifdef SS_ENDELLIPSIS
 200     // do we need to ellipsize the contents?
 201     long styleReal = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 202     if ( !(styleReal & SS_ENDELLIPSIS) )
 203     {
 204         // we don't have SS_ENDELLIPSIS style:
 205         // we need to (eventually) do ellipsization ourselves
 206         UpdateLabel();
 207     }
 208     //else: we don't or the OS will do it for us
 209 #endif // SS_ENDELLIPSIS
 210
 211     // we need to refresh the window after changing its size as the standard
 212     // control doesn't always update itself properly
 213     Refresh();
 214 }
 215
 216 void wxStaticText::SetLabel(const wxString& label)
 217 {
 218 #ifdef SS_ENDELLIPSIS
 219     long styleReal = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 220     if ( HasFlag(wxST_ELLIPSIZE_END) &&
 221           wxGetOsVersion() == wxOS_WINDOWS_NT )
 222     {
 223         // adding SS_ENDELLIPSIS or SS_ENDELLIPSIS "disables" the correct
 224         // newline handling in static texts: the newlines in the labels are
 225         // shown as square. Thus we don't use it even on newer OS when
 226         // the static label contains a newline.
 227         if ( label.Contains(wxT('\n')) )
 228             styleReal &= ~SS_ENDELLIPSIS;
 229         else
 230             styleReal |= SS_ENDELLIPSIS;
 231
 232         ::SetWindowLong(GetHwnd(), GWL_STYLE, styleReal);
 233     }
 234     else // style not supported natively
 235     {
 236         styleReal &= ~SS_ENDELLIPSIS;
 237         ::SetWindowLong(GetHwnd(), GWL_STYLE, styleReal);
 238     }
 239 #endif // SS_ENDELLIPSIS
 240
 241     // this call will save the label in m_labelOrig and set it into this window
 242     // (through wxWindow::SetLabel)
 243     m_labelOrig = label;
 244
 245 #ifdef SS_ENDELLIPSIS
 246     if ( styleReal & SS_ENDELLIPSIS )
 247         DoSetLabel(RemoveMarkup(label));
 248     else
 249 #endif // SS_ENDELLIPSIS
 250         DoSetLabel(GetEllipsizedLabelWithoutMarkup());
 251
 252     // adjust the size of the window to fit to the label unless autoresizing is
 253     // disabled
 254     if ( !HasFlag(wxST_NO_AUTORESIZE) &&
 255          !IsEllipsized() )  // if ellipsize is ON, then we don't want to get resized!
 256     {
 257         InvalidateBestSize();
 258         DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, wxDefaultCoord,
 259                   wxSIZE_AUTO_WIDTH | wxSIZE_AUTO_HEIGHT);
 260     }
 261 }
 262
 263 bool wxStaticText::SetFont(const wxFont& font)
 264 {
 265     bool ret = wxControl::SetFont(font);
 266
 267     // adjust the size of the window to fit to the label unless autoresizing is
 268     // disabled
 269     if ( !HasFlag(wxST_NO_AUTORESIZE) )
 270     {
 271         InvalidateBestSize();
 272         DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, wxDefaultCoord,
 273                   wxSIZE_AUTO_WIDTH | wxSIZE_AUTO_HEIGHT);
 274     }
 275
 276     return ret;
 277 }
 278
 279 // for wxST_ELLIPSIZE_* support:
 280
 281 wxString wxStaticText::DoGetLabel() const
 282 {
 283     return wxGetWindowText(GetHwnd());
 284 }
 285
 286 void wxStaticText::DoSetLabel(const wxString& str)
 287 {
 288     SetWindowText(GetHwnd(), str.c_str());
 289 }
 290
 291
 292 #endif // wxUSE_STATTEXT