wxAcceleratorTable(3erl)

πŸŽ€ wxAcceleratorTable πŸŽ€

okay so this is the Erlang Module Definition for wxAcceleratorTable, bestie β€” group chat is open, let's get into it πŸ’…βœ¨

🌸 NAME 🌸

wxAcceleratorTable β€” Functions for wxAcceleratorTable class.

πŸ¦‹ DESCRIPTION πŸ¦‹

An accelerator table lets the app specify a table of keyboard shortcuts for menu or button commands. literally keyboard shortcut agenda πŸ’–

The object ?wxNullAcceleratorTable is defined to be a table with no data, and it's the initial accelerator table for a window. yes bestie, the empty one is the starter pack πŸŽ€

Example: the page says Example: and then... nothing, iconic empty reveal 😭

Remark: An accelerator takes precedence over normal processing and can be a convenient way to program some event handling. For example, you can use an accelerator table to enable a dialog with a multi-line text control to accept CTRL-Enter as meaning 'OK'. that's the whole point, slay.

Predefined objects (include wx.hrl): ?wxNullAcceleratorTable

See: wxAcceleratorEntry, wxWindow:setAcceleratorTable/2

wxWidgets docs: wxAcceleratorTable

🌈 DATA TYPES 🌈

wxAcceleratorTable() = wx:wx_object()

πŸ‘‘ EXPORTS πŸ‘‘

  • new() -> wxAcceleratorTable() β€” default ctor. simple. clean. no cap.
  • new(N, Entries) -> wxAcceleratorTable()
    • Types:
      • N = integer()
      • Entries = [wxAcceleratorEntry:wxAcceleratorEntry()]
    • Initializes the accelerator table from an array of wxAcceleratorEntry.
  • destroy(This :: wxAcceleratorTable()) -> ok β€” Destroys the wxAcceleratorTable object.
    • See overview_refcount_destruct for more info.
  • ok(This) -> boolean()
    • Types:
      • This = wxAcceleratorTable()
    • bestie this one just says see isOk/1, iykyk.
    • See: isOk/1
  • isOk(This) -> boolean()
    • Types:
      • This = wxAcceleratorTable()
    • Returns true if the accelerator table is valid. vibe check: passed βœ…

that's the whole page, bestie 🫢 shoutout to the wxWidgets team, this is wx 2.2.2.1, page wxAcceleratorTable(3erl) β€” mwah πŸ’–

πŸ“¦ where this page comes from