removed unused variable

[wxWidgets.git] / docs / latex / wx / calctrl.tex

diff --git a/docs/latex/wx/calctrl.tex b/docs/latex/wx/calctrl.tex
index 1c223d58b177d86a4b49582ede60b689ac2dd3b8..d13b88f1d54385cf0f46c17f4a5456625b8c31cf 100644 (file)
--- a/docs/latex/wx/calctrl.tex
+++ b/docs/latex/wx/calctrl.tex
@@ -29,7 +29,7 @@ font and without border, but setting custom attributes with
 create a custom attribute object and set it for the day you want to be
 displayed specially (note that the control will take ownership of the pointer,
 i.e. it will delete it itself). A day may be marked as being a holiday, even
-if it is not reckognized as oen by \helpref{wxDateTime}{tdateholidays} using 
+if it is not recognized as one by \helpref{wxDateTime}{tdateholidays} using 
 \helpref{SetHoliday}{wxcalendardateattrsetholiday} method.
 
 As the attributes are specified for each day, they may change when the month
@@ -56,6 +56,8 @@ is changed, so you will often want to update them in
 \twocolitem{\windowstyle{wxCAL\_SHOW\_HOLIDAYS}}{Highlight holidays in the calendar}
 \twocolitem{\windowstyle{wxCAL\_NO\_YEAR\_CHANGE}}{Disable the year changing}
 \twocolitem{\windowstyle{wxCAL\_NO\_MONTH\_CHANGE}}{Disable the month (and, implicitly, the year) changing}
+\twocolitem{\windowstyle{wxCAL\_SHOW\_SURROUNDING\_WEEKS}}{Show the neighbouring weeks in the previous and next months}
+\twocolitem{\windowstyle{wxCAL\_SEQUENTIAL\_MONTH\_SELECTION}}{Use alternative, more compact, style for the month and year selection controls.}
 \end{twocollist}
 
 The default calendar style is {\tt wxCAL\_SHOW\_HOLIDAYS}.
@@ -68,7 +70,7 @@ direct input to member functions that take a
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=7pt
-\twocolitem{{\bf EVT\_CALENDAR(id, func)}}{A day was double clickedi n the calendar.}
+\twocolitem{{\bf EVT\_CALENDAR(id, func)}}{A day was double clicked in the calendar.}
 \twocolitem{{\bf EVT\_CALENDAR\_SEL\_CHANGED(id, func)}}{The selected date changed.}
 \twocolitem{{\bf EVT\_CALENDAR\_DAY(id, func)}}{The selected day changed.}
 \twocolitem{{\bf EVT\_CALENDAR\_MONTH(id, func)}}{The selected month changed.}
@@ -85,14 +87,16 @@ Note that changing the selected date will result in either of
 The following are the possible return values for 
 \helpref{HitTest}{wxcalendarctrlhittest} method:
 
+{\small
 \begin{verbatim}
 enum wxCalendarHitTestResult
-\{
+{
     wxCAL_HITTEST_NOWHERE,      // outside of anything
     wxCAL_HITTEST_HEADER,       // on the header (weekdays)
     wxCAL_HITTEST_DAY           // on a day in the calendar
-\};
+}
 \end{verbatim}
+}
 
 \wxheading{See also}
 
@@ -141,15 +145,15 @@ Gets the currently selected date.
 
 \membersection{wxCalendarCtrl::EnableYearChange}\label{wxcalendarctrlenableyearchange}
 
-\func{void}{EnableYearChange}{\param{bool }{enable = TRUE}}
+\func{void}{EnableYearChange}{\param{bool }{enable = true}}
 
 This function should be used instead of changing {\tt wxCAL\_NO\_YEAR\_CHANGE}
-style bit directly. It allows or disallows the user to chaneg the year
+style bit directly. It allows or disallows the user to change the year
 interactively.
 
 \membersection{wxCalendarCtrl::EnableMonthChange}\label{wxcalendarctrlenablemonthchange}
 
-\func{void}{EnableMonthChange}{\param{bool }{enable = TRUE}}
+\func{void}{EnableMonthChange}{\param{bool }{enable = true}}
 
 This function should be used instead of changing 
 {\tt wxCAL\_NO\_MONTH\_CHANGE} style bit. It allows or disallows the user to
@@ -158,7 +162,7 @@ year can not be changed neither.
 
 \membersection{wxCalendarCtrl::EnableHolidayDisplay}\label{wxcalendarctrlenableholidaydisplay}
 
