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
30class MouseEvent;
31class TrackingEvent;
32class KeyEvent;
33class HelpEvent;
35
36/*************************************************************************
37
38Description
39============
40
41class Calendar
42
43This class allows for the selection of a date. The displayed date range is
44the one specified by the Date class. We display as many months as we have
45space 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
50WinBits
51
52WB_BORDER We draw a border around the window.
53WB_TABSTOP Keyboard control is possible. We get the focus, when
54 the user clicks in the Control.
55
56--------------------------------------------------------------------------
57
58We set and get the selected date by SetCurDate()/GetCurDate().
59If the user selects a date Select() is called. If the user double clicks
60DoubleClick() is called.
61
62--------------------------------------------------------------------------
63
64CalcWindowSizePixel() calculates the window size in pixel that is needed
65to display a certain number of months.
66
67--------------------------------------------------------------------------
68
69SetSaturdayColor() and SetSundayColor() set a special color for Saturdays
70and Sundays.
71AddDateInfo() marks special days. With that we can set e.g. public holidays
72to another color or encircle them (for e.g. appointments).
73If we do not supply a year in the date, the day is used in EVERY year.
74
75AddDateInfo() can also add text for every date, which is displayed if the
76BalloonHelp is enabled.
77In order to not have to supply all years with the relevant data, we call
78the RequestDateInfo() handler if a new year is displayed. We can then query
79the year in the handler with GetRequestYear().
80
81--------------------------------------------------------------------------
82
83In order to display a ContextMenu for a date, we need to override the
84Command handler. GetDate() can infer the date from the mouse's position.
85If we use the keyboard, the current date should be use.
86
87If a ContextMenu is displayed, the baseclass' handler must not be called.
88
89--------------------------------------------------------------------------
90
91SetNoSelection() deselects everything.
92SetCurDate() does not select the current date, but only defines the focus
93rectangle.
94GetSelectDateCount()/GetSelectDate() query the selected range.
95IsDateSelected() queries for the status of a date.
96
97The SelectionChanging() handler is being called while a user selects a
98date. In it, we can change the selected range. E.g. if we want to limit
99or extend the selected range. The selected range is realised via SelectDate()
100and SelectDateRange() and queried with GetSelectDateCount()/GetSelectDate().
101
102IsSelectLeft() returns the direction of the selection:
103sal_True is a selection to the left or up
104sal_False is a selection to the right or down
105
106--------------------------------------------------------------------------
107
108If the DateRange area changes and we want to take over the selection, we
109should only do this is if IsScrollDateRangeChanged() returns sal_True.
110This method returns sal_True if the area change was triggered by using the
111ScrollButtons and sal_False if it was triggered by Resize(), other method
112calls or by ending a selection.
113
114*************************************************************************/
115
116typedef std::set<sal_Int32> IntDateSet;
117
118class 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;
129 sal_Int32 mnDayOfWeekAry[7];
138 sal_Int32 mnDayCount;
149 sal_Int16 mnFirstYear;
150 sal_Int16 mnLastYear;
151 bool mbCalc: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 sal_uInt16 ImplDoHitTest( const Point& rPos, Date& rDate ) const;
170 void ImplDrawSpin(vcl::RenderContext& rRenderContext);
171 void ImplDrawDate(vcl::RenderContext& rRenderContext, tools::Long nX, tools::Long nY,
172 sal_uInt16 nDay, sal_uInt16 nMonth, sal_Int16 nYear,
173 bool bOther, sal_Int32 nToday);
174 void ImplDraw(vcl::RenderContext& rRenderContext);
175 void ImplUpdateDate( const Date& rDate );
176 void ImplUpdateSelection( IntDateSet* pOld );
177 void ImplMouseSelect( const Date& rDate, sal_uInt16 nHitTest );
178 void ImplUpdate( bool bCalcNew = false );
179 using Window::ImplScroll;
180 void ImplScroll( bool bPrev );
181 void ImplShowMenu( const Point& rPos, const Date& rDate );
182 void ImplTracking( const Point& rPos, bool bRepeat );
183 void ImplEndTracking( bool bCancel );
185
186 virtual Size GetOptimalSize() const override;
187public:
188 Calendar( vcl::Window* pParent, WinBits nWinStyle );
189 virtual ~Calendar() override;
190 virtual void dispose() override;
191
192 virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
193 virtual void Tracking( const TrackingEvent& rMEvt ) override;
194 virtual void KeyInput( const KeyEvent& rKEvt ) override;
195 virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
196 virtual void Resize() override;
197 virtual void GetFocus() override;
198 virtual void LoseFocus() override;
199 virtual void RequestHelp( const HelpEvent& rHEvt ) override;
200 virtual void Command( const CommandEvent& rCEvt ) override;
201 virtual void StateChanged( StateChangedType nStateChange ) override;
202 virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
203
204 void Select();
205
207
208 void SetCurDate( const Date& rNewDate );
209 void SetFirstDate( const Date& rNewFirstDate );
210 const Date& GetFirstDate() const { return maFirstDate; }
211 Date GetLastDate() const { return GetFirstDate() + mnDayCount; }
212 Date GetFirstMonth() const;
213 Date GetLastMonth() const;
214 sal_uInt16 GetMonthCount() const;
215 bool GetDate( const Point& rPos, Date& rDate ) const;
216 tools::Rectangle GetDateRect( const Date& rDate ) const;
217
218 void EndSelection();
219
221
222 void SetSelectHdl( const Link<Calendar*,void>& rLink ) { maSelectHdl = rLink; }
223 void SetActivateHdl( const Link<Calendar*,void>& rLink ) { maActivateHdl = rLink; }
224};
225
226#endif // INCLUDED_VCL_CALENDAR_HXX
227
228/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void EndSelection()
Definition: calendar.cxx:1485
void ImplDrawSpin(vcl::RenderContext &rRenderContext)
Definition: calendar.cxx:504
sal_Int16 mnLastYear
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect) override
Definition: calendar.cxx:1131
tools::Long mnMonthWidth
const Date & GetFirstDate() const
tools::Rectangle maPrevRect
WinBits mnWinStyle
sal_Int16 mnFirstYear
void SetCurDate(const Date &rNewDate)
Definition: calendar.cxx:1282
void SetSelectHdl(const Link< Calendar *, void > &rLink)
DayOfWeek ImplGetWeekStart() const
Definition: calendar.cxx:158
tools::Long mnDaysOffX
void ImplFormat()
Definition: calendar.cxx:193
void SetActivateHdl(const Link< Calendar *, void > &rLink)
Calendar(vcl::Window *pParent, WinBits nWinStyle)
Definition: calendar.cxx:133
virtual void LoseFocus() override
Definition: calendar.cxx:1142
virtual void MouseButtonDown(const MouseEvent &rMEvt) override
Definition: calendar.cxx:1007
void ImplUpdate(bool bCalcNew=false)
Definition: calendar.cxx:845
Link< Calendar *, void > maActivateHdl
tools::Rectangle GetDateRect(const Date &rDate) const
Definition: calendar.cxx:1385
virtual void KeyInput(const KeyEvent &rKEvt) override
Definition: calendar.cxx:1066
sal_uInt16 GetMonthCount() const
Definition: calendar.cxx:1364
void ImplInit(WinBits nWinStyle)
Definition: calendar.cxx:70
virtual void Resize() override
Definition: calendar.cxx:1148
tools::Long mnMonthPerLine
void ImplEndTracking(bool bCancel)
Definition: calendar.cxx:950
tools::Long mnWeekDayOffY
void ImplInitSettings()
Definition: calendar.cxx:124
OUString maDayText
Date GetLastMonth() const
Definition: calendar.cxx:1354
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:522
Date GetFirstMonth() const
Definition: calendar.cxx:1341
std::unique_ptr< IntDateSet > mpSelectTable
bool GetDate(const Point &rPos, Date &rDate) const
Definition: calendar.cxx:1372
virtual void DataChanged(const DataChangedEvent &rDCEvt) override
Definition: calendar.cxx:1252
sal_uInt16 ImplDoHitTest(const Point &rPos, Date &rDate) const
Definition: calendar.cxx:329
Date GetLastDate() const
virtual void Tracking(const TrackingEvent &rMEvt) override
Definition: calendar.cxx:1056
sal_Int32 mnDayOfWeekAry[7]
Date maOldFormatLastDate
void Select()
Definition: calendar.cxx:1266
virtual ~Calendar() override
Definition: calendar.cxx:146
CalendarWrapper maCalendarWrapper
sal_Int32 mnDayCount
void ImplUpdateSelection(IntDateSet *pOld)
Definition: calendar.cxx:789
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects.
Definition: calendar.cxx:151
tools::Long mnMonthHeight
Date GetFirstSelectedDate() const
Definition: calendar.cxx:1271
Size CalcWindowSizePixel() const
Definition: calendar.cxx:1498
OUString maDayOfWeekText
virtual void ApplySettings(vcl::RenderContext &rRenderContext) override
Definition: calendar.cxx:115
Link< Calendar *, void > maSelectHdl
virtual Size GetOptimalSize() const override
Definition: calendar.cxx:1515
OUString maDayTexts[31]
virtual void GetFocus() override
Definition: calendar.cxx:1136
tools::Long mnDayHeight
std::unique_ptr< IntDateSet > mpOldSelectTable
void ImplTracking(const Point &rPos, bool bRepeat)
Definition: calendar.cxx:931
tools::Long mnDaysOffY
void ImplDraw(vcl::RenderContext &rRenderContext)
Definition: calendar.cxx:597
void ImplUpdateDate(const Date &rDate)
Definition: calendar.cxx:777
tools::Long mnLines
void ImplMouseSelect(const Date &rDate, sal_uInt16 nHitTest)
Definition: calendar.cxx:812
void ImplScroll(bool bPrev)
Definition: calendar.cxx:864
virtual void StateChanged(StateChangedType nStateChange) override
Definition: calendar.cxx:1244
virtual void Command(const CommandEvent &rCEvt) override
Definition: calendar.cxx:1199
tools::Rectangle maNextRect
void ImplShowMenu(const Point &rPos, const Date &rDate)
Definition: calendar.cxx:877
Date maOldFormatFirstDate
void SetFirstDate(const Date &rNewFirstDate)
Definition: calendar.cxx:1332
virtual void RequestHelp(const HelpEvent &rHEvt) override
Definition: calendar.cxx:1154
tools::Long mnDayWidth
OUString maWeekText
Definition: ctrl.hxx:82
void ImplInitSettings()
Definition: ctrl.cxx:423
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:176
DayOfWeek
long Long
std::set< sal_Int32 > IntDateSet
StateChangedType
Definition: window.hxx:290
sal_Int64 WinBits