include/svtools/calendar.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SVTOOLS_CALENDAR_HXX
  21 #define INCLUDED_SVTOOLS_CALENDAR_HXX
  22
  23 #include <svtools/svtdllapi.h>
  24 #include <unotools/calendarwrapper.hxx>
  25
  26 #include <vcl/calendar.hxx>
  27 #include <vcl/ctrl.hxx>
  28 #include <vcl/field.hxx>
  29 #include <memory>
  30 #include <set>
  31
  32 class MouseEvent;
  33 class TrackingEvent;
  34 class KeyEvent;
  35 class HelpEvent;
  36 class DataChangedEvent;
  37 class FloatingWindow;
  38 class PushButton;
  39 class ImplCFieldFloatWin;
  40 class Button;
  41
  42 /*************************************************************************
  43
  44 Description
  45 ============
  46
  47 class CalendarField
  48
  49 This class is a DateField with which one can select a date via a DropDownButton
  50 and the CalendarControl.
  51
  52 --------------------------------------------------------------------------
  53
  54 WinBits
  55
  56 See DateField
  57
  58 The preferences for the CalendarControl can be set via SetCalendarStyle().
  59
  60 --------------------------------------------------------------------------
  61
  62 With EnableToday()/EnableNone() we can enable a TodayButton and a NoneButton.
  63
  64 --------------------------------------------------------------------------
  65
  66 Because we only take over the start date into the field, we should query
  67 with GetCalendar() in the SelectHandler and with GetSelectDateCount()/GetSelectDate()
  68 the selected range. We then can e.g. take over that value to another field.
  69
  70 --------------------------------------------------------------------------
  71
  72 If a derived Calendar should be used, we can override the CreateCalendar()
  73 method in CalendarField and create an own calendar there ourselves.
  74
  75 *************************************************************************/
  76
  77
  78 class SVT_DLLPUBLIC CalendarField : public DateField
  79 {
  80 private:
  81     VclPtr<ImplCFieldFloatWin> mpFloatWin;
  82     VclPtr<Calendar>    mpCalendar;
  83     VclPtr<PushButton>  mpTodayBtn;
  84     VclPtr<PushButton>  mpNoneBtn;
  85     bool                mbToday;
  86     bool                mbNone;
  87
  88                         DECL_DLLPRIVATE_LINK( ImplSelectHdl, Calendar*, void );
  89                         DECL_DLLPRIVATE_LINK( ImplClickHdl, Button*, void );
  90                         DECL_DLLPRIVATE_LINK( ImplPopupModeEndHdl, FloatingWindow*, void );
  91
  92 public:
  93                         CalendarField( vcl::Window* pParent, WinBits nWinStyle );
  94     virtual             ~CalendarField() override;
  95     virtual void        dispose() override;
  96
  97     virtual bool        ShowDropDown( bool bShow ) override;
  98     Calendar*           GetCalendar();
  99
 100     void                EnableToday() { mbToday = true; }
 101     void                EnableNone() { mbNone = true; }
 102
 103 protected:
 104     virtual void    StateChanged( StateChangedType nStateChange ) override;
 105 };
 106
 107 #endif // INCLUDED_SVTOOLS_CALENDAR_HXX
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */