src/msw/datectrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/datectrl.cpp
   3 // Purpose:     wxDatePickerCtrl implementation
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     2005-01-09
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2005 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_DATEPICKCTRL
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/msw/wrapwin.h"
  30     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  31     #include "wx/app.h"
  32     #include "wx/intl.h"
  33     #include "wx/dcclient.h"
  34     #include "wx/msw/private.h"
  35 #endif
  36
  37 #include "wx/datectrl.h"
  38 #include "wx/dynlib.h"
  39
  40 #define _WX_DEFINE_DATE_EVENTS_
  41 #include "wx/dateevt.h"
  42
  43 // apparently some versions of mingw define these macros erroneously
  44 #ifndef DateTime_GetSystemtime
  45     #define DateTime_GetSystemtime DateTime_GetSystemTime
  46 #endif
  47
  48 #ifndef DateTime_SetSystemtime
  49     #define DateTime_SetSystemtime DateTime_SetSystemTime
  50 #endif
  51
  52 IMPLEMENT_DYNAMIC_CLASS(wxDatePickerCtrl, wxControl)
  53
  54 // ============================================================================
  55 // implementation
  56 // ============================================================================
  57
  58 // ----------------------------------------------------------------------------
  59 // helpers for wxDateTime <-> SYSTEMTIME conversion
  60 // ----------------------------------------------------------------------------
  61
  62 static inline void wxFromSystemTime(wxDateTime *dt, const SYSTEMTIME& st)
  63 {
  64     dt->Set(st.wDay,
  65             wx_static_cast(wxDateTime::Month, wxDateTime::Jan + st.wMonth - 1),
  66             st.wYear,
  67             0, 0, 0);
  68 }
  69
  70 static inline void wxToSystemTime(SYSTEMTIME *st, const wxDateTime& dt)
  71 {
  72     const wxDateTime::Tm tm(dt.GetTm());
  73
  74     st->wYear = (WXWORD)tm.year;
  75     st->wMonth = (WXWORD)(tm.mon - wxDateTime::Jan + 1);
  76     st->wDay = tm.mday;
  77
  78     st->wDayOfWeek =
  79     st->wHour =
  80     st->wMinute =
  81     st->wSecond =
  82     st->wMilliseconds = 0;
  83 }
  84
  85 // ----------------------------------------------------------------------------
  86 // wxDatePickerCtrl creation
  87 // ----------------------------------------------------------------------------
  88
  89 bool
  90 wxDatePickerCtrl::Create(wxWindow *parent,
  91                          wxWindowID id,
  92                          const wxDateTime& dt,
  93                          const wxPoint& pos,
  94                          const wxSize& size,
  95                          long style,
  96                          const wxValidator& validator,
  97                          const wxString& name)
  98 {
  99     // although we already call InitCommonControls() in app.cpp which is
 100     // supposed to initialize all common controls, in comctl32.dll 4.72 (and
 101     // presumably earlier versions 4.70 and 4.71, date time picker not being
 102     // supported in < 4.70 anyhow) it does not do it and we have to initialize
 103     // it explicitly
 104     static bool s_initDone = false; // MT-ok: used from GUI thread only
 105     if ( !s_initDone )
 106     {
 107 #ifndef __WXWINCE__
 108         if ( wxApp::GetComCtl32Version() < 470 )
 109         {
 110             wxLogError(_("This system doesn't support date picker control, please upgrade your version of comctl32.dll"));
 111
 112             return false;
 113         }
 114 #endif
 115
 116 #if wxUSE_DYNLIB_CLASS
 117         INITCOMMONCONTROLSEX icex;
 118         icex.dwSize = sizeof(icex);
 119         icex.dwICC = ICC_DATE_CLASSES;
 120
 121         wxDynamicLibrary dllComCtl32(
 122 #ifdef __WXWINCE__
 123             _T("commctrl.dll")
 124 #else
 125             _T("comctl32.dll")
 126 #endif
 127             , wxDL_VERBATIM);
 128
 129         if ( dllComCtl32.IsLoaded() )
 130         {
 131             typedef BOOL (WINAPI *ICCEx_t)(INITCOMMONCONTROLSEX *);
 132             wxDYNLIB_FUNCTION( ICCEx_t, InitCommonControlsEx, dllComCtl32 );
 133
 134             if ( pfnInitCommonControlsEx )
 135             {
 136                 (*pfnInitCommonControlsEx)(&icex);
 137             }
 138
 139             s_initDone = true;
 140         }
 141 #endif
 142     }
 143
 144
 145     // use wxDP_SPIN if wxDP_DEFAULT (0) was given as style
 146     if ( !(style & wxDP_DROPDOWN) )
 147         style |= wxDP_SPIN;
 148
 149     // initialize the base class
 150     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 151         return false;
 152
 153     // create the native control
 154     if ( !MSWCreateControl(DATETIMEPICK_CLASS, wxEmptyString, pos, size) )
 155         return false;
 156
 157     if ( dt.IsValid() || (style & wxDP_ALLOWNONE) )
 158         SetValue(dt);
 159     else
 160         SetValue(wxDateTime::Today());
 161
 162     return true;
 163 }
 164
 165 WXDWORD wxDatePickerCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const
 166 {
 167     WXDWORD styleMSW = wxDatePickerCtrlBase::MSWGetStyle(style, exstyle);
 168
 169     // although MSDN doesn't mention it, DTS_UPDOWN doesn't work with
 170     // comctl32.dll 4.72
 171     if ( wxApp::GetComCtl32Version() > 472 && (style & wxDP_SPIN) )
 172         styleMSW |= DTS_UPDOWN;
 173     //else: drop down by default
 174
 175 #ifdef DTS_SHORTDATECENTURYFORMAT
 176     if ( style & wxDP_SHOWCENTURY )
 177         styleMSW |= DTS_SHORTDATECENTURYFORMAT;
 178     else
 179 #endif // DTS_SHORTDATECENTURYFORMAT
 180         styleMSW |= DTS_SHORTDATEFORMAT;
 181
 182     if ( style & wxDP_ALLOWNONE )
 183         styleMSW |= DTS_SHOWNONE;
 184
 185     return styleMSW;
 186 }
 187
 188 // TODO: handle WM_WININICHANGE
 189
 190 // ----------------------------------------------------------------------------
 191 // wxDatePickerCtrl geometry
 192 // ----------------------------------------------------------------------------
 193
 194 wxSize wxDatePickerCtrl::DoGetBestSize() const
 195 {
 196     wxClientDC dc(wx_const_cast(wxDatePickerCtrl *, this));
 197     dc.SetFont(GetFont());
 198
 199     // we can't use FormatDate() here as the CRT doesn't always use the same
 200     // format as the date picker control
 201     wxString s;
 202     for ( int len = 100; ; len *= 2 )
 203     {
 204         if ( ::GetDateFormat
 205                (
 206                     LOCALE_USER_DEFAULT,    // the control should use the same
 207                     DATE_SHORTDATE,         // the format used by the control
 208                     NULL,                   // use current date (we don't care)
 209                     NULL,                   // no custom format
 210                     wxStringBuffer(s, len), // output buffer
 211                     len                     // and its length
 212                ) )
 213         {
 214             // success
 215             break;
 216         }
 217
 218         const DWORD rc = ::GetLastError();
 219         if ( rc != ERROR_INSUFFICIENT_BUFFER )
 220         {
 221             wxLogApiError(_T("GetDateFormat"), rc);
 222
 223             // fall back on wxDateTime, what else to do?
 224             s = wxDateTime::Today().FormatDate();
 225             break;
 226         }
 227     }
 228
 229     // the control adds a lot of extra space around separators
 230     s.Replace(_T(","), _T("    ,    "));
 231
 232     int x, y;
 233     dc.GetTextExtent(s, &x, &y);
 234
 235     wxSize best(x + 40 /* margin + arrows */, EDIT_HEIGHT_FROM_CHAR_HEIGHT(y));
 236     CacheBestSize(best);
 237     return best;
 238 }
 239
 240 // ----------------------------------------------------------------------------
 241 // wxDatePickerCtrl operations
 242 // ----------------------------------------------------------------------------
 243
 244 void wxDatePickerCtrl::SetValue(const wxDateTime& dt)
 245 {
 246     wxCHECK_RET( dt.IsValid() || HasFlag(wxDP_ALLOWNONE),
 247                     _T("this control requires a valid date") );
 248
 249     SYSTEMTIME st;
 250     if ( dt.IsValid() )
 251         wxToSystemTime(&st, dt);
 252     if ( !DateTime_SetSystemtime(GetHwnd(),
 253                                  dt.IsValid() ? GDT_VALID : GDT_NONE,
 254                                  &st) )
 255     {
 256         wxLogDebug(_T("DateTime_SetSystemtime() failed"));
 257     }
 258
 259     // we need to keep only the date part, times don't make sense for this
 260     // control (in particular, comparisons with other dates would fail)
 261     m_date = dt;
 262     if ( m_date.IsValid() )
 263         m_date.ResetTime();
 264 }
 265
 266 wxDateTime wxDatePickerCtrl::GetValue() const
 267 {
 268 #ifdef __WXDEBUG__
 269     wxDateTime dt;
 270     SYSTEMTIME st;
 271     if ( DateTime_GetSystemtime(GetHwnd(), &st) == GDT_VALID )
 272     {
 273         wxFromSystemTime(&dt, st);
 274     }
 275
 276     wxASSERT_MSG( m_date.IsValid() == dt.IsValid() &&
 277                     (!dt.IsValid() || dt == m_date),
 278                   _T("bug in wxDatePickerCtrl: m_date not in sync") );
 279 #endif // __WXDEBUG__
 280
 281     return m_date;
 282 }
 283
 284 void wxDatePickerCtrl::SetRange(const wxDateTime& dt1, const wxDateTime& dt2)
 285 {
 286     SYSTEMTIME st[2];
 287
 288     DWORD flags = 0;
 289     if ( dt1.IsValid() )
 290     {
 291         wxToSystemTime(&st[0], dt1);
 292         flags |= GDTR_MIN;
 293     }
 294
 295     if ( dt2.IsValid() )
 296     {
 297         wxToSystemTime(&st[1], dt2);
 298         flags |= GDTR_MAX;
 299     }
 300
 301     if ( !DateTime_SetRange(GetHwnd(), flags, st) )
 302     {
 303         wxLogDebug(_T("DateTime_SetRange() failed"));
 304     }
 305 }
 306
 307 bool wxDatePickerCtrl::GetRange(wxDateTime *dt1, wxDateTime *dt2) const
 308 {
 309     SYSTEMTIME st[2];
 310
 311     DWORD flags = DateTime_GetRange(GetHwnd(), st);
 312     if ( dt1 )
 313     {
 314         if ( flags & GDTR_MIN )
 315             wxFromSystemTime(dt1, st[0]);
 316         else
 317             *dt1 = wxDefaultDateTime;
 318     }
 319
 320     if ( dt2 )
 321     {
 322         if ( flags & GDTR_MAX )
 323             wxFromSystemTime(dt2, st[1]);
 324         else
 325             *dt2 = wxDefaultDateTime;
 326     }
 327
 328     return flags != 0;
 329 }
 330
 331 // ----------------------------------------------------------------------------
 332 // wxDatePickerCtrl events
 333 // ----------------------------------------------------------------------------
 334
 335 bool
 336 wxDatePickerCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 337 {
 338     NMHDR* hdr = (NMHDR *)lParam;
 339     switch ( hdr->code )
 340     {
 341         case DTN_DATETIMECHANGE:
 342         {
 343             NMDATETIMECHANGE *dtch = (NMDATETIMECHANGE *)hdr;
 344             wxDateTime dt;
 345             if ( dtch->dwFlags == GDT_VALID )
 346                 wxFromSystemTime(&dt, dtch->st);
 347
 348             // filter out duplicate DTN_DATETIMECHANGE events which the native
 349             // control sends us when using wxDP_DROPDOWN style
 350             if ( (m_date.IsValid() != dt.IsValid()) ||
 351                     (m_date.IsValid() && dt != m_date) )
 352             {
 353                 m_date = dt;
 354                 wxDateEvent event(this, dt, wxEVT_DATE_CHANGED);
 355                 if ( GetEventHandler()->ProcessEvent(event) )
 356                 {
 357                     *result = 0;
 358                     return true;
 359                 }
 360             }
 361             //else: both the old and new values are invalid, nothing changed
 362         }
 363     }
 364
 365     return wxDatePickerCtrlBase::MSWOnNotify(idCtrl, lParam, result);
 366 }
 367
 368 #endif // wxUSE_DATEPICKCTRL