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> 24 #include <unotools/calendarwrapper.hxx> 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; 34 class DataChangedEvent; 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; 125 CalendarWrapper maCalendarWrapper; 126 tools::Rectangle maPrevRect; 127 tools::Rectangle maNextRect; 128 OUString maDayOfWeekText; 129 tools::Long mnDayOfWeekAry[7]; 130 Date maOldFormatFirstDate; 131 Date maOldFormatLastDate; 132 Date maFirstDate; 133 Date maOldFirstDate; 134 Date maCurDate; 135 Date maOldCurDate; 136 Color maSelColor; 137 Color maOtherColor; 138 sal_Int32 mnDayCount; 139 tools::Long mnDaysOffX; 140 tools::Long mnWeekDayOffY; 141 tools::Long mnDaysOffY; 142 tools::Long mnMonthHeight; 143 tools::Long mnMonthWidth; 144 tools::Long mnMonthPerLine; 145 tools::Long mnLines; 146 tools::Long mnDayWidth; 147 tools::Long mnDayHeight; 148 WinBits mnWinStyle; 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; 158 Link<Calendar*,void> maSelectHdl; 159 Link<Calendar*,void> maActivateHdl; 160 161 using Control::ImplInitSettings; 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 ); 184 DayOfWeek ImplGetWeekStart() const; 185 186 virtual Size GetOptimalSize() const override; 187 public: 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 206 Date GetFirstSelectedDate() const; 207 208 void SetCurDate( const Date& rNewDate ); 209 void SetFirstDate( const Date& rNewFirstDate ); GetFirstDate() const210 const Date& GetFirstDate() const { return maFirstDate; } GetLastDate() const211 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 220 Size CalcWindowSizePixel() const; 221 SetSelectHdl(const Link<Calendar *,void> & rLink)222 void SetSelectHdl( const Link<Calendar*,void>& rLink ) { maSelectHdl = rLink; } SetActivateHdl(const Link<Calendar *,void> & 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: */ 229