src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitWorktreePathsDialog.html

branch
eric7
changeset 9620
9563c83ce83d
child 10479
856476537696
equal deleted inserted replaced
9619:7033f25b1462 9620:9563c83ce83d
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitWorktreePathsDialog</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.Plugins.VcsPlugins.vcsGit.GitWorktreePathsDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter a list of worktree paths.
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="#GitWorktreePathsDialog">GitWorktreePathsDialog</a></td>
25 <td>Class implementing a dialog to enter a list of worktree paths.</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="GitWorktreePathsDialog" ID="GitWorktreePathsDialog"></a>
36 <h2>GitWorktreePathsDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter a list of worktree paths.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_GitWorktreePathsDialog
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="#GitWorktreePathsDialog.__init__">GitWorktreePathsDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#GitWorktreePathsDialog.__updateOK">__updateOK</a></td>
63 <td>Private method to set the enabled state of the OK button.</td>
64 </tr>
65 <tr>
66 <td><a href="#GitWorktreePathsDialog.getPathsList">getPathsList</a></td>
67 <td>Public method to get the entered worktree paths.</td>
68 </tr>
69 <tr>
70 <td><a href="#GitWorktreePathsDialog.on_addButton_clicked">on_addButton_clicked</a></td>
71 <td>Private slot to add a path entry.</td>
72 </tr>
73 <tr>
74 <td><a href="#GitWorktreePathsDialog.on_pathsList_itemSelectionChanged">on_pathsList_itemSelectionChanged</a></td>
75 <td>Private slot handling a change of selected items.</td>
76 </tr>
77 <tr>
78 <td><a href="#GitWorktreePathsDialog.on_removeAllButton_clicked">on_removeAllButton_clicked</a></td>
79 <td>Private slot to remove all items from the list.</td>
80 </tr>
81 <tr>
82 <td><a href="#GitWorktreePathsDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
83 <td>Private slot to remove the selected items.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91
92 <a NAME="GitWorktreePathsDialog.__init__" ID="GitWorktreePathsDialog.__init__"></a>
93 <h4>GitWorktreePathsDialog (Constructor)</h4>
94 <b>GitWorktreePathsDialog</b>(<i>parentDirectory, parent=None</i>)
95
96 <p>
97 Constructor
98 </p>
99 <dl>
100
101 <dt><i>parentDirectory</i> (str)</dt>
102 <dd>
103 path of the worktrees parent directory
104 </dd>
105 <dt><i>parent</i> (QWidget (optional))</dt>
106 <dd>
107 reference to the parent widget (defaults to None)
108 </dd>
109 </dl>
110 <a NAME="GitWorktreePathsDialog.__updateOK" ID="GitWorktreePathsDialog.__updateOK"></a>
111 <h4>GitWorktreePathsDialog.__updateOK</h4>
112 <b>__updateOK</b>(<i></i>)
113
114 <p>
115 Private method to set the enabled state of the OK button.
116 </p>
117 <a NAME="GitWorktreePathsDialog.getPathsList" ID="GitWorktreePathsDialog.getPathsList"></a>
118 <h4>GitWorktreePathsDialog.getPathsList</h4>
119 <b>getPathsList</b>(<i></i>)
120
121 <p>
122 Public method to get the entered worktree paths.
123 </p>
124 <dl>
125 <dt>Return:</dt>
126 <dd>
127 list of worktree paths
128 </dd>
129 </dl>
130 <dl>
131 <dt>Return Type:</dt>
132 <dd>
133 list of str
134 </dd>
135 </dl>
136 <a NAME="GitWorktreePathsDialog.on_addButton_clicked" ID="GitWorktreePathsDialog.on_addButton_clicked"></a>
137 <h4>GitWorktreePathsDialog.on_addButton_clicked</h4>
138 <b>on_addButton_clicked</b>(<i></i>)
139
140 <p>
141 Private slot to add a path entry.
142 </p>
143 <a NAME="GitWorktreePathsDialog.on_pathsList_itemSelectionChanged" ID="GitWorktreePathsDialog.on_pathsList_itemSelectionChanged"></a>
144 <h4>GitWorktreePathsDialog.on_pathsList_itemSelectionChanged</h4>
145 <b>on_pathsList_itemSelectionChanged</b>(<i></i>)
146
147 <p>
148 Private slot handling a change of selected items.
149 </p>
150 <a NAME="GitWorktreePathsDialog.on_removeAllButton_clicked" ID="GitWorktreePathsDialog.on_removeAllButton_clicked"></a>
151 <h4>GitWorktreePathsDialog.on_removeAllButton_clicked</h4>
152 <b>on_removeAllButton_clicked</b>(<i></i>)
153
154 <p>
155 Private slot to remove all items from the list.
156 </p>
157 <a NAME="GitWorktreePathsDialog.on_removeButton_clicked" ID="GitWorktreePathsDialog.on_removeButton_clicked"></a>
158 <h4>GitWorktreePathsDialog.on_removeButton_clicked</h4>
159 <b>on_removeButton_clicked</b>(<i></i>)
160
161 <p>
162 Private slot to remove the selected items.
163 </p>
164 <div align="right"><a href="#top">Up</a></div>
165 <hr />
166 </body></html>

eric ide

mercurial