Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxCalendarDateAttr (3erl)

Name

wxCalendarDateAttr - Functions for wxCalendarDateAttr class

Synopsis

Please see following description for synopsis

Description

wxCalendarDateAttr(3)      Erlang Module Definition      wxCalendarDateAttr(3)



NAME
       wxCalendarDateAttr - Functions for wxCalendarDateAttr class

DESCRIPTION
       wxCalendarDateAttr  is  a  custom  attributes  for a calendar date. The
       objects of this class are used with wxCalendarCtrl.

       See: wxCalendarCtrl

       wxWidgets docs: wxCalendarDateAttr

DATA TYPES
       wxCalendarDateAttr() = wx:wx_object()

EXPORTS
       new() -> wxCalendarDateAttr()

       new(Border) -> wxCalendarDateAttr()

       new(Border :: [Option]) -> wxCalendarDateAttr()

              Types:

                 Option =
                     {colText, wx:wx_colour()} |
                     {colBack, wx:wx_colour()} |
                     {colBorder, wx:wx_colour()} |
                     {font, wxFont:wxFont()} |
                     {border, wx:wx_enum()}

              Constructor for specifying all wxCalendarDateAttr properties.

       new(Border, Options :: [Option]) -> wxCalendarDateAttr()

              Types:

                 Border = wx:wx_enum()
                 Option = {colBorder, wx:wx_colour()}

              Constructor using default properties except the given border.

       setTextColour(This, ColText) -> ok

              Types:

                 This = wxCalendarDateAttr()
                 ColText = wx:wx_colour()

              Sets the text (foreground) colour to use.

       setBackgroundColour(This, ColBack) -> ok

              Types:

                 This = wxCalendarDateAttr()
                 ColBack = wx:wx_colour()

              Sets the text background colour to use.

       setBorderColour(This, Col) -> ok

              Types:

                 This = wxCalendarDateAttr()
                 Col = wx:wx_colour()

              Sets the border colour to use.

       setFont(This, Font) -> ok

              Types:

                 This = wxCalendarDateAttr()
                 Font = wxFont:wxFont()

              Sets the font to use.

       setBorder(This, Border) -> ok

              Types:

                 This = wxCalendarDateAttr()
                 Border = wx:wx_enum()

              Sets the border to use.

       setHoliday(This, Holiday) -> ok

              Types:

                 This = wxCalendarDateAttr()
                 Holiday = boolean()

              If holiday is true, this calendar day will  be  displayed  as  a
              holiday.

       hasTextColour(This) -> boolean()

              Types:

                 This = wxCalendarDateAttr()

              Returns true if a non-default text foreground colour is set.

       hasBackgroundColour(This) -> boolean()

              Types:

                 This = wxCalendarDateAttr()

              Returns true if a non-default text background colour is set.

       hasBorderColour(This) -> boolean()

              Types:

                 This = wxCalendarDateAttr()

              Returns true if a non-default border colour is set.

       hasFont(This) -> boolean()

              Types:

                 This = wxCalendarDateAttr()

              Returns true if a non-default font is set.

       hasBorder(This) -> boolean()

              Types:

                 This = wxCalendarDateAttr()

              Returns true if a non-default (i.e. any) border is set.

       isHoliday(This) -> boolean()

              Types:

                 This = wxCalendarDateAttr()

              Returns true if this calendar day is displayed as a holiday.

       getTextColour(This) -> wx:wx_colour4()

              Types:

                 This = wxCalendarDateAttr()

              Returns the text colour set for the calendar date.

       getBackgroundColour(This) -> wx:wx_colour4()

              Types:

                 This = wxCalendarDateAttr()

              Returns the background colour set for the calendar date.

       getBorderColour(This) -> wx:wx_colour4()

              Types:

                 This = wxCalendarDateAttr()

              Returns the border colour set for the calendar date.

       getFont(This) -> wxFont:wxFont()

              Types:

                 This = wxCalendarDateAttr()

              Returns the font set for the calendar date.

       getBorder(This) -> wx:wx_enum()

              Types:

                 This = wxCalendarDateAttr()

              Returns the border set for the calendar date.

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

              Destroys the object.



wxWidgets team.                    wx 2.1.1              wxCalendarDateAttr(3)