Skip to content

Commit a0b5241

Browse files
3nids3nids
committedOct 30, 2014
remove "added" notes for 1.x and 2.0 versions
·
ltr-3_40archive/master_2
1 parent ef56c53 commit a0b5241

File tree

109 files changed

+391
-1255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+391
-1255
lines changed
 

‎python/gui/qgisinterface.sip

Lines changed: 24 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@ class QgisInterface : QObject
2525
/** Virtual destructor */
2626
virtual ~QgisInterface();
2727

28-
/** Get pointer to legend interface
29-
\note added in 1.4
30-
*/
28+
/** Get pointer to legend interface */
3129
virtual QgsLegendInterface* legendInterface() = 0;
3230

3331
virtual QgsPluginManagerInterface* pluginManagerInterface() = 0;
@@ -69,7 +67,6 @@ class QgisInterface : QObject
6967

7068
//! Set the active layer (layer gets selected in the legend)
7169
//! returns true if the layer exists, false otherwise
72-
//! added in 1.4
7370
virtual bool setActiveLayer( QgsMapLayer * ) = 0;
7471

7572
//! Add an icon to the plugins toolbar
@@ -99,16 +96,12 @@ class QgisInterface : QObject
9996
virtual QAction* addRasterToolBarWidget( QWidget* widget ) = 0;
10097

10198
//! Add an icon to the Raster toolbar
102-
//! @note added in 2.0
10399
virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
104100

105101
//! Remove an action (icon) from the Raster toolbar
106-
//! @note added in 2.0
107102
virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
108103

109104
//! Add an icon to the Vector toolbar
110-
//! @note added in 2.0
111-
112105
virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
113106

114107
/**
@@ -122,11 +115,9 @@ class QgisInterface : QObject
122115
virtual QAction* addVectorToolBarWidget( QWidget* widget ) = 0;
123116

124117
//! Remove an action (icon) from the Vector toolbar
125-
//! @note added in 2.0
126118
virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
127119

128120
//! Add an icon to the Database toolbar
129-
//! @note added in 2.0
130121
virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
131122

132123
/**
@@ -140,11 +131,9 @@ class QgisInterface : QObject
140131
virtual QAction* addDatabaseToolBarWidget( QWidget* widget ) = 0;
141132

142133
//! Remove an action (icon) from the Database toolbar
143-
//! @note added in 2.0
144134
virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
145135

146136
//! Add an icon to the Web toolbar
147-
//! @note added in 2.0
148137
virtual int addWebToolBarIcon( QAction *qAction ) = 0;
149138

150139
/**
@@ -158,7 +147,6 @@ class QgisInterface : QObject
158147
virtual QAction* addWebToolBarWidget( QWidget* widget ) = 0;
159148

160149
//! Remove an action (icon) from the Web toolbar
161-
//! @note added in 2.0
162150
virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
163151

164152
//! Add toolbar with specified name
@@ -183,42 +171,33 @@ class QgisInterface : QObject
183171
/** Create a new composer
184172
* @param title window title for new composer (one will be generated if empty)
185173
* @return pointer to composer's view
186-
* @note new composer window will be shown and activated (added in 1.9)
174+
* @note new composer window will be shown and activated
187175
*/
188176
virtual QgsComposerView* createNewComposer( QString title = QString( "" ) ) = 0;
189177

190178
/** Duplicate an existing parent composer from composer view
191179
* @param composerView pointer to existing composer view
192180
* @param title window title for duplicated composer (one will be generated if empty)
193181
* @return pointer to duplicate composer's view
194-
* @note dupicate composer window will be hidden until loaded, then shown and activated (added in 1.9)
182+
* @note dupicate composer window will be hidden until loaded, then shown and activated
195183
*/
196184
virtual QgsComposerView* duplicateComposer( QgsComposerView* composerView, QString title = QString( "" ) ) = 0;
197185

