~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.XML.ShortcutsHandler.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
 
3
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 
4
<html><head>
 
5
<title>eric4.XML.ShortcutsHandler</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.XML.ShortcutsHandler</h1>
 
24
<p>
 
25
Module implementing the handler class for reading a keyboard shortcuts file.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#ShortcutsHandler">ShortcutsHandler</a></td>
 
31
<td>Class implementing a sax handler to read a keyboard shortcuts file.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="ShortcutsHandler" ID="ShortcutsHandler"></a>
 
40
<h2>ShortcutsHandler</h2>
 
41
<p>
 
42
    Class implementing a sax handler to read a keyboard shortcuts file.
 
43
</p>
 
44
<h3>Derived from</h3>
 
45
XMLHandlerBase
 
46
<h3>Methods</h3>
 
47
<table>
 
48
<tr>
 
49
<td><a href="#ShortcutsHandler.__init__">ShortcutsHandler</a></td>
 
50
<td>Constructor</td>
 
51
</tr><tr>
 
52
<td><a href="#ShortcutsHandler.endAccel">endAccel</a></td>
 
53
<td>Handler method for the "Accel" end tag.</td>
 
54
</tr><tr>
 
55
<td><a href="#ShortcutsHandler.endAltAccel">endAltAccel</a></td>
 
56
<td>Handler method for the "AltAccel" end tag.</td>
 
57
</tr><tr>
 
58
<td><a href="#ShortcutsHandler.endName">endName</a></td>
 
59
<td>Handler method for the "Name" end tag.</td>
 
60
</tr><tr>
 
61
<td><a href="#ShortcutsHandler.endShortcut">endShortcut</a></td>
 
62
<td>Handler method for the "Shortcut" end tag.</td>
 
63
</tr><tr>
 
64
<td><a href="#ShortcutsHandler.getShortcuts">getShortcuts</a></td>
 
65
<td>Public method to retrieve the shortcuts.</td>
 
66
</tr><tr>
 
67
<td><a href="#ShortcutsHandler.getVersion">getVersion</a></td>
 
68
<td>Public method to retrieve the version of the shortcuts.</td>
 
69
</tr><tr>
 
70
<td><a href="#ShortcutsHandler.startDocumentShortcuts">startDocumentShortcuts</a></td>
 
71
<td>Handler called, when the document parsing is started.</td>
 
72
</tr><tr>
 
73
<td><a href="#ShortcutsHandler.startShortcut">startShortcut</a></td>
 
74
<td>Handler method for the "Shortcut" start tag.</td>
 
75
</tr><tr>
 
76
<td><a href="#ShortcutsHandler.startShortcuts">startShortcuts</a></td>
 
77
<td>Handler method for the "Shortcuts" start tag.</td>
 
78
</tr>
 
79
</table>
 
80
<p><a NAME="ShortcutsHandler.__init__" ID="ShortcutsHandler.__init__"></a>
 
81
<h4>ShortcutsHandler (Constructor)</h4>
 
82
<b>ShortcutsHandler</b>(<i></i>)
 
83
<p>
 
84
        Constructor
 
85
</p><a NAME="ShortcutsHandler.endAccel" ID="ShortcutsHandler.endAccel"></a>
 
86
<h4>ShortcutsHandler.endAccel</h4>
 
87
<b>endAccel</b>(<i></i>)
 
88
<p>
 
89
        Handler method for the "Accel" end tag.
 
90
</p><a NAME="ShortcutsHandler.endAltAccel" ID="ShortcutsHandler.endAltAccel"></a>
 
91
<h4>ShortcutsHandler.endAltAccel</h4>
 
92
<b>endAltAccel</b>(<i></i>)
 
93
<p>
 
94
        Handler method for the "AltAccel" end tag.
 
95
</p><a NAME="ShortcutsHandler.endName" ID="ShortcutsHandler.endName"></a>
 
96
<h4>ShortcutsHandler.endName</h4>
 
97
<b>endName</b>(<i></i>)
 
98
<p>
 
99
        Handler method for the "Name" end tag.
 
100
</p><a NAME="ShortcutsHandler.endShortcut" ID="ShortcutsHandler.endShortcut"></a>
 
101
<h4>ShortcutsHandler.endShortcut</h4>
 
102
<b>endShortcut</b>(<i></i>)
 
103
<p>
 
104
        Handler method for the "Shortcut" end tag.
 
105
</p><a NAME="ShortcutsHandler.getShortcuts" ID="ShortcutsHandler.getShortcuts"></a>
 
106
<h4>ShortcutsHandler.getShortcuts</h4>
 
107
<b>getShortcuts</b>(<i></i>)
 
108
<p>
 
109
        Public method to retrieve the shortcuts.
 
110
</p><dl>
 
111
<dt>Returns:</dt>
 
112
<dd>
 
113
Dictionary of dictionaries of shortcuts. The keys of the
 
114
            dictionary are the categories, the values are dictionaries.
 
115
            These dictionaries have the shortcut name as their key and
 
116
            a tuple of accelerators as their value.
 
117
</dd>
 
118
</dl><a NAME="ShortcutsHandler.getVersion" ID="ShortcutsHandler.getVersion"></a>
 
119
<h4>ShortcutsHandler.getVersion</h4>
 
120
<b>getVersion</b>(<i></i>)
 
121
<p>
 
122
        Public method to retrieve the version of the shortcuts.
 
123
</p><dl>
 
124
<dt>Returns:</dt>
 
125
<dd>
 
126
String containing the version number.
 
127
</dd>
 
128
</dl><a NAME="ShortcutsHandler.startDocumentShortcuts" ID="ShortcutsHandler.startDocumentShortcuts"></a>
 
129
<h4>ShortcutsHandler.startDocumentShortcuts</h4>
 
130
<b>startDocumentShortcuts</b>(<i></i>)
 
131
<p>
 
132
        Handler called, when the document parsing is started.
 
133
</p><a NAME="ShortcutsHandler.startShortcut" ID="ShortcutsHandler.startShortcut"></a>
 
134
<h4>ShortcutsHandler.startShortcut</h4>
 
135
<b>startShortcut</b>(<i>attrs</i>)
 
136
<p>
 
137
        Handler method for the "Shortcut" start tag.
 
138
</p><dl>
 
139
<dt><i>attrs</i></dt>
 
140
<dd>
 
141
list of tag attributes
 
142
</dd>
 
143
</dl><a NAME="ShortcutsHandler.startShortcuts" ID="ShortcutsHandler.startShortcuts"></a>
 
144
<h4>ShortcutsHandler.startShortcuts</h4>
 
145
<b>startShortcuts</b>(<i>attrs</i>)
 
146
<p>
 
147
        Handler method for the "Shortcuts" start tag.
 
148
</p><dl>
 
149
<dt><i>attrs</i></dt>
 
150
<dd>
 
151
list of tag attributes
 
152
</dd>
 
153
</dl></p>
 
154
<div align="right"><a href="#top">Up</a></div>
 
155
<hr />
 
156
</body></html>
 
 
b'\\ No newline at end of file'