wxColourPickerCtrl(3erl)

💖 wxColourPickerCtrl 💖

Erlang Module Definition — okay bestie, welcome to the manual page for the wxColourPickerCtrl class. We are keeping every function, tuple, and footer crumb intact, but making it cute. Periodt. ✨

🌸 NAME 🌸

wxColourPickerCtrl — functions for the wxColourPickerCtrl class. That's the name, no cap. 🫶

🦋 DESCRIPTION 🦋

This control lets the user select a colour. Literally its whole main-character job. 🎨

The generic implementation is a button which brings up a wxColourDialog when clicked. Native implementation may differ, but this is usually a (small) widget which gives access to the colour-chooser dialog. It is only available if wxUSE_COLOURPICKERCTRL is set to 1 (the default). Slay. 💅

Styles — this class supports the following styles:

The original page doesn't enumerate them right here, so I'm not inventing any, bestie. Leaving it exactly as-is. 🙈

See: wxColourDialog, wxColourPickerEvent.

This class is derived (and can use functions) from: wxPickerBase wxControl wxWindow wxEvtHandler.

wxWidgets docs: wxColourPickerCtrl.

🌈 EVENTS 🌈

• command_colourpicker_changed — event type emitted from this class.

🎀 DATA TYPES 🎀

wxColourPickerCtrl() = wx:wx_object()

✨ EXPORTS ✨

🐣 new() -> wxColourPickerCtrl()

Zero-argument constructor moment. It just returns a wxColourPickerCtrl(). Iconic.

🐣 new(Parent, Id) -> wxColourPickerCtrl()

Types:

Parent = wxWindow:wxWindow()
Id = integer()

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

Types:

Parent = wxWindow:wxWindow()
Id = integer()
Option =
    {col, wx:wx_colour()} |
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()} |
    {validator, wx:wx_object()}

Initializes the object and calls create/4 with all the parameters. Bestie, it's handing the whole options list over. 🫶

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

Types:

This = wxColourPickerCtrl()
Parent = wxWindow:wxWindow()
Id = integer()

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

Types:

This = wxColourPickerCtrl()
Parent = wxWindow:wxWindow()
Id = integer()
Option =
    {col, wx:wx_colour()} |
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()} |
    {validator, wx:wx_object()}

Creates a colour picker with the given arguments.

Return: true if the control was successfully created or false if creation failed. No mystery, just boolean realness. 💖

🎨 getColour(This) -> wx:wx_colour4()

Types:

This = wxColourPickerCtrl()

Returns the currently selected colour. Obsessed with a straightforward getter. ✨

💅 setColour/2

• setColour(This, Colname) -> ok
• setColour(This, Col) -> ok

Types:

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

Sets the currently selected colour.

See wxColour::Set() (not implemented in wx).

💀 destroy(This :: wxColourPickerCtrl()) -> ok

Destroys the object. RIP little widget, but make it cute. 🪦

---

Cute final sign-off, bestie: shoutout to the wxWidgets team for the source, wx 2.2.2.1 for the version, and the footer date/manual-name energy — wxColourPickerCtrl(3erl) — if your copy's footer has a date, consider it kissed. Mwah! 💋💖✨