198-
/** Deletes parent composer of composer view, after closing composer window
199-
* @note (added in 1.9)
200-
*/
186+
/** Deletes parent composer of composer view, after closing composer window */
201187
virtual void deleteComposer( QgsComposerView* composerView ) = 0;
202188

203-
/** Return changeable options built from settings and/or defaults
204-
* @note (added in 1.9)
205-
*/
189+
/** Return changeable options built from settings and/or defaults */
206190
virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
207191

208192
/** Generate stylesheet
209193
* @param opts generated default option values, or a changed copy of them
210-
* @note added in 1.9
211194
*/
212195
virtual void buildStyleSheet( const QMap<QString, QVariant>& opts ) = 0;
213196

214-
/** Save changed default option keys/values to user settings
215-
* @note added in 1.9
216-
*/
197+
/** Save changed default option keys/values to user settings */
217198
virtual void saveStyleSheetOptions( const QMap<QString, QVariant>& opts ) = 0;
218199

219-
/** Get reference font for initial qApp (may not be same as QgisApp)
220-
* @note added in 1.9
221-
*/
200+
/** Get reference font for initial qApp (may not be same as QgisApp) */
222201
virtual QFont defaultStyleSheetFont() = 0;
223202

224203
/** Add action to the plugins menu */
@@ -227,72 +206,46 @@ class QgisInterface : QObject
227206
/** Remove action from the plugins menu */
228207
virtual void removePluginMenu( QString name, QAction* action ) = 0;
229208

230-
/** Add "add layer" action to layer menu
231-
* @note added in 1.7
232-
*/
209+
/** Add "add layer" action to layer menu */
233210
virtual void insertAddLayerAction( QAction *action ) = 0;
234211

235-
/** Remove "add layer" action from layer menu
236-
* @note added in 1.7
237-
*/
212+
/** Remove "add layer" action from layer menu */
238213
virtual void removeAddLayerAction( QAction *action ) = 0;
239214

240-
/** Add action to the Database menu
241-
* @note added in 1.7
242-
*/
215+
/** Add action to the Database menu */
243216
virtual void addPluginToDatabaseMenu( QString name, QAction* action ) = 0;
244217

245-
/** Remove action from the Database menu
246-
* @note added in 1.7
247-
*/
218+
/** Remove action from the Database menu */
248219
virtual void removePluginDatabaseMenu( QString name, QAction* action ) = 0;
249220

250-
/** Add action to the Raster menu
251-
* @note added in 2.0
252-
*/
221+
/** Add action to the Raster menu */
253222
virtual void addPluginToRasterMenu( QString name, QAction* action ) = 0;
254223

255-
/** Remove action from the Raster menu
256-
* @note added in 2.0
257-
*/
224+
/** Remove action from the Raster menu */
258225
virtual void removePluginRasterMenu( QString name, QAction* action ) = 0;
259226

260-
/** Add action to the Vector menu
261-
* @note added in 2.0
262-
*/
227+
/** Add action to the Vector menu */
263228
virtual void addPluginToVectorMenu( QString name, QAction* action ) = 0;
264229

265-
/** Remove action from the Vector menu
266-
* @note added in 2.0
267-
*/
230+
/** Remove action from the Vector menu */
268231
virtual void removePluginVectorMenu( QString name, QAction* action ) = 0;
269232

270-
/** Add action to the Web menu
271-
* @note added in 2.0
272-
*/
233+
/** Add action to the Web menu */
273234
virtual void addPluginToWebMenu( QString name, QAction* action ) = 0;
274235

275-
/** Remove action from the Web menu
276-
* @note added in 2.0
277-
*/
236+
/** Remove action from the Web menu */
278237
virtual void removePluginWebMenu( QString name, QAction* action ) = 0;
279238

280239
/** Add a dock widget to the main window */
281240
virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget * dockwidget ) = 0;
282241

