wxColourData(3)

πŸ“¦
version 29.0.6 Β· 3 versions
, in ubuntu stonking

πŸ’– wxColourData β€” the Erlang module, bestie edition πŸ’–

okay so real quick, this is the manual page for wxColourData(3) β€” an Erlang module definition, and honestly? it's giving "the lil info packet that colour dialogs carry around." It's not the dialog, it's the vibe behind the dialog. The little bag of settings. The main character's emotional support data structure. πŸŽ€


✨ NAME ✨

wxColourData β€” this class holds a variety of information related to colour dialogs. πŸ’…


🌈 DESCRIPTION 🌈

This is the class that keeps all the colour-dialog tea together. That's it. That's the whole job. πŸ‘‘

Wanna know more? Go check out:

  • wx_color()
  • wxColourDialog
  • Overview cmndlg

Also there's the wxWidgets docs: wxColourData β€” the og source, no cap. πŸ“š


πŸ¦‹ DATA TYPES πŸ¦‹

  • wxColourData() :: wx:wx_object().

that's it. that's the type. it's a wx object. slay. ✨


πŸŽ€ FUNCTIONS πŸŽ€

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

Destroys the object. bye bestie, it's over, gone, no more. πŸ’€


getChooseFull(This) -> boolean() when This :: wxColourData().

Under Windows, this one decides whether the Windows colour dialog is gonna display the full dialog β€” custom colour selection controls and all. the deluxe version. 🫢

Under other platforms? Has no meaning, like, at all. literally nothing. πŸ™ˆ

The default value is true.


getColour(This) -> wx:wx_colour4() when This :: wxColourData().

Gets the current colour that's associated with the colour dialog.

The default colour is black πŸ–€.


`getCustomColour(This, I) -> wx:wx_colour4()

when This :: wxColourData(), I :: integer().`

Returns the custom colours associated with the colour dialog. yes, plural, custom, the whole collection. 🌸


new() -> wxColourData().

Constructor. it's the birth of a legend, honestly. ✨

It initializes:

  • the custom colours to wxNullColour
  • the data colour setting to black
  • the choose full setting to true

iconic defaults, periodt. πŸ‘‘


`setChooseFull(This, Flag) -> ok

when This :: wxColourData(), Flag :: boolean().`

Under Windows, this tells the Windows colour dialog to display the full dialog, custom colour selection controls included. go big or go home. πŸ”₯

Under other platforms, it has no effect. nothing. nada. 🧚

The default value is true.


`setColour(This, Colour) -> ok

when This :: wxColourData(), Colour :: wx:wx_colour().`

Sets the default colour for the colour dialog.

The default colour is black πŸ–€.


`setCustomColour(This, I, Colour) -> ok

when This :: wxColourData(), I :: integer(), Colour :: wx:wx_colour().`

Sets custom colours for the colour dialog. your palette, your rules, your moment. πŸŽ¨πŸ’œ


ngl bestie, if you're on Windows and wondering why your dialog looks a whole lot extra, that's choose full doing its thing. on any other platform it's just out here being decorative. 😭

that's the whole page, fr fr β€” every option, every default, every vibe, no skips. 🌈

This lil love letter was brought to you by Ericsson AB, running wx 2.6, and it answers to the name wxColourData(3). mwah, bye bestie πŸ’–πŸ¦‹βœ¨

πŸ“¦ where this page comes from