wxCalendarDateAttr(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

💖 NAME 💖

wxCalendarDateAttr — bestie, this is the custom-attrs-for-a-calendar-date module, and it's giving main character energy for your calendar glow-ups. It lives in the Erlang module definitions for wx 2.6, and yeah, that's the whole vibe.

✨ DESCRIPTION ✨

Okay so real talk: the objects of this class are used with wxCalendarCtrl.

See: wxCalendarCtrl

wxWidgets docs: wxCalendarDateAttr

Translation: you don't just get a boring calendar, you get a calendar where every single date can show up dressed for the occasion. 🎀

🦋 DATA TYPES 🦋

  • wxCalendarDateAttr() :: wx:wx_object().

That's it, that's the type, she's an object and she's iconic. 💅

🔥 FUNCTIONS 🔥

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

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

Destroys the object. Bye bestie, you had a good run. 💀

getBackgroundColour(This)

getBackgroundColour(This) -> wx:wx_colour4()
                             when This :: wxCalendarDateAttr().

Returns the background colour set for the calendar date. Yes, the ~background~, the underlayer, the lewk underneath. 🌈

getBorder(This)

getBorder(This) -> wx:wx_enum() when This :: wxCalendarDateAttr().

Returns the border set for the calendar date. The outline. The frame. The edges of the moment. ✨

getBorderColour(This)

getBorderColour(This) -> wx:wx_colour4()
                         when This :: wxCalendarDateAttr().

Returns the border colour set for the calendar date. 🎀

getFont(This)

getFont(This) -> wxFont:wxFont() when This :: wxCalendarDateAttr().

Returns the font set for the calendar date. Typeface check, and this one's passing fr fr. 🔤

getTextColour(This)

getTextColour(This) -> wx:wx_colour4()
                       when This :: wxCalendarDateAttr().

Returns the text colour set for the calendar date. 💜

hasBackgroundColour(This)

hasBackgroundColour(This) -> boolean()
                            when This :: wxCalendarDateAttr().

Returns true if a non-default text background colour is set. So like, is the background doing something custom? Inquiring minds. 👀

hasBorder(This)

hasBorder(This) -> boolean() when This :: wxCalendarDateAttr().

Returns true if a non-default (i.e. any) border is set. Note the parenthetical bestie — any border at all counts as non-default here.

hasBorderColour(This)

hasBorderColour(This) -> boolean()
                        when This :: wxCalendarDateAttr().

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

hasFont(This)

hasFont(This) -> boolean() when This :: wxCalendarDateAttr().

Returns true if a non-default font is set. ⭐

hasTextColour(This)

hasTextColour(This) -> boolean() when This :: wxCalendarDateAttr().

Returns true if a non-default text foreground colour is set. Foreground, bestie, not background — don't mix them up. 💅

isHoliday(This)

isHoliday(This) -> boolean() when This :: wxCalendarDateAttr().

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

new(Border) / new([Option])

new(Border) -> wxCalendarDateAttr() when Border :: wx:wx_enum();
         ([Option]) -> wxCalendarDateAttr()
             when
                 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. Go big, set everything, no crumbs. 👑

new(Border, [Option])

new(Border, [Option]) -> wxCalendarDateAttr()
             when
                 Border :: wx:wx_enum(),
                 Option :: {colBorder, wx:wx_colour()}.

Constructor using default properties except the given border. Minimal effort, maximum slay. 🧚

setBackgroundColour(This, ColBack)

setBackgroundColour(This, ColBack) -> ok
                             when
                                 This :: wxCalendarDateAttr(),
                                 ColBack :: wx:wx_colour().

Sets the text background colour to use. 🎨

setBorder(This, Border)

setBorder(This, Border) -> ok
                   when
                       This :: wxCalendarDateAttr(),
                       Border :: wx:wx_enum().

Sets the border to use. 🖼️

setBorderColour(This, Col)

setBorderColour(This, Col) -> ok
                         when
                             This :: wxCalendarDateAttr(),
                             Col :: wx:wx_colour().

Sets the border colour to use. ✨

setFont(This, Font)

setFont(This, Font) -> ok
                 when
                     This :: wxCalendarDateAttr(),
                     Font :: wxFont:wxFont().

Sets the font to use. 🖋️

setHoliday(This, Holiday)

setHoliday(This, Holiday) -> ok
                    when
                        This :: wxCalendarDateAttr(),
                        Holiday :: boolean().

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

setTextColour(This, ColText)

setTextColour(This, ColText) -> ok
                       when
                           This :: wxCalendarDateAttr(),
                           ColText :: wx:wx_colour().

Sets the text (foreground) colour to use. 🫶

Okay that's the whole page bestie, every single function accounted for, no skips, no cuts, we ate and left no crumbs. 💖

And a lil sign-off moment: this one's brought to you by Ericsson AB, from the wx 2.6 era, and wxCalendarDateAttr(3) said periodt. ✨🌸💅

📦 where this page comes from