-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsapplication.sip
788 lines (652 loc) · 20.4 KB
/
qgsapplication.sip
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsapplication.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsApplication : QApplication
{
%Docstring
Extends QApplication to provide access to QGIS specific resources such
as theme paths, database paths etc.
This is a subclass of QApplication and should be instantiated in place of
QApplication. Most methods are static in keeping with the design of QApplication.
This class hides platform-specific path information and provides
a portable way of referencing specific files and directories.
Ideally, hard-coded paths should appear only here and not in other modules
so that platform-conditional code is minimized and paths are easier
to change due to centralization.
%End
%TypeHeaderCode
#include "qgsapplication.h"
%End
%TypeCode
// Convert a Python argv list to a conventional C argc count and argv array.
static char **qtgui_ArgvToC( PyObject *argvlist, int &argc )
{
char **argv;
argc = PyList_GET_SIZE( argvlist );
// Allocate space for two copies of the argument pointers, plus the
// terminating NULL.
if ( ( argv = ( char ** )sipMalloc( 2 * ( argc + 1 ) * sizeof( char * ) ) ) == NULL )
return NULL;
// Convert the list.
for ( int a = 0; a < argc; ++a )
{
char *arg;
// Get the argument and allocate memory for it.
if ( ( arg = PyBytes_AsString( PyList_GET_ITEM( argvlist, a ) ) ) == NULL ||
( argv[a] = ( char * )sipMalloc( strlen( arg ) + 1 ) ) == NULL )
return NULL;
// Copy the argument and save a pointer to it.
strcpy( argv[a], arg );
argv[a + argc + 1] = argv[a];
}
argv[argc + argc + 1] = argv[argc] = NULL;
return argv;
}
// Remove arguments from the Python argv list that have been removed from the
// C argv array.
static void qtgui_UpdatePyArgv( PyObject *argvlist, int argc, char **argv )
{
for ( int a = 0, na = 0; a < argc; ++a )
{
// See if it was removed.
if ( argv[na] == argv[a + argc + 1] )
++na;
else
PyList_SetSlice( argvlist, na, na + 1, NULL );
}
}
%End
public:
static const char *QGIS_ORGANIZATION_NAME;
static const char *QGIS_ORGANIZATION_DOMAIN;
static const char *QGIS_APPLICATION_NAME;
QgsApplication( SIP_PYLIST argv, bool GUIenabled, QString profileFolder = QString(), QString platformName = "desktop" ) / PostHook = __pyQtQAppHook__ / [( int &argc, char **argv, bool GUIenabled, const QString &profileFolder = QString(), const QString &platformName = "desktop" )];
%MethodCode
// The Python interface is a list of argument strings that is modified.
int argc;
char **argv;
// Convert the list.
if ( ( argv = qtgui_ArgvToC( a0, argc ) ) == NULL )
sipIsErr = 1;
else
{
// Create it now the arguments are right.
static int nargc = argc;
sipCpp = new sipQgsApplication( nargc, argv, a1, *a2, *a3 );
// Now modify the original list.
qtgui_UpdatePyArgv( a0, argc, argv );
}
%End
virtual ~QgsApplication();
static QgsApplication *instance();
%Docstring
Returns the singleton instance of the QgsApplication.
.. versionadded:: 3.0
:rtype: QgsApplication
%End
virtual bool event( QEvent *event );
%Docstring
Watch for QFileOpenEvent.
:rtype: bool
%End
virtual bool notify( QObject *receiver, QEvent *event );
%Docstring
Catch exceptions when sending event to receiver.
:rtype: bool
%End
static void setFileOpenEventReceiver( QObject *receiver );
%Docstring
Set the FileOpen event receiver
%End
static void setThemeName( const QString &themeName );
%Docstring
Set the active theme to the specified theme.
The theme name should be a single word e.g. 'default','classic'.
The theme search path usually will be pkgDataPath + "/themes/" + themName + "/"
but plugin writers etc can use themeName() as a basis for searching
for resources in their own datastores e.g. a Qt4 resource bundle.
.. note::
A basic test will be carried out to ensure the theme search path
based on the supplied theme name exists. If it does not the theme name will
be reverted to 'default'.
%End
static QString themeName();
%Docstring
Set the active theme to the specified theme.
The theme name should be a single word e.g. 'default','classic'.
The theme search path usually will be pkgDataPath + "/themes/" + themName + "/"
but plugin writers etc can use this method as a basis for searching
for resources in their own datastores e.g. a Qt4 resource bundle.
:rtype: str
%End
static void setUITheme( const QString &themeName );
%Docstring
Set the current UI theme used to style the interface. Use uiThemes() to
find valid themes to use. Variables found in variables.qss will be added to the stylesheet
on load.
\param themeName The name of the theme.
.. note::
using an invalid theme name will reset to default
%End
static QHash<QString, QString> uiThemes();
%Docstring
All themes found in ~/.qgis3/themes folder.
The path is to the root folder for the theme
.. note::
Valid theme folders must contain a style.qss file.
:return: A hash of theme name and theme path. Valid theme folders contain style.qss
:rtype: QHash<str, QString>
%End
static QString authorsFilePath();
%Docstring
Returns the path to the authors file.
:rtype: str
%End
static QString contributorsFilePath();
%Docstring
Returns the path to the contributors file.
Contributors are people who have submitted patches
but don't have commit access. *
:rtype: str
%End
static QString developersMapFilePath();
%Docstring
Returns the path to the developers map file.
The developers map was created by using leaflet framework,
it shows the doc/contributors.json file.
.. versionadded:: 2.7
:rtype: str
%End
static QString sponsorsFilePath();
%Docstring
Returns the path to the sponsors file.
:rtype: str
%End
static QString donorsFilePath();
%Docstring
Returns the path to the donors file.
:rtype: str
%End
static QString translatorsFilePath();
%Docstring
Returns the path to the sponsors file.
:rtype: str
%End
static QString licenceFilePath();
%Docstring
Returns the path to the licence file.
:rtype: str
%End
static QString i18nPath();
%Docstring
Returns the path to the translation directory.
:rtype: str
%End
static QString metadataPath();
%Docstring
Returns the path to the metadata directory.
.. versionadded:: 3.0
:rtype: str
%End
static QString qgisMasterDatabaseFilePath();
%Docstring
Returns the path to the master qgis.db file.
:rtype: str
%End
static QString qgisSettingsDirPath();
%Docstring
Returns the path to the settings directory in user's home dir
:rtype: str
%End
static QString qgisUserDatabaseFilePath();
%Docstring
Returns the path to the user qgis.db file.
:rtype: str
%End
static QString qgisAuthDatabaseFilePath();
%Docstring
Returns the path to the user authentication database file: qgis-auth.db.
:rtype: str
%End
static QString splashPath();
%Docstring
Returns the path to the splash screen image directory.
:rtype: str
%End
static QString iconsPath();
%Docstring
Returns the path to the icons image directory.
:rtype: str
%End
static QString srsDatabaseFilePath();
%Docstring
Returns the path to the srs.db file.
:rtype: str
%End
static QStringList svgPaths();
%Docstring
Returns the paths to svg directories.
:rtype: list of str
%End
static QStringList composerTemplatePaths();
%Docstring
Returns the paths to composer template directories
:rtype: list of str
%End
static QMap<QString, QString> systemEnvVars();
%Docstring
Returns the system environment variables passed to application.
:rtype: QMap<str, QString>
%End
static QString prefixPath();
%Docstring
Returns the path to the application prefix directory.
:rtype: str
%End
static QString pluginPath();
%Docstring
Returns the path to the application plugin directory.
:rtype: str
%End
static QString pkgDataPath();
%Docstring
Returns the common root path of all application data directories.
:rtype: str
%End
static QString activeThemePath();
%Docstring
Returns the path to the currently active theme directory.
:rtype: str
%End
static QString defaultThemePath();
%Docstring
Returns the path to the default theme directory.
:rtype: str
%End
static QString iconPath( const QString &iconFile );
%Docstring
First it tries to use the active theme path, then default theme path
:rtype: str
%End
static QIcon getThemeIcon( const QString &name );
%Docstring
default theme if the active theme does not have the required icon.
:rtype: QIcon
%End
static QPixmap getThemePixmap( const QString &name );
%Docstring
default theme if the active theme does not have the required icon.
:rtype: QPixmap
%End
static QString userStylePath();
%Docstring
Returns the path to user's style.
:rtype: str
%End
static QRegExp shortNameRegExp();
%Docstring
Returns the short name regular expression for line edit validator
:rtype: QRegExp
%End
static QString userLoginName();
%Docstring
Returns the user's operating system login account name.
.. versionadded:: 2.14
.. seealso:: userFullName()
:rtype: str
%End
static QString userFullName();
%Docstring
Returns the user's operating system login account full display name.
.. versionadded:: 2.14
.. seealso:: userLoginName()
:rtype: str
%End
static QString osName();
%Docstring
Returns a string name of the operating system QGIS is running on.
.. versionadded:: 2.14
.. seealso:: platform()
:rtype: str
%End
static QString platform();
%Docstring
Returns the QGIS platform name, e.g., "desktop" or "server".
.. versionadded:: 2.14
.. seealso:: osName()
:rtype: str
%End
static QString locale();
%Docstring
Returns the QGIS locale.
.. versionadded:: 3.0
:rtype: str
%End
static QString userThemesFolder();
%Docstring
Returns the path to user's themes folder
:rtype: str
%End
static QString defaultStylePath();
%Docstring
Returns the path to default style (works as a starting point).
:rtype: str
%End
static QString defaultThemesFolder();
%Docstring
Returns the path to default themes folder from install (works as a starting point).
:rtype: str
%End
static QString libraryPath();
%Docstring
Returns the path containing qgis_core, qgis_gui, qgispython (and other) libraries
:rtype: str
%End
static QString libexecPath();
%Docstring
Returns the path with utility executables (help viewer, crssync, ...)
:rtype: str
%End
static void setPrefixPath( const QString &prefixPath, bool useDefaultPaths = false );
%Docstring
Alters prefix path - used by 3rd party apps
%End
static void setPluginPath( const QString &pluginPath );
%Docstring
Alters plugin path - used by 3rd party apps
%End
static void setPkgDataPath( const QString &pkgDataPath );
%Docstring
Alters pkg data path - used by 3rd party apps
%End
static void setDefaultSvgPaths( const QStringList &pathList );
%Docstring
Alters default svg paths - used by 3rd party apps.
%End
static void setAuthDatabaseDirPath( const QString &authDbDirPath );
%Docstring
Alters authentication data base directory path - used by 3rd party apps
%End
static void initQgis();
%Docstring
loads providers
%End
static bool createDatabase( QString *errorMessage = 0 );
%Docstring
initialize qgis.db
:rtype: bool
%End
static bool createThemeFolder();
%Docstring
Create the users theme folder
:rtype: bool
%End
static void exitQgis();
%Docstring
deletes provider registry and map layer registry
%End
static QString appIconPath();
%Docstring
get application icon
:rtype: str
%End
enum endian_t
{
XDR,
NDR
};
static endian_t endian();
%Docstring
Returns whether this machine uses big or little endian
:rtype: endian_t
%End
static QString reportStyleSheet();
%Docstring
get a standard css style sheet for reports.
Typically you will use this method by doing:
QString myStyle = QgsApplication.reportStyleSheet();
textBrowserReport->document()->setDefaultStyleSheet(myStyle);
:return: QString containing the CSS 2.1 compliant stylesheet.
.. note::
you can use the special Qt extensions too, for example
the gradient fills for backgrounds.
:rtype: str
%End
static QString showSettings();
%Docstring
Convenience function to get a summary of the paths used in this
application instance useful for debugging mainly.*
:rtype: str
%End
static void registerOgrDrivers();
%Docstring
Register OGR drivers ensuring this only happens once.
This is a workaround for an issue with older gdal versions that
caused duplicate driver name entries to appear in the list
of registered drivers when QgsApplication.registerOgrDrivers was called multiple
times.
%End
static QString absolutePathToRelativePath( const QString &apath, const QString &targetPath );
%Docstring
Converts absolute path to path relative to target
:rtype: str
%End
static QString relativePathToAbsolutePath( const QString &rpath, const QString &targetPath );
%Docstring
Converts path relative to target to an absolute path
:rtype: str
%End
static bool isRunningFromBuildDir();
%Docstring
Indicates whether running from build directory (not installed)
:rtype: bool
%End
static QString buildSourcePath();
%Docstring
Returns path to the source directory. Valid only when running from build directory
:rtype: str
%End
static QString buildOutputPath();
%Docstring
Returns path to the build output directory. Valid only when running from build directory
:rtype: str
%End
static void skipGdalDriver( const QString &driver );
%Docstring
Sets the GDAL_SKIP environment variable to include the specified driver
and then calls GDALDriverManager.AutoSkipDrivers() to unregister it. The
driver name should be the short format of the Gdal driver name e.g. GTIFF.
%End
static void restoreGdalDriver( const QString &driver );
%Docstring
Sets the GDAL_SKIP environment variable to exclude the specified driver
and then calls GDALDriverManager.AutoSkipDrivers() to unregister it. The
driver name should be the short format of the Gdal driver name e.g. GTIFF.
%End
static QStringList skippedGdalDrivers();
%Docstring
Returns the list of gdal drivers that should be skipped (based on
GDAL_SKIP environment variable)
:rtype: list of str
%End
static void applyGdalSkippedDrivers();
%Docstring
Apply the skipped drivers list to gdal
.. seealso:: skipGdalDriver
.. seealso:: restoreGdalDriver
.. seealso:: skippedGdalDrivers *
%End
static int maxThreads();
%Docstring
Get maximum concurrent thread count
.. versionadded:: 2.4
:rtype: int
%End
static void setMaxThreads( int maxThreads );
%Docstring
Set maximum concurrent thread count
.. note::
must be between 1 and \#cores, -1 means use all available cores
.. versionadded:: 2.4
%End
static QgsTaskManager *taskManager();
%Docstring
Returns the application's task manager, used for managing application
wide background task handling.
.. versionadded:: 3.0
:rtype: QgsTaskManager
%End
static QgsColorSchemeRegistry *colorSchemeRegistry();
%Docstring
Returns the application's color scheme registry, used for managing color schemes.
.. versionadded:: 3.0
:rtype: QgsColorSchemeRegistry
%End
static QgsPaintEffectRegistry *paintEffectRegistry();
%Docstring
Returns the application's paint effect registry, used for managing paint effects.
.. versionadded:: 3.0
:rtype: QgsPaintEffectRegistry
%End
static QgsRendererRegistry *rendererRegistry();
%Docstring
Returns the application's renderer registry, used for managing vector layer renderers.
.. versionadded:: 3.0
:rtype: QgsRendererRegistry
%End
static QgsDataItemProviderRegistry *dataItemProviderRegistry();
%Docstring
Returns the application's data item provider registry, which keeps a list of data item
providers that may add items to the browser tree.
.. versionadded:: 3.0
:rtype: QgsDataItemProviderRegistry
%End
static QgsSvgCache *svgCache();
%Docstring
Returns the application's SVG cache, used for caching SVG images and handling parameter replacement
within SVG files.
.. versionadded:: 3.0
:rtype: QgsSvgCache
%End
static QgsSymbolLayerRegistry *symbolLayerRegistry();
%Docstring
Returns the application's symbol layer registry, used for managing symbol layers.
.. versionadded:: 3.0
:rtype: QgsSymbolLayerRegistry
%End
static QgsLayoutItemRegistry *layoutItemRegistry();
%Docstring
Returns the application's layout item registry, used for layout item types.
.. versionadded:: 3.0
:rtype: QgsLayoutItemRegistry
%End
static QgsGPSConnectionRegistry *gpsConnectionRegistry();
%Docstring
Returns the application's GPS connection registry, used for managing GPS connections.
.. versionadded:: 3.0
:rtype: QgsGPSConnectionRegistry
%End
static QgsPluginLayerRegistry *pluginLayerRegistry();
%Docstring
Returns the application's plugin layer registry, used for managing plugin layer types.
.. versionadded:: 3.0
:rtype: QgsPluginLayerRegistry
%End
static QgsMessageLog *messageLog();
%Docstring
Returns the application's message log.
.. versionadded:: 3.0
:rtype: QgsMessageLog
%End
static QgsProcessingRegistry *processingRegistry();
%Docstring
Returns the application's processing registry, used for managing processing providers,
algorithms, and various parameters and outputs.
.. versionadded:: 3.0
:rtype: QgsProcessingRegistry
%End
static QgsPageSizeRegistry *pageSizeRegistry();
%Docstring
Returns the application's page size registry, used for managing layout page sizes.
.. versionadded:: 3.0
:rtype: QgsPageSizeRegistry
%End
static QgsActionScopeRegistry *actionScopeRegistry();
%Docstring
Returns the action scope registry.
.. versionadded:: 3.0
:rtype: QgsActionScopeRegistry
%End
static QgsRuntimeProfiler *profiler();
%Docstring
Returns the application runtime profiler.
.. versionadded:: 3.0
:rtype: QgsRuntimeProfiler
%End
static QgsFieldFormatterRegistry *fieldFormatterRegistry();
%Docstring
Get the registry of available field formatters.
:rtype: QgsFieldFormatterRegistry
%End
static QString nullRepresentation();
%Docstring
This string is used to represent the value `NULL` throughout QGIS.
In general, when passing values around, prefer to use a null QVariant
`QVariant( field.type() )` or `QVariant( QVariant.Int )`. This value
should only be used in the final presentation step when showing values
in a widget or sending it to a web browser.
:rtype: str
%End
static void setNullRepresentation( const QString &nullRepresentation );
%Docstring
\copydoc nullRepresentation()
%End
static QVariantMap customVariables();
%Docstring
Custom expression variables for this application.
This does not include generated variables (like system name, user name etc.)
.. seealso:: QgsExpressionContextUtils.globalVariables().
.. versionadded:: 3.0
:rtype: QVariantMap
%End
static void setCustomVariables( const QVariantMap &customVariables );
%Docstring
Custom expression variables for this application.
Do not include generated variables (like system name, user name etc.)
.. seealso:: QgsExpressionContextUtils.globalVariables().
.. versionadded:: 3.0
%End
static void setCustomVariable( const QString &name, const QVariant &value );
%Docstring
Set a single custom expression variable.
.. versionadded:: 3.0
%End
%If (ANDROID)
//dummy method to workaround sip generation issue
bool x11EventFilter( XEvent *event );
%Docstring
:rtype: bool
%End
%End
signals:
void customVariablesChanged();
%Docstring
Emitted whenever a custom global variable changes.
.. versionadded:: 3.0
%End
void nullRepresentationChanged();
%Docstring
\copydoc nullRepresentation()
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsapplication.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/