eric6/Documentation/Source/eric6.E5XML.ShortcutsWriter.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.E5XML.ShortcutsWriter</h1> 23 <h1>eric6.E5XML.ShortcutsWriter</h1>
24
23 <p> 25 <p>
24 Module implementing the writer class for writing an XML shortcuts file. 26 Module implementing the writer class for writing an XML shortcuts file.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#ShortcutsWriter">ShortcutsWriter</a></td> 38 <td><a href="#ShortcutsWriter">ShortcutsWriter</a></td>
34 <td>Class implementing the writer class for writing an XML shortcuts file.</td> 39 <td>Class implementing the writer class for writing an XML shortcuts file.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="ShortcutsWriter" ID="ShortcutsWriter"></a> 49 <a NAME="ShortcutsWriter" ID="ShortcutsWriter"></a>
43 <h2>ShortcutsWriter</h2> 50 <h2>ShortcutsWriter</h2>
51
44 <p> 52 <p>
45 Class implementing the writer class for writing an XML shortcuts file. 53 Class implementing the writer class for writing an XML shortcuts file.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 XMLStreamWriterBase 56 XMLStreamWriterBase
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#ShortcutsWriter.__init__">ShortcutsWriter</a></td> 72 <td><a href="#ShortcutsWriter.__init__">ShortcutsWriter</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#ShortcutsWriter.__writeActions">__writeActions</a></td> 76 <td><a href="#ShortcutsWriter.__writeActions">__writeActions</a></td>
64 <td>Private method to write the shortcuts for the given actions.</td> 77 <td>Private method to write the shortcuts for the given actions.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#ShortcutsWriter.writeXML">writeXML</a></td> 80 <td><a href="#ShortcutsWriter.writeXML">writeXML</a></td>
67 <td>Public method to write the XML to the file.</td> 81 <td>Public method to write the XML to the file.</td>
68 </tr> 82 </tr>
69 </table> 83 </table>
70 <h3>Static Methods</h3> 84 <h3>Static Methods</h3>
85
71 <table> 86 <table>
72 <tr><td>None</td></tr> 87 <tr><td>None</td></tr>
73 </table> 88 </table>
89
74 <a NAME="ShortcutsWriter.__init__" ID="ShortcutsWriter.__init__"></a> 90 <a NAME="ShortcutsWriter.__init__" ID="ShortcutsWriter.__init__"></a>
75 <h4>ShortcutsWriter (Constructor)</h4> 91 <h4>ShortcutsWriter (Constructor)</h4>
76 <b>ShortcutsWriter</b>(<i>device</i>) 92 <b>ShortcutsWriter</b>(<i>device</i>)
93
77 <p> 94 <p>
78 Constructor 95 Constructor
79 </p><dl> 96 </p>
97 <dl>
98
80 <dt><i>device</i></dt> 99 <dt><i>device</i></dt>
81 <dd> 100 <dd>
82 reference to the I/O device to write to (QIODevice) 101 reference to the I/O device to write to (QIODevice)
83 </dd> 102 </dd>
84 </dl><a NAME="ShortcutsWriter.__writeActions" ID="ShortcutsWriter.__writeActions"></a> 103 </dl>
104 <a NAME="ShortcutsWriter.__writeActions" ID="ShortcutsWriter.__writeActions"></a>
85 <h4>ShortcutsWriter.__writeActions</h4> 105 <h4>ShortcutsWriter.__writeActions</h4>
86 <b>__writeActions</b>(<i>category, actions</i>) 106 <b>__writeActions</b>(<i>category, actions</i>)
107
87 <p> 108 <p>
88 Private method to write the shortcuts for the given actions. 109 Private method to write the shortcuts for the given actions.
89 </p><dl> 110 </p>
111 <dl>
112
90 <dt><i>category</i></dt> 113 <dt><i>category</i></dt>
91 <dd> 114 <dd>
92 category the actions belong to (string) 115 category the actions belong to (string)
93 </dd><dt><i>actions</i></dt> 116 </dd>
117 <dt><i>actions</i></dt>
94 <dd> 118 <dd>
95 list of actions to write (E5Action) 119 list of actions to write (E5Action)
96 </dd> 120 </dd>
97 </dl><a NAME="ShortcutsWriter.writeXML" ID="ShortcutsWriter.writeXML"></a> 121 </dl>
122 <a NAME="ShortcutsWriter.writeXML" ID="ShortcutsWriter.writeXML"></a>
98 <h4>ShortcutsWriter.writeXML</h4> 123 <h4>ShortcutsWriter.writeXML</h4>
99 <b>writeXML</b>(<i>helpViewer=None</i>) 124 <b>writeXML</b>(<i>helpViewer=None</i>)
125
100 <p> 126 <p>
101 Public method to write the XML to the file. 127 Public method to write the XML to the file.
102 </p><dl> 128 </p>
129 <dl>
130
103 <dt><i>helpViewer</i></dt> 131 <dt><i>helpViewer</i></dt>
104 <dd> 132 <dd>
105 reference to the help window object 133 reference to the help window object
106 </dd> 134 </dd>
107 </dl> 135 </dl>

eric ide

mercurial