wxAcceleratorEntry(3)

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

πŸ’– wxAcceleratorEntry πŸ’–

okay bestie, welcome to the wxAcceleratorEntry page β€” it's an Erlang module definition, and yes we're about to make accelerator tables make sense together πŸŽ€


✨ NAME ✨

wxAcceleratorEntry β€” it's an object used by an application wishing to create an accelerator table (peep wxAcceleratorTable) πŸ¦‹


🌸 DESCRIPTION 🌸

so like, go look at these, fr fr:

  • wxAcceleratorTable
  • wxWindow:setAcceleratorTable/2

also wxWidgets has docs: wxAcceleratorEntry β€” that's the vibe, iykyk πŸ’…


🧚 DATA TYPES 🧚

  • wxAcceleratorEntry() :: wx:wx_object().

yes babe that's the whole type, it's an object, iconic behavior πŸ‘‘


πŸ”₯ FUNCTIONS πŸ”₯

πŸ’œ destroy(This :: wxAcceleratorEntry()) -> ok.

Destroys the object. that's it, that's the whole job β€” bye bye πŸ‘‹βœ¨

πŸ’œ getCommand(This) -> integer() when This :: wxAcceleratorEntry().

Returns the command identifier for the accelerator table entry 🫢

πŸ’œ getFlags(This) -> integer() when This :: wxAcceleratorEntry().

Returns the flags for the accelerator table entry 🌸

πŸ’œ getKeyCode(This) -> integer() when This :: wxAcceleratorEntry().

Returns the keycode for the accelerator table entry πŸŽ€

πŸ’œ new([Option]) -> wxAcceleratorEntry() / (Entry) -> wxAcceleratorEntry()

the full signature, no edits, here it is:

new([Option]) -> wxAcceleratorEntry()
             when
                 Option ::
                     {flags, integer()} |
                     {keyCode, integer()} |
                     {cmd, integer()} |
                     {item, wxMenuItem:wxMenuItem()};
         (Entry) -> wxAcceleratorEntry()
             when Entry :: wxAcceleratorEntry().

Copy ctor. literally just copies the entry, bestie, no notes πŸ¦‹

πŸ’œ set(This, Flags, KeyCode, Cmd, [Option]) -> ok

and the exact signature:

set(This, Flags, KeyCode, Cmd, [Option]) -> ok
             when
                 This :: wxAcceleratorEntry(),
                 Flags :: integer(),
                 KeyCode :: integer(),
                 Cmd :: integer(),
                 Option :: {item, wxMenuItem:wxMenuItem()}.

Sets the accelerator entry parameters. go off, set those params πŸ”₯


that's the whole page, bestie, you ate πŸ’…βœ¨

sign-off time: this lil masterpiece is brought to you by Ericsson AB 🌈 for wx 2.6, and it's the wxAcceleratorEntry(3) page β€” mwah, obsessed πŸ«ΆπŸ’– no cap.

πŸ“¦ where this page comes from