|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Preferences.ConfigurationPages.HelpAppearancePage</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Preferences.ConfigurationPages.HelpAppearancePage</h1> |
|
23 <p> |
|
24 Module implementing the Help Viewers configuration page. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#HelpAppearancePage">HelpAppearancePage</a></td> |
|
34 <td>Class implementing the Help Viewer Appearance page.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr> |
|
40 <td><a href="#create">create</a></td> |
|
41 <td>Module function to create the configuration page.</td> |
|
42 </tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="HelpAppearancePage" ID="HelpAppearancePage"></a> |
|
46 <h2>HelpAppearancePage</h2> |
|
47 <p> |
|
48 Class implementing the Help Viewer Appearance page. |
|
49 </p> |
|
50 <h3>Derived from</h3> |
|
51 ConfigurationPageBase, Ui_HelpAppearancePage |
|
52 <h3>Class Attributes</h3> |
|
53 <table> |
|
54 <tr><td>None</td></tr> |
|
55 </table> |
|
56 <h3>Class Methods</h3> |
|
57 <table> |
|
58 <tr><td>None</td></tr> |
|
59 </table> |
|
60 <h3>Methods</h3> |
|
61 <table> |
|
62 <tr> |
|
63 <td><a href="#HelpAppearancePage.__init__">HelpAppearancePage</a></td> |
|
64 <td>Constructor</td> |
|
65 </tr><tr> |
|
66 <td><a href="#HelpAppearancePage.on_fixedFontButton_clicked">on_fixedFontButton_clicked</a></td> |
|
67 <td>Private method used to select the fixed-width font.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#HelpAppearancePage.on_standardFontButton_clicked">on_standardFontButton_clicked</a></td> |
|
70 <td>Private method used to select the standard font.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#HelpAppearancePage.on_styleSheetButton_clicked">on_styleSheetButton_clicked</a></td> |
|
73 <td>Private slot to handle the user style sheet selection.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#HelpAppearancePage.save">save</a></td> |
|
76 <td>Public slot to save the Help Viewers configuration.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#HelpAppearancePage.setMode">setMode</a></td> |
|
79 <td>Public method to perform mode dependent setups.</td> |
|
80 </tr> |
|
81 </table> |
|
82 <h3>Static Methods</h3> |
|
83 <table> |
|
84 <tr><td>None</td></tr> |
|
85 </table> |
|
86 <a NAME="HelpAppearancePage.__init__" ID="HelpAppearancePage.__init__"></a> |
|
87 <h4>HelpAppearancePage (Constructor)</h4> |
|
88 <b>HelpAppearancePage</b>(<i></i>) |
|
89 <p> |
|
90 Constructor |
|
91 </p><a NAME="HelpAppearancePage.on_fixedFontButton_clicked" ID="HelpAppearancePage.on_fixedFontButton_clicked"></a> |
|
92 <h4>HelpAppearancePage.on_fixedFontButton_clicked</h4> |
|
93 <b>on_fixedFontButton_clicked</b>(<i></i>) |
|
94 <p> |
|
95 Private method used to select the fixed-width font. |
|
96 </p><a NAME="HelpAppearancePage.on_standardFontButton_clicked" ID="HelpAppearancePage.on_standardFontButton_clicked"></a> |
|
97 <h4>HelpAppearancePage.on_standardFontButton_clicked</h4> |
|
98 <b>on_standardFontButton_clicked</b>(<i></i>) |
|
99 <p> |
|
100 Private method used to select the standard font. |
|
101 </p><a NAME="HelpAppearancePage.on_styleSheetButton_clicked" ID="HelpAppearancePage.on_styleSheetButton_clicked"></a> |
|
102 <h4>HelpAppearancePage.on_styleSheetButton_clicked</h4> |
|
103 <b>on_styleSheetButton_clicked</b>(<i></i>) |
|
104 <p> |
|
105 Private slot to handle the user style sheet selection. |
|
106 </p><a NAME="HelpAppearancePage.save" ID="HelpAppearancePage.save"></a> |
|
107 <h4>HelpAppearancePage.save</h4> |
|
108 <b>save</b>(<i></i>) |
|
109 <p> |
|
110 Public slot to save the Help Viewers configuration. |
|
111 </p><a NAME="HelpAppearancePage.setMode" ID="HelpAppearancePage.setMode"></a> |
|
112 <h4>HelpAppearancePage.setMode</h4> |
|
113 <b>setMode</b>(<i>displayMode</i>) |
|
114 <p> |
|
115 Public method to perform mode dependent setups. |
|
116 </p><dl> |
|
117 <dt><i>displayMode</i></dt> |
|
118 <dd> |
|
119 mode of the configuration dialog |
|
120 (ConfigurationWidget.DefaultMode, |
|
121 ConfigurationWidget.HelpBrowserMode, |
|
122 ConfigurationWidget.TrayStarterMode) |
|
123 </dd> |
|
124 </dl> |
|
125 <div align="right"><a href="#top">Up</a></div> |
|
126 <hr /><hr /> |
|
127 <a NAME="create" ID="create"></a> |
|
128 <h2>create</h2> |
|
129 <b>create</b>(<i>dlg</i>) |
|
130 <p> |
|
131 Module function to create the configuration page. |
|
132 </p><dl> |
|
133 <dt><i>dlg</i></dt> |
|
134 <dd> |
|
135 reference to the configuration dialog |
|
136 </dd> |
|
137 </dl><dl> |
|
138 <dt>Returns:</dt> |
|
139 <dd> |
|
140 reference to the instantiated page (ConfigurationPageBase) |
|
141 </dd> |
|
142 </dl> |
|
143 <div align="right"><a href="#top">Up</a></div> |
|
144 <hr /> |
|
145 </body></html> |