wxCalendarCtrl(3)

MODULE
wxCalendarCtrl - See external documentation: wxCalendarCtrl.

DESCRIPTION

See external documentation: wxCalendarCtrl <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html>.

This class is derived (and can use functions) from:
wxControl
wxWindow
wxEvtHandler

DATA TYPES

    wxCalendarCtrl():

        An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new() -> wxCalendarCtrl()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlwxcalendarctrl>.

new(Parent::wxWindow() (see module wxWindow), Id::integer()) -> wxCalendarCtrl()

    Equivalent to new(Parent, Id, []).

new(Parent::wxWindow() (see module wxWindow), Id::integer(), Options::[Option]) -> wxCalendarCtrl()

    Types
        Option = {date, datetime() (see module wx)} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlwxcalendarctrl>.

create(This::wxCalendarCtrl(), Parent::wxWindow() (see module wxWindow), Id::integer()) -> bool()

    Equivalent to create(This, Parent, Id, []).

create(This::wxCalendarCtrl(), Parent::wxWindow() (see module wxWindow), Id::integer(), Options::[Option]) -> bool()

    Types
        Option = {date, datetime() (see module wx)} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlcreate>.

setDate(This::wxCalendarCtrl(), Date::datetime() (see module wx)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetdate>.

getDate(This::wxCalendarCtrl()) -> datetime() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetdate>.

enableYearChange(This::wxCalendarCtrl()) -> ok

    Equivalent to enableYearChange(This, []).

enableYearChange(This::wxCalendarCtrl(), Options::[Option]) -> ok

    Types
        Option = {enable, bool()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlenableyearchange>.

enableMonthChange(This::wxCalendarCtrl()) -> ok

    Equivalent to enableMonthChange(This, []).

enableMonthChange(This::wxCalendarCtrl(), Options::[Option]) -> ok

    Types
        Option = {enable, bool()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlenablemonthchange>.

enableHolidayDisplay(This::wxCalendarCtrl()) -> ok

    Equivalent to enableHolidayDisplay(This, []).

enableHolidayDisplay(This::wxCalendarCtrl(), Options::[Option]) -> ok

    Types
        Option = {display, bool()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlenableholidaydisplay>.

setHeaderColours(This::wxCalendarCtrl(), ColFg::colour() (see module wx), ColBg::colour() (see module wx)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetheadercolours>.

getHeaderColourFg(This::wxCalendarCtrl()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetheadercolourfg>.

getHeaderColourBg(This::wxCalendarCtrl()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetheadercolourbg>.

setHighlightColours(This::wxCalendarCtrl(), ColFg::colour() (see module wx), ColBg::colour() (see module wx)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsethighlightcolours>.

getHighlightColourFg(This::wxCalendarCtrl()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgethighlightcolourfg>.

getHighlightColourBg(This::wxCalendarCtrl()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgethighlightcolourbg>.

setHolidayColours(This::wxCalendarCtrl(), ColFg::colour() (see module wx), ColBg::colour() (see module wx)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetholidaycolours>.

getHolidayColourFg(This::wxCalendarCtrl()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetholidaycolourfg>.

getHolidayColourBg(This::wxCalendarCtrl()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetholidaycolourbg>.

getAttr(This::wxCalendarCtrl(), Day::integer()) -> wxCalendarDateAttr() (see module wxCalendarDateAttr)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlgetattr>.

setAttr(This::wxCalendarCtrl(), Day::integer(), Attr::wxCalendarDateAttr() (see module wxCalendarDateAttr)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetattr>.

setHoliday(This::wxCalendarCtrl(), Day::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlsetholiday>.

resetAttr(This::wxCalendarCtrl(), Day::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlresetattr>.

hitTest(This::wxCalendarCtrl(), Pos::{X::integer(), Y::integer()}) -> {WxCalendarHitTestResult, Date::datetime() (see module wx), Wd::WeekDay}

    Types
        WxCalendarHitTestResult = integer()
        WeekDay = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcalendarctrl.html#wxcalendarctrlhittest>.
     WxCalendarHitTestResult is one of ?wxCAL_HITTEST_NOWHERE | ?wxCAL_HITTEST_HEADER | ?wxCAL_HITTEST_DAY | ?wxCAL_HITTEST_INCMONTH | ?wxCAL_HITTEST_DECMONTH | ?wxCAL_HITTEST_SURROUNDING_WEEK
     WeekDay is one of ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay

destroy(This::wxCalendarCtrl()) -> ok

    Destroys this object, do not use object again