LibreOffice Module vcl (master)  1
vcl/inc/calendar.hxx
Go to the documentation of this file.
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_VCL_CALENDAR_HXX
21 #define INCLUDED_VCL_CALENDAR_HXX
22 
23 #include <vcl/dllapi.h>
25 
26 #include <vcl/ctrl.hxx>
27 #include <memory>
28 #include <set>
29 
30 class MouseEvent;
31 class TrackingEvent;
32 class KeyEvent;
33 class HelpEvent;
35 
36 /*************************************************************************
37 
38 Description
39 ============
40 
41 class Calendar
42 
43 This class allows for the selection of a date. The displayed date range is
44 the one specified by the Date class. We display as many months as we have
45 space in the control. The user can switch between months using a ContextMenu
46 (clicking on the month's name) or via two ScrollButtons in-between the months.
47 
48 --------------------------------------------------------------------------
49 
50 WinBits
51 
52 WB_BORDER We draw a border around the window.
53 WB_TABSTOP Keyboard control is possible. We get the focus, when
54  the user clicks in the Control.
55 
56 --------------------------------------------------------------------------
57 
58 We set and get the selected date by SetCurDate()/GetCurDate().
59 If the user selects a date Select() is called. If the user double clicks
60 DoubleClick() is called.
61 
62 --------------------------------------------------------------------------
63 
64 CalcWindowSizePixel() calculates the window size in pixel that is needed
65 to display a certain number of months.
66 
67 --------------------------------------------------------------------------
68 
69 SetSaturdayColor() and SetSundayColor() set a special color for Saturdays
70 and Sundays.
71 AddDateInfo() marks special days. With that we can set e.g. public holidays
72 to another color or encircle them (for e.g. appointments).
73 If we do not supply a year in the date, the day is used in EVERY year.
74 
75 AddDateInfo() can also add text for every date, which is displayed if the
76 BalloonHelp is enabled.
77 In order to not have to supply all years with the relevant data, we call
78 the RequestDateInfo() handler if a new year is displayed. We can then query
79 the year in the handler with GetRequestYear().
80 
81 --------------------------------------------------------------------------
82 
83 In order to display a ContextMenu for a date, we need to override the
84 Command handler. GetDate() can infer the date from the mouse's position.
85 If we use the keyboard, the current date should be use.
86 
87 If a ContextMenu is displayed, the baseclass' handler must not be called.
88 
89 --------------------------------------------------------------------------
90 
91 SetNoSelection() deselects everything.
92 SetCurDate() does not select the current date, but only defines the focus
93 rectangle.
94 GetSelectDateCount()/GetSelectDate() query the selected range.
95 IsDateSelected() queries for the status of a date.
96 
97 The SelectionChanging() handler is being called while a user selects a
98 date. In it, we can change the selected range. E.g. if we want to limit
99 or extend the selected range. The selected range is realised via SelectDate()
100 and SelectDateRange() and queried with GetSelectDateCount()/GetSelectDate().
101 
102 IsSelectLeft() returns the direction of the selection:
103 sal_True is a selection to the left or up
104 sal_False is a selection to the right or down
105 
106 --------------------------------------------------------------------------
107 
108 If the DateRange area changes and we want to take over the selection, we
109 should only do this is if IsScrollDateRangeChanged() returns sal_True.
110 This method returns sal_True if the area change was triggered by using the
111 ScrollButtons and sal_False if it was triggered by Resize(), other method
112 calls or by ending a selection.
113 
114 *************************************************************************/
115 
116 typedef std::set<sal_Int32> IntDateSet;
117 
118 class Calendar final : public Control
119 {
120  std::unique_ptr<IntDateSet> mpSelectTable;
121  std::unique_ptr<IntDateSet> mpOldSelectTable;
122  OUString maDayTexts[31];
123  OUString maDayText;
124  OUString maWeekText;
128  OUString maDayOfWeekText;
138  sal_Int32 mnDayCount;
149  sal_Int16 mnFirstYear;
150  sal_Int16 mnLastYear;
151  bool mbCalc:1,
152  mbFormat:1,
153  mbDrag:1,
154  mbMenuDown:1,
155  mbSpinDown:1,
156  mbPrevIn:1,
157  mbNextIn:1;
160 
162  using Window::ImplInit;
163  void ImplInit( WinBits nWinStyle );
164  void ImplInitSettings();
165 
166  virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
167 
168  void ImplFormat();
169  using Window::ImplHitTest;
170  sal_uInt16 ImplHitTest( const Point& rPos, Date& rDate ) const;
171  void ImplDrawSpin(vcl::RenderContext& rRenderContext);
172  void ImplDrawDate(vcl::RenderContext& rRenderContext, tools::Long nX, tools::Long nY,
173  sal_uInt16 nDay, sal_uInt16 nMonth, sal_Int16 nYear,
174  bool bOther, sal_Int32 nToday);
175  void ImplDraw(vcl::RenderContext& rRenderContext);
176  void ImplUpdateDate( const Date& rDate );
177  void ImplUpdateSelection( IntDateSet* pOld );
178  void ImplMouseSelect( const Date& rDate, sal_uInt16 nHitTest );
179  void ImplUpdate( bool bCalcNew = false );
180  using Window::ImplScroll;
181  void ImplScroll( bool bPrev );
182  void ImplShowMenu( const Point& rPos, const Date& rDate );
183  void ImplTracking( const Point& rPos, bool bRepeat );
184  void ImplEndTracking( bool bCancel );
185  DayOfWeek ImplGetWeekStart() const;
186 
187  virtual Size GetOptimalSize() const override;
188 public:
189  Calendar( vcl::Window* pParent, WinBits nWinStyle );
190  virtual ~Calendar() override;
191  virtual void dispose() override;
192 
193  virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
194  virtual void Tracking( const TrackingEvent& rMEvt ) override;
195  virtual void KeyInput( const KeyEvent& rKEvt ) override;
196  virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
197  virtual void Resize() override;
198  virtual void GetFocus() override;
199  virtual void LoseFocus() override;
200  virtual void RequestHelp( const HelpEvent& rHEvt ) override;
201  virtual void Command( const CommandEvent& rCEvt ) override;
202  virtual void StateChanged( StateChangedType nStateChange ) override;
203  virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
204 
205  void Select();
206 
207  Date GetFirstSelectedDate() const;
208 
209  void SetCurDate( const Date& rNewDate );
210  void SetFirstDate( const Date& rNewFirstDate );
211  const Date& GetFirstDate() const { return maFirstDate; }
212  Date GetLastDate() const { return GetFirstDate() + mnDayCount; }
213  Date GetFirstMonth() const;
214  Date GetLastMonth() const;
215  sal_uInt16 GetMonthCount() const;
216  bool GetDate( const Point& rPos, Date& rDate ) const;
217  tools::Rectangle GetDateRect( const Date& rDate ) const;
218 
219  void EndSelection();
220 
221  Size CalcWindowSizePixel() const;
222 
223  void SetSelectHdl( const Link<Calendar*,void>& rLink ) { maSelectHdl = rLink; }
224  void SetActivateHdl( const Link<Calendar*,void>& rLink ) { maActivateHdl = rLink; }
225 };
226 
227 #endif // INCLUDED_VCL_CALENDAR_HXX
228 
229 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
tools::Long mnLines
virtual void LoseFocus() override
Definition: calendar.cxx:1138
tools::Rectangle maNextRect
void ImplDraw(vcl::RenderContext &rRenderContext)
Definition: calendar.cxx:596
const Date & GetFirstDate() const
Link< Calendar *, void > maActivateHdl
sal_Int16 mnFirstYear
long Long
tools::Long mnDayWidth
virtual ~Calendar() override
Definition: calendar.cxx:145
void ImplUpdate(bool bCalcNew=false)
Definition: calendar.cxx:841
std::unique_ptr< IntDateSet > mpOldSelectTable
virtual void ApplySettings(vcl::RenderContext &rRenderContext) override
Definition: calendar.cxx:114
void ImplUpdateDate(const Date &rDate)
Definition: calendar.cxx:773
virtual void DataChanged(const DataChangedEvent &rDCEvt) override
Definition: calendar.cxx:1248
Size CalcWindowSizePixel() const
Definition: calendar.cxx:1494
tools::Long mnWeekDayOffY
void ImplUpdateSelection(IntDateSet *pOld)
Definition: calendar.cxx:785
CalendarWrapper maCalendarWrapper
void ImplInitSettings()
Definition: calendar.cxx:123
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect) override
Definition: calendar.cxx:1127
StateChangedType
Definition: window.hxx:317
tools::Long mnMonthHeight
tools::Long mnMonthWidth
OUString maWeekText
sal_Int64 WinBits
bool GetDate(const Point &rPos, Date &rDate) const
Definition: calendar.cxx:1368
void ImplShowMenu(const Point &rPos, const Date &rDate)
Definition: calendar.cxx:873
tools::Rectangle GetDateRect(const Date &rDate) const
Definition: calendar.cxx:1381
virtual void GetFocus() override
Definition: calendar.cxx:1132
sal_uInt16 ImplHitTest(const Point &rPos, Date &rDate) const
Definition: calendar.cxx:328
sal_Int32 mnDayCount
virtual Size GetOptimalSize() const override
Definition: calendar.cxx:1511
virtual void MouseButtonDown(const MouseEvent &rMEvt) override
Definition: calendar.cxx:1003
OUString maDayTexts[31]
Date GetFirstMonth() const
Definition: calendar.cxx:1337
std::set< sal_Int32 > IntDateSet
void SetActivateHdl(const Link< Calendar *, void > &rLink)
virtual void Tracking(const TrackingEvent &rMEvt) override
Definition: calendar.cxx:1052
tools::Long mnDayHeight
void ImplMouseSelect(const Date &rDate, sal_uInt16 nHitTest)
Definition: calendar.cxx:808
void ImplScroll(bool bPrev)
Definition: calendar.cxx:860
std::unique_ptr< IntDateSet > mpSelectTable
tools::Rectangle maPrevRect
Calendar(vcl::Window *pParent, WinBits nWinStyle)
Definition: calendar.cxx:132
sal_uInt16 GetMonthCount() const
Definition: calendar.cxx:1360
OUString maDayText
void ImplFormat()
Definition: calendar.cxx:192
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:303
virtual void Resize() override
Definition: calendar.cxx:1144
tools::Long mnMonthPerLine
void SetSelectHdl(const Link< Calendar *, void > &rLink)
void ImplDrawSpin(vcl::RenderContext &rRenderContext)
Definition: calendar.cxx:503
virtual void KeyInput(const KeyEvent &rKEvt) override
Definition: calendar.cxx:1062
DayOfWeek ImplGetWeekStart() const
Definition: calendar.cxx:157
Date maOldFormatLastDate
void SetCurDate(const Date &rNewDate)
Definition: calendar.cxx:1278
void ImplDrawDate(vcl::RenderContext &rRenderContext, tools::Long nX, tools::Long nY, sal_uInt16 nDay, sal_uInt16 nMonth, sal_Int16 nYear, bool bOther, sal_Int32 nToday)
Definition: calendar.cxx:521
void ImplInit(WinBits nWinStyle)
Definition: calendar.cxx:69
WinBits mnWinStyle
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects...
Definition: calendar.cxx:150
Definition: ctrl.hxx:33
OUString maDayOfWeekText
DayOfWeek
Date GetLastMonth() const
Definition: calendar.cxx:1350
void ImplTracking(const Point &rPos, bool bRepeat)
Definition: calendar.cxx:927
Date maOldFormatFirstDate
void ImplEndTracking(bool bCancel)
Definition: calendar.cxx:946
void SetFirstDate(const Date &rNewFirstDate)
Definition: calendar.cxx:1328
virtual void RequestHelp(const HelpEvent &rHEvt) override
Definition: calendar.cxx:1150
tools::Long mnDaysOffX
Date GetFirstSelectedDate() const
Definition: calendar.cxx:1267
Date GetLastDate() const
Link< Calendar *, void > maSelectHdl
void ImplInitSettings()
Definition: ctrl.cxx:428
tools::Long mnDayOfWeekAry[7]
sal_Int16 mnLastYear
tools::Long mnDaysOffY
void EndSelection()
Definition: calendar.cxx:1481
void Select()
Definition: calendar.cxx:1262
virtual void StateChanged(StateChangedType nStateChange) override
Definition: calendar.cxx:1240
virtual void Command(const CommandEvent &rCEvt) override
Definition: calendar.cxx:1195