User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.99

Expand All
Contract All

Table of Contents

# wxCalendarCtrl

### MODULE

wxCalendarCtrl

### MODULE SUMMARY

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::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.

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.

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

See external documentation.

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

See external documentation.

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

Equivalent to enableYearChange(This, []).

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

Types:

Option = {enable, bool()}

See external documentation.

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

Equivalent to enableMonthChange(This, []).

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

Types:

Option = {enable, bool()}

See external documentation.

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

Equivalent to enableHolidayDisplay(This, []).

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

Types:

Option = {display, bool()}

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

Types:

WxCalendarHitTestResult = integer()
WeekDay = integer()

See external documentation.
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