283-
/** Remove specified dock widget from main window (doesn't delete it).
284-
* @note Added in 1.1
285-
*/
242+
/** Remove specified dock widget from main window (doesn't delete it). */
286243
virtual void removeDockWidget( QDockWidget * dockwidget ) = 0;
287244

288-
/** open layer properties dialog
289-
\note added in 1.5
290-
*/
245+
/** open layer properties dialog */
291246
virtual void showLayerProperties( QgsMapLayer *l ) = 0;
292247

293-
/** open attribute table dialog
294-
\note added in 1.7
295-
*/
248+
/** open attribute table dialog */
296249
virtual void showAttributeTable( QgsVectorLayer *l ) = 0;
297250

298251
/** Add window to Window menu. The action title is the window title
@@ -304,12 +257,10 @@ class QgisInterface : QObject
304257
virtual void removeWindow( QAction *action ) = 0;
305258

306259
/** Register action to the shortcuts manager so its shortcut can be changed in GUI
307-
\note added in 1.2
308260
*/
309261
virtual bool registerMainWindowAction( QAction* action, QString defaultShortcut ) = 0;
310262

311263
/** Unregister a previously registered action. (e.g. when plugin is going to be unloaded)
312-
\note added in 1.2
313264
*/
314265
virtual bool unregisterMainWindowAction( QAction* action ) = 0;
315266

@@ -334,23 +285,14 @@ class QgisInterface : QObject
334285
virtual QMenu *editMenu() = 0;
335286
virtual QMenu *viewMenu() = 0;
336287
virtual QMenu *layerMenu() = 0;
337-
/** \note added in 2.0
338-
*/
339288
virtual QMenu *newLayerMenu() = 0;
340-
/** \note added in 2.5
341-
*/
289+
/** @note added in 2.5 */
342290
virtual QMenu *addLayerMenu() = 0;
343291
virtual QMenu *settingsMenu() = 0;
344292
virtual QMenu *pluginMenu() = 0;
345293
virtual QMenu *rasterMenu() = 0;
346-
/** \note added in 1.7
347-
*/
348294
virtual QMenu *databaseMenu() = 0;
349-
/** \note added in 2.0
350-
*/
351295
virtual QMenu *vectorMenu() = 0;
352-
/** \note added in 2.0
353-
*/
354296
virtual QMenu *webMenu() = 0;
355297
virtual QMenu *firstRightStandardMenu() = 0;
356298
virtual QMenu *windowMenu() = 0;
@@ -361,21 +303,13 @@ class QgisInterface : QObject
361303
virtual QToolBar *layerToolBar() = 0;
362304
virtual QToolBar *mapNavToolToolBar() = 0;
363305
virtual QToolBar *digitizeToolBar() = 0;
364-
virtual QToolBar *advancedDigitizeToolBar() = 0; // added in v1.5
306+
virtual QToolBar *advancedDigitizeToolBar() = 0;
365307
virtual QToolBar *attributesToolBar() = 0;
366308
virtual QToolBar *pluginToolBar() = 0;
367309
virtual QToolBar *helpToolBar() = 0;
368-
/** \note added in 1.7
369-
*/
370310
virtual QToolBar *rasterToolBar() = 0;
371-
/** \note added in 2.0
372-
*/
373311
virtual QToolBar *vectorToolBar() = 0;
374-
/** \note added in 2.0
375-
*/
376312
virtual QToolBar *databaseToolBar() = 0;
377-
/** \note added in 2.0
378-
*/
379313
virtual QToolBar *webToolBar() = 0;
380314

