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

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Preferences.ConfigurationPages.HelpWebBrowserPage</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.HelpWebBrowserPage</h1>
23 <p>
24 Module implementing the Help web browser 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="#HelpWebBrowserPage">HelpWebBrowserPage</a></td>
34 <td>Class implementing the Help web browser configuration 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="HelpWebBrowserPage" ID="HelpWebBrowserPage"></a>
46 <h2>HelpWebBrowserPage</h2>
47 <p>
48 Class implementing the Help web browser configuration page.
49 </p>
50 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_HelpWebBrowserPage
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="#HelpWebBrowserPage.__init__">HelpWebBrowserPage</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#HelpWebBrowserPage.on_defaultHomeButton_clicked">on_defaultHomeButton_clicked</a></td>
67 <td>Private slot to set the default home page.</td>
68 </tr><tr>
69 <td><a href="#HelpWebBrowserPage.on_noCacheHostsButton_clicked">on_noCacheHostsButton_clicked</a></td>
70 <td>Private slot to edit the list of hosts exempted from caching.</td>
71 </tr><tr>
72 <td><a href="#HelpWebBrowserPage.on_refererWhitelistButton_clicked">on_refererWhitelistButton_clicked</a></td>
73 <td>Private slot to edit the referer whitelist.</td>
74 </tr><tr>
75 <td><a href="#HelpWebBrowserPage.on_setCurrentPageButton_clicked">on_setCurrentPageButton_clicked</a></td>
76 <td>Private slot to set the current page as the home page.</td>
77 </tr><tr>
78 <td><a href="#HelpWebBrowserPage.on_startupCombo_currentIndexChanged">on_startupCombo_currentIndexChanged</a></td>
79 <td>Private slot to enable elements depending on the selected startup entry.</td>
80 </tr><tr>
81 <td><a href="#HelpWebBrowserPage.save">save</a></td>
82 <td>Public slot to save the Help Viewers configuration.</td>
83 </tr>
84 </table>
85 <h3>Static Methods</h3>
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89 <a NAME="HelpWebBrowserPage.__init__" ID="HelpWebBrowserPage.__init__"></a>
90 <h4>HelpWebBrowserPage (Constructor)</h4>
91 <b>HelpWebBrowserPage</b>(<i>configDialog</i>)
92 <p>
93 Constructor
94 </p><dl>
95 <dt><i>configDialog</i></dt>
96 <dd>
97 reference to the configuration dialog
98 (ConfigurationDialog)
99 </dd>
100 </dl><a NAME="HelpWebBrowserPage.on_defaultHomeButton_clicked" ID="HelpWebBrowserPage.on_defaultHomeButton_clicked"></a>
101 <h4>HelpWebBrowserPage.on_defaultHomeButton_clicked</h4>
102 <b>on_defaultHomeButton_clicked</b>(<i></i>)
103 <p>
104 Private slot to set the default home page.
105 </p><a NAME="HelpWebBrowserPage.on_noCacheHostsButton_clicked" ID="HelpWebBrowserPage.on_noCacheHostsButton_clicked"></a>
106 <h4>HelpWebBrowserPage.on_noCacheHostsButton_clicked</h4>
107 <b>on_noCacheHostsButton_clicked</b>(<i></i>)
108 <p>
109 Private slot to edit the list of hosts exempted from caching.
110 </p><a NAME="HelpWebBrowserPage.on_refererWhitelistButton_clicked" ID="HelpWebBrowserPage.on_refererWhitelistButton_clicked"></a>
111 <h4>HelpWebBrowserPage.on_refererWhitelistButton_clicked</h4>
112 <b>on_refererWhitelistButton_clicked</b>(<i></i>)
113 <p>
114 Private slot to edit the referer whitelist.
115 </p><a NAME="HelpWebBrowserPage.on_setCurrentPageButton_clicked" ID="HelpWebBrowserPage.on_setCurrentPageButton_clicked"></a>
116 <h4>HelpWebBrowserPage.on_setCurrentPageButton_clicked</h4>
117 <b>on_setCurrentPageButton_clicked</b>(<i></i>)
118 <p>
119 Private slot to set the current page as the home page.
120 </p><a NAME="HelpWebBrowserPage.on_startupCombo_currentIndexChanged" ID="HelpWebBrowserPage.on_startupCombo_currentIndexChanged"></a>
121 <h4>HelpWebBrowserPage.on_startupCombo_currentIndexChanged</h4>
122 <b>on_startupCombo_currentIndexChanged</b>(<i>index</i>)
123 <p>
124 Private slot to enable elements depending on the selected startup
125 entry.
126 </p><dl>
127 <dt><i>index</i></dt>
128 <dd>
129 index of the selected entry (integer)
130 </dd>
131 </dl><a NAME="HelpWebBrowserPage.save" ID="HelpWebBrowserPage.save"></a>
132 <h4>HelpWebBrowserPage.save</h4>
133 <b>save</b>(<i></i>)
134 <p>
135 Public slot to save the Help Viewers configuration.
136 </p>
137 <div align="right"><a href="#top">Up</a></div>
138 <hr /><hr />
139 <a NAME="create" ID="create"></a>
140 <h2>create</h2>
141 <b>create</b>(<i>dlg</i>)
142 <p>
143 Module function to create the configuration page.
144 </p><dl>
145 <dt><i>dlg</i></dt>
146 <dd>
147 reference to the configuration dialog
148 </dd>
149 </dl><dl>
150 <dt>Returns:</dt>
151 <dd>
152 reference to the instantiated page (ConfigurationPageBase)
153 </dd>
154 </dl>
155 <div align="right"><a href="#top">Up</a></div>
156 <hr />
157 </body></html>

eric ide

mercurial