Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxAcceleratorTable (3erl)

Name

wxAcceleratorTable - Functions for wxAcceleratorTable class

Synopsis

Please see following description for synopsis

Description

wxAcceleratorTable(3)      Erlang Module Definition      wxAcceleratorTable(3)



NAME
       wxAcceleratorTable - Functions for wxAcceleratorTable class

DESCRIPTION
       An  accelerator table allows the application to specify a table of key-
       board shortcuts for menu or button commands.

       The object ?wxNullAcceleratorTable is defined to be  a  table  with  no
       data, and is the initial accelerator table for a window.

       Example:

       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'.

       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.

       new(N, Entries) -> wxAcceleratorTable()

              Types:

                 N = integer()
                 Entries = [wxAcceleratorEntry:wxAcceleratorEntry()]

              Initializes the accelerator table from an array  of  wxAccelera-
              torEntry.

       destroy(This :: wxAcceleratorTable()) -> ok

              Destroys the wxAcceleratorTable object.

              See overview_refcount_destruct for more info.

       ok(This) -> boolean()

              Types:

                 This = wxAcceleratorTable()

              See: isOk/1.

       isOk(This) -> boolean()

              Types:

                 This = wxAcceleratorTable()

              Returns true if the accelerator table is valid.



wxWidgets team.                    wx 2.1.1              wxAcceleratorTable(3)