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 bool wxStaticText::Create(wxWindow *parent,
  34                           wxWindowID id,
  35                           const wxString& label,
  36                           const wxPoint& pos,
  37                           const wxSize& size,
  38                           long style,
  39                           const wxString& name)
  40 {
  41     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
  42         return false;
  43
  44     if ( !MSWCreateControl(wxT("STATIC"), wxEmptyString, pos, size) )
  45         return false;
  46
  47     // we set the label here and not through MSWCreateControl() because we
  48     // need to do many operation on it for ellipsization&markup support
  49     SetLabel(label);
  50
  51     // as we didn't pass the correct label to MSWCreateControl(), it didn't set
  52     // the initial size correctly -- do it now
  53     InvalidateBestSize();
  54     SetInitialSize(size);
  55
  56     // NOTE: if the label contains ampersand characters which are interpreted as
  57     //       accelerators, they will be rendered (at least on WinXP) only if the
  58     //       static text is placed inside a window class which correctly handles
  59     //       focusing by TAB traversal (e.g. wxPanel).
  60
  61     return true;
  62 }
  63
  64 WXDWORD wxStaticText::MSWGetStyle(long style, WXDWORD *exstyle) const
  65 {
  66     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
  67
  68     // translate the alignment flags to the Windows ones
  69     //
  70     // note that both wxALIGN_LEFT and SS_LEFT are equal to 0 so we shouldn't
  71     // test for them using & operator
  72     if ( style & wxALIGN_CENTRE )
  73         msStyle |= SS_CENTER;
  74     else if ( style & wxALIGN_RIGHT )
  75         msStyle |= SS_RIGHT;
  76     else
  77         msStyle |= SS_LEFT;
  78
  79 #ifdef SS_ENDELLIPSIS
  80     // this style is necessary to receive mouse events
  81     // Win NT and later have the SS_ENDELLIPSIS style which is useful to us:
  82     if (wxGetOsVersion() == wxOS_WINDOWS_NT)
  83     {
  84         // for now, add the SS_ENDELLIPSIS style if wxST_ELLIPSIZE_END is given;
  85         // we may need to remove it later in ::SetLabel() if the given label
  86         // has newlines
  87         if ( style & wxST_ELLIPSIZE_END )
  88             msStyle |= SS_ENDELLIPSIS;
  89     }
  90 #endif // SS_ENDELLIPSIS
  91
  92     msStyle |= SS_NOTIFY;
  93
  94     return msStyle;
  95 }
  96
  97 wxSize wxStaticText::DoGetBestClientSize() const
  98 {
  99     wxClientDC dc(const_cast<wxStaticText *>(this));
 100     wxFont font(GetFont());
 101     if (!font.Ok())
 102         font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 103
 104     dc.SetFont(font);
 105
 106     wxCoord widthTextMax, heightTextTotal;
 107     dc.GetMultiLineTextExtent(GetLabelText(), &widthTextMax, &heightTextTotal);
 108
 109 #ifdef __WXWINCE__
 110     if ( widthTextMax )
 111         widthTextMax += 2;
 112 #endif // __WXWINCE__
 113
 114     // It looks like the static control needs "slightly" more vertical space
 115     // than the character height and while the text isn't actually truncated if
 116     // we use just the minimal height, it is positioned differently than when
 117     // the control has enough space and this result in the text in edit and
 118     // static controls not being aligned when the controls themselves are. As
 119     // this is something you really should be able to count on, increase the
 120     // space allocated for the control so that the base lines do align
 121     // correctly. Notice that while the above is true at least for the single
 122     // line controls, there doesn't seem to do any harm to allocate two extra
 123     // pixels in multi-line case neither so do it always for consistency.
 124     //
 125     // I still have no idea why exactly is this needed nor why should we use 2
 126     // and not something else. This seems to work in all the configurations
 127     // though (small/large fonts, different OS versions, ...) so just hard code
 128     // it for now. If we need something better later it might be worth looking
 129     // at the height of the text control returned by ::GetComboBoxInfo() as it
 130     // seems to be the "minimal acceptable" height.
 131     heightTextTotal += 2;
 132
 133     return wxSize(widthTextMax, heightTextTotal);
 134 }
 135
 136 void wxStaticText::DoSetSize(int x, int y, int w, int h, int sizeFlags)
 137 {
 138     // note: we first need to set the size and _then_ call UpdateLabel
 139     wxStaticTextBase::DoSetSize(x, y, w, h, sizeFlags);
 140
 141 #ifdef SS_ENDELLIPSIS
 142     // do we need to ellipsize the contents?
 143     long styleReal = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 144     if ( !(styleReal & SS_ENDELLIPSIS) )
 145     {
 146         // we don't have SS_ENDELLIPSIS style:
 147         // we need to (eventually) do ellipsization ourselves
 148         UpdateLabel();
 149     }
 150     //else: we don't or the OS will do it for us
 151 #endif // SS_ENDELLIPSIS
 152
 153     // we need to refresh the window after changing its size as the standard
 154     // control doesn't always update itself properly
 155     Refresh();
 156 }
 157
 158 void wxStaticText::SetLabel(const wxString& label)
 159 {
 160 #ifdef SS_ENDELLIPSIS
 161     long styleReal = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 162     if ( HasFlag(wxST_ELLIPSIZE_END) &&
 163           wxGetOsVersion() == wxOS_WINDOWS_NT )
 164     {
 165         // adding SS_ENDELLIPSIS or SS_ENDELLIPSIS "disables" the correct
 166         // newline handling in static texts: the newlines in the labels are
 167         // shown as square. Thus we don't use it even on newer OS when
 168         // the static label contains a newline.
 169         if ( label.Contains(wxT('\n')) )
 170             styleReal &= ~SS_ENDELLIPSIS;
 171         else
 172             styleReal |= SS_ENDELLIPSIS;
 173
 174         ::SetWindowLong(GetHwnd(), GWL_STYLE, styleReal);
 175     }
 176     else // style not supported natively
 177     {
 178         styleReal &= ~SS_ENDELLIPSIS;
 179         ::SetWindowLong(GetHwnd(), GWL_STYLE, styleReal);
 180     }
 181 #endif // SS_ENDELLIPSIS
 182
 183     // save the label in m_labelOrig with both the markup (if any) and
 184     // the mnemonics characters (if any)
 185     m_labelOrig = label;
 186
 187 #ifdef SS_ENDELLIPSIS
 188     if ( styleReal & SS_ENDELLIPSIS )
 189         DoSetLabel(GetLabelWithoutMarkup());
 190     else
 191 #endif // SS_ENDELLIPSIS
 192         DoSetLabel(GetEllipsizedLabelWithoutMarkup());
 193
 194     // adjust the size of the window to fit to the label unless autoresizing is
 195     // disabled
 196     if ( !HasFlag(wxST_NO_AUTORESIZE) &&
 197          !IsEllipsized() )  // if ellipsize is ON, then we don't want to get resized!
 198     {
 199         InvalidateBestSize();
 200         DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, wxDefaultCoord,
 201                   wxSIZE_AUTO_WIDTH | wxSIZE_AUTO_HEIGHT);
 202     }
 203 }
 204
 205 bool wxStaticText::SetFont(const wxFont& font)
 206 {
 207     bool ret = wxControl::SetFont(font);
 208
 209     // adjust the size of the window to fit to the label unless autoresizing is
 210     // disabled
 211     if ( !HasFlag(wxST_NO_AUTORESIZE) )
 212     {
 213         InvalidateBestSize();
 214         DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, wxDefaultCoord,
 215                   wxSIZE_AUTO_WIDTH | wxSIZE_AUTO_HEIGHT);
 216     }
 217
 218     return ret;
 219 }
 220
 221 // for wxST_ELLIPSIZE_* support:
 222
 223 wxString wxStaticText::DoGetLabel() const
 224 {
 225     return wxGetWindowText(GetHwnd());
 226 }
 227
 228 void wxStaticText::DoSetLabel(const wxString& str)
 229 {
 230     SetWindowText(GetHwnd(), str.c_str());
 231 }
 232
 233
 234 #endif // wxUSE_STATTEXT