-\func{void}{EnableHolidayDisplay}{\param{bool }{display = TRUE}}
+\func{void}{EnableHolidayDisplay}{\param{bool }{display = true}}
 
 This function should be used instead of changing {\tt wxCAL\_SHOW\_HOLIDAYS}
 style bit directly. It enables or disables the special highlighting of the
@@ -227,7 +231,7 @@ window style includes {\tt wxCAL\_SHOW\_HOLIDAYS} flag).
 
 \constfunc{const wxColour\&}{GetHolidayColourFg}{\void}
 
-Return the foregound colour currently used for holiday highlighting.
+Return the foreground colour currently used for holiday highlighting.
 
 \wxheading{See also}
 
@@ -296,9 +300,9 @@ Here are the possible kinds of borders which may be used to decorate a date:
 \begin{verbatim}
 enum wxCalendarDateBorder
 {
-    wxCAL\_BORDER\_NONE,          // no border (default)
-    wxCAL\_BORDER\_SQUARE,        // a rectangular border
-    wxCAL\_BORDER\_ROUND          // a round border
+    wxCAL_BORDER_NONE,          // no border (default)
+    wxCAL_BORDER_SQUARE,        // a rectangular border
+    wxCAL_BORDER_ROUND          // a round border
 }
 \end{verbatim}
 
@@ -358,37 +362,37 @@ Display the date with this attribute as a holiday.
 
 \constfunc{bool}{HasTextColour}{\void}
 
-Returns {\tt TRUE} if this item has a non default text foreground colour.
+Returns {\tt true} if this item has a non default text foreground colour.
 
 \membersection{wxCalendarDateAttr::HasBackgroundColour}\label{wxcalendardateattrhasbackgroundcolour}
 
 \constfunc{bool}{HasBackgroundColour}{\void}
 
-Returns {\tt TRUE} if this attribute specifies a non default text background colour.
+Returns {\tt true} if this attribute specifies a non default text background colour.
 
 \membersection{wxCalendarDateAttr::HasBorderColour}\label{wxcalendardateattrhasbordercolour}
 
 \constfunc{bool}{HasBorderColour}{\void}
 
-Returns {\tt TRUE} if this attribute specifies a non default border colour.
+Returns {\tt true} if this attribute specifies a non default border colour.
 
 \membersection{wxCalendarDateAttr::HasFont}\label{wxcalendardateattrhasfont}
 
 \constfunc{bool}{HasFont}{\void}
 
-Returns {\tt TRUE} if this attribute specifies a non default font.
+Returns {\tt true} if this attribute specifies a non default font.
 
 \membersection{wxCalendarDateAttr::HasBorder}\label{wxcalendardateattrhasborder}
 
 \constfunc{bool}{HasBorder}{\void}
 
-Returns {\tt TRUE} if this attribute specifies a non default (i.e. any) border.
+Returns {\tt true} if this attribute specifies a non default (i.e. any) border.
 
 \membersection{wxCalendarDateAttr::IsHoliday}\label{wxcalendardateattrisholiday}
 
 \constfunc{bool}{IsHoliday}{\void}
 
-Returns {\tt TRUE} if this attribute specifies that this item should be
+Returns {\tt true} if this attribute specifies that this item should be
 displayed as a holiday.
 
 \membersection{wxCalendarDateAttr::GetTextColour}\label{wxcalendardateattrgettextcolour}
@@ -434,7 +438,7 @@ The wxCalendarEvent class is used together with
 
 \membersection{wxCalendarEvent::GetDate}{wxcalendareventgetdate}
 
-\constfunc{const wxDateTime&}{GetDate}{\void}
+\constfunc{const wxDateTime\&}{GetDate}{\void}
 
 Returns the date. This function may be called for all event types except 
 {\tt EVT\_CALENDAR\_WEEKDAY\_CLICKED} one for which it doesn't make sense.
@@ -447,3 +451,15 @@ Returns the week day on which the user clicked in
 {\tt EVT\_CALENDAR\_WEEKDAY\_CLICKED} handler. It doesn't make sense to call
 this function in other handlers.
 
+\membersection{wxCalendarEvent::SetDate}{wxcalendareventsetdate}
+
+\func{void}{SetDate}{\param{const wxDateTime\&}{ date}}
+
+Sets the date.
+
+\membersection{wxCalendarEvent::SetWeekDay}{wxcalendareventsetweekday}
+
+\func{void}{SetWeekDay}{\param{wxDateTime::WeekDay}{ day}}
+
+Sets the week day.
+