wxXmlResource(3erl)

💖 NAME 💖

wxXmlResource — the Erlang module definition, and yup bestie, this is the 3erl manual page for all the Functions for the wxXmlResource class. 🫶

---

✨ DESCRIPTION ✨

This is the main class for interacting with the XML-based resource system. It’s giving very important, very singleton energy. 💅

The class holds XML resources from one or more .xml files, binary files or zip archive files. 🎀

Note that this is a singleton class and you'll never allocate/deallocate it. Just use the static get/0 getter. No cap — that’s the whole vibe. 🌸

See: Overview xrc, Overview xrcformat

wxWidgets docs: wxXmlResource

---

🦋 DATA TYPES 🦋

wxXmlResource() = wx:wx_object()

---

🔥 EXPORTS 🔥

• new() -> wxXmlResource()
• new(Options :: [Option]) -> wxXmlResource() — Constructor. ✨

Types:

• Option = {flags, integer()} | {domain, unicode:chardata()}

• new(Filemask, Options :: [Option]) -> wxXmlResource() — Constructor. 🎀

Types:

• Filemask = unicode:chardata()
• Option = {flags, integer()} | {domain, unicode:chardata()}

• destroy(This :: wxXmlResource()) -> ok — Destructor. 💀

Types:

• This = wxXmlResource()

• attachUnknownControl(This, Name, Control) -> boolean()

Types:

• This = wxXmlResource()
• Name = unicode:chardata()
• Control = wxWindow:wxWindow()

• attachUnknownControl(This, Name, Control, Options :: [Option]) -> boolean() — Attaches an unknown control to the given panel/window/dialog. 🫶

Types:

• This = wxXmlResource()
• Name = unicode:chardata()
• Control = wxWindow:wxWindow()
• Option = {parent, wxWindow:wxWindow()}

Unknown controls are used in conjunction with <object class="unknown">.

• clearHandlers(This) -> ok — Removes all handlers and deletes them. This means that any handlers added using AddHandler() (not implemented in wx) must be allocated on the heap. 😭

Types:

• This = wxXmlResource()

• compareVersion(This, Major, Minor, Release, Revision) -> integer() — Compares the XRC version to the argument. 🔍

Types:

• This = wxXmlResource()
• Major = Minor = Release = Revision = integer()

Returns -1 if the XRC version is less than the argument, +1 if greater, and 0 if they are equal. Periodt.

• get() -> wxXmlResource() — Gets the global resources object or creates one if none exists. 👑
• getFlags(This) -> integer() — Returns flags, which may be a bitlist of ?wxXmlResourceFlags enumeration values. 🌈

Types:

• This = wxXmlResource()

• getVersion(This) -> integer() — Returns version information (a.b.c.d = d + 256*c + 2562*b + 2563*a). ⭐

Types:

• This = wxXmlResource()

• getXRCID(Str_id) -> integer()

Types:

• Str_id = unicode:chardata()

• getXRCID(Str_id, Options :: [Option]) -> integer() — Returns a numeric ID that is equivalent to the string ID used in an XML resource. 🎀

Types:

• Str_id = unicode:chardata()
• Option = {value_if_not_found, integer()}

If an unknown str_id is requested (i.e. other than wxID_XXX or integer), a new record is created which associates the given string with a number.

If value_if_not_found is wxID_NONE, the number is obtained via wx_misc:newId/0. Otherwise value_if_not_found is used.

Macro XRCID(name) is provided for convenient use in event tables.

Note: IDs returned by XRCID() cannot be used with the EVT_*_RANGE macros, because the order in which they are assigned to symbolic name values is not guaranteed. 🙈

• initAllHandlers(This) -> ok — Initializes handlers for all supported controls/windows. ✨

Types:

• This = wxXmlResource()

This will make the executable quite big because it forces linking against most of the wxWidgets library. Big yikes, but also iconic.

• load(This, Filemask) -> boolean() — Loads resources from XML files that match given filemask. 🦋

Types:

• This = wxXmlResource()
• Filemask = unicode:chardata()

Example: (the original page leaves this blank, bestie — mysterious main character energy 😭)

Note: If wxUSE_FILESYS is enabled, this method understands wxFileSystem (not implemented in wx) URLs (see wxFileSystem::FindFirst() (not implemented in wx)).

Note: If you are sure that the argument is name of single XRC file (rather than an URL or a wildcard), use LoadFile() (not implemented in wx) instead.

See: LoadFile() (not implemented in wx), LoadAllFiles() (not implemented in wx)

• loadBitmap(This, Name) -> wxBitmap:wxBitmap() — Loads a bitmap resource from a file. 🖼️

Types:

• This = wxXmlResource()
• Name = unicode:chardata()

• loadDialog(This, Parent, Name) -> wxDialog:wxDialog() — Loads a dialog. 💅

Types:

• This = wxXmlResource()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

parent points to parent window (if any).

• loadDialog(This, Dlg, Parent, Name) -> boolean() — Loads a dialog. 🎀

Types:

• This = wxXmlResource()
• Dlg = wxDialog:wxDialog()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

parent points to parent window (if any).

This form is used to finish creation of an already existing instance (the main reason for this is that you may want to use derived class with a new event table). Example: (blank in the original — the suspense is real 😭)

• loadFrame(This, Parent, Name) -> wxFrame:wxFrame() — Loads a frame from the resource. 🌸

Types:

• This = wxXmlResource()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

parent points to parent window (if any).

• loadFrame(This, Frame, Parent, Name) -> boolean() — Loads the contents of a frame onto an existing wxFrame. 🫶

Types:

• This = wxXmlResource()
• Frame = wxFrame:wxFrame()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

This form is used to finish creation of an already existing instance (the main reason for this is that you may want to use derived class with a new event table).

• loadIcon(This, Name) -> wxIcon:wxIcon() — Loads an icon resource from a file. ⭐

Types:

• This = wxXmlResource()
• Name = unicode:chardata()

• loadMenu(This, Name) -> wxMenu:wxMenu() — Loads menu from resource. 🍓

Types:

• This = wxXmlResource()
• Name = unicode:chardata()

Returns NULL on failure.

• loadMenuBar(This, Name) -> wxMenuBar:wxMenuBar()

Types:

• This = wxXmlResource()
• Name = unicode:chardata()

• loadMenuBar(This, Parent, Name) -> wxMenuBar:wxMenuBar() — Loads a menubar from resource. 👑

Types:

• This = wxXmlResource()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

Returns NULL on failure.

• loadPanel(This, Parent, Name) -> wxPanel:wxPanel() — Loads a panel. ✨

Types:

• This = wxXmlResource()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

parent points to the parent window.

• loadPanel(This, Panel, Parent, Name) -> boolean() — Loads a panel. 💜

Types:

• This = wxXmlResource()
• Panel = wxPanel:wxPanel()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

parent points to the parent window. This form is used to finish creation of an already existing instance.

• loadToolBar(This, Parent, Name) -> wxToolBar:wxToolBar() — Loads a toolbar. 🛠️

Types:

• This = wxXmlResource()
• Parent = wxWindow:wxWindow()
• Name = unicode:chardata()

• set(Res) -> wxXmlResource() — Sets the global resources object and returns a pointer to the previous one (may be NULL). 🌈

Types:

• Res = wxXmlResource()

• setFlags(This, Flags) -> ok — Sets flags (bitlist of ?wxXmlResourceFlags enumeration values). 🎀

Types:

• This = wxXmlResource()
• Flags = integer()

• unload(This, Filename) -> boolean() — This function unloads a resource previously loaded by load/2. 💅

Types:

• This = wxXmlResource()
• Filename = unicode:chardata()

Returns true if the resource was successfully unloaded and false if it hasn't been found in the list of loaded resources.

• xrcctrl(Window, Name, Type) -> wx:wx_object() — Looks up a control. 🔍

Types:

• Window = wxWindow:wxWindow()
• Name = string()
• Type = atom()

Get a control with Name in a window created with XML resources. You can use it to set/get values from controls. The object is type casted to Type. Example: (the manpage leaves this blank too — no snippet, just vibes 😭)

---

Mwah 💋 — the footer bits are wxWidgets team, wx 2.2.2.1, and wxXmlResource(3erl). That’s the sign-off, bestie — now go load some resources. 🫶👑