/usr/include/wx-3.0/wx/wxPython/i_files/calendar.i is in python-wxgtk3.0-dev 3.0.2.0+dfsg-7.
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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 | /////////////////////////////////////////////////////////////////////////////
// Name: calendar.i
// Purpose: SWIG definitions for the wxCalendarCtrl
//
// Author: Robin Dunn
//
// Created: 23-May-2000
// RCS-ID: $Id$
// Copyright: (c) 2000 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
%define DOCSTRING
"Classes for an interactive Calendar control."
%enddef
%module(package="wx", docstring=DOCSTRING) calendar
%{
#include "wx/wxPython/wxPython.h"
#include "wx/wxPython/pyclasses.h"
#include <wx/calctrl.h>
#include <wx/generic/calctrlg.h>
%}
//----------------------------------------------------------------------
%import misc.i
%pythoncode { wx = _core }
%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
//---------------------------------------------------------------------------
enum {
wxCAL_SUNDAY_FIRST,
wxCAL_MONDAY_FIRST,
wxCAL_SHOW_HOLIDAYS,
wxCAL_NO_YEAR_CHANGE,
wxCAL_NO_MONTH_CHANGE,
wxCAL_SEQUENTIAL_MONTH_SELECTION,
wxCAL_SHOW_SURROUNDING_WEEKS,
wxCAL_SHOW_WEEK_NUMBERS,
};
enum wxCalendarHitTestResult
{
wxCAL_HITTEST_NOWHERE, // outside of anything
wxCAL_HITTEST_HEADER, // on the header (weekdays)
wxCAL_HITTEST_DAY, // on a day in the calendar
wxCAL_HITTEST_INCMONTH,
wxCAL_HITTEST_DECMONTH,
wxCAL_HITTEST_SURROUNDING_WEEK,
wxCAL_HITTEST_WEEK
};
// border types for a date
enum wxCalendarDateBorder
{
wxCAL_BORDER_NONE, // no border (default)
wxCAL_BORDER_SQUARE, // a rectangular border
wxCAL_BORDER_ROUND // a round border
};
//---------------------------------------------------------------------------
DocStr(wxCalendarDateAttr,
"A set of customization attributes for a calendar date, which can be
used to control the look of the Calendar object.", "");
class wxCalendarDateAttr
{
public:
DocStr(wxCalendarDateAttr,
"Create a CalendarDateAttr.", "");
wxCalendarDateAttr(const wxColour& colText = wxNullColour,
const wxColour& colBack = wxNullColour,
const wxColour& colBorder = wxNullColour,
const wxFont& font = wxNullFont,
wxCalendarDateBorder border = wxCAL_BORDER_NONE);
~wxCalendarDateAttr();
// setters
void SetTextColour(const wxColour& colText);
void SetBackgroundColour(const wxColour& colBack);
void SetBorderColour(const wxColour& col);
void SetFont(const wxFont& font);
void SetBorder(wxCalendarDateBorder border);
void SetHoliday(bool holiday);
// accessors
bool HasTextColour() const;
bool HasBackgroundColour() const;
bool HasBorderColour() const;
bool HasFont() const;
bool HasBorder() const;
bool IsHoliday() const;
wxColour GetTextColour() const;
wxColour GetBackgroundColour() const;
wxColour GetBorderColour() const;
wxFont GetFont() const;
wxCalendarDateBorder GetBorder() const;
// get or change the "mark" attribute, i.e. the one used for the items
// marked with wxCalendarCtrl::Mark()
static const wxCalendarDateAttr& GetMark();
static void SetMark(wxCalendarDateAttr const& m);
%property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
%property(Border, GetBorder, SetBorder, doc="See `GetBorder` and `SetBorder`");
%property(BorderColour, GetBorderColour, SetBorderColour, doc="See `GetBorderColour` and `SetBorderColour`");
%property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
%property(TextColour, GetTextColour, SetTextColour, doc="See `GetTextColour` and `SetTextColour`");
};
//---------------------------------------------------------------------------
class wxCalendarCtrl;
class wxCalendarEvent : public wxDateEvent
{
public:
wxCalendarEvent(wxWindow *win, const wxDateTime& dt, wxEventType type);
void SetWeekDay(const wxDateTime::WeekDay wd);
wxDateTime::WeekDay GetWeekDay() const;
%pythoncode {
def PySetDate(self, date):
"""takes datetime.datetime or datetime.date object"""
self.SetDate(_pydate2wxdate(date))
def PyGetDate(self):
"""returns datetime.date object"""
return _wxdate2pydate(self.GetDate())
}
%property(WeekDay, GetWeekDay, SetWeekDay, doc="See `GetWeekDay` and `SetWeekDay`");
};
%constant wxEventType wxEVT_CALENDAR_DOUBLECLICKED;
%constant wxEventType wxEVT_CALENDAR_SEL_CHANGED;
%constant wxEventType wxEVT_CALENDAR_WEEKDAY_CLICKED;
%constant wxEventType wxEVT_CALENDAR_PAGE_CHANGED;
%constant wxEventType wxEVT_CALENDAR_DAY_CHANGED;
%constant wxEventType wxEVT_CALENDAR_MONTH_CHANGED;
%constant wxEventType wxEVT_CALENDAR_YEAR_CHANGED;
%pythoncode {
EVT_CALENDAR = wx.PyEventBinder( wxEVT_CALENDAR_DOUBLECLICKED, 1)
EVT_CALENDAR_SEL_CHANGED = wx.PyEventBinder( wxEVT_CALENDAR_SEL_CHANGED, 1)
EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED, 1)
EVT_CALENDAR_PAGE_CHANGED = wx.PyEventBinder( wxEVT_CALENDAR_PAGE_CHANGED, 1)
EVT_CALENDAR_DAY = wx.PyEventBinder( wxEVT_CALENDAR_DAY_CHANGED, 1)
EVT_CALENDAR_MONTH = wx.PyEventBinder( wxEVT_CALENDAR_MONTH_CHANGED, 1)
EVT_CALENDAR_YEAR = wx.PyEventBinder( wxEVT_CALENDAR_YEAR_CHANGED, 1)
}
//---------------------------------------------------------------------------
MAKE_CONST_WXSTRING(CalendarNameStr);
DocStr(wxCalendarCtrlBase,
"Common base class for `CalendarCtrl` and `GenericCalendarCtrl`.
The calendar control allows the user to pick a date interactively.
The CalendarCtrl displays a window containing several parts: the
control to pick the month and the year at the top (either or both of
them may be disabled) and a month area below them which shows all the
days in the month. The user can move the current selection using the
keyboard and select the date (generating EVT_CALENDAR event) by
pressing <Return> or double clicking it.
It has advanced possibilities for the customization of its
display. All global settings (such as colours and fonts used) can, of
course, be changed. But also, the display style for each day in the
month can be set independently using CalendarDateAttr class.
An item without custom attributes is drawn with the default colours
and font and without border, but setting custom attributes with
`SetAttr` allows to modify its appearance. Just create a custom
attribute object and set it for the day you want to be displayed
specially A day may be marked as being a holiday, (even if it is not
recognized as one by `wx.DateTime`) by using the SetHoliday method.
As the attributes are specified for each day, they may change when the
month is changed, so you will often want to update them in an
EVT_CALENDAR_MONTH event handler.", "
Window Styles
-------------
============================== ============================
CAL_SUNDAY_FIRST Show Sunday as the first day
in the week
CAL_MONDAY_FIRST Show Monday as the first day
in the week
CAL_SHOW_HOLIDAYS Highlight holidays in the
calendar
CAL_NO_YEAR_CHANGE Disable the year changing
CAL_NO_MONTH_CHANGE Disable the month (and,
implicitly, the year) changing
CAL_SHOW_SURROUNDING_WEEKS Show the neighbouring weeks in
the previous and next months
CAL_SEQUENTIAL_MONTH_SELECTION Use alternative, more compact,
style for the month and year
selection controls.
============================== ============================
The default calendar style is CAL_SHOW_HOLIDAYS.
Events
-------
============================= ==============================
EVT_CALENDAR A day was double clicked in the
calendar.
EVT_CALENDAR_SEL_CHANGED The selected date changed.
EVT_CALENDAR_DAY The selected day changed.
EVT_CALENDAR_MONTH The selected month changed.
EVT_CALENDAR_YEAR The selected year changed.
EVT_CALENDAR_WEEKDAY_CLICKED User clicked on the week day
header
============================= ==============================
Note that changing the selected date will result in one of
EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED
event.");
class wxCalendarCtrlBase : public wxControl
{
public:
// **** This is an ABC, so no constructor
// do we allow changing the month/year?
bool AllowMonthChange() const;
DocDeclStr(
bool, SetDate(const wxDateTime& date),
"Sets the current date.", "");
DocDeclStr(
const wxDateTime, GetDate() const,
"Gets the currently selected date.", "");
DocDeclStr(
bool, SetDateRange(const wxDateTime& lowerdate = wxDefaultDateTime,
const wxDateTime& upperdate = wxDefaultDateTime),
"set the range in which selection can occur", "");
// virtual bool
// GetDateRange(wxDateTime *lowerdate, wxDateTime *upperdate) const
%extend {
PyObject* GetDateRange()
{
bool result;
wxDateTime* lower = new wxDateTime;
wxDateTime* upper = new wxDateTime;
result = self->GetDateRange(lower, upper);
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(3);
PyTuple_SET_ITEM(tup, 0, PyBool_FromLong(result));
PyTuple_SET_ITEM(tup, 1, wxPyConstructObject(lower, wxT("wxDateTime"), 1));
PyTuple_SET_ITEM(tup, 2, wxPyConstructObject(upper, wxT("wxDateTime"), 1));
wxPyEndBlockThreads(blocked);
return tup;
}
}
DocAStr(HitTest,
"HitTest(Point pos) -> (result, date, weekday)",
"Returns 3-tuple with information about the given position on the
calendar control. The first value of the tuple is a result code and
determines the validity of the remaining two values.",
"
The result codes are:
=================== ============================================
CAL_HITTEST_NOWHERE hit outside of anything
CAL_HITTEST_HEADER hit on the header, weekday is valid
CAL_HITTEST_DAY hit on a day in the calendar, date is set.
=================== ============================================
");
%extend {
PyObject* HitTest(const wxPoint& pos) {
wxDateTime* date = new wxDateTime;
wxDateTime::WeekDay wd;
wxCalendarHitTestResult result = self->HitTest(pos, date, &wd);
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(3);
PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(result));
PyTuple_SET_ITEM(tup, 1, wxPyConstructObject(date, wxT("wxDateTime"), 1));
PyTuple_SET_ITEM(tup, 2, PyInt_FromLong(wd));
wxPyEndBlockThreads(blocked);
return tup;
}
}
DocDeclStr(
void, EnableMonthChange(bool enable = true),
"This function should be used instead of changing CAL_NO_MONTH_CHANGE
style bit. It allows or disallows the user to change the month
interactively. Note that if the month can not be changed, the year can
not be changed either.", "");
DocDeclStr(
virtual void , Mark(size_t day, bool mark),
"", "");
DocDeclStr(
wxCalendarDateAttr*, GetAttr(size_t day) const,
"Returns the attribute for the given date (should be in the range
1...31). The returned value may be None", "");
%disownarg(wxCalendarDateAttr *attr);
DocDeclStr(
void, SetAttr(size_t day, wxCalendarDateAttr *attr),
"Associates the attribute with the specified date (in the range
1...31). If the attribute passed is None, the items attribute is
cleared.", "");
%cleardisown(wxCalendarDateAttr *attr);
DocDeclStr(
void, ResetAttr(size_t day),
"Clears any attributes associated with the given day (in the range
1...31).", "");
DocDeclStr(
void, EnableHolidayDisplay(bool display = true),
"This function should be used instead of changing CAL_SHOW_HOLIDAYS
style bit directly. It enables or disables the special highlighting of
the holidays.", "");
DocDeclStr(
void, SetHolidayColours(const wxColour& colFg, const wxColour& colBg),
"Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
used).", "");
DocDeclStr(
wxColour, GetHolidayColourFg() const,
"Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
used).", "");
DocDeclStr(
wxColour, GetHolidayColourBg() const,
"Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
used).", "");
DocDeclStr(
void, SetHoliday(size_t day),
"Marks the specified day as being a holiday in the current month.", "");
DocDeclStr(
void, SetHeaderColours(const wxColour& colFg, const wxColour& colBg),
"Header colours are used for painting the weekdays at the top.", "");
DocDeclStr(
wxColour, GetHeaderColourFg() const,
"Header colours are used for painting the weekdays at the top.", "");
DocDeclStr(
wxColour, GetHeaderColourBg() const,
"Header colours are used for painting the weekdays at the top.", "");
DocDeclStr(
void, SetHighlightColours(const wxColour& colFg, const wxColour& colBg),
"Highlight colour is used for the currently selected date.", "");
DocDeclStr(
wxColour, GetHighlightColourFg() const,
"Highlight colour is used for the currently selected date.", "");
DocDeclStr(
wxColour, GetHighlightColourBg() const,
"Highlight colour is used for the currently selected date.", "");
%pythoncode {
def PySetDate(self, date):
"""takes datetime.datetime or datetime.date object"""
self.SetDate(_pydate2wxdate(date))
def PyGetDate(self):
"""returns datetime.date object"""
return _wxdate2pydate(self.GetDate())
def PySetLowerDateLimit(self, date):
"""takes datetime.datetime or datetime.date object"""
self.SetLowerDateLimit(_pydate2wxdate(date))
def PySetUpperDateLimit(self, date):
"""takes datetime.datetime or datetime.date object"""
self.SetUpperDateLimit(_pydate2wxdate(date))
def PySetDateRange(self, lowerdate, upperdate):
"""takes datetime.datetime or datetime.date objects"""
self.PySetLowerDateLimit(lowerdate)
self.PySetUpperDateLimit(upperdate)
def PyGetLowerDateLimit(self):
"""returns datetime.date object"""
return _wxdate2pydate(self.GetLowerDateLimit())
def PyGetUpperDateLimit(self):
"""returns datetime.date object"""
return _wxdate2pydate(self.GetUpperDateLimit())
}
%property(Date, GetDate, SetDate, doc="See `GetDate` and `SetDate`");
%property(HeaderColourBg, GetHeaderColourBg, doc="See `GetHeaderColourBg`");
%property(HeaderColourFg, GetHeaderColourFg, doc="See `GetHeaderColourFg`");
%property(HighlightColourBg, GetHighlightColourBg, doc="See `GetHighlightColourBg`");
%property(HighlightColourFg, GetHighlightColourFg, doc="See `GetHighlightColourFg`");
%property(HolidayColourBg, GetHolidayColourBg, doc="See `GetHolidayColourBg`");
%property(HolidayColourFg, GetHolidayColourFg, doc="See `GetHolidayColourFg`");
};
//---------------------------------------------------------------------------
DocStr(wxGenericCalendarCtrl,
"A generic implementation of the Calendar Control which, depending on
platform, may offer more functionality and configurability then the
native `CalendarCtrl` at the cost of losing the native look and feel.", "");
MustHaveApp(wxGenericCalendarCtrl);
class wxGenericCalendarCtrl : public wxCalendarCtrlBase
{
public:
%pythonAppend wxGenericCalendarCtrl "self._setOORInfo(self)"
%pythonAppend wxGenericCalendarCtrl() ""
DocCtorStr(
wxGenericCalendarCtrl(wxWindow *parent,
wxWindowID id=-1,
const wxDateTime& date = wxDefaultDateTime,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
const wxString& name = wxPyCalendarNameStr),
"Create and show a calendar control.", "");
DocCtorStrName(
wxGenericCalendarCtrl(),
"Precreate a GenericCalendarCtrl for 2-phase creation.", "",
PreGenericCalendarCtrl);
DocDeclStr(
bool , Create(wxWindow *parent,
wxWindowID id,
const wxDateTime& date = wxDefaultDateTime,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
const wxString& name = wxPyCalendarNameStr),
"Acutally create the GUI portion of the CalendarCtrl for 2-phase
creation.", "");
// // generate the given calendar event(s)
// void GenerateEvent(wxEventType type);
DocDeclStr(
bool, SetLowerDateLimit(const wxDateTime& date = wxDefaultDateTime),
"set the range in which selection can occur", "");
DocDeclStr(
bool, SetUpperDateLimit(const wxDateTime& date = wxDefaultDateTime),
"set the range in which selection can occur", "");
DocDeclStr(
const wxDateTime, GetLowerDateLimit() const,
"get the range in which selection can occur", "");
DocDeclStr(
const wxDateTime, GetUpperDateLimit() const,
"get the range in which selection can occur", "");
DocDeclStr(
void, EnableYearChange(bool enable = true),
"This function should be used instead of changing CAL_NO_YEAR_CHANGE
style bit directly. It allows or disallows the user to change the year
interactively.", "");
DocDeclStr(
wxControl*, GetMonthControl() const,
"Get the currently shown control for month.", "");
DocDeclStr(
wxControl*, GetYearControl() const,
"Get the currently shown control for year.", "");
static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
%property(LowerDateLimit, GetLowerDateLimit, SetLowerDateLimit, doc="See `GetLowerDateLimit` and `SetLowerDateLimit`");
%property(MonthControl, GetMonthControl, doc="See `GetMonthControl`");
%property(UpperDateLimit, GetUpperDateLimit, SetUpperDateLimit, doc="See `GetUpperDateLimit` and `SetUpperDateLimit`");
%property(YearControl, GetYearControl, doc="See `GetYearControl`");
};
%pythoncode {
def _pydate2wxdate(date):
import datetime
assert isinstance(date, (datetime.datetime, datetime.date))
tt = date.timetuple()
dmy = (tt[2], tt[1]-1, tt[0])
return wx.DateTimeFromDMY(*dmy)
def _wxdate2pydate(date):
import datetime
assert isinstance(date, wx.DateTime)
if date.IsValid():
ymd = map(int, date.FormatISODate().split('-'))
return datetime.date(*ymd)
else:
return None
}
//---------------------------------------------------------------------------
DocStr(wxCalendarCtrl,
"If the platform has a native calendar widget then this class will
provide a way to use it, otherwise the `GenericCalendarCtrl` will
be used.", "");
MustHaveApp(wxCalendarCtrl);
class wxCalendarCtrl : public wxCalendarCtrlBase
{
public:
%pythonAppend wxCalendarCtrl "self._setOORInfo(self)"
%pythonAppend wxCalendarCtrl() ""
DocCtorStr(
wxCalendarCtrl(wxWindow *parent,
wxWindowID id=-1,
const wxDateTime& date = wxDefaultDateTime,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
const wxString& name = wxPyCalendarNameStr),
"Create and show a calendar control.", "");
DocCtorStrName(
wxCalendarCtrl(),
"Precreate a CalendarCtrl for 2-phase creation.", "",
PreCalendarCtrl);
DocDeclStr(
bool , Create(wxWindow *parent,
wxWindowID id,
const wxDateTime& date = wxDefaultDateTime,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxCAL_SHOW_HOLIDAYS | wxWANTS_CHARS,
const wxString& name = wxPyCalendarNameStr),
"Acutally create the GUI portion of the CalendarCtrl for 2-phase
creation.", "");
};
//---------------------------------------------------------------------------
%init %{
%}
//---------------------------------------------------------------------------
|