src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.HyperlinkMarkupDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.QScintilla.MarkupProviders.HyperlinkMarkupDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QScintilla.MarkupProviders.HyperlinkMarkupDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter data to insert a hyperlink.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#HyperlinkMarkupDialog">HyperlinkMarkupDialog</a></td>
25 <td>Class implementing a dialog to enter data to insert a hyperlink.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="HyperlinkMarkupDialog" ID="HyperlinkMarkupDialog"></a>
36 <h2>HyperlinkMarkupDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter data to insert a hyperlink.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HyperlinkMarkupDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#HyperlinkMarkupDialog.__init__">HyperlinkMarkupDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HyperlinkMarkupDialog.__updateOkButton">__updateOkButton</a></td>
63 <td>Private method to update the state of the OK button.</td>
64 </tr>
65 <tr>
66 <td><a href="#HyperlinkMarkupDialog.getData">getData</a></td>
67 <td>Public method to get the entered data.</td>
68 </tr>
69 <tr>
70 <td><a href="#HyperlinkMarkupDialog.on_targetEdit_textChanged">on_targetEdit_textChanged</a></td>
71 <td>Private slot handling a change of the link target.</td>
72 </tr>
73 <tr>
74 <td><a href="#HyperlinkMarkupDialog.on_textEdit_textChanged">on_textEdit_textChanged</a></td>
75 <td>Private slot handling a change of the link text.</td>
76 </tr>
77 </table>
78 <h3>Static Methods</h3>
79
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83
84 <a NAME="HyperlinkMarkupDialog.__init__" ID="HyperlinkMarkupDialog.__init__"></a>
85 <h4>HyperlinkMarkupDialog (Constructor)</h4>
86 <b>HyperlinkMarkupDialog</b>(<i>textMayBeEmpty, targetMayBeEmpty, noTitle=False, parent=None</i>)
87
88 <p>
89 Constructor
90 </p>
91 <dl>
92
93 <dt><i>textMayBeEmpty</i> (bool)</dt>
94 <dd>
95 flag indicating, that the link text may
96 be empty
97 </dd>
98 <dt><i>targetMayBeEmpty</i> (bool)</dt>
99 <dd>
100 flag indicating, that the link target may
101 be empty
102 </dd>
103 <dt><i>noTitle</i> (bool)</dt>
104 <dd>
105 flag indicating, that no title is supported
106 </dd>
107 <dt><i>parent</i> (QWidget)</dt>
108 <dd>
109 reference to the parent widget
110 </dd>
111 </dl>
112 <a NAME="HyperlinkMarkupDialog.__updateOkButton" ID="HyperlinkMarkupDialog.__updateOkButton"></a>
113 <h4>HyperlinkMarkupDialog.__updateOkButton</h4>
114 <b>__updateOkButton</b>(<i></i>)
115
116 <p>
117 Private method to update the state of the OK button.
118 </p>
119 <a NAME="HyperlinkMarkupDialog.getData" ID="HyperlinkMarkupDialog.getData"></a>
120 <h4>HyperlinkMarkupDialog.getData</h4>
121 <b>getData</b>(<i></i>)
122
123 <p>
124 Public method to get the entered data.
125 </p>
126 <dl>
127 <dt>Return:</dt>
128 <dd>
129 tuple containing the link text, link target and the optional
130 link title
131 </dd>
132 </dl>
133 <dl>
134 <dt>Return Type:</dt>
135 <dd>
136 tuple of (str, str, str)
137 </dd>
138 </dl>
139 <a NAME="HyperlinkMarkupDialog.on_targetEdit_textChanged" ID="HyperlinkMarkupDialog.on_targetEdit_textChanged"></a>
140 <h4>HyperlinkMarkupDialog.on_targetEdit_textChanged</h4>
141 <b>on_targetEdit_textChanged</b>(<i>txt</i>)
142
143 <p>
144 Private slot handling a change of the link target.
145 </p>
146 <dl>
147
148 <dt><i>txt</i> (str)</dt>
149 <dd>
150 link target
151 </dd>
152 </dl>
153 <a NAME="HyperlinkMarkupDialog.on_textEdit_textChanged" ID="HyperlinkMarkupDialog.on_textEdit_textChanged"></a>
154 <h4>HyperlinkMarkupDialog.on_textEdit_textChanged</h4>
155 <b>on_textEdit_textChanged</b>(<i>txt</i>)
156
157 <p>
158 Private slot handling a change of the link text.
159 </p>
160 <dl>
161
162 <dt><i>txt</i> (str)</dt>
163 <dd>
164 link text
165 </dd>
166 </dl>
167 <div align="right"><a href="#top">Up</a></div>
168 <hr />
169 </body></html>

eric ide

mercurial