/usr/include/Wt/WCalendar is in libwt-dev 3.1.10-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WCALENDAR_H_
#define WCALENDAR_H_
#include <Wt/WCompositeWidget>
#include <Wt/WDate>
#include <Wt/WSignalMapper>
#include <set>
namespace boost {
namespace gregorian {
class date;
}
}
namespace Wt {
class WComboBox;
class WInPlaceEdit;
class WTemplate;
/*! \class WCalendar Wt/WCalendar Wt/WCalendar
* \brief A calendar.
*
* The calendar provides navigation by month and year, and indicates the
* current day.
*
* You can listen for single click or double click events on a
* calendar cell using the clicked() and activated() methods.
*
* The calendar may be configured to allow selection of single or
* multiple days using setSelectionMode(), and you may listen for
* changes in the selection using the selectionChanged()
* signals. Selection can also be entirely disabled in which case you
* can implement your own selection handling by listening for cell
* click events.
*
* Cell rendering may be customized by reimplementing renderCell().
*
* Internationalization is provided by the internationalization
* features of the Wt::WDate class.
*
* \if cpp
* Usage example:
* \code
* Wt::WDate today = Wt::WDate::currentDate();
*
* Wt::WCalendar *calendar = new Wt::WCalendar(this);
* calendar->browseTo(today.addMonths(1));
* calendar->select(today.addMonths(1).addDays(3));
* calendar->selected().connect(this, &MyWidget::daySelected);
* \endcode
* \endif
*
* Here is a snapshot, taken on 19/01/2010 (shown as
* today), and 14/01/2010 currently selected.
* <TABLE border="0" align="center"> <TR> <TD>
* \image html WCalendar-default-1.png "WCalendar with default look"
* </TD> <TD>
* \image html WCalendar-polished-1.png "WCalendar with polished look"
* </TD> </TR> </TABLE>
*
* <h3>CSS</h3>
*
* The calendar is styled by the current CSS theme. The look can be
* overridden using the <tt>Wt-calendar</tt> CSS class and the following
* selectors:
*
* \verbatim
.Wt-cal table : The table
.Wt-cal table.d1 : The table (single letter day headers)
.Wt-cal table.d3 : The table (three letter day headers)
.Wt-cal table.dlong : The table (long day headers)
.Wt-cal caption : The caption (containing the navigation buttons)
.Wt-cal-year : The caption year in-place-edit
.Wt-cal th : Header cell (week day)
.Wt-cal td : Day cell
.Wt-cal-oom : Out-of-month day
.Wt-cal-oor : Out-of-range day (day < bottom or day > top)
.Wt-cal-sel : Selected day
.Wt-cal-now : Today day
\endverbatim
*
*/
class WT_API WCalendar : public WCompositeWidget
{
public:
/*! \brief The format of the horizontal header.
*/
enum HorizontalHeaderFormat {
SingleLetterDayNames, //!< First letter of a day (e.g. 'M' for Monday)
ShortDayNames, //!< First 3 letters of a day (e.g. 'Mon' for Monday)
LongDayNames //!< Full day name
// NoHorizontalHeader //No horizontal header (not yet implemented)
};
/*! \brief Creates a new calendar.
*
* Constructs a new calendar with English day/month names. The
* calendar shows the current day, and has an empty selection.
*/
WCalendar(WContainerWidget *parent = 0);
/*! \brief Sets the selection mode.
*
* The default selection mode is
* \link Wt::SingleSelection SingleSelection\endlink.
*/
void setSelectionMode(SelectionMode mode);
/*! \brief Browses to the same month in the previous year.
*
* Displays the same month in the previous year. This does not
* affect the selection.
*
* This will emit the currentPageChanged() singal.
*/
void browseToPreviousYear();
/*! \brief Browses to the previous month.
*
* Displays the previous month. This does not affect the selection.
*
* This will emit the currentPageChanged() singal.
*/
void browseToPreviousMonth();
/*! \brief Browses to the same month in the next year.
*
* Displays the same month in the next year. This does not change
* the current selection.
*
* This will emit the currentPageChanged() singal.
*/
void browseToNextYear();
/*! \brief Browses to the next month.
*
* Displays the next month. This does not change the current selection.
*
* This will emit the currentPageChanged() singal.
*/
void browseToNextMonth();
/*! \brief Browses to a date.
*
* Displays the month which contains the given date. This does not change
* the current selection.
*
* This will emit the currentPageChanged() signal if another month
* is displayed.
*/
void browseTo(const WDate& date);
/*! \brief Returns the current month displayed
*
* Returns the month (1-12) that is currently displayed.
*/
int currentMonth() const { return currentMonth_; }
/*! \brief Returns the current year displayed
*
* Returns the year that is currently displayed.
*/
int currentYear() const { return currentYear_; }
/*! \brief Clears the current selection.
*
* Clears the current selection. Will result in a selection() that is
* empty().
*/
void clearSelection();
/*! \brief Selects a date.
*
* Select one date. Both in single or multiple selection mode, this results
* in a selection() that contains exactly one date.
*/
void select(const WDate& date);
/*! \brief Selects multiple dates.
*
* Select multiple dates. In multiple selection mode, this results
* in a selection() that contains exactly the given dates. In single
* selection mode, at most one date is set.
*/
void select(const std::set<WDate>& dates);
/*! \brief Sets the horizontal header format.
*
* The default horizontal header format is WCalendar::ShortDayNames.
*/
void setHorizontalHeaderFormat(HorizontalHeaderFormat format);
/*! \brief Returns the horizontal header format.
*
* \sa setHorizontalHeaderFormat()
*/
HorizontalHeaderFormat horizontalHeaderFormat() {
return horizontalHeaderFormat_;
}
/*! \brief Sets the first day of the week.
*
* Possible values or 1 to 7, as accepted by WDate::shortDayName().
*
* The default value is 1 ("Monday").
*/
void setFirstDayOfWeek(int dayOfWeek);
/*! \brief Returns the current selection.
*
* Returns the set of dates currently selected. In single selection mode,
* this set contains 0 or 1 dates.
*/
const std::set<WDate>& selection() const { return selection_; }
/*! \brief %Signal emitted when the user changes the selection.
*
* Emitted after the user has changed the current selection.
*/
Signal<>& selectionChanged() { return selectionChanged_; }
/*! \brief %Signal emitted when the user double-clicks a date.
*
* You may want to connect to this signal to treat a double click
* as the selection of a date.
*/
Signal<WDate>& activated() { return activated_; }
/*! \brief %Signal emitted when the user clicks a date.
*
* You may want to connect to this signal if you want to provide a
* custom selection handling.
*/
Signal<WDate>& clicked() { return clicked_; }
/*! \brief %Signal emitted when the current month is changed.
*
* The method is emitted both when the change is done through the
* user interface or via the public API. The two parameters are
* respectively the new year and month.
*/
Signal<int, int>& currentPageChanged() { return currentPageChanged_; }
/*! \brief Configures single or multiple selection mode (<b> deprecated </b>).
*
* In single selection mode, only one date may be selected: the selection()
* will be empty or contain exactly one item.
*
* \deprecated use setSelectionMode() instead.
*/
void setMultipleSelection(bool multiple);
/*! \brief %Signal emitted when the user has double clicked on a date (<b>deprecated</b>).
*
* This signal indicates that he user has selected a new date, which
* is only available when in single selection mode.
*
* \deprecated use activated() instead.
*/
Signal<WDate>& selected() { return activated_; }
/*! \brief Configures the calendar to use single click for activation (<b>deprecated</b>)
*
* By default, double click will trigger activate(). Use this method
* if you want a single click to trigger activate() (and the now
* deprecated selected() method). This only applies to a
* single-selection calendar.
*
* \deprecated listen to the clicked() signal if you want to react
* to a single click, or activated() signal if you want to react to
* a double click.
*
* \sa setMultipleSelection()
*/
void setSingleClickSelect(bool single);
/*! \brief Sets the length for the abbreviated day of week (<b> deprecated </b>).
*
* The \p chars may be 1 or 3, which render "Monday" as
* respectively "M" or "Mon".
*
* The default length is 3.
*
* \deprecated use setHorizontalHeaderFormat() instead.
*/
void setDayOfWeekLength(int chars);
/*! \brief Sets the bottom of the valid date range.
*
* \if cpp
* The default is a null date constructed using WDate().
* \elseif java
* The default bottom is null.
* \endif
*/
void setBottom(const WDate& bottom);
/*! \brief Returns the bottom date of the valid range.
*/
const WDate& bottom() const { return bottom_; }
/*! \brief Sets the top of the valid date range.
*
* \if cpp
* The default is a null date constructed using WDate().
* \elseif java
* The default top is null.
* \endif
*/
void setTop(const WDate& top);
/*! \brief Returns the top date of the valid range.
*/
const WDate& top() const { return top_; }
protected:
virtual void render(WFlags<RenderFlag> renderFlags);
/*! \brief Creates or updates a widget that renders a cell.
*
* The default implementation creates a WText
*
* You may want to reimplement this method if you wish to customize
* how a cell is rendered. When \p widget is \c 0, a new widget
* should be created and returned. Otherwise, you may either modify
* the passed \p widget, or return a new widget. If you return a new
* widget, the prevoius widget will be deleted.
*/
virtual WWidget* renderCell(WWidget* widget, const WDate& date);
/*! \brief Returns whether a date is selected.
*
* This is a convenience method that can be used when reimplementing
* renderCell().
*/
bool isSelected(const WDate& date) const;
private:
SelectionMode selectionMode_;
bool singleClickSelect_;
int currentYear_;
int currentMonth_;
HorizontalHeaderFormat horizontalHeaderFormat_;
int firstDayOfWeek_;
std::set<WDate> selection_;
bool needRenderMonth_;
Signal<> selectionChanged_;
Signal<WDate> activated_;
Signal<WDate> clicked_;
Signal<int, int> currentPageChanged_;
WDate bottom_, top_;
struct Coordinate {
int i, j;
Coordinate() : i(0), j(0) { }
Coordinate(int x, int y) { i = x; j = y; }
};
WTemplate *impl_;
WComboBox *monthEdit_;
WInPlaceEdit *yearEdit_;
WSignalMapper<Coordinate, NoClass> *cellClickMapper_;
WSignalMapper<Coordinate, NoClass> *cellDblClickMapper_;
void create();
void renderMonth();
void emitCurrentPageChanged();
void monthChanged(int newMonth);
void yearChanged(WString newYear);
boost::gregorian::date dateForCell(int week, int dayOfWeek);
void selectInCurrentMonth(const WDate& d);
void cellClicked(Coordinate c);
void cellDblClicked(Coordinate c);
};
}
#endif // WCALENDAR_H_
|