X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..7b4b24bca94555afc29762acfc5b100009bb29ff:/docs/latex/wx/calctrl.tex

diff --git a/docs/latex/wx/calctrl.tex b/docs/latex/wx/calctrl.tex
index 94ef5c113c..abf17fa45a 100644
--- a/docs/latex/wx/calctrl.tex
+++ b/docs/latex/wx/calctrl.tex
@@ -6,14 +6,14 @@
 %% Created:     03.01.00
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
-%% License:     wxWidgets license
+%% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxCalendarCtrl}}\label{wxcalendarctrl}
 
-The calendar control allows the user to pick a date interactively. For this,
-it 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
+The calendar control allows the user to pick a date. For this,
+it displays a window containing several parts: a control at the top to pick the month
+and the year (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 
 {\tt EVT\_CALENDAR} event) by pressing {\tt <Return>} or double clicking it.
@@ -106,18 +106,18 @@ enum wxCalendarHitTestResult
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxCalendarCtrl::wxCalendarCtrl}\label{wxcalendarctrlwxcalendarctrldef}
 
 \func{}{wxCalendarCtrl}{\void}
 
 Default constructor, use \helpref{Create}{wxcalendarctrlcreate} after it.
 
-\membersection{wxCalendarCtrl::wxCalendarCtrl}\label{wxcalendarctrlwxcalendarctrl}
-
 \func{}{wxCalendarCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxDateTime\& }{date = wxDefaultDateTime}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxCAL\_SHOW\_HOLIDAYS}, \param{const wxString\& }{name = wxCalendarNameStr}}
 
 Does the same as \helpref{Create}{wxcalendarctrlcreate} method.
 
+
 \membersection{wxCalendarCtrl::Create}\label{wxcalendarctrlcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxDateTime\& }{date = wxDefaultDateTime}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxCAL\_SHOW\_HOLIDAYS}, \param{const wxString\& }{name = wxCalendarNameStr}}
@@ -125,24 +125,28 @@ Does the same as \helpref{Create}{wxcalendarctrlcreate} method.
 Creates the control. See \helpref{wxWindow}{wxwindowctor} for the meaning of
 the parameters and the control overview for the possible styles.
 
+
 \membersection{wxCalendarCtrl::\destruct{wxCalendarCtrl}}\label{wxcalendarctrldtor}
 
 \func{}{\destruct{wxCalendarCtrl}}{\void}
 
 Destroys the control.
 
+
 \membersection{wxCalendarCtrl::SetDate}\label{wxcalendarctrlsetdate}
 
 \func{void}{SetDate}{\param{const wxDateTime\& }{date}}
 
 Sets the current date.
 
+
 \membersection{wxCalendarCtrl::GetDate}\label{wxcalendarctrlgetdate}
 
 \constfunc{const wxDateTime\&}{GetDate}{\void}
 
 Gets the currently selected date.
 
+
 \membersection{wxCalendarCtrl::EnableYearChange}\label{wxcalendarctrlenableyearchange}
 
 \func{void}{EnableYearChange}{\param{bool }{enable = true}}
@@ -151,6 +155,7 @@ This function should be used instead of changing {\tt wxCAL\_NO\_YEAR\_CHANGE}
 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}}
@@ -160,6 +165,7 @@ This function should be used instead of changing
 change the month interactively. Note that if the month can not be changed, the
 year can not be changed neither.
 
+
 \membersection{wxCalendarCtrl::EnableHolidayDisplay}\label{wxcalendarctrlenableholidaydisplay}
 
 \func{void}{EnableHolidayDisplay}{\param{bool }{display = true}}
@@ -168,12 +174,14 @@ This function should be used instead of changing {\tt wxCAL\_SHOW\_HOLIDAYS}
 style bit directly. It enables or disables the special highlighting of the
 holidays.
 
+
 \membersection{wxCalendarCtrl::SetHeaderColours}\label{wxcalendarctrlsetheadercolours}
 
 \func{void}{SetHeaderColours}{\param{const wxColour\& }{colFg}, \param{const wxColour\& }{colBg}}
 
 Set the colours used for painting the weekdays at the top of the control.
 
+
 \membersection{wxCalendarCtrl::GetHeaderColourFg}\label{wxcalendarctrlgetheadercolourfg}
 
 \constfunc{const wxColour\&}{GetHeaderColourFg}{\void}
@@ -184,6 +192,7 @@ Gets the foreground colour of the header part of the calendar window.
 
 \helpref{SetHeaderColours}{wxcalendarctrlsetheadercolours}
 
