src/msw/calctrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/calctrl.cpp
   3 // Purpose:     wxCalendarCtrl implementation
   4 // Author:      Vadim Zeitlin
   5 // Created:     2008-04-04
   6 // RCS-ID:      $Id$
   7 // Copyright:   (C) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // ============================================================================
  12 // declarations
  13 // ============================================================================
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/wxprec.h"
  20
  21 #ifdef __BORLANDC__
  22     #pragma hdrstop
  23 #endif
  24
  25 #if wxUSE_CALENDARCTRL
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/msw/wrapwin.h"
  29     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  30     #include "wx/msw/private.h"
  31 #endif
  32
  33 #include "wx/calctrl.h"
  34
  35 #include "wx/msw/private/datecontrols.h"
  36
  37 IMPLEMENT_DYNAMIC_CLASS(wxCalendarCtrl, wxControl)
  38
  39 // ----------------------------------------------------------------------------
  40 // constants
  41 // ----------------------------------------------------------------------------
  42
  43 namespace
  44 {
  45
  46 // values of week days used by the native control
  47 enum
  48 {
  49     MonthCal_Monday,
  50     MonthCal_Tuesday,
  51     MonthCal_Wednesday,
  52     MonthCal_Thursday,
  53     MonthCal_Friday,
  54     MonthCal_Saturday,
  55     MonthCal_Sunday
  56 };
  57
  58 } // anonymous namespace
  59
  60 // ============================================================================
  61 // implementation
  62 // ============================================================================
  63
  64 // ----------------------------------------------------------------------------
  65 // wxCalendarCtrl creation
  66 // ----------------------------------------------------------------------------
  67
  68 void wxCalendarCtrl::Init()
  69 {
  70     m_marks =
  71     m_holidays = 0;
  72 }
  73
  74 bool
  75 wxCalendarCtrl::Create(wxWindow *parent,
  76                        wxWindowID id,
  77                        const wxDateTime& dt,
  78                        const wxPoint& pos,
  79                        const wxSize& size,
  80                        long style,
  81                        const wxString& name)
  82 {
  83     if ( !wxMSWDateControls::CheckInitialization() )
  84         return false;
  85
  86     // we need the arrows for the navigation
  87     style |= wxWANTS_CHARS;
  88
  89     // initialize the base class
  90     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
  91         return false;
  92
  93     // create the native control: this is a bit tricky as we want to receive
  94     // double click events but the MONTHCAL_CLASS doesn't use CS_DBLCLKS style
  95     // and so we create our own copy of it which does
  96     static ClassRegistrar s_clsMonthCal;
  97     if ( !s_clsMonthCal.IsInitialized() )
  98     {
  99         // get a copy of standard class and modify it
 100         WNDCLASS wc;
 101         if ( ::GetClassInfo(NULL, MONTHCAL_CLASS, &wc) )
 102         {
 103             wc.lpszClassName = wxT("_wx_SysMonthCtl32");
 104             wc.style |= CS_DBLCLKS;
 105             s_clsMonthCal.Register(wc);
 106         }
 107         else
 108         {
 109             wxLogLastError(wxT("GetClassInfoEx(SysMonthCal32)"));
 110         }
 111     }
 112
 113     const wxChar * const clsname = s_clsMonthCal.IsRegistered()
 114         ? s_clsMonthCal.GetName().wx_str()
 115         : MONTHCAL_CLASS;
 116
 117     if ( !MSWCreateControl(clsname, wxEmptyString, pos, size) )
 118         return false;
 119
 120     // initialize the control
 121     UpdateFirstDayOfWeek();
 122
 123     SetDate(dt.IsValid() ? dt : wxDateTime::Today());
 124
 125     if ( SetHolidayAttrs() )
 126         UpdateMarks();
 127
 128     Connect(wxEVT_LEFT_DOWN,
 129             wxMouseEventHandler(wxCalendarCtrl::MSWOnClick));
 130     Connect(wxEVT_LEFT_DCLICK,
 131             wxMouseEventHandler(wxCalendarCtrl::MSWOnDoubleClick));
 132
 133     return true;
 134 }
 135
 136 WXDWORD wxCalendarCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const
 137 {
 138     WXDWORD styleMSW = wxCalendarCtrlBase::MSWGetStyle(style, exstyle);
 139
 140     // right now we don't support all native styles but we should add wx styles
 141     // corresponding to MCS_NOTODAY and MCS_NOTODAYCIRCLE probably (TODO)
 142
 143     // for compatibility with the other versions, just turn off today display
 144     // unconditionally for now
 145     styleMSW |= MCS_NOTODAY;
 146
 147     // we also need this style for Mark() to work
 148     styleMSW |= MCS_DAYSTATE;
 149
 150     if ( style & wxCAL_SHOW_WEEK_NUMBERS )
 151        styleMSW |= MCS_WEEKNUMBERS;
 152
 153     return styleMSW;
 154 }
 155
 156 void wxCalendarCtrl::SetWindowStyleFlag(long style)
 157 {
 158     const bool hadMondayFirst = HasFlag(wxCAL_MONDAY_FIRST);
 159
 160     wxCalendarCtrlBase::SetWindowStyleFlag(style);
 161
 162     if ( HasFlag(wxCAL_MONDAY_FIRST) != hadMondayFirst )
 163         UpdateFirstDayOfWeek();
 164 }
 165
 166 // ----------------------------------------------------------------------------
 167 // wxCalendarCtrl geometry
 168 // ----------------------------------------------------------------------------
 169
 170 // TODO: handle WM_WININICHANGE
 171 wxSize wxCalendarCtrl::DoGetBestSize() const
 172 {
 173     RECT rc;
 174     if ( !GetHwnd() || !MonthCal_GetMinReqRect(GetHwnd(), &rc) )
 175     {
 176         return wxCalendarCtrlBase::DoGetBestSize();
 177     }
 178
 179     const wxSize best = wxRectFromRECT(rc).GetSize() + GetWindowBorderSize();
 180     CacheBestSize(best);
 181     return best;
 182 }
 183
 184 wxCalendarHitTestResult
 185 wxCalendarCtrl::HitTest(const wxPoint& pos,
 186                         wxDateTime *date,
 187                         wxDateTime::WeekDay *wd)
 188 {
 189     WinStruct<MCHITTESTINFO> hti;
 190
 191     // Vista and later SDKs add a few extra fields to MCHITTESTINFO which are
 192     // not supported by the previous versions, as we don't use them anyhow we
 193     // should pretend that we always use the old struct format to make the call
 194     // below work on pre-Vista systems (see #11057)
 195 #ifdef MCHITTESTINFO_V1_SIZE
 196     hti.cbSize = MCHITTESTINFO_V1_SIZE;
 197 #endif
 198
 199     hti.pt.x = pos.x;
 200     hti.pt.y = pos.y;
 201     switch ( MonthCal_HitTest(GetHwnd(), &hti) )
 202     {
 203         default:
 204         case MCHT_CALENDARWEEKNUM:
 205             wxFAIL_MSG( "unexpected" );
 206             // fall through
 207
 208         case MCHT_NOWHERE:
 209         case MCHT_CALENDARBK:
 210         case MCHT_TITLEBK:
 211         case MCHT_TITLEMONTH:
 212         case MCHT_TITLEYEAR:
 213             return wxCAL_HITTEST_NOWHERE;
 214
 215         case MCHT_CALENDARDATE:
 216             if ( date )
 217                 date->SetFromMSWSysTime(hti.st);
 218             return wxCAL_HITTEST_DAY;
 219
 220         case MCHT_CALENDARDAY:
 221             if ( wd )
 222             {
 223                 int day = hti.st.wDayOfWeek;
 224
 225                 // the native control returns incorrect day of the week when
 226                 // the first day isn't Monday, i.e. the first column is always
 227                 // "Monday" even if its label is "Sunday", compensate for it
 228                 const int first = LOWORD(MonthCal_GetFirstDayOfWeek(GetHwnd()));
 229                 if ( first == MonthCal_Monday )
 230                 {
 231                     // as MonthCal_Monday is 0 while wxDateTime::Mon is 1,
 232                     // normally we need to do this to transform from MSW
 233                     // convention to wx one
 234                     day++;
 235                     day %= 7;
 236                 }
 237                 //else: but when the first day is MonthCal_Sunday, the native
 238                 //      control still returns 0 (i.e. MonthCal_Monday) for the
 239                 //      first column which looks like a bug in it but to work
 240                 //      around it it's enough to not apply the correction above
 241
 242                 *wd = static_cast<wxDateTime::WeekDay>(day);
 243             }
 244             return wxCAL_HITTEST_HEADER;
 245
 246         case MCHT_TITLEBTNNEXT:
 247             return wxCAL_HITTEST_INCMONTH;
 248
 249         case MCHT_TITLEBTNPREV:
 250             return wxCAL_HITTEST_DECMONTH;
 251
 252         case MCHT_CALENDARDATENEXT:
 253         case MCHT_CALENDARDATEPREV:
 254             return wxCAL_HITTEST_SURROUNDING_WEEK;
 255     }
 256 }
 257
 258 // ----------------------------------------------------------------------------
 259 // wxCalendarCtrl operations
 260 // ----------------------------------------------------------------------------
 261
 262 bool wxCalendarCtrl::SetDate(const wxDateTime& dt)
 263 {
 264     wxCHECK_MSG( dt.IsValid(), false, "invalid date" );
 265
 266     const wxDateTime date = dt.GetDateOnly();
 267
 268     SYSTEMTIME st;
 269     date.GetAsMSWSysTime(&st);
 270     if ( !MonthCal_SetCurSel(GetHwnd(), &st) )
 271     {
 272         wxLogDebug(wxT("DateTime_SetSystemtime() failed"));
 273
 274         return false;
 275     }
 276
 277     m_date = date;
 278
 279     return true;
 280 }
 281
 282 wxDateTime wxCalendarCtrl::GetDate() const
 283 {
 284 #if wxDEBUG_LEVEL
 285     SYSTEMTIME st;
 286     if ( !MonthCal_GetCurSel(GetHwnd(), &st) )
 287     {
 288         wxASSERT_MSG( !m_date.IsValid(), "mismatch between data and control" );
 289
 290         return wxDefaultDateTime;
 291     }
 292
 293     wxDateTime dt(st);
 294
 295     // Windows XP and earlier didn't include the time component into the
 296     // returned date but Windows 7 does, so we can't compare the full objects
 297     // in the same way under all the Windows versions, just compare their date
 298     // parts
 299     wxASSERT_MSG( dt.GetDateOnly() == m_date.GetDateOnly(),
 300                   "mismatch between data and control" );
 301 #endif // wxDEBUG_LEVEL
 302
 303     return m_date;
 304 }
 305
 306 bool wxCalendarCtrl::SetDateRange(const wxDateTime& dt1, const wxDateTime& dt2)
 307 {
 308     SYSTEMTIME st[2];
 309
 310     DWORD flags = 0;
 311     if ( dt1.IsValid() )
 312     {
 313         dt1.GetAsMSWSysTime(st + 0);
 314         flags |= GDTR_MIN;
 315     }
 316
 317     if ( dt2.IsValid() )
 318     {
 319         dt2.GetAsMSWSysTime(st + 1);
 320         flags |= GDTR_MAX;
 321     }
 322
 323     if ( !MonthCal_SetRange(GetHwnd(), flags, st) )
 324     {
 325         wxLogDebug(wxT("MonthCal_SetRange() failed"));
 326     }
 327
 328     return flags != 0;
 329 }
 330
 331 bool wxCalendarCtrl::GetDateRange(wxDateTime *dt1, wxDateTime *dt2) const
 332 {
 333     SYSTEMTIME st[2];
 334
 335     DWORD flags = MonthCal_GetRange(GetHwnd(), st);
 336     if ( dt1 )
 337     {
 338         if ( flags & GDTR_MIN )
 339             dt1->SetFromMSWSysTime(st[0]);
 340         else
 341             *dt1 = wxDefaultDateTime;
 342     }
 343
 344     if ( dt2 )
 345     {
 346         if ( flags & GDTR_MAX )
 347             dt2->SetFromMSWSysTime(st[1]);
 348         else
 349             *dt2 = wxDefaultDateTime;
 350     }
 351
 352     return flags != 0;
 353 }
 354
 355 // ----------------------------------------------------------------------------
 356 // other wxCalendarCtrl operations
 357 // ----------------------------------------------------------------------------
 358
 359 bool wxCalendarCtrl::EnableMonthChange(bool enable)
 360 {
 361     if ( !wxCalendarCtrlBase::EnableMonthChange(enable) )
 362         return false;
 363
 364     wxDateTime dtStart, dtEnd;
 365     if ( !enable )
 366     {
 367         dtStart = GetDate();
 368         dtStart.SetDay(1);
 369
 370         dtEnd = dtStart.GetLastMonthDay();
 371     }
 372     //else: leave them invalid to remove the restriction
 373
 374     SetDateRange(dtStart, dtEnd);
 375
 376     return true;
 377 }
 378
 379 void wxCalendarCtrl::Mark(size_t day, bool mark)
 380 {
 381     wxCHECK_RET( day > 0 && day < 32, "invalid day" );
 382
 383     int mask = 1 << (day - 1);
 384     if ( mark )
 385         m_marks |= mask;
 386     else
 387         m_marks &= ~mask;
 388
 389     // calling Refresh() here is not enough to change the day appearance
 390     UpdateMarks();
 391 }
 392
 393 void wxCalendarCtrl::SetHoliday(size_t day)
 394 {
 395     wxCHECK_RET( day > 0 && day < 32, "invalid day" );
 396
 397     m_holidays |= 1 << (day - 1);
 398 }
 399
 400 void wxCalendarCtrl::UpdateMarks()
 401 {
 402     // we show only one full month but there can be some days from the month
 403     // before it and from the one after it so days from 3 different months can
 404     // be partially shown
 405     MONTHDAYSTATE states[3] = { 0 };
 406     const DWORD nMonths = MonthCal_GetMonthRange(GetHwnd(), GMR_DAYSTATE, NULL);
 407
 408     // although in principle the calendar might not show any days from the
 409     // preceding months, it seems like it always does, consider e.g. Feb 2010
 410     // which starts on Monday and ends on Sunday and so could fit on 4 lines
 411     // without showing any subsequent months -- the standard control still
 412     // shows it on 6 lines and the number of visible months is still 3
 413     //
 414     // OTOH Windows 7 control can show all 12 months or even years or decades
 415     // in its window if you "zoom out" of it by double clicking on free areas
 416     // so the return value can be (much, in case of decades view) greater than
 417     // 3 but in this case marks are not visible anyhow so simply ignore it
 418     if ( nMonths < WXSIZEOF(states) )
 419     {
 420         wxFAIL_MSG("unexpectedly few months shown in the control");
 421     }
 422     else if ( nMonths == WXSIZEOF(states) )
 423     {
 424         // the fully visible month is the one in the middle
 425         states[1] = m_marks | m_holidays;
 426
 427         if ( !MonthCal_SetDayState(GetHwnd(), nMonths, states) )
 428         {
 429             wxLogLastError(wxT("MonthCal_SetDayState"));
 430         }
 431     }
 432     //else: not a month view at all
 433 }
 434
 435 void wxCalendarCtrl::UpdateFirstDayOfWeek()
 436 {
 437     MonthCal_SetFirstDayOfWeek(GetHwnd(),
 438                                HasFlag(wxCAL_MONDAY_FIRST) ? MonthCal_Monday
 439                                                            : MonthCal_Sunday);
 440 }
 441
 442 // ----------------------------------------------------------------------------
 443 // wxCalendarCtrl events
 444 // ----------------------------------------------------------------------------
 445
 446 bool wxCalendarCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
 447 {
 448     NMHDR* hdr = (NMHDR *)lParam;
 449     switch ( hdr->code )
 450     {
 451         case MCN_SELCHANGE:
 452             {
 453                 // we need to update m_date first, before calling the user code
 454                 // which expects GetDate() to return the new date
 455                 const wxDateTime dateOld = m_date;
 456                 const NMSELCHANGE * const sch = (NMSELCHANGE *)lParam;
 457                 m_date.SetFromMSWSysTime(sch->stSelStart);
 458
 459                 // changing the year or the month results in a second dummy
 460                 // MCN_SELCHANGE event on this system which doesn't really
 461                 // change anything -- filter it out
 462                 if ( m_date != dateOld )
 463                 {
 464                     if ( GenerateAllChangeEvents(dateOld) )
 465                     {
 466                         // month changed, need to update the holidays if we use
 467                         // them
 468                         if ( SetHolidayAttrs() )
 469                             UpdateMarks();
 470                     }
 471                 }
 472             }
 473             break;
 474
 475         case MCN_GETDAYSTATE:
 476             {
 477                 const NMDAYSTATE * const ds = (NMDAYSTATE *)lParam;
 478                 for ( int i = 0; i < ds->cDayState; i++ )
 479                 {
 480                     ds->prgDayState[i] = m_marks | m_holidays;
 481                 }
 482             }
 483             break;
 484
 485         default:
 486             return wxCalendarCtrlBase::MSWOnNotify(idCtrl, lParam, result);
 487     }
 488
 489     *result = 0;
 490     return true;
 491 }
 492
 493 void wxCalendarCtrl::MSWOnDoubleClick(wxMouseEvent& event)
 494 {
 495     if ( HitTest(event.GetPosition()) == wxCAL_HITTEST_DAY )
 496     {
 497         if ( GenerateEvent(wxEVT_CALENDAR_DOUBLECLICKED) )
 498             return; // skip event.Skip() below
 499     }
 500
 501     event.Skip();
 502 }
 503
 504 void wxCalendarCtrl::MSWOnClick(wxMouseEvent& event)
 505 {
 506     // for some reason, the control doesn't get focus on its own when the user
 507     // clicks in it
 508     SetFocus();
 509
 510     event.Skip();
 511 }
 512
 513 #endif // wxUSE_CALENDARCTRL