/
qgisinterface.sip.in
1616 lines (1247 loc) · 48 KB
/
qgisinterface.sip.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgisinterface.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgisInterface : QObject
{
%Docstring
QgisInterface
Abstract base class defining interfaces exposed by QgisApp and
made available to plugins.
Only functionality exposed by QgisInterface can be used in plugins.
This interface has to be implemented with application specific details.
QGIS implements it in QgisAppInterface class, 3rd party applications
could provide their own implementation to be able to use plugins.
%End
%TypeHeaderCode
#include "qgisinterface.h"
%End
public:
QgisInterface();
%Docstring
Constructor
%End
virtual QgsPluginManagerInterface *pluginManagerInterface() = 0;
virtual QgsLayerTreeView *layerTreeView() = 0;
virtual void addCustomActionForLayerType( QAction *action, QString menu,
QgsMapLayerType type, bool allLayers ) = 0;
%Docstring
Add action to context menu for layers in the layer tree.
If allLayers is ``True``, then the action will be available for all layers of given type,
otherwise the action will be available only for specific layers added with :py:func:`~QgisInterface.addCustomActionForLayer`
after this call.
If menu argument is not empty, the action will be also added to a menu within the main window,
creating menu with the given name if it does not exist yet.
.. seealso:: :py:func:`removeCustomActionForLayerType`
.. seealso:: :py:func:`addCustomActionForLayer`
%End
virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0;
%Docstring
Add action to context menu for a specific layer in the layer tree.
It is necessary to first call :py:func:`~QgisInterface.addCustomActionForLayerType` with allLayers=false
in order for this method to have any effect.
.. seealso:: :py:func:`addCustomActionForLayerType`
%End
virtual bool removeCustomActionForLayerType( QAction *action ) = 0;
%Docstring
Remove action for layers in the layer tree previously added with :py:func:`~QgisInterface.addCustomActionForLayerType`
.. seealso:: :py:func:`addCustomActionForLayerType`
%End
virtual QList< QgsMapCanvas * > mapCanvases() = 0;
%Docstring
Returns a list of all map canvases open in the app.
.. versionadded:: 3.0
%End
virtual QgsMapCanvas *createNewMapCanvas( const QString &name ) = 0;
%Docstring
Create a new map canvas with the specified unique ``name``.
.. seealso:: :py:func:`closeMapCanvas`
.. versionadded:: 3.0
%End
virtual void closeMapCanvas( const QString &name ) = 0;
%Docstring
Closes the additional map canvas with matching ``name``.
.. seealso:: :py:func:`createNewMapCanvas`
.. versionadded:: 3.0
%End
virtual QSize iconSize( bool dockedToolbar = false ) const = 0;
%Docstring
Returns the toolbar icon size. If ``dockedToolbar`` is ``True``, the icon size
for toolbars contained within docks is returned.
%End
virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const = 0;
%Docstring
Returns vector layers in edit mode
:param modified: whether to return only layers that have been modified
:return: list of layers in legend order, or empty list
%End
virtual QgsMapLayer *activeLayer() = 0;
%Docstring
Returns a pointer to the active layer (layer selected in the legend)
%End
virtual QgsMapCanvas *mapCanvas() = 0;
%Docstring
Returns a pointer to the map canvas
%End
virtual QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() = 0;
%Docstring
Returns a pointer to the layer tree canvas bridge
.. versionadded:: 2.12
%End
virtual QWidget *mainWindow() = 0;
%Docstring
Returns a pointer to the main window (instance of QgisApp in case of QGIS)
%End
virtual QgsMessageBar *messageBar() = 0;
%Docstring
Returns the message bar of the main app
%End
virtual QList<QgsLayoutDesignerInterface *> openLayoutDesigners() = 0;
%Docstring
Returns all currently open layout designers.
.. versionadded:: 3.0
%End
virtual QMap<QString, QVariant> defaultStyleSheetOptions() = 0;
%Docstring
Returns changeable options built from settings and/or defaults
%End
virtual QFont defaultStyleSheetFont() = 0;
%Docstring
Returns a reference font for initial qApp (may not be same as QgisApp)
%End
virtual QgsAdvancedDigitizingDockWidget *cadDockWidget() = 0;
%Docstring
Advanced digitizing dock widget
.. versionadded:: 2.12
%End
virtual QMenu *projectMenu() = 0;
%Docstring
Returns a reference to the main window "Project" menu.
%End
virtual QMenu *editMenu() = 0;
%Docstring
Returns a reference to the main window "Edit" menu.
%End
virtual QMenu *viewMenu() = 0;
%Docstring
Returns a reference to the main window "View" menu.
%End
virtual QMenu *layerMenu() = 0;
%Docstring
Returns a reference to the main window "Layer" menu.
%End
virtual QMenu *newLayerMenu() = 0;
%Docstring
Returns a reference to the main window "Create New Layer" menu.
%End
virtual QMenu *addLayerMenu() = 0;
%Docstring
Returns a reference to the main window "Add Layer" menu.
.. versionadded:: 2.5
%End
virtual QMenu *settingsMenu() = 0;
%Docstring
Returns a reference to the main window "Settings" menu.
%End
virtual QMenu *pluginMenu() = 0;
%Docstring
Returns a reference to the main window "Plugin" menu.
%End
virtual QMenu *pluginHelpMenu() = 0;
%Docstring
Returns a reference to the main window "Plugin Help" sub-menu.
Plugins are encouraged to insert help and about actions in this submenu instead of creating
a submenu under the :py:func:`~QgisInterface.pluginMenu` which solely contains Plugin Help or About actions.
.. versionadded:: 3.10
%End
virtual QMenu *rasterMenu() = 0;
%Docstring
Returns a reference to the main window "Raster" menu.
%End
virtual QMenu *databaseMenu() = 0;
%Docstring
Returns a reference to the main window "Database" menu.
%End
virtual QMenu *vectorMenu() = 0;
%Docstring
Returns a reference to the main window "Vector" menu.
%End
virtual QMenu *webMenu() = 0;
%Docstring
Returns a reference to the main window "Web" menu.
%End
virtual QMenu *firstRightStandardMenu() = 0;
%Docstring
Returns a reference to the right most standard menu, which is
usually the last menu item before the "Help" menu.
This can be used to insert additional top-level menus into
their correct position BEFORE the help menu.
%End
virtual QMenu *windowMenu() = 0;
%Docstring
Returns a reference to the main window "Window" menu.
%End
virtual QMenu *helpMenu() = 0;
%Docstring
Returns a reference to the main window "Help" menu.
%End
virtual QToolBar *fileToolBar() = 0;
%Docstring
Returns a reference to the main window "File" toolbar.
%End
virtual QToolBar *layerToolBar() = 0;
%Docstring
Returns a reference to the main window "Layer" toolbar.
%End
virtual QToolBar *dataSourceManagerToolBar() = 0;
%Docstring
Returns a reference to the main window "Data Source Manager" toolbar.
.. versionadded:: 3.4
%End
virtual QToolBar *mapNavToolToolBar() = 0;
%Docstring
Returns a reference to the main window "Map Navigation" toolbar.
%End
virtual QToolBar *digitizeToolBar() = 0;
%Docstring
Returns a reference to the main window "Digitize" toolbar.
%End
virtual QToolBar *advancedDigitizeToolBar() = 0;
%Docstring
Returns a reference to the main window "Advanced Digitizing" toolbar.
%End
virtual QToolBar *shapeDigitizeToolBar() = 0;
%Docstring
Returns a reference to the main window "Shape Digitizing" toolbar.
.. versionadded:: 3.0
%End
virtual QToolBar *attributesToolBar() = 0;
%Docstring
Returns a reference to the main window "Attributes" toolbar.
%End
virtual QToolBar *selectionToolBar() = 0;
%Docstring
Returns a reference to the main window "Selection" toolbar.
.. versionadded:: 3.14
%End
virtual QToolBar *pluginToolBar() = 0;
%Docstring
Returns a reference to the main window "Plugin" toolbar.
%End
virtual QToolBar *helpToolBar() = 0;
%Docstring
Returns a reference to the main window "Help" toolbar.
%End
virtual QToolBar *rasterToolBar() = 0;
%Docstring
Returns a reference to the main window "Raster" toolbar.
%End
virtual QToolBar *vectorToolBar() = 0;
%Docstring
Returns a reference to the main window "Vector" toolbar.
%End
virtual QToolBar *databaseToolBar() = 0;
%Docstring
Returns a reference to the main window "Database" toolbar.
%End
virtual QToolBar *webToolBar() = 0;
%Docstring
Returns a reference to the main window "Web" toolbar.
%End
virtual QAction *actionNewProject() = 0;
%Docstring
Returns the native New Project action.
%End
virtual QAction *actionOpenProject() = 0;
%Docstring
Returns the Open Project action.
%End
virtual QAction *actionSaveProject() = 0;
%Docstring
Returns the native Save Project action.
%End
virtual QAction *actionSaveProjectAs() = 0;
%Docstring
Returns the native Save Project As action.
%End
virtual QAction *actionSaveMapAsImage() = 0;
%Docstring
Returns the native Save Map as Image action.
%End
virtual QAction *actionProjectProperties() = 0;
%Docstring
Returns the native Project Properties action.
%End
virtual QAction *actionCreatePrintLayout() = 0;
%Docstring
Create new print layout action
%End
virtual QAction *actionShowLayoutManager() = 0;
%Docstring
Show layout manager action
%End
virtual QAction *actionExit() = 0;
%Docstring
Returns the Exit QGIS action.
%End
virtual QAction *actionCutFeatures() = 0;
%Docstring
Returns the native Cut Features action.
%End
virtual QAction *actionCopyFeatures() = 0;
%Docstring
Returns the native Copy Features action.
%End
virtual QAction *actionPasteFeatures() = 0;
%Docstring
Returns the native Paste Features action.
%End
virtual QAction *actionAddFeature() = 0;
%Docstring
Returns the native Add Feature action.
%End
virtual QAction *actionDeleteSelected() = 0;
%Docstring
Returns the native Delete Selected Features action.
%End
virtual QAction *actionMoveFeature() = 0;
%Docstring
Returns the native Move Features action.
%End
virtual QAction *actionSplitFeatures() = 0;
%Docstring
Returns the native Split Features action.
%End
virtual QAction *actionSplitParts() = 0;
%Docstring
Returns the native Split Parts action.
%End
virtual QAction *actionAddRing() = 0;
%Docstring
Returns the native Add Ring action.
%End
virtual QAction *actionAddPart() = 0;
%Docstring
Returns the native Add Part action.
%End
virtual QAction *actionSimplifyFeature() = 0;
%Docstring
Returns the native Simplify/Smooth Features action.
%End
virtual QAction *actionDeleteRing() = 0;
%Docstring
Returns the native Delete Ring action.
%End
virtual QAction *actionDeletePart() = 0;
%Docstring
Returns the native Delete Part action.
%End
virtual QAction *actionVertexTool() = 0;
%Docstring
Returns the native "Vertex Tool for All Layers" action.
.. seealso:: :py:func:`actionVertexToolActiveLayer`
%End
virtual QAction *actionVertexToolActiveLayer() = 0;
%Docstring
Returns the native "Vertex Tool for Active Layer" action.
.. seealso:: :py:func:`actionVertexTool`
.. versionadded:: 3.6
%End
virtual QActionGroup *mapToolActionGroup() = 0;
%Docstring
Returns the action group for map tools.
Any actions added by plugins for toggling a map tool should also be added to this action
group so that they behave identically to the native, in-built map tool actions.
.. versionadded:: 3.16
%End
virtual QAction *actionPan() = 0;
%Docstring
Returns the native pan action. Call :py:func:`~QgisInterface.trigger` on it to set the default pan map tool.
%End
virtual QAction *actionPanToSelected() = 0;
%Docstring
Returns the native pan to selected action. Call :py:func:`~QgisInterface.trigger` on it to pan the map canvas to the selection.
%End
virtual QAction *actionZoomIn() = 0;
%Docstring
Returns the native zoom in action. Call :py:func:`~QgisInterface.trigger` on it to set the default zoom in map tool.
%End
virtual QAction *actionZoomOut() = 0;
%Docstring
Returns the native zoom out action. Call :py:func:`~QgisInterface.trigger` on it to set the default zoom out map tool.
%End
virtual QAction *actionSelect() = 0;
%Docstring
Returns the native select action. Call :py:func:`~QgisInterface.trigger` on it to set the default select map tool.
%End
virtual QAction *actionSelectRectangle() = 0;
%Docstring
Returns the native select rectangle action. Call :py:func:`~QgisInterface.trigger` on it to set the default select rectangle map tool.
%End
virtual QAction *actionSelectPolygon() = 0;
%Docstring
Returns the native select polygon action. Call :py:func:`~QgisInterface.trigger` on it to set the default select polygon map tool.
%End
virtual QAction *actionSelectFreehand() = 0;
%Docstring
Returns the native select freehand action. Call :py:func:`~QgisInterface.trigger` on it to set the default select freehand map tool.
%End
virtual QAction *actionSelectRadius() = 0;
%Docstring
Returns the native select radius action. Call :py:func:`~QgisInterface.trigger` on it to set the default select radius map tool.
%End
virtual QAction *actionIdentify() = 0;
%Docstring
Returns the native identify action. Call :py:func:`~QgisInterface.trigger` on it to set the default identify map tool.
%End
virtual QAction *actionFeatureAction() = 0;
%Docstring
Returns the native run action feature action. Call :py:func:`~QgisInterface.trigger` on it to set the default run feature action map tool.
%End
virtual QAction *actionMeasure() = 0;
%Docstring
Returns the native measure action. Call :py:func:`~QgisInterface.trigger` on it to set the default measure map tool.
%End
virtual QAction *actionMeasureArea() = 0;
%Docstring
Returns the native measure area action. Call :py:func:`~QgisInterface.trigger` on it to set the default measure area map tool.
%End
virtual QAction *actionZoomFullExtent() = 0;
%Docstring
Returns the native zoom full extent action. Call :py:func:`~QgisInterface.trigger` on it to zoom to the full extent.
%End
virtual QAction *actionZoomToLayer() = 0;
%Docstring
Returns the native zoom to layer action. Call :py:func:`~QgisInterface.trigger` on it to zoom to the active layer.
%End
virtual QAction *actionZoomToLayers() = 0;
%Docstring
Returns the native zoom to layers action. Call :py:func:`~QgisInterface.trigger` on it to zoom to the selected layers.
%End
virtual QAction *actionZoomToSelected() = 0;
%Docstring
Returns the native zoom to selected action. Call :py:func:`~QgisInterface.trigger` on it to zoom to the current selection.
%End
virtual QAction *actionZoomLast() = 0;
%Docstring
Returns the native zoom last action. Call :py:func:`~QgisInterface.trigger` on it to zoom to last.
%End
virtual QAction *actionZoomNext() = 0;
%Docstring
Returns the native zoom next action. Call :py:func:`~QgisInterface.trigger` on it to zoom to next.
%End
virtual QAction *actionZoomActualSize() = 0;
%Docstring
Returns the native zoom resolution (100%) action. Call :py:func:`~QgisInterface.trigger` on it to zoom to actual size.
%End
virtual QAction *actionMapTips() = 0;
%Docstring
Returns the native map tips action. Call :py:func:`~QgisInterface.trigger` on it to toggle map tips.
%End
virtual QAction *actionNewBookmark() = 0;
%Docstring
Returns the native new bookmark action. Call :py:func:`~QgisInterface.trigger` on it to open the new bookmark dialog.
%End
virtual QAction *actionShowBookmarks() = 0;
%Docstring
Returns the native show bookmarks action. Call :py:func:`~QgisInterface.trigger` on it to open the bookmarks dialog.
%End
virtual QAction *actionDraw() = 0;
%Docstring
Returns the native draw action.
%End
virtual QAction *actionNewVectorLayer() = 0;
virtual QAction *actionAddOgrLayer() = 0;
virtual QAction *actionAddRasterLayer() = 0;
virtual QAction *actionAddPgLayer() = 0;
virtual QAction *actionAddWmsLayer() = 0;
virtual QAction *actionAddXyzLayer() = 0;
%Docstring
Returns the native Add XYZ Layer action.
.. versionadded:: 3.14
%End
virtual QAction *actionAddVectorTileLayer() = 0;
%Docstring
Returns the native Add Vector Tile Layer action.
.. versionadded:: 3.14
%End
virtual QAction *actionAddPointCloudLayer() = 0;
%Docstring
Returns the native Add Point Cloud Layer action.
.. versionadded:: 3.18
%End
virtual QAction *actionAddAfsLayer() = 0;
%Docstring
Returns the native Add ArcGIS FeatureServer action.
%End
virtual QAction *actionAddAmsLayer() = 0;
%Docstring
Returns the native Add ArcGIS MapServer action.
%End
virtual QAction *actionCopyLayerStyle() = 0;
virtual QAction *actionPasteLayerStyle() = 0;
virtual QAction *actionOpenTable() = 0;
virtual QAction *actionOpenFieldCalculator() = 0;
virtual QAction *actionOpenStatisticalSummary() = 0;
%Docstring
Statistical summary action.
.. versionadded:: 3.0
%End
virtual QAction *actionToggleEditing() = 0;
virtual QAction *actionSaveActiveLayerEdits() = 0;
virtual QAction *actionAllEdits() = 0;
virtual QAction *actionSaveEdits() = 0;
virtual QAction *actionSaveAllEdits() = 0;
virtual QAction *actionRollbackEdits() = 0;
virtual QAction *actionRollbackAllEdits() = 0;
virtual QAction *actionCancelEdits() = 0;
virtual QAction *actionCancelAllEdits() = 0;
virtual QAction *actionLayerSaveAs() = 0;
virtual QAction *actionDuplicateLayer() = 0;
virtual QAction *actionLayerProperties() = 0;
virtual QAction *actionAddToOverview() = 0;
virtual QAction *actionAddAllToOverview() = 0;
virtual QAction *actionRemoveAllFromOverview() = 0;
virtual QAction *actionHideAllLayers() = 0;
virtual QAction *actionShowAllLayers() = 0;
virtual QAction *actionHideSelectedLayers() = 0;
virtual QAction *actionToggleSelectedLayers() = 0;
%Docstring
Returns the Toggle Selected Layers action.
.. versionadded:: 3.14
%End
virtual QAction *actionToggleSelectedLayersIndependently() = 0;
%Docstring
Returns the Toggle Selected Layers Independently action.
.. versionadded:: 3.14
%End
virtual QAction *actionHideDeselectedLayers() = 0;
%Docstring
Returns the Hide Deselected Layers action.
.. versionadded:: 3.0
%End
virtual QAction *actionShowSelectedLayers() = 0;
virtual QAction *actionManagePlugins() = 0;
virtual QAction *actionPluginListSeparator() = 0;
virtual QAction *actionShowPythonDialog() = 0;
virtual QAction *actionToggleFullScreen() = 0;
virtual QAction *actionOptions() = 0;
virtual QAction *actionCustomProjection() = 0;
virtual QAction *actionHelpContents() = 0;
virtual QAction *actionQgisHomePage() = 0;
virtual QAction *actionCheckQgisVersion() = 0;
virtual QAction *actionAbout() = 0;
virtual QAction *actionCircle2Points() = 0;
%Docstring
Returns the native add circle from 2 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionCircle3Points() = 0;
%Docstring
Returns the native add circle from 3 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionCircle3Tangents() = 0;
%Docstring
Returns the native add circle from 3 tangents action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionCircle2TangentsPoint() = 0;
%Docstring
Returns the native add circle from 2 tangents and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionCircleCenterPoint() = 0;
%Docstring
Returns the native add circle from center action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionEllipseCenter2Points() = 0;
%Docstring
Returns the native add ellipse from center and 2 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionEllipseCenterPoint() = 0;
%Docstring
Returns the native add ellipse from center and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionEllipseExtent() = 0;
%Docstring
Returns the native add ellipse from an extent action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionEllipseFoci() = 0;
%Docstring
Returns the native add ellipse from foci action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionRectangleCenterPoint() = 0;
%Docstring
Returns the native add rectangle from center and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionRectangleExtent() = 0;
%Docstring
Returns the native add rectangle from extent action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionRectangle3PointsDistance() = 0;
%Docstring
Returns the native add rectangle from 3 points (distance from 2nd and 3rd points) action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionRectangle3PointsProjected() = 0;
%Docstring
Returns the native add rectangle from 3 points (distance from projected 3rd point on segment p1 and p2) action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionRegularPolygon2Points() = 0;
%Docstring
Returns the native add regular polygon from 2 points action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionRegularPolygonCenterPoint() = 0;
%Docstring
Returns the native add regular polygon from center and a point action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QAction *actionRegularPolygonCenterCorner() = 0;
%Docstring
Returns the native add regular polygon from center and a corner action. Call :py:func:`~QgisInterface.trigger` on it to set the map tool.
%End
virtual QgsVectorLayerTools *vectorLayerTools() = 0;
%Docstring
Access the vector layer tools instance.
With the help of this you can access methods like addFeature, startEditing
or stopEditing while giving the user the appropriate dialogs.
:return: An instance of the vector layer tools
%End
virtual int messageTimeout() = 0;
%Docstring
Returns the timeout for timed messages: default of 5 seconds
%End
virtual QgsStatusBar *statusBarIface() = 0;
%Docstring
Returns a pointer to the app's status bar interface. This should be
used for interacting and adding widgets and messages to the app's
status bar (do not use the native Qt :py:func:`~QgisInterface.statusBar` method).
.. versionadded:: 3.0
%End
virtual void takeAppScreenShots( const QString &saveDirectory, const int categories = 0 );
%Docstring
Take screenshots for user documentation
:param saveDirectory: path where the screenshots will be saved
:param categories: an int as a flag value of QgsAppScreenShots.Categories
.. versionadded:: 3.4
%End
virtual QgsLayerTreeRegistryBridge::InsertionPoint layerTreeInsertionPoint() = 0;
%Docstring
Returns the insertion point.
This represents the current layer tree group and index where newly added map layers should be inserted into.
.. versionadded:: 3.10
%End
public slots: // TODO: do these functions really need to be slots?
virtual void zoomFull() = 0;
%Docstring
Zooms to the full extent of all map layers.
%End
virtual void zoomToPrevious() = 0;
%Docstring
Zooms to the previous view extent.
%End
virtual void zoomToNext() = 0;
%Docstring
Zooms to the next view extent.
%End
virtual void zoomToActiveLayer() = 0;
%Docstring
Zooms to extent of the active layer.
%End
virtual QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ) = 0;
%Docstring
Adds a vector layer to the current project.
%End
virtual QgsRasterLayer *addRasterLayer( const QString &rasterLayerPath, const QString &baseName = QString() ) = 0;
%Docstring
Adds a raster layer to the current project, given a raster layer file name.
%End
virtual QgsRasterLayer *addRasterLayer( const QString &url, const QString &layerName, const QString &providerKey ) = 0;
%Docstring
Adds a raster layer to the current project, from the specified raster data provider.
%End
virtual QgsMeshLayer *addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
%Docstring
Adds a mesh layer to the current project.
%End
virtual QgsVectorTileLayer *addVectorTileLayer( const QString &url, const QString &baseName ) = 0;
%Docstring
Adds a vector tile layer to the current project.
.. versionadded:: 3.14
%End
virtual QgsPointCloudLayer *addPointCloudLayer( const QString &url, const QString &baseName, const QString &providerKey ) = 0;
%Docstring
Adds a point cloud layer to the current project.
.. versionadded:: 3.18
%End
virtual bool addProject( const QString &project ) = 0;
%Docstring
Adds (opens) a project
%End
virtual bool newProject( bool promptToSaveFlag = false ) = 0;
%Docstring
Starts a new blank project.
If ``promptToSaveFlag`` is ``True`` then users will be prompted to save any currently open
project (if that project has changes). If the flag is ``False``, then the current project will
be closed without prompting to save (possibly resulting in data loss).
Since QGIS 3.10.1, returns ``True`` if a new project was created, or ``False`` if the operation was not successful (e.g.
the user opted to cancel when prompted to save the current project).
%End
virtual void reloadConnections( ) = 0;
%Docstring
Triggered when connections have changed.
This calls reloadConnections in the main application and triggers a signal that is
forwarded to the GUI elements that needs to be updated (i.e. the source
select dialogs and the browser widgets)
.. versionadded:: 3.0
%End
virtual bool setActiveLayer( QgsMapLayer * ) = 0;
%Docstring
Set the active layer (layer gets selected in the legend)
returns ``True`` if the layer exists, ``False`` otherwise
%End
virtual void copySelectionToClipboard( QgsMapLayer * ) = 0;
%Docstring
Copy selected features from the layer to clipboard
.. versionadded:: 3.0
%End
virtual void pasteFromClipboard( QgsMapLayer * ) = 0;
%Docstring
Paste features from clipboard to the layer
.. versionadded:: 3.0
%End
virtual int addToolBarIcon( QAction *qAction ) = 0;
%Docstring
Add an icon to the plugins toolbar
%End
virtual QAction *addToolBarWidget( QWidget *widget /Transfer/ ) = 0;
%Docstring
Add a widget to the plugins toolbar.
To remove this widget again, call :py:func:`~QgisInterface.removeToolBarIcon`
with the returned QAction.
:param widget: widget to add. The toolbar will take ownership of this widget
:return: the QAction you can use to remove this widget from the toolbar
%End
virtual void removeToolBarIcon( QAction *qAction ) = 0;
%Docstring
Remove an action (icon) from the plugin toolbar
%End
virtual QAction *addRasterToolBarWidget( QWidget *widget /Transfer/ ) = 0;
%Docstring
Add a widget to the raster toolbar.
To remove this widget again, call :py:func:`~QgisInterface.removeRasterToolBarIcon`
with the returned QAction.
:param widget: widget to add. The toolbar will take ownership of this widget
:return: the QAction you can use to remove this widget from the toolbar
%End
virtual int addRasterToolBarIcon( QAction *qAction ) = 0;
%Docstring
Add an icon to the Raster toolbar
%End
virtual void removeRasterToolBarIcon( QAction *qAction ) = 0;
%Docstring
Remove an action (icon) from the Raster toolbar
%End
virtual int addVectorToolBarIcon( QAction *qAction ) = 0;
%Docstring
Add an icon to the Vector toolbar
%End
virtual QAction *addVectorToolBarWidget( QWidget *widget /Transfer/ ) = 0;
%Docstring
Add a widget to the vector toolbar.
To remove this widget again, call :py:func:`~QgisInterface.removeVectorToolBarIcon`
with the returned QAction.
:param widget: widget to add. The toolbar will take ownership of this widget
:return: the QAction you can use to remove this widget from the toolbar
%End
virtual void removeVectorToolBarIcon( QAction *qAction ) = 0;
%Docstring
Remove an action (icon) from the Vector toolbar
%End
virtual int addDatabaseToolBarIcon( QAction *qAction ) = 0;
%Docstring
Add an icon to the Database toolbar
%End
virtual QAction *addDatabaseToolBarWidget( QWidget *widget /Transfer/ ) = 0;
%Docstring
Add a widget to the database toolbar.
To remove this widget again, call :py:func:`~QgisInterface.removeDatabaseToolBarIcon`
with the returned QAction.
:param widget: widget to add. The toolbar will take ownership of this widget
:return: the QAction you can use to remove this widget from the toolbar
%End
virtual void removeDatabaseToolBarIcon( QAction *qAction ) = 0;
%Docstring
Remove an action (icon) from the Database toolbar
%End
virtual int addWebToolBarIcon( QAction *qAction ) = 0;
%Docstring
Add an icon to the Web toolbar
%End
virtual QAction *addWebToolBarWidget( QWidget *widget /Transfer/ ) = 0;
%Docstring
Add a widget to the web toolbar.
To remove this widget again, call :py:func:`~QgisInterface.removeWebToolBarIcon`
with the returned QAction.
:param widget: widget to add. The toolbar will take ownership of this widget
:return: the QAction you can use to remove this widget from the toolbar
%End
virtual void removeWebToolBarIcon( QAction *qAction ) = 0;
%Docstring
Remove an action (icon) from the Web toolbar
%End
virtual QToolBar *addToolBar( const QString &name ) = 0 /Factory/;
%Docstring
Add toolbar with specified name
%End
virtual void addToolBar( QToolBar *toolbar /Transfer/, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0;
%Docstring
Add a toolbar
.. versionadded:: 2.3
%End
virtual void openMessageLog() = 0;
%Docstring
Opens the message log dock widget.
%End
virtual void addUserInputWidget( QWidget *widget ) = 0;
%Docstring
Adds a widget to the user input tool bar.
%End
virtual void showLayoutManager() = 0;
%Docstring
Opens the layout manager dialog.
.. versionadded:: 3.0
%End