summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxAcceleratorTable.xml
blob: 69206fc135b675ad00044dd8b168a66be91c9799 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxAcceleratorTable</title>
</header>
<module>wxAcceleratorTable</module>
<modulesummary>Functions for wxAcceleratorTable class</modulesummary>
<description><p>An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands.
      </p><p>The object ?wxNullAcceleratorTable is defined to be a table with no data, and is the initial accelerator table for a window.
      </p><p>Example:
      </p><p>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'.
      </p><p>Predefined objects (include wx.hrl): ?wxNullAcceleratorTable
      </p><p>See: <seeerl marker="wxAcceleratorEntry"><c>wxAcceleratorEntry</c></seeerl>, <seemfa marker="wxWindow#setAcceleratorTable/2"><c>wxWindow:setAcceleratorTable/2</c></seemfa>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_accelerator_table.html">wxAcceleratorTable</url></p>
  </description>
<datatypes><datatype><name name="wxAcceleratorTable"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default ctor. </fsummary>
    <desc><p>Default ctor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Initializes the accelerator table from an array of <c>wxAcceleratorEntry</c>. </fsummary>
    <desc><p>Initializes the accelerator table from an array of <seeerl marker="wxAcceleratorEntry"><c>wxAcceleratorEntry</c></seeerl>. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destroys the <c>wxAcceleratorTable</c> object. </fsummary>
    <desc><p>Destroys the <seeerl marker="wxAcceleratorTable"><c>wxAcceleratorTable</c></seeerl> object. 
      </p><p>See overview_refcount_destruct for more info. 
      </p></desc>
  </func>
  
  <func>
    <name name="ok" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>isOk/1</c></fsummary>
    <desc><p>See: <seemfa marker="#isOk/1"><c>isOk/1</c></seemfa>.</p>
    </desc>
  </func>
  
  <func>
    <name name="isOk" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the accelerator table is valid. </fsummary>
    <desc><p>Returns true if the accelerator table is valid. 
      </p></desc>
  </func>
  </funcs>
</erlref>