diff options
Diffstat (limited to 'lib/wx/src/gen/wxCalendarCtrl.erl')
| -rw-r--r-- | lib/wx/src/gen/wxCalendarCtrl.erl | 114 |
1 files changed, 76 insertions, 38 deletions
diff --git a/lib/wx/src/gen/wxCalendarCtrl.erl b/lib/wx/src/gen/wxCalendarCtrl.erl index 8ad4d5954b..01d171800b 100644 --- a/lib/wx/src/gen/wxCalendarCtrl.erl +++ b/lib/wx/src/gen/wxCalendarCtrl.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2010. All Rights Reserved. +%% Copyright Ericsson AB 2008-2012. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -74,27 +74,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxCalendarCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxCalendarCtrl() +-type wxCalendarCtrl() :: wx:wx_object(). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlwxcalendarctrl">external documentation</a>. +-spec new() -> wxCalendarCtrl(). new() -> wxe_util:construct(?wxCalendarCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxCalendarCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxCalendarCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxCalendarCtrl() -%% Option = {date, wx:datetime()} | {pos, {X::integer(),Y::integer()}} | {size, {W::integer(),H::integer()}} | {style, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlwxcalendarctrl">external documentation</a>. +-spec new(Parent, Id, [Option]) -> wxCalendarCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {date, wx:wx_datetime()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -107,15 +115,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxCalendarCtrl_new_3, <<ParentRef:32/?UI,Id:32/?UI, BinOpt/binary>>). -%% @spec (This::wxCalendarCtrl(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxCalendarCtrl(), Parent::wxWindow:wxWindow(), Id::integer(). + create(This,Parent,Id) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id) -> create(This,Parent,Id, []). -%% @spec (This::wxCalendarCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {date, wx:datetime()} | {pos, {X::integer(),Y::integer()}} | {size, {W::integer(),H::integer()}} | {style, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlcreate">external documentation</a>. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxCalendarCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {date, wx:wx_datetime()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -129,30 +143,35 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxCalendarCtrl_Create, <<ThisRef:32/?UI,ParentRef:32/?UI,Id:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxCalendarCtrl(), Date::wx:datetime()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetdate">external documentation</a>. +-spec setDate(This, Date) -> boolean() when + This::wxCalendarCtrl(), Date::wx:wx_datetime(). setDate(#wx_ref{type=ThisT,ref=ThisRef},Date) when tuple_size(Date) =:= 2 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_SetDate, <<ThisRef:32/?UI,(wxe_util:datetime_bin(Date)):24/binary>>). -%% @spec (This::wxCalendarCtrl()) -> wx:datetime() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetdate">external documentation</a>. +-spec getDate(This) -> wx:wx_datetime() when + This::wxCalendarCtrl(). getDate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetDate, <<ThisRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @equiv enableYearChange(This, []) +-spec enableYearChange(This) -> ok when + This::wxCalendarCtrl(). + enableYearChange(This) when is_record(This, wx_ref) -> enableYearChange(This, []). -%% @spec (This::wxCalendarCtrl(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlenableyearchange">external documentation</a>. +-spec enableYearChange(This, [Option]) -> ok when + This::wxCalendarCtrl(), + Option :: {enable, boolean()}. enableYearChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -162,15 +181,18 @@ enableYearChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxCalendarCtrl_EnableYearChange, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @equiv enableMonthChange(This, []) +-spec enableMonthChange(This) -> ok when + This::wxCalendarCtrl(). + enableMonthChange(This) when is_record(This, wx_ref) -> enableMonthChange(This, []). -%% @spec (This::wxCalendarCtrl(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlenablemonthchange">external documentation</a>. +-spec enableMonthChange(This, [Option]) -> ok when + This::wxCalendarCtrl(), + Option :: {enable, boolean()}. enableMonthChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -180,15 +202,18 @@ enableMonthChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxCalendarCtrl_EnableMonthChange, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @equiv enableHolidayDisplay(This, []) +-spec enableHolidayDisplay(This) -> ok when + This::wxCalendarCtrl(). + enableHolidayDisplay(This) when is_record(This, wx_ref) -> enableHolidayDisplay(This, []). -%% @spec (This::wxCalendarCtrl(), [Option]) -> ok -%% Option = {display, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlenableholidaydisplay">external documentation</a>. +-spec enableHolidayDisplay(This, [Option]) -> ok when + This::wxCalendarCtrl(), + Option :: {display, boolean()}. enableHolidayDisplay(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -198,82 +223,93 @@ enableHolidayDisplay(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxCalendarCtrl_EnableHolidayDisplay, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxCalendarCtrl(), ColFg::wx:colour(), ColBg::wx:colour()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetheadercolours">external documentation</a>. +-spec setHeaderColours(This, ColFg, ColBg) -> ok when + This::wxCalendarCtrl(), ColFg::wx:wx_colour(), ColBg::wx:wx_colour(). setHeaderColours(#wx_ref{type=ThisT,ref=ThisRef},ColFg,ColBg) when tuple_size(ColFg) =:= 3; tuple_size(ColFg) =:= 4,tuple_size(ColBg) =:= 3; tuple_size(ColBg) =:= 4 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHeaderColours, <<ThisRef:32/?UI,(wxe_util:colour_bin(ColFg)):16/binary,(wxe_util:colour_bin(ColBg)):16/binary>>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetheadercolourfg">external documentation</a>. +-spec getHeaderColourFg(This) -> wx:wx_colour4() when + This::wxCalendarCtrl(). getHeaderColourFg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHeaderColourFg, <<ThisRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetheadercolourbg">external documentation</a>. +-spec getHeaderColourBg(This) -> wx:wx_colour4() when + This::wxCalendarCtrl(). getHeaderColourBg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHeaderColourBg, <<ThisRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl(), ColFg::wx:colour(), ColBg::wx:colour()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsethighlightcolours">external documentation</a>. +-spec setHighlightColours(This, ColFg, ColBg) -> ok when + This::wxCalendarCtrl(), ColFg::wx:wx_colour(), ColBg::wx:wx_colour(). setHighlightColours(#wx_ref{type=ThisT,ref=ThisRef},ColFg,ColBg) when tuple_size(ColFg) =:= 3; tuple_size(ColFg) =:= 4,tuple_size(ColBg) =:= 3; tuple_size(ColBg) =:= 4 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHighlightColours, <<ThisRef:32/?UI,(wxe_util:colour_bin(ColFg)):16/binary,(wxe_util:colour_bin(ColBg)):16/binary>>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgethighlightcolourfg">external documentation</a>. +-spec getHighlightColourFg(This) -> wx:wx_colour4() when + This::wxCalendarCtrl(). getHighlightColourFg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHighlightColourFg, <<ThisRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgethighlightcolourbg">external documentation</a>. +-spec getHighlightColourBg(This) -> wx:wx_colour4() when + This::wxCalendarCtrl(). getHighlightColourBg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHighlightColourBg, <<ThisRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl(), ColFg::wx:colour(), ColBg::wx:colour()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetholidaycolours">external documentation</a>. +-spec setHolidayColours(This, ColFg, ColBg) -> ok when + This::wxCalendarCtrl(), ColFg::wx:wx_colour(), ColBg::wx:wx_colour(). setHolidayColours(#wx_ref{type=ThisT,ref=ThisRef},ColFg,ColBg) when tuple_size(ColFg) =:= 3; tuple_size(ColFg) =:= 4,tuple_size(ColBg) =:= 3; tuple_size(ColBg) =:= 4 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHolidayColours, <<ThisRef:32/?UI,(wxe_util:colour_bin(ColFg)):16/binary,(wxe_util:colour_bin(ColBg)):16/binary>>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetholidaycolourfg">external documentation</a>. +-spec getHolidayColourFg(This) -> wx:wx_colour4() when + This::wxCalendarCtrl(). getHolidayColourFg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHolidayColourFg, <<ThisRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetholidaycolourbg">external documentation</a>. +-spec getHolidayColourBg(This) -> wx:wx_colour4() when + This::wxCalendarCtrl(). getHolidayColourBg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHolidayColourBg, <<ThisRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl(), Day::integer()) -> wxCalendarDateAttr:wxCalendarDateAttr() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetattr">external documentation</a>. +-spec getAttr(This, Day) -> wxCalendarDateAttr:wxCalendarDateAttr() when + This::wxCalendarCtrl(), Day::integer(). getAttr(#wx_ref{type=ThisT,ref=ThisRef},Day) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetAttr, <<ThisRef:32/?UI,Day:32/?UI>>). -%% @spec (This::wxCalendarCtrl(), Day::integer(), Attr::wxCalendarDateAttr:wxCalendarDateAttr()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetattr">external documentation</a>. +-spec setAttr(This, Day, Attr) -> ok when + This::wxCalendarCtrl(), Day::integer(), Attr::wxCalendarDateAttr:wxCalendarDateAttr(). setAttr(#wx_ref{type=ThisT,ref=ThisRef},Day,#wx_ref{type=AttrT,ref=AttrRef}) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -281,36 +317,38 @@ setAttr(#wx_ref{type=ThisT,ref=ThisRef},Day,#wx_ref{type=AttrT,ref=AttrRef}) wxe_util:cast(?wxCalendarCtrl_SetAttr, <<ThisRef:32/?UI,Day:32/?UI,AttrRef:32/?UI>>). -%% @spec (This::wxCalendarCtrl(), Day::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetholiday">external documentation</a>. +-spec setHoliday(This, Day) -> ok when + This::wxCalendarCtrl(), Day::integer(). setHoliday(#wx_ref{type=ThisT,ref=ThisRef},Day) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHoliday, <<ThisRef:32/?UI,Day:32/?UI>>). -%% @spec (This::wxCalendarCtrl(), Day::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlresetattr">external documentation</a>. +-spec resetAttr(This, Day) -> ok when + This::wxCalendarCtrl(), Day::integer(). resetAttr(#wx_ref{type=ThisT,ref=ThisRef},Day) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_ResetAttr, <<ThisRef:32/?UI,Day:32/?UI>>). -%% @spec (This::wxCalendarCtrl(), Pos::{X::integer(),Y::integer()}) -> {WxCalendarHitTestResult,Date::wx:datetime(),Wd::WeekDay} -%% WxCalendarHitTestResult = integer() -%% WeekDay = integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlhittest">external documentation</a>. -%%<br /> WxCalendarHitTestResult is one of ?wxCAL_HITTEST_NOWHERE | ?wxCAL_HITTEST_HEADER | ?wxCAL_HITTEST_DAY | ?wxCAL_HITTEST_INCMONTH | ?wxCAL_HITTEST_DECMONTH | ?wxCAL_HITTEST_SURROUNDING_WEEK -%%<br /> WeekDay is one of ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay +%%<br /> Wd = ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay +%%<br /> Res = ?wxCAL_HITTEST_NOWHERE | ?wxCAL_HITTEST_HEADER | ?wxCAL_HITTEST_DAY | ?wxCAL_HITTEST_INCMONTH | ?wxCAL_HITTEST_DECMONTH | ?wxCAL_HITTEST_SURROUNDING_WEEK +-spec hitTest(This, Pos) -> Result when + Result ::{Res ::wx:wx_enum(), Date::wx:wx_datetime(), Wd::wx:wx_enum()}, + This::wxCalendarCtrl(), Pos::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY}) when is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_HitTest, <<ThisRef:32/?UI,PosX:32/?UI,PosY:32/?UI>>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxCalendarCtrl()) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxCalendarCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), |