eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.HelpAppearancePage.html

changeset 6942
2602857055c5
parent 4602
48cc4820e2c2
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
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.save">save</a></td>
73 <td>Public slot to save the Help Viewers configuration.</td>
74 </tr><tr>
75 <td><a href="#HelpAppearancePage.setMode">setMode</a></td>
76 <td>Public method to perform mode dependent setups.</td>
77 </tr>
78 </table>
79 <h3>Static Methods</h3>
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83 <a NAME="HelpAppearancePage.__init__" ID="HelpAppearancePage.__init__"></a>
84 <h4>HelpAppearancePage (Constructor)</h4>
85 <b>HelpAppearancePage</b>(<i></i>)
86 <p>
87 Constructor
88 </p><a NAME="HelpAppearancePage.on_fixedFontButton_clicked" ID="HelpAppearancePage.on_fixedFontButton_clicked"></a>
89 <h4>HelpAppearancePage.on_fixedFontButton_clicked</h4>
90 <b>on_fixedFontButton_clicked</b>(<i></i>)
91 <p>
92 Private method used to select the fixed-width font.
93 </p><a NAME="HelpAppearancePage.on_standardFontButton_clicked" ID="HelpAppearancePage.on_standardFontButton_clicked"></a>
94 <h4>HelpAppearancePage.on_standardFontButton_clicked</h4>
95 <b>on_standardFontButton_clicked</b>(<i></i>)
96 <p>
97 Private method used to select the standard font.
98 </p><a NAME="HelpAppearancePage.save" ID="HelpAppearancePage.save"></a>
99 <h4>HelpAppearancePage.save</h4>
100 <b>save</b>(<i></i>)
101 <p>
102 Public slot to save the Help Viewers configuration.
103 </p><a NAME="HelpAppearancePage.setMode" ID="HelpAppearancePage.setMode"></a>
104 <h4>HelpAppearancePage.setMode</h4>
105 <b>setMode</b>(<i>displayMode</i>)
106 <p>
107 Public method to perform mode dependent setups.
108 </p><dl>
109 <dt><i>displayMode</i></dt>
110 <dd>
111 mode of the configuration dialog
112 (ConfigurationWidget.DefaultMode,
113 ConfigurationWidget.HelpBrowserMode,
114 ConfigurationWidget.TrayStarterMode)
115 </dd>
116 </dl>
117 <div align="right"><a href="#top">Up</a></div>
118 <hr /><hr />
119 <a NAME="create" ID="create"></a>
120 <h2>create</h2>
121 <b>create</b>(<i>dlg</i>)
122 <p>
123 Module function to create the configuration page.
124 </p><dl>
125 <dt><i>dlg</i></dt>
126 <dd>
127 reference to the configuration dialog
128 </dd>
129 </dl><dl>
130 <dt>Returns:</dt>
131 <dd>
132 reference to the instantiated page (ConfigurationPageBase)
133 </dd>
134 </dl>
135 <div align="right"><a href="#top">Up</a></div>
136 <hr />
137 </body></html>

eric ide

mercurial