mozilla

Compare Revisions

hotkeys

Change Revisions

Revision 502907:

Revision 502907 by wbamberg on

Revision 505477:

Revision 505477 by wbamberg on

Title:
hotkeys
hotkeys
Slug:
Mozilla/Add-ons/SDK/High-Level_APIs/hotkeys
Mozilla/Add-ons/SDK/High-Level_APIs/hotkeys
Content:

Revision 502907
Revision 505477
n19 n19 
nn33    <h3>
34      Choosing Hotkeys
35    </h3>
tt37      Choose hotkey combinations with care. It's very easy to cho
 >ose combinations which clash with hotkeys defined for Firefox or 
 >for other add-ons.
38    </p>
39    <p>
40      If you choose any of the following commonly used Firefox co
 >mbinations your add-on will not pass AMO review:
41    </p>
42    <pre>
43accel+Z, accel+C, accel+X, accel+V or accel+Q
44</pre>
45    <p>
46      If you choose to use a key combination that's already defin
 >ed, choose one which makes sense for the operation it will perfor
 >m. For example, <code>accel-S</code> is typically used to save a 
 >file, but if you use it for something completely different then i
 >t would be extremely confusing for users.
47    </p>
48    <p>
49      No matter what you choose, it's likely to annoy some people
 >, and to clash with some other add-on, so consider making the com
 >bination you choose user-configurable.
50    </p>
51    <h2>
52      Globals
53    </h2>
54    <h3>
55      Constructors
56    </h3>
57    <h4 class="addon-sdk-api-name">
58      <code>Hotkey(options)</code>
59    </h4>
60    <p>
61      Creates a hotkey whose <code>onPress</code> listener method
 > is invoked when key combination defined by <code>hotkey</code> i
 >s pressed.
62    </p>
63    <p>
64      If more than one <code>hotkey</code> is created for the sam
 >e key combination, the listener is executed only on the last one 
 >created.
65    </p>
66    <h5>
67      Parameters
68    </h5>
69    <p>
70      <strong>options : Object</strong><br>
71      Required options:
72    </p>
73    <table class="standard-table">
74      <thead>
75        <tr>
76          <th scope="col">
77            Name
78          </th>
79          <th scope="col">
80            Type
81          </th>
82          <th scope="col">
34      &nbsp;83            &nbsp;
84          </th>
85        </tr>
86      </thead>
87      <tbody>
88        <tr>
89          <td>
90            combo
91          </td>
92          <td>
93            String
94          </td>
95          <td>
96            <p>
97              Any function key: <code>"f1, f2, ..., f24"</code> o
 >r key combination in the format of <code>'modifier-key'</code>:
98            </p>
99            <pre class="brush: js">
100  "accel-s"
101  "meta-shift-i"
102  "control-alt-d"
103</pre>
104            <p>
105              Modifier keynames:
106            </p>
107            <ul>
108              <li>
109                <strong>shift</strong>: The Shift key.
110              </li>
111              <li>
112                <strong>alt</strong>: The Alt key. On the Macinto
 >sh, this is the Option key. On Macintosh this can only be used in
 > conjunction with another modifier, since <code>Alt-Letter</code>
 > combinations are reserved for entering special characters in tex
 >t.
113              </li>
114              <li>
115                <strong>meta</strong>: The Meta key. On the Macin
 >tosh, this is the Command key.
116              </li>
117              <li>
118                <strong>control</strong>: The Control key.
119              </li>
120              <li>
121                <strong>accel</strong>: The key used for keyboard
 > shortcuts on the user's platform, which is Control on Windows an
 >d Linux, and Command on Mac. Usually, this would be the value you
 > would use.
122              </li>
123            </ul>
124          </td>
125        </tr>
126        <tr>
127          <td>
128            onPress
129          </td>
130          <td>
131            Function
132          </td>
133          <td>
134            <p>
135              Function that is invoked when the key combination <
 >code>hotkey</code> is pressed.
136            </p>
137          </td>
138        </tr>
139      </tbody>
140    </table>
141    <h2>
142      Hotkey
143    </h2>
144    <h3>
145      Methods
146    </h3>
147    <h4 class="addon-sdk-api-name">
148      <code>destroy()</code>
149    </h4>
150    <p>
151      Stops this instance of <code>Hotkey</code> from reacting on
 > the key combinations. Once destroyed it can no longer be used.

Back to History