381315
// Project menu actions
@@ -461,34 +395,23 @@ class QgisInterface : QObject
461395
virtual QAction *actionAddRasterLayer() = 0;
462396
virtual QAction *actionAddPgLayer() = 0;
463397
virtual QAction *actionAddWmsLayer() = 0;
464-
/** @note added in 1.9 */
465398
virtual QAction *actionCopyLayerStyle() = 0;
466-
/** @note added in 1.9 */
467399
virtual QAction *actionPasteLayerStyle() = 0;
468400
virtual QAction *actionOpenTable() = 0;
469401
virtual QAction *actionOpenFieldCalculator() = 0;
470402
virtual QAction *actionToggleEditing() = 0;
471-
/** @note added in 1.9 */
472403
virtual QAction *actionSaveActiveLayerEdits() = 0;
473-
/** @note added in 1.9 */
474404
virtual QAction *actionAllEdits() = 0;
475-
/** @note added in 1.9 */
476405
virtual QAction *actionSaveEdits() = 0;
477-
/** @note added in 1.9 */
478406
virtual QAction *actionSaveAllEdits() = 0;
479-
/** @note added in 1.9 */
480407
virtual QAction *actionRollbackEdits() = 0;
481-
/** @note added in 1.9 */
482408
virtual QAction *actionRollbackAllEdits() = 0;
483-
/** @note added in 1.9 */
484409
virtual QAction *actionCancelEdits() = 0;
485-
/** @note added in 1.9 */
486410
virtual QAction *actionCancelAllEdits() = 0;
487411
virtual QAction *actionLayerSaveAs() = 0;
488412
/** @deprecated in 2.4 - returns null pointer */
489413
virtual QAction *actionLayerSelectionSaveAs() = 0 /Deprecated/;
490414
virtual QAction *actionRemoveLayer() = 0;
491-
/** @note added in 1.9 */
492415
virtual QAction *actionDuplicateLayer() = 0;
493416
virtual QAction *actionLayerProperties() = 0;
494417
virtual QAction *actionAddToOverview() = 0;
@@ -521,7 +444,6 @@ class QgisInterface : QObject
521444
* @param f feature to show/modify
522445
* @param updateFeatureOnly only update the feature update (don't change any attributes of the layer) [UNUSED]
523446
* @param showModal if true, will wait for the dialog to be executed (only shown otherwise)
524-
* @note added in 1.6
525447
*/
526448
virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0;
527449

@@ -559,12 +481,10 @@ class QgisInterface : QObject
559481

560482
/** Return vector layers in edit mode
561483
* @param modified whether to return only layers that have been modified
562-
* @returns list of layers in legend order, or empty list
563-
* @note added in 1.9 */
484+
* @returns list of layers in legend order, or empty list */
564485
virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
565486

566-
/** Get timeout for timed messages: default of 5 seconds
567-
* @note added in 1.9 */
487+
/** Get timeout for timed messages: default of 5 seconds */
568488
virtual int messageTimeout() = 0;
569489

570490
signals:
@@ -575,27 +495,22 @@ class QgisInterface : QObject
575495

576496
/**
577497
* This signal is emitted when a new composer instance has been created
578-
* @note added in 1.4
579498
*/
580499
void composerAdded( QgsComposerView* v );
581500

582501
/**
583502
* This signal is emitted before a new composer instance is going to be removed
584-
* @note added in 1.4
585503
*/
586504
void composerWillBeRemoved( QgsComposerView* v );
587505
/**
588506
* This signal is emitted when the initialization is complete
589-
* @note added in 1.6
590507
*/
591508
void initializationCompleted();
592509
/** emitted when a project file is successfully read
593510
@note
594511
This is useful for plug-ins that store properties with project files. A
595512
plug-in can connect to this signal. When it is emitted, the plug-in
596513
knows to then check the project properties for any relevant state.
597-
598-
Added in 1.6
599514
*/
600515
void projectRead();
601516
/** emitted when starting an entirely new project
@@ -605,8 +520,6 @@ class QgisInterface : QObject
605520
overloaded to be used in the case of new projects instead. However,
606521
it's probably more semantically correct to have an entirely separate
607522
signal for when this happens.
608-
609-
Added in 1.6
610523
*/
611524
void newProjectCreated();
612525
};

0 commit comments

Comments
 (0)
Please sign in to comment.