+
 \membersection{wxCalendarCtrl::GetHeaderColourBg}\label{wxcalendarctrlgetheadercolourbg}
 
 \constfunc{const wxColour\&}{GetHeaderColourBg}{\void}
@@ -194,12 +203,14 @@ Gets the background colour of the header part of the calendar window.
 
 \helpref{SetHeaderColours}{wxcalendarctrlsetheadercolours}
 
+
 \membersection{wxCalendarCtrl::SetHighlightColours}\label{wxcalendarctrlsethighlightcolours}
 
 \func{void}{SetHighlightColours}{\param{const wxColour\& }{colFg}, \param{const wxColour\& }{colBg}}
 
 Set the colours to be used for highlighting the currently selected date.
 
+
 \membersection{wxCalendarCtrl::GetHighlightColourFg}\label{wxcalendarctrlgethighlightcolourfg}
 
 \constfunc{const wxColour\&}{GetHighlightColourFg}{\void}
@@ -210,6 +221,7 @@ Gets the foreground highlight colour.
 
 \helpref{SetHighlightColours}{wxcalendarctrlsethighlightcolours}
 
+
 \membersection{wxCalendarCtrl::GetHighlightColourBg}\label{wxcalendarctrlgethighlightcolourbg}
 
 \constfunc{const wxColour\&}{GetHighlightColourBg}{\void}
@@ -220,6 +232,7 @@ Gets the background highlight colour.
 
 \helpref{SetHighlightColours}{wxcalendarctrlsethighlightcolours}
 
+
 \membersection{wxCalendarCtrl::SetHolidayColours}\label{wxcalendarctrlsetholidaycolours}
 
 \func{void}{SetHolidayColours}{\param{const wxColour\& }{colFg}, \param{const wxColour\& }{colBg}}
@@ -227,6 +240,7 @@ Gets the background highlight colour.
 Sets the colours to be used for the holidays highlighting (only used if the
 window style includes {\tt wxCAL\_SHOW\_HOLIDAYS} flag).
 
+
 \membersection{wxCalendarCtrl::GetHolidayColourFg}\label{wxcalendarctrlgetholidaycolourfg}
 
 \constfunc{const wxColour\&}{GetHolidayColourFg}{\void}
@@ -237,6 +251,7 @@ Return the foreground colour currently used for holiday highlighting.
 
 \helpref{SetHolidayColours}{wxcalendarctrlsetholidaycolours}
 
+
 \membersection{wxCalendarCtrl::GetHolidayColourBg}\label{wxcalendarctrlgetholidaycolourbg}
 
 \constfunc{const wxColour\&}{GetHolidayColourBg}{\void}
@@ -247,6 +262,7 @@ Return the background colour currently used for holiday highlighting.
 
 \helpref{SetHolidayColours}{wxcalendarctrlsetholidaycolours}
 
+
 \membersection{wxCalendarCtrl::GetAttr}\label{wxcalendarctrlgetattr}
 
 \constfunc{wxCalendarDateAttr *}{GetAttr}{\param{size\_t }{day}}
@@ -255,6 +271,7 @@ Returns the attribute for the given date (should be in the range $1\ldots31$).
 
 The returned pointer may be {\tt NULL}.
 
+
 \membersection{wxCalendarCtrl::SetAttr}\label{wxcalendarctrlsetattr}
 
 \func{void}{SetAttr}{\param{size\_t }{day}, \param{wxCalendarDateAttr* }{attr}}
@@ -263,12 +280,14 @@ Associates the attribute with the specified date (in the range $1\ldots31$).
 
 If the pointer is {\tt NULL}, the items attribute is cleared.
 
+
 \membersection{wxCalendarCtrl::SetHoliday}\label{wxcalendarctrlsetholiday}
 
 \func{void}{SetHoliday}{\param{size\_t }{day}}
 
 Marks the specified day as being a holiday in the current month.
 
+
 \membersection{wxCalendarCtrl::ResetAttr}\label{wxcalendarctrlresetattr}
 
 \func{void}{ResetAttr}{\param{size\_t }{day}}
@@ -276,6 +295,7 @@ Marks the specified day as being a holiday in the current month.
 Clears any attributes associated with the given day (in the range
 $1\ldots31$).
 
+
 \membersection{wxCalendarCtrl::HitTest}\label{wxcalendarctrlhittest}
 
 \func{wxCalendarHitTestResult}{HitTest}{\param{const wxPoint\& }{pos}, \param{wxDateTime* }{date = NULL}, \param{wxDateTime::WeekDay* }{wd = NULL}}
@@ -310,8 +330,13 @@ enum wxCalendarDateBorder
 
 \helpref{wxCalendarCtrl}{wxcalendarctrl}
 
+\wxheading{Include files}
+
+<wx/calctrl.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxCalendarDateAttr::wxCalendarDateAttr}\label{wxcalendardateattrwxcalendardateattr}
 
 \func{}{wxCalendarDateAttr}{\void}
@@ -322,71 +347,83 @@ enum wxCalendarDateBorder
 
 The constructors.
 
+
 \membersection{wxCalendarDateAttr::SetTextColour}\label{wxcalendardateattrsettextcolour}
 
 \func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
 
 Sets the text (foreground) colour to use.
 
+
 \membersection{wxCalendarDateAttr::SetBackgroundColour}\label{wxcalendardateattrsetbackgroundcolour}
 
 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
 
 Sets the text background colour to use.
 
+
 \membersection{wxCalendarDateAttr::SetBorderColour}\label{wxcalendardateattrsetbordercolour}
 
 \func{void}{SetBorderColour}{\param{const wxColour\& }{col}}
 
 Sets the border colour to use.
 
+
 \membersection{wxCalendarDateAttr::SetFont}\label{wxcalendardateattrsetfont}
 
 \func{void}{SetFont}{\param{const wxFont\& }{font}}
 
 Sets the font to use.
 
+
 \membersection{wxCalendarDateAttr::SetBorder}\label{wxcalendardateattrsetborder}
 
 \func{void}{SetBorder}{\param{wxCalendarDateBorder }{border}}
 
 Sets the \helpref{border kind}{wxcalendardateattr}
 
+
 \membersection{wxCalendarDateAttr::SetHoliday}\label{wxcalendardateattrsetholiday}
 
 \func{void}{SetHoliday}{\param{bool }{holiday}}
 
 Display the date with this attribute as a holiday.
 
+
 \membersection{wxCalendarDateAttr::HasTextColour}\label{wxcalendardateattrhastextcolour}
 
 \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}
 
@@ -395,55 +432,68 @@ Returns {\tt true} if this attribute specifies a non default (i.e. any) border.
 Returns {\tt true} if this attribute specifies that this item should be
 displayed as a holiday.
 
+
 \membersection{wxCalendarDateAttr::GetTextColour}\label{wxcalendardateattrgettextcolour}
 
 \constfunc{const wxColour\&}{GetTextColour}{\void}
 
 Returns the text colour to use for the item with this attribute.
 
+
 \membersection{wxCalendarDateAttr::GetBackgroundColour}\label{wxcalendardateattrgetbackgroundcolour}
 
 \constfunc{const wxColour\&}{GetBackgroundColour}{\void}
 
 Returns the background colour to use for the item with this attribute.
 
+
 \membersection{wxCalendarDateAttr::GetBorderColour}\label{wxcalendardateattrgetbordercolour}
 
 \constfunc{const wxColour\&}{GetBorderColour}{\void}
 
 Returns the border colour to use for the item with this attribute.
 
+
 \membersection{wxCalendarDateAttr::GetFont}\label{wxcalendardateattrgetfont}
 
 \constfunc{const wxFont\&}{GetFont}{\void}
 
 Returns the font to use for the item with this attribute.
 
+
 \membersection{wxCalendarDateAttr::GetBorder}\label{wxcalendardateattrgetborder}
 
 \constfunc{wxCalendarDateBorder}{GetBorder}{\void}
 
 Returns the \helpref{border}{wxcalendardateattr} to use for the item with this attribute.
 
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{\class{wxCalendarEvent}}\label{wxcalendarevent}
 
 The wxCalendarEvent class is used together with 
 \helpref{wxCalendarCtrl}{wxcalendarctrl}.
 
+\wxheading{Derived from}
+
+\helpref{wxDateEvent}{wxdateevent}\\
+\helpref{wxCommandEvent}{wxcommandevent}\\
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/calctrl.h>
+
 \wxheading{See also}
 
 \helpref{wxCalendarCtrl}{wxcalendarctrl}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxCalendarEvent::GetDate}{wxcalendareventgetdate}
-
-\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.
-
-\membersection{wxCalendarEvent::GetWeekDay}{wxcalendareventgetweekday}
+\membersection{wxCalendarEvent::GetWeekDay}\label{wxcalendareventgetweekday}
 
 \constfunc{wxDateTime::WeekDay}{GetWeekDay}{\void}
 
@@ -451,15 +501,11 @@ 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}
+\membersection{wxCalendarEvent::SetWeekDay}\label{wxcalendareventsetweekday}
 
 \func{void}{SetWeekDay}{\param{wxDateTime::WeekDay}{ day}}
 
-Sets the week day.
+Sets the week day carried by the event, normally only used by the library
+internally.