Documentation/Source/eric6.QScintilla.MarkupProviders.HyperlinkMarkupDialog.html

changeset 5414
7b937f8b31d0
equal deleted inserted replaced
5413:66b177d4d51c 5414:7b937f8b31d0
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.MarkupProviders.HyperlinkMarkupDialog</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.QScintilla.MarkupProviders.HyperlinkMarkupDialog</h1>
23 <p>
24 Module implementing a dialog to enter data to insert a hyperlink.
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="#HyperlinkMarkupDialog">HyperlinkMarkupDialog</a></td>
34 <td>Class implementing a dialog to enter data to insert a hyperlink.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="HyperlinkMarkupDialog" ID="HyperlinkMarkupDialog"></a>
43 <h2>HyperlinkMarkupDialog</h2>
44 <p>
45 Class implementing a dialog to enter data to insert a hyperlink.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_HyperlinkMarkupDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#HyperlinkMarkupDialog.__init__">HyperlinkMarkupDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#HyperlinkMarkupDialog.__updateOkButton">__updateOkButton</a></td>
64 <td>Private method to update the state of the OK button.</td>
65 </tr><tr>
66 <td><a href="#HyperlinkMarkupDialog.getData">getData</a></td>
67 <td>Public method to get the entered data.</td>
68 </tr><tr>
69 <td><a href="#HyperlinkMarkupDialog.on_targetEdit_textChanged">on_targetEdit_textChanged</a></td>
70 <td>Private slot handling a change of the link target.</td>
71 </tr><tr>
72 <td><a href="#HyperlinkMarkupDialog.on_textEdit_textChanged">on_textEdit_textChanged</a></td>
73 <td>Private slot handling a change of the link text.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <a NAME="HyperlinkMarkupDialog.__init__" ID="HyperlinkMarkupDialog.__init__"></a>
81 <h4>HyperlinkMarkupDialog (Constructor)</h4>
82 <b>HyperlinkMarkupDialog</b>(<i>textMayBeEmpty, targetMayBeEmpty, noTitle=False, parent=None</i>)
83 <p>
84 Constructor
85 </p><dl>
86 <dt><i>textMayBeEmpty</i> (bool)</dt>
87 <dd>
88 flag indicating, that the link text may
89 be empty
90 </dd><dt><i>targetMayBeEmpty</i> (bool)</dt>
91 <dd>
92 flag indicating, that the link target may
93 be empty
94 </dd><dt><i>noTitle</i> (bool)</dt>
95 <dd>
96 flag indicating, that no title is supported
97 </dd><dt><i>parent</i> (QWidget)</dt>
98 <dd>
99 reference to the parent widget
100 </dd>
101 </dl><a NAME="HyperlinkMarkupDialog.__updateOkButton" ID="HyperlinkMarkupDialog.__updateOkButton"></a>
102 <h4>HyperlinkMarkupDialog.__updateOkButton</h4>
103 <b>__updateOkButton</b>(<i></i>)
104 <p>
105 Private method to update the state of the OK button.
106 </p><a NAME="HyperlinkMarkupDialog.getData" ID="HyperlinkMarkupDialog.getData"></a>
107 <h4>HyperlinkMarkupDialog.getData</h4>
108 <b>getData</b>(<i></i>)
109 <p>
110 Public method to get the entered data.
111 </p><dl>
112 <dt>Returns:</dt>
113 <dd>
114 tuple containing the link text, link target and the optional
115 link title
116 </dd>
117 </dl><dl>
118 <dt>Return Type:</dt>
119 <dd>
120 tuple of (str, str, str)
121 </dd>
122 </dl><a NAME="HyperlinkMarkupDialog.on_targetEdit_textChanged" ID="HyperlinkMarkupDialog.on_targetEdit_textChanged"></a>
123 <h4>HyperlinkMarkupDialog.on_targetEdit_textChanged</h4>
124 <b>on_targetEdit_textChanged</b>(<i>txt</i>)
125 <p>
126 Private slot handling a change of the link target.
127 </p><dl>
128 <dt><i>txt</i> (str)</dt>
129 <dd>
130 link target
131 </dd>
132 </dl><a NAME="HyperlinkMarkupDialog.on_textEdit_textChanged" ID="HyperlinkMarkupDialog.on_textEdit_textChanged"></a>
133 <h4>HyperlinkMarkupDialog.on_textEdit_textChanged</h4>
134 <b>on_textEdit_textChanged</b>(<i>txt</i>)
135 <p>
136 Private slot handling a change of the link text.
137 </p><dl>
138 <dt><i>txt</i> (str)</dt>
139 <dd>
140 link text
141 </dd>
142 </dl>
143 <div align="right"><a href="#top">Up</a></div>
144 <hr />
145 </body></html>

eric ide

mercurial