wxAuiDockArt(3)

💖 wxAuiDockArt 💖

okay bestie, welcome to wxAuiDockArt(3), an Erlang module definition, and no I will not be normal about it ✨

---

🌸 NAME 🌸

wxAuiDockArt — it's literally part of the wxAUI class framework, that's the whole name situation 💅

---

🦋 DESCRIPTION 🦋

See also overview_aui — go look at it, I'm not kidding 🫶

So wxAuiDockArt is the art provider. What that means is: it hands all the drawing functionality to the wxAui dock manager. That's the whole point — it lets the dock manager have a pluggable look-and-feel. Like, interchangeable outfits for your UI. iconic behavior, truly 👑

By default, a wxAuiManager uses an instance of this class called wxAuiDefaultDockArt (not implemented in wx, fyi) which provides bitmap art and a colour scheme that's adapted to the major platforms' look. So it just kinda... matches your OS vibe automatically, no cap 🌈

You've got two options, bestie:

• derive from that class and alter its behaviour, or
• write a completely new dock art class from scratch. main character energy fr fr 💅

Then call wxAuiManager:setArtProvider/2 to force wxAUI to use your new dock art provider. That's the moment where it becomes yours ✨

See:

• wxAuiManager
• wxAuiPaneInfo

wxWidgets docs: wxAuiDockArt

---

🎀 DATA TYPES 🎀

• wxAuiDockArt() :: wx:wx_object().

---

⭐ FUNCTIONS ⭐

💜 getColour

getColour(This, Id) -> wx:wx_colour4()
                          when This :: wxAuiDockArt(), Id :: integer().

Get the colour of a certain setting. 🎨

id can be one of the colour values of wxAuiPaneDockArtSetting.

---

💜 getFont

getFont(This, Id) -> wxFont:wxFont()
                        when This :: wxAuiDockArt(), Id :: integer().

Get a font setting. that's it, that's the function, go get your font 🫶

---

💜 getMetric

getMetric(This, Id) -> integer()
                          when This :: wxAuiDockArt(), Id :: integer().

Get the value of a certain setting. 📏

id can be one of the size values of wxAuiPaneDockArtSetting.

---

💜 setColour

setColour(This, Id, Colour) -> ok
                          when
                              This :: wxAuiDockArt(),
                              Id :: integer(),
                              Colour :: wx:wx_colour().

Set a certain setting with the value colour. 🎨✨

id can be one of the colour values of wxAuiPaneDockArtSetting.

---

💜 setFont

setFont(This, Id, Font) -> ok
                        when
                            This :: wxAuiDockArt(),
                            Id :: integer(),
                            Font :: wxFont:wxFont().

Set a font setting. yes bestie, customize the typography, it's giving taste 💅

---

💜 setMetric

setMetric(This, Id, New_val) -> ok
                          when
                              This :: wxAuiDockArt(),
                              Id :: integer(),
                              New_val :: integer().

Set a certain setting with the value new\_val. 📐

id can be one of the size values of wxAuiPaneDockArtSetting.

---

ok that's the whole page, and you understood all of it, I'm so proud of you 🥹💖

---

and that's a wrap! brought to you by Ericsson AB, living in the wx 2.6 era 🌸 — this was wxAuiDockArt(3), slay, bye bestie 👑💅✨