Module wxCalendarCtrl

Description
Data Types
Function Index
Function Details

See external documentation: wxCalendarCtrl.

Description

See external documentation: wxCalendarCtrl.
This class is derived (and can use functions) from:

Data Types

wxCalendarCtrl()

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

Function Index

create/3*	Equivalent to `create(This, Parent, Id, [])`.
create/4*	See external documentation.
destroy/1*	Destroys this object, do not use object again.
enableHolidayDisplay/1*	Equivalent to `enableHolidayDisplay(This, [])`.
enableHolidayDisplay/2*	See external documentation.
enableMonthChange/1*	Equivalent to `enableMonthChange(This, [])`.
enableMonthChange/2*	See external documentation.
enableYearChange/1*	Equivalent to `enableYearChange(This, [])`.
enableYearChange/2*	See external documentation.
getAttr/2*	See external documentation.
getDate/1*	See external documentation.
getHeaderColourBg/1*	See external documentation.
getHeaderColourFg/1*	See external documentation.
getHighlightColourBg/1*	See external documentation.
getHighlightColourFg/1*	See external documentation.
getHolidayColourBg/1*	See external documentation.
getHolidayColourFg/1*	See external documentation.
hitTest/2*	See external documentation.
new/0*	See external documentation.
new/2*	Equivalent to `new(Parent, Id, [])`.
new/3*	See external documentation.
resetAttr/2*	See external documentation.
setAttr/3*	See external documentation.
setDate/2*	See external documentation.
setHeaderColours/3*	See external documentation.
setHighlightColours/3*	See external documentation.
setHoliday/2*	See external documentation.
setHolidayColours/3*	See external documentation.

Function Details

create/3 *

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

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

create/4 *

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

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

See external documentation.

destroy/1 *

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

Destroys this object, do not use object again

enableHolidayDisplay/1 *

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

Equivalent to enableHolidayDisplay(This, []).

enableHolidayDisplay/2 *

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

Option = {display, bool()}

See external documentation.

enableMonthChange/1 *

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

Equivalent to enableMonthChange(This, []).

enableMonthChange/2 *

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

Option = {enable, bool()}

See external documentation.

enableYearChange/1 *

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

Equivalent to enableYearChange(This, []).

enableYearChange/2 *

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

Option = {enable, bool()}

See external documentation.

getAttr/2 *

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

See external documentation.

getDate/1 *

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

See external documentation.

getHeaderColourBg/1 *

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

See external documentation.

getHeaderColourFg/1 *

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

See external documentation.

getHighlightColourBg/1 *

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

See external documentation.

getHighlightColourFg/1 *

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

See external documentation.

getHolidayColourBg/1 *

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

See external documentation.

getHolidayColourFg/1 *

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

See external documentation.

hitTest/2 *

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

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

new/0 *

new() -> wxCalendarCtrl()

See external documentation.

new/2 *

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

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

new/3 *

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

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

See external documentation.

resetAttr/2 *

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

See external documentation.

setAttr/3 *

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

See external documentation.

setDate/2 *

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

See external documentation.

setHeaderColours/3 *

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

See external documentation.

setHighlightColours/3 *

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

See external documentation.

setHoliday/2 *

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

See external documentation.

setHolidayColours/3 *

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

See external documentation.

Generated by EDoc, May 26 2008, 12:35:27.