Documentation/Source/eric5.Plugins.PluginVcsPySvn.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 178
dd9f0bca5e2f
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.PluginVcsPySvn</h1> 23 <h1>eric5.Plugins.PluginVcsPySvn</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;y&#83;v&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#112;&#108;&#117;&#103;&#105;&#110;. 25 Module implementing the PySvn version control plugin.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>subversionCfgPluginObject</td></tr><tr><td>version</td></tr> 29 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>subversionCfgPluginObject</td></tr><tr><td>version</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#VcsPySvnPlugin">VcsPySvnPlugin</a></td> 34 <td><a href="#VcsPySvnPlugin">VcsPySvnPlugin</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;y&#83;v&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#112;&#108;&#117;&#103;&#105;&#110;.</td> 35 <td>Class implementing the PySvn version control plugin.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr> 40 <tr>
41 <td><a href="#createConfigurationPage">createConfigurationPage</a></td> 41 <td><a href="#createConfigurationPage">createConfigurationPage</a></td>
42 <td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;.</td> 42 <td>Module function to create the configuration page.</td>
43 </tr><tr> 43 </tr><tr>
44 <td><a href="#displayString">displayString</a></td> 44 <td><a href="#displayString">displayString</a></td>
45 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103;.</td> 45 <td>Public function to get the display string.</td>
46 </tr><tr> 46 </tr><tr>
47 <td><a href="#exeDisplayData">exeDisplayData</a></td> 47 <td><a href="#exeDisplayData">exeDisplayData</a></td>
48 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#115;&#111;&#109;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#105;&#110;&#102;&#111;.</td> 48 <td>Public method to support the display of some executable info.</td>
49 </tr><tr> 49 </tr><tr>
50 <td><a href="#getConfigData">getConfigData</a></td> 50 <td><a href="#getConfigData">getConfigData</a></td>
51 <td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#100;&#97;&#116;&#97; &#97;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.</td> 51 <td>Module function returning data as required by the configuration dialog.</td>
52 </tr><tr> 52 </tr><tr>
53 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td> 53 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td>
54 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#111;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#105;&#115; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#115;y&#115;&#116;&#101;&#109;.</td> 54 <td>Public function to get the indicators for this version control system.</td>
55 </tr><tr> 55 </tr><tr>
56 <td><a href="#prepareUninstall">prepareUninstall</a></td> 56 <td><a href="#prepareUninstall">prepareUninstall</a></td>
57 <td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.</td> 57 <td>Module function to prepare for an uninstallation.</td>
58 </tr> 58 </tr>
59 </table> 59 </table>
60 <hr /><hr /> 60 <hr /><hr />
61 <a NAME="VcsPySvnPlugin" ID="VcsPySvnPlugin"></a> 61 <a NAME="VcsPySvnPlugin" ID="VcsPySvnPlugin"></a>
62 <h2>VcsPySvnPlugin</h2> 62 <h2>VcsPySvnPlugin</h2>
63 <p> 63 <p>
64 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;y&#83;v&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#112;&#108;&#117;&#103;&#105;&#110;. 64 Class implementing the PySvn version control plugin.
65 </p> 65 </p>
66 <h3>Derived from</h3> 66 <h3>Derived from</h3>
67 object 67 object
68 <h3>Class Attributes</h3> 68 <h3>Class Attributes</h3>
69 <table> 69 <table>
71 </table> 71 </table>
72 <h3>Methods</h3> 72 <h3>Methods</h3>
73 <table> 73 <table>
74 <tr> 74 <tr>
75 <td><a href="#VcsPySvnPlugin.__init__">VcsPySvnPlugin</a></td> 75 <td><a href="#VcsPySvnPlugin.__init__">VcsPySvnPlugin</a></td>
76 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 76 <td>Constructor</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#VcsPySvnPlugin.activate">activate</a></td> 78 <td><a href="#VcsPySvnPlugin.activate">activate</a></td>
79 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td> 79 <td>Public method to activate this plugin.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#VcsPySvnPlugin.deactivate">deactivate</a></td> 81 <td><a href="#VcsPySvnPlugin.deactivate">deactivate</a></td>
82 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td> 82 <td>Public method to deactivate this plugin.</td>
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#VcsPySvnPlugin.getConfigPath">getConfigPath</a></td> 84 <td><a href="#VcsPySvnPlugin.getConfigPath">getConfigPath</a></td>
85 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101;.</td> 85 <td>Public method to get the filename of the config file.</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#VcsPySvnPlugin.getPreferences">getPreferences</a></td> 87 <td><a href="#VcsPySvnPlugin.getPreferences">getPreferences</a></td>
88 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.</td> 88 <td>Public method to retrieve the various refactoring settings.</td>
89 </tr><tr> 89 </tr><tr>
90 <td><a href="#VcsPySvnPlugin.getProjectHelper">getProjectHelper</a></td> 90 <td><a href="#VcsPySvnPlugin.getProjectHelper">getProjectHelper</a></td>
91 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116;.</td> 91 <td>Public method to get a reference to the project helper object.</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#VcsPySvnPlugin.getServersPath">getServersPath</a></td> 93 <td><a href="#VcsPySvnPlugin.getServersPath">getServersPath</a></td>
94 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#114;v&#101;&#114;&#115; &#102;&#105;&#108;&#101;.</td> 94 <td>Public method to get the filename of the servers file.</td>
95 </tr><tr> 95 </tr><tr>
96 <td><a href="#VcsPySvnPlugin.prepareUninstall">prepareUninstall</a></td> 96 <td><a href="#VcsPySvnPlugin.prepareUninstall">prepareUninstall</a></td>
97 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.</td> 97 <td>Public method to prepare for an uninstallation.</td>
98 </tr><tr> 98 </tr><tr>
99 <td><a href="#VcsPySvnPlugin.setPreferences">setPreferences</a></td> 99 <td><a href="#VcsPySvnPlugin.setPreferences">setPreferences</a></td>
100 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.</td> 100 <td>Public method to store the various refactoring settings.</td>
101 </tr> 101 </tr>
102 </table> 102 </table>
103 <a NAME="VcsPySvnPlugin.__init__" ID="VcsPySvnPlugin.__init__"></a> 103 <a NAME="VcsPySvnPlugin.__init__" ID="VcsPySvnPlugin.__init__"></a>
104 <h4>VcsPySvnPlugin (Constructor)</h4> 104 <h4>VcsPySvnPlugin (Constructor)</h4>
105 <b>VcsPySvnPlugin</b>(<i>ui</i>) 105 <b>VcsPySvnPlugin</b>(<i>ui</i>)
106 <p> 106 <p>
107 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 107 Constructor
108 </p><dl> 108 </p><dl>
109 <dt><i>ui</i></dt> 109 <dt><i>ui</i></dt>
110 <dd> 110 <dd>
111 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#111;&#98;&#106;&#101;&#99;&#116; (&#85;&#73;.&#85;&#115;&#101;&#114;&#73;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;) 111 reference to the user interface object (UI.UserInterface)
112 </dd> 112 </dd>
113 </dl><a NAME="VcsPySvnPlugin.activate" ID="VcsPySvnPlugin.activate"></a> 113 </dl><a NAME="VcsPySvnPlugin.activate" ID="VcsPySvnPlugin.activate"></a>
114 <h4>VcsPySvnPlugin.activate</h4> 114 <h4>VcsPySvnPlugin.activate</h4>
115 <b>activate</b>(<i></i>) 115 <b>activate</b>(<i></i>)
116 <p> 116 <p>
117 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;. 117 Public method to activate this plugin.
118 </p><dl> 118 </p><dl>
119 <dt>Returns:</dt> 119 <dt>Returns:</dt>
120 <dd> 120 <dd>
121 &#116;&#117;&#112;&#108;&#101; &#111;&#102; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#105;&#110;&#115;&#116;&#97;&#110;&#116;&#105;&#97;&#116;&#101;&#100; v&#105;&#101;w&#109;&#97;&#110;&#97;&#103;&#101;&#114; &#97;&#110;&#100; 121 tuple of reference to instantiated viewmanager and
122 &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#97;&#116;&#117;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 122 activation status (boolean)
123 </dd> 123 </dd>
124 </dl><a NAME="VcsPySvnPlugin.deactivate" ID="VcsPySvnPlugin.deactivate"></a> 124 </dl><a NAME="VcsPySvnPlugin.deactivate" ID="VcsPySvnPlugin.deactivate"></a>
125 <h4>VcsPySvnPlugin.deactivate</h4> 125 <h4>VcsPySvnPlugin.deactivate</h4>
126 <b>deactivate</b>(<i></i>) 126 <b>deactivate</b>(<i></i>)
127 <p> 127 <p>
128 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;. 128 Public method to deactivate this plugin.
129 </p><a NAME="VcsPySvnPlugin.getConfigPath" ID="VcsPySvnPlugin.getConfigPath"></a> 129 </p><a NAME="VcsPySvnPlugin.getConfigPath" ID="VcsPySvnPlugin.getConfigPath"></a>
130 <h4>VcsPySvnPlugin.getConfigPath</h4> 130 <h4>VcsPySvnPlugin.getConfigPath</h4>
131 <b>getConfigPath</b>(<i></i>) 131 <b>getConfigPath</b>(<i></i>)
132 <p> 132 <p>
133 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101;. 133 Public method to get the filename of the config file.
134 </p><dl> 134 </p><dl>
135 <dt>Returns:</dt> 135 <dt>Returns:</dt>
136 <dd> 136 <dd>
137 &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 137 filename of the config file (string)
138 </dd> 138 </dd>
139 </dl><a NAME="VcsPySvnPlugin.getPreferences" ID="VcsPySvnPlugin.getPreferences"></a> 139 </dl><a NAME="VcsPySvnPlugin.getPreferences" ID="VcsPySvnPlugin.getPreferences"></a>
140 <h4>VcsPySvnPlugin.getPreferences</h4> 140 <h4>VcsPySvnPlugin.getPreferences</h4>
141 <b>getPreferences</b>(<i>key</i>) 141 <b>getPreferences</b>(<i>key</i>)
142 <p> 142 <p>
143 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;. 143 Public method to retrieve the various refactoring settings.
144 </p><dl> 144 </p><dl>
145 <dt><i>key</i></dt> 145 <dt><i>key</i></dt>
146 <dd> 146 <dd>
147 &#116;&#104;&#101; &#107;&#101;y &#111;&#102; &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#116;&#111; &#103;&#101;&#116; 147 the key of the value to get
148 </dd><dt><i>prefClass</i></dt> 148 </dd><dt><i>prefClass</i></dt>
149 <dd> 149 <dd>
150 &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97; 150 preferences class used as the storage area
151 </dd> 151 </dd>
152 </dl><dl> 152 </dl><dl>
153 <dt>Returns:</dt> 153 <dt>Returns:</dt>
154 <dd> 154 <dd>
155 &#116;&#104;&#101; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103; 155 the requested refactoring setting
156 </dd> 156 </dd>
157 </dl><a NAME="VcsPySvnPlugin.getProjectHelper" ID="VcsPySvnPlugin.getProjectHelper"></a> 157 </dl><a NAME="VcsPySvnPlugin.getProjectHelper" ID="VcsPySvnPlugin.getProjectHelper"></a>
158 <h4>VcsPySvnPlugin.getProjectHelper</h4> 158 <h4>VcsPySvnPlugin.getProjectHelper</h4>
159 <b>getProjectHelper</b>(<i></i>) 159 <b>getProjectHelper</b>(<i></i>)
160 <p> 160 <p>
161 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116;. 161 Public method to get a reference to the project helper object.
162 </p><dl> 162 </p><dl>
163 <dt>Returns:</dt> 163 <dt>Returns:</dt>
164 <dd> 164 <dd>
165 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116; 165 reference to the project helper object
166 </dd> 166 </dd>
167 </dl><a NAME="VcsPySvnPlugin.getServersPath" ID="VcsPySvnPlugin.getServersPath"></a> 167 </dl><a NAME="VcsPySvnPlugin.getServersPath" ID="VcsPySvnPlugin.getServersPath"></a>
168 <h4>VcsPySvnPlugin.getServersPath</h4> 168 <h4>VcsPySvnPlugin.getServersPath</h4>
169 <b>getServersPath</b>(<i></i>) 169 <b>getServersPath</b>(<i></i>)
170 <p> 170 <p>
171 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#114;v&#101;&#114;&#115; &#102;&#105;&#108;&#101;. 171 Public method to get the filename of the servers file.
172 </p><dl> 172 </p><dl>
173 <dt>Returns:</dt> 173 <dt>Returns:</dt>
174 <dd> 174 <dd>
175 &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#114;v&#101;&#114;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 175 filename of the servers file (string)
176 </dd> 176 </dd>
177 </dl><a NAME="VcsPySvnPlugin.prepareUninstall" ID="VcsPySvnPlugin.prepareUninstall"></a> 177 </dl><a NAME="VcsPySvnPlugin.prepareUninstall" ID="VcsPySvnPlugin.prepareUninstall"></a>
178 <h4>VcsPySvnPlugin.prepareUninstall</h4> 178 <h4>VcsPySvnPlugin.prepareUninstall</h4>
179 <b>prepareUninstall</b>(<i></i>) 179 <b>prepareUninstall</b>(<i></i>)
180 <p> 180 <p>
181 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;. 181 Public method to prepare for an uninstallation.
182 </p><a NAME="VcsPySvnPlugin.setPreferences" ID="VcsPySvnPlugin.setPreferences"></a> 182 </p><a NAME="VcsPySvnPlugin.setPreferences" ID="VcsPySvnPlugin.setPreferences"></a>
183 <h4>VcsPySvnPlugin.setPreferences</h4> 183 <h4>VcsPySvnPlugin.setPreferences</h4>
184 <b>setPreferences</b>(<i>key, value</i>) 184 <b>setPreferences</b>(<i>key, value</i>)
185 <p> 185 <p>
186 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;. 186 Public method to store the various refactoring settings.
187 </p><dl> 187 </p><dl>
188 <dt><i>key</i></dt> 188 <dt><i>key</i></dt>
189 <dd> 189 <dd>
190 &#116;&#104;&#101; &#107;&#101;y &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103; &#116;&#111; &#98;&#101; &#115;&#101;&#116; 190 the key of the setting to be set
191 </dd><dt><i>value</i></dt> 191 </dd><dt><i>value</i></dt>
192 <dd> 192 <dd>
193 &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#115;&#101;&#116; 193 the value to be set
194 </dd><dt><i>prefClass</i></dt> 194 </dd><dt><i>prefClass</i></dt>
195 <dd> 195 <dd>
196 &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97; 196 preferences class used as the storage area
197 </dd> 197 </dd>
198 </dl> 198 </dl>
199 <div align="right"><a href="#top">Up</a></div> 199 <div align="right"><a href="#top">Up</a></div>
200 <hr /><hr /> 200 <hr /><hr />
201 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> 201 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a>
202 <h2>createConfigurationPage</h2> 202 <h2>createConfigurationPage</h2>
203 <b>createConfigurationPage</b>(<i>configDlg</i>) 203 <b>createConfigurationPage</b>(<i>configDlg</i>)
204 <p> 204 <p>
205 &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;. 205 Module function to create the configuration page.
206 </p><dl> 206 </p><dl>
207 <dt>Returns:</dt> 207 <dt>Returns:</dt>
208 <dd> 208 <dd>
209 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101; 209 reference to the configuration page
210 </dd> 210 </dd>
211 </dl> 211 </dl>
212 <div align="right"><a href="#top">Up</a></div> 212 <div align="right"><a href="#top">Up</a></div>
213 <hr /><hr /> 213 <hr /><hr />
214 <a NAME="displayString" ID="displayString"></a> 214 <a NAME="displayString" ID="displayString"></a>
215 <h2>displayString</h2> 215 <h2>displayString</h2>
216 <b>displayString</b>(<i></i>) 216 <b>displayString</b>(<i></i>)
217 <p> 217 <p>
218 &#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103;. 218 Public function to get the display string.
219 </p><dl> 219 </p><dl>
220 <dt>Returns:</dt> 220 <dt>Returns:</dt>
221 <dd> 221 <dd>
222 &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;) 222 display string (string)
223 </dd> 223 </dd>
224 </dl> 224 </dl>
225 <div align="right"><a href="#top">Up</a></div> 225 <div align="right"><a href="#top">Up</a></div>
226 <hr /><hr /> 226 <hr /><hr />
227 <a NAME="exeDisplayData" ID="exeDisplayData"></a> 227 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
228 <h2>exeDisplayData</h2> 228 <h2>exeDisplayData</h2>
229 <b>exeDisplayData</b>(<i></i>) 229 <b>exeDisplayData</b>(<i></i>)
230 <p> 230 <p>
231 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#115;&#111;&#109;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#105;&#110;&#102;&#111;. 231 Public method to support the display of some executable info.
232 </p><dl> 232 </p><dl>
233 <dt>Returns:</dt> 233 <dt>Returns:</dt>
234 <dd> 234 <dd>
235 &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#97;&#116;&#97; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; 235 dictionary containing the data to be shown
236 </dd> 236 </dd>
237 </dl> 237 </dl>
238 <div align="right"><a href="#top">Up</a></div> 238 <div align="right"><a href="#top">Up</a></div>
239 <hr /><hr /> 239 <hr /><hr />
240 <a NAME="getConfigData" ID="getConfigData"></a> 240 <a NAME="getConfigData" ID="getConfigData"></a>
241 <h2>getConfigData</h2> 241 <h2>getConfigData</h2>
242 <b>getConfigData</b>(<i></i>) 242 <b>getConfigData</b>(<i></i>)
243 <p> 243 <p>
244 &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#100;&#97;&#116;&#97; &#97;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;. 244 Module function returning data as required by the configuration dialog.
245 </p><dl> 245 </p><dl>
246 <dt>Returns:</dt> 246 <dt>Returns:</dt>
247 <dd> 247 <dd>
248 &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y w&#105;&#116;&#104; &#107;&#101;y "zzz&#95;&#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110;&#80;&#97;&#103;&#101;" &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#114;&#101;&#108;&#101;v&#97;&#110;&#116; &#100;&#97;&#116;&#97; 248 dictionary with key "zzz_subversionPage" containing the relevant data
249 </dd> 249 </dd>
250 </dl> 250 </dl>
251 <div align="right"><a href="#top">Up</a></div> 251 <div align="right"><a href="#top">Up</a></div>
252 <hr /><hr /> 252 <hr /><hr />
253 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> 253 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a>
254 <h2>getVcsSystemIndicator</h2> 254 <h2>getVcsSystemIndicator</h2>
255 <b>getVcsSystemIndicator</b>(<i></i>) 255 <b>getVcsSystemIndicator</b>(<i></i>)
256 <p> 256 <p>
257 &#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#111;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#105;&#115; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#115;y&#115;&#116;&#101;&#109;. 257 Public function to get the indicators for this version control system.
258 </p><dl> 258 </p><dl>
259 <dt>Returns:</dt> 259 <dt>Returns:</dt>
260 <dd> 260 <dd>
261 &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y w&#105;&#116;&#104; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#111;&#114; &#97;&#115; &#107;&#101;y &#97;&#110;&#100; &#97; &#116;&#117;&#112;&#108;&#101; w&#105;&#116;&#104; &#116;&#104;&#101; v&#99;&#115; &#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 261 dictionary with indicator as key and a tuple with the vcs name (string)
262 &#97;&#110;&#100; v&#99;&#115; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;) 262 and vcs display string (string)
263 </dd> 263 </dd>
264 </dl> 264 </dl>
265 <div align="right"><a href="#top">Up</a></div> 265 <div align="right"><a href="#top">Up</a></div>
266 <hr /><hr /> 266 <hr /><hr />
267 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 267 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
268 <h2>prepareUninstall</h2> 268 <h2>prepareUninstall</h2>
269 <b>prepareUninstall</b>(<i></i>) 269 <b>prepareUninstall</b>(<i></i>)
270 <p> 270 <p>
271 &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;. 271 Module function to prepare for an uninstallation.
272 </p> 272 </p>
273 <div align="right"><a href="#top">Up</a></div> 273 <div align="right"><a href="#top">Up</a></div>
274 <hr /> 274 <hr />
275 </body></html> 275 </body></html>

eric ide

mercurial