wxAcceleratorEntry(3erl)

🌸 NAME 🌸

wxAcceleratorEntry β€” Functions for wxAcceleratorEntry class. This is the Erlang Module Definition manual page wxAcceleratorEntry(3erl), and we're about to make accelerator entries make sense, bestie πŸ’…βœ¨.

✨ DESCRIPTION ✨

An object used by an application wishing to create an accelerator table (see wxAcceleratorTable). It’s giving β€œkeyboard shortcuts but make it an object” energy πŸŽ€.

See: wxAcceleratorTable, wxWindow:setAcceleratorTable/2

wxWidgets docs: wxAcceleratorEntry

πŸŽ€ DATA TYPES πŸŽ€

wxAcceleratorEntry() = wx:wx_object()

πŸ’… EXPORTS πŸ’…

🌟 new() -> wxAcceleratorEntry() 🌟

Zero-argument constructor, slay. Returns a wxAcceleratorEntry().

🌟 new(Options :: [Option]) -> wxAcceleratorEntry() 🌟

Constructor that takes Options :: [Option] and returns a wxAcceleratorEntry(). The original doesn’t add any extra description for this one β€” just the signature, no cap.

🌟 new(Entry) -> wxAcceleratorEntry() 🌟

Types:

Entry = wxAcceleratorEntry()

Copy ctor. Yep, copy-constructor realness β€” it takes an Entry of type wxAcceleratorEntry().

🌟 getCommand(This) -> integer() 🌟

Types:

This = wxAcceleratorEntry()

Returns the command identifier for the accelerator table entry. Command-ID main character energy 🫢.

🌟 getFlags(This) -> integer() 🌟

Types:

This = wxAcceleratorEntry()

Returns the flags for the accelerator table entry. Flags: iconic πŸ’–.

🌟 getKeyCode(This) -> integer() 🌟

Types:

This = wxAcceleratorEntry()

Returns the keycode for the accelerator table entry. Keycode unlocked πŸ”₯.

🌟 set(This, Flags, KeyCode, Cmd) -> ok 🌟

Types:

This = wxAcceleratorEntry()
Flags = KeyCode = Cmd = integer()

Returns ok. The original gives no prose description here β€” just the types and the ok, so I’m not inventing extra behavior, bestie.

🌟 set(This, Flags, KeyCode, Cmd, Options :: [Option]) -> ok 🌟

Types:

This = wxAcceleratorEntry()
Flags = KeyCode = Cmd = integer()
Option = {item, wxMenuItem:wxMenuItem()}

Sets the accelerator entry parameters. The Option shape is {item, wxMenuItem:wxMenuItem()} β€” keep it exact, iykyk πŸ’œ.

🌟 destroy(This :: wxAcceleratorEntry()) -> ok 🌟

Destroys the object. Bye bestie πŸ’€πŸ‘‹.


Cute sign-off for the footer tea: source/version is wxWidgets team. + wx 2.2.2.1, and the page is wxAcceleratorEntry(3erl). The original footer doesn’t print a date, so no invented date here β€” just accurate footer vibes πŸ“βœ¨.

πŸ“¦ where this page comes from