wxCalendarCtrl(3)

NAME
wxCalendarCtrl - See external documentation: wxCalendarCtrl.

DESCRIPTION

See external documentation: wxCalendarCtrl.

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.

new(Parent, Id) -> wxCalendarCtrl()

    Types:
        Parent = wxWindow() (see module wxWindow)
        Id = integer()

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

new(Parent, Id, Options::[Option]) -> wxCalendarCtrl()

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

    See external documentation.

create(This, Parent, Id) -> boolean()

    Types:
        This = wxCalendarCtrl()
        Parent = wxWindow() (see module wxWindow)
        Id = integer()

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

create(This, Parent, Id, Options::[Option]) -> boolean()

    Types:
        This = wxCalendarCtrl()
        Parent = wxWindow() (see module wxWindow)
        Id = integer()
        Option = {date, wx_datetime() (see module wx)} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}

    See external documentation.

setDate(This, Date) -> boolean()

    Types:
        This = wxCalendarCtrl()
        Date = wx_datetime() (see module wx)

    See external documentation.

getDate(This) -> wx_datetime() (see module wx)

    Types:
        This = wxCalendarCtrl()

    See external documentation.

enableYearChange(This) -> ok

    Types:
        This = wxCalendarCtrl()

    This function is deprecated: deprecated function not available in wxWidgets-2.9 and later

    Equivalent to enableYearChange(This, []).

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

    Types:
        This = wxCalendarCtrl()
        Option = {enable, boolean()}

    This function is deprecated: deprecated function not available in wxWidgets-2.9 and later

    See external documentation.

enableMonthChange(This) -> ok

    Types:
        This = wxCalendarCtrl()

    Equivalent to enableMonthChange(This, []).

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

    Types:
        This = wxCalendarCtrl()
        Option = {enable, boolean()}

    See external documentation.

enableHolidayDisplay(This) -> ok

    Types:
        This = wxCalendarCtrl()

    Equivalent to enableHolidayDisplay(This, []).

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

    Types:
        This = wxCalendarCtrl()
        Option = {display, boolean()}

    See external documentation.

setHeaderColours(This, ColFg, ColBg) -> ok

    Types:
        This = wxCalendarCtrl()
        ColFg = wx_colour() (see module wx)
        ColBg = wx_colour() (see module wx)

    See external documentation.

getHeaderColourFg(This) -> wx_colour4() (see module wx)

    Types:
        This = wxCalendarCtrl()

    See external documentation.

getHeaderColourBg(This) -> wx_colour4() (see module wx)

    Types:
        This = wxCalendarCtrl()

    See external documentation.

setHighlightColours(This, ColFg, ColBg) -> ok

    Types:
        This = wxCalendarCtrl()
        ColFg = wx_colour() (see module wx)
        ColBg = wx_colour() (see module wx)

    See external documentation.

getHighlightColourFg(This) -> wx_colour4() (see module wx)

    Types:
        This = wxCalendarCtrl()

    See external documentation.

getHighlightColourBg(This) -> wx_colour4() (see module wx)

    Types:
        This = wxCalendarCtrl()

    See external documentation.

setHolidayColours(This, ColFg, ColBg) -> ok

    Types:
        This = wxCalendarCtrl()
        ColFg = wx_colour() (see module wx)
        ColBg = wx_colour() (see module wx)

    See external documentation.

getHolidayColourFg(This) -> wx_colour4() (see module wx)

    Types:
        This = wxCalendarCtrl()

    See external documentation.

getHolidayColourBg(This) -> wx_colour4() (see module wx)

    Types:
        This = wxCalendarCtrl()

    See external documentation.

getAttr(This, Day) -> wxCalendarDateAttr() (see module wxCalendarDateAttr)

    Types:
        This = wxCalendarCtrl()
        Day = integer()

    See external documentation.

setAttr(This, Day, Attr) -> ok

    Types:
        This = wxCalendarCtrl()
        Day = integer()
        Attr = wxCalendarDateAttr() (see module wxCalendarDateAttr)

    See external documentation.

setHoliday(This, Day) -> ok

    Types:
        This = wxCalendarCtrl()
        Day = integer()

    See external documentation.

resetAttr(This, Day) -> ok

    Types:
        This = wxCalendarCtrl()
        Day = integer()

    See external documentation.

hitTest(This, Pos) -> Result

    Types:
        Result = {Res::wx_enum() (see module wx), Date::wx_datetime() (see module wx), Wd::wx_enum() (see module wx)}
        This = wxCalendarCtrl()
        Pos = {X::integer(), Y::integer()}

    See external documentation.
    Wd = ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay
    Res = ?wxCAL_HITTEST_NOWHERE | ?wxCAL_HITTEST_HEADER | ?wxCAL_HITTEST_DAY | ?wxCAL_HITTEST_INCMONTH | ?wxCAL_HITTEST_DECMONTH | ?wxCAL_HITTEST_SURROUNDING_WEEK

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

    Destroys this object, do not use object again

AUTHORS

<>