-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsdataitem.sip
760 lines (606 loc) · 18.2 KB
/
qgsdataitem.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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsdataitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsDataItem : QObject
{
%Docstring
Base class for all items in the model.
Parent/children hierarchy is not based on QObject.
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
%ConvertToSubClassCode
if ( qobject_cast<QgsLayerItem *>( sipCpp ) )
sipType = sipType_QgsLayerItem;
else if ( qobject_cast<QgsErrorItem *>( sipCpp ) )
sipType = sipType_QgsErrorItem;
else if ( qobject_cast<QgsDirectoryItem *>( sipCpp ) )
sipType = sipType_QgsDirectoryItem;
else if ( qobject_cast<QgsFavoritesItem *>( sipCpp ) )
sipType = sipType_QgsFavoritesItem;
else if ( qobject_cast<QgsZipItem *>( sipCpp ) )
sipType = sipType_QgsZipItem;
else if ( qobject_cast<QgsDataCollectionItem *>( sipCpp ) )
sipType = sipType_QgsDataCollectionItem;
else if ( qobject_cast<QgsProjectItem *>( sipCpp ) )
sipType = sipType_QgsProjectItem;
else
sipType = 0;
%End
public:
enum Type
{
Collection,
Directory,
Layer,
Error,
Favorites,
Project,
Custom,
};
QgsDataItem( QgsDataItem::Type type, QgsDataItem *parent /TransferThis/, const QString &name, const QString &path );
%Docstring
Create new data item.
%End
virtual ~QgsDataItem();
bool hasChildren();
%Docstring
:rtype: bool
%End
int rowCount();
%Docstring
:rtype: int
%End
virtual QVector<QgsDataItem *> createChildren() /Factory/;
%Docstring
Create children. Children are not expected to have parent set.
This method MUST BE THREAD SAFE. *
:rtype: list of QgsDataItem
%End
enum State
{
NotPopulated,
Populating,
Populated
};
State state() const;
%Docstring
.. versionadded:: 2.8
:rtype: State
%End
virtual void setState( State state );
%Docstring
Set item state. It also take care about starting/stopping loading icon animation.
\param state
.. versionadded:: 2.8
%End
virtual void addChildItem( QgsDataItem *child /Transfer/, bool refresh = false );
%Docstring
Inserts a new child item. The child will be inserted at a position using an alphabetical order based on mName.
\param child child item to insert. Ownership is transferred, and item parent will be set and relevant connections made.
\param refresh - set to true to refresh populated item, emitting relevant signals to the model
.. seealso:: :py:func:`deleteChildItem()`
%End
virtual void deleteChildItem( QgsDataItem *child );
%Docstring
Removes and deletes a child item, emitting relevant signals to the model.
\param child child to remove. Item must exist as a current child.
.. seealso:: :py:func:`addChildItem()`
%End
virtual QgsDataItem *removeChildItem( QgsDataItem *child ) /TransferBack/;
%Docstring
Removes a child item and returns it without deleting it. Emits relevant signals to model as required.
\param child child to remove
:return: pointer to the removed item or null if no such item was found
:rtype: QgsDataItem
%End
virtual bool equal( const QgsDataItem *other );
%Docstring
Returns true if this item is equal to another item (by testing item type and path).
:rtype: bool
%End
virtual QWidget *paramWidget() /Factory/;
%Docstring
:rtype: QWidget
%End
virtual QList<QAction *> actions( QWidget *parent );
%Docstring
Returns the list of actions available for this item. This is usually used for the popup menu on right-clicking
the item. Subclasses should override this to provide actions.
Subclasses should ensure that ownership of created actions is correctly handled by parenting them
to the specified parent widget.
:rtype: list of QAction
%End
virtual QList<QMenu *> menus( QWidget *parent );
%Docstring
Returns the list of menus available for this item. This is usually used for the popup menu on right-clicking
the item. Subclasses should override this to provide actions. Subclasses should ensure that ownership of
created menus is correctly handled by parenting them to the specified parent widget.
\param parent a parent widget of the menu
:return: list of menus
.. versionadded:: 3.0
:rtype: list of QMenu
%End
virtual bool acceptDrop();
%Docstring
Returns whether the item accepts drag and dropped layers - e.g. for importing a dataset to a provider.
Subclasses should override this and handleDrop() to accept dropped layers.
.. seealso:: :py:func:`handleDrop()`
:rtype: bool
%End
virtual bool handleDrop( const QMimeData * /*data*/, Qt::DropAction /*action*/ );
%Docstring
Attempts to process the mime data dropped on this item. Subclasses must override this and acceptDrop() if they
accept dropped layers.
.. seealso:: :py:func:`acceptDrop()`
:rtype: bool
%End
virtual bool handleDoubleClick();
%Docstring
Called when a user double clicks on the item. Subclasses should return true
if they have implemented a double-click handler and do not want the default
double-click behavior for items.
.. versionadded:: 3.0
:rtype: bool
%End
virtual bool hasDragEnabled() const;
%Docstring
Returns true if the item may be dragged.
Default implementation returns false.
A draggable item has to implement mimeUri() that will be used to pass data.
.. seealso:: :py:func:`mimeUri()`
.. versionadded:: 3.0
:rtype: bool
%End
virtual QgsMimeDataUtils::Uri mimeUri() const;
%Docstring
Return mime URI for the data item.
Items that return valid URI will be returned in mime data when dragging a selection from browser model.
.. seealso:: :py:func:`hasDragEnabled()`
.. versionadded:: 3.0
:rtype: QgsMimeDataUtils.Uri
%End
enum Capability
{
NoCapabilities,
SetCrs,
Fertile,
Fast,
Collapse
};
typedef QFlags<QgsDataItem::Capability> Capabilities;
virtual bool setCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Writes the selected crs into data source. The original data source will be modified when calling this
method.
:rtype: bool
%End
virtual Capabilities capabilities2() const;
%Docstring
:rtype: Capabilities
%End
virtual void setCapabilities( Capabilities capabilities );
%Docstring
Sets the capabilities for the data item.
%End
static int findItem( QVector<QgsDataItem *> items, QgsDataItem *item );
%Docstring
:rtype: int
%End
Type type() const;
%Docstring
:rtype: Type
%End
QgsDataItem *parent() const;
%Docstring
Get item parent. QgsDataItem maintains its own items hierarchy, it does not use
QObject hierarchy. *
:rtype: QgsDataItem
%End
void setParent( QgsDataItem *parent );
%Docstring
Set item parent and connect / disconnect parent to / from item signals.
It does not add itself to parents children (mChildren) *
%End
QVector<QgsDataItem *> children() const;
%Docstring
:rtype: list of QgsDataItem
%End
virtual QIcon icon();
%Docstring
:rtype: QIcon
%End
QString name() const;
%Docstring
:rtype: str
%End
void setName( const QString &name );
QString path() const;
%Docstring
:rtype: str
%End
void setPath( const QString &path );
static QString pathComponent( const QString &component );
%Docstring
Create path component replacing path separators
:rtype: str
%End
virtual QVariant sortKey() const;
%Docstring
Returns the sorting key for the item. By default name() is returned,
but setSortKey() can be used to set a custom sort key for the item.
Alternatively subclasses can override this method to return a custom
sort key.
.. seealso:: :py:func:`setSortKey()`
.. versionadded:: 3.0
:rtype: QVariant
%End
void setSortKey( const QVariant &key );
%Docstring
Sets a custom sorting ``key`` for the item.
.. seealso:: :py:func:`sortKey()`
.. versionadded:: 3.0
%End
void setIcon( const QIcon &icon );
void setIconName( const QString &iconName );
void setToolTip( const QString &msg );
QString toolTip() const;
%Docstring
:rtype: str
%End
static void deleteLater( QVector<QgsDataItem *> &items );
void moveToThread( QThread *targetThread );
%Docstring
Move object and all its descendants to thread
%End
protected:
virtual void populate( const QVector<QgsDataItem *> &children );
virtual void refresh( const QVector<QgsDataItem *> &children );
%Docstring
Refresh the items from a specified list of child items.
%End
bool deferredDelete();
%Docstring
The item is scheduled to be deleted. E.g. if deleteLater() is called when
item is in Populating state (createChildren() running in another thread),
the deferredDelete() returns true and item will be deleted once Populating finished.
Items with slow reateChildren() (for example network or database based) may
check during createChildren() if deferredDelete() returns true and return from
createChildren() immediately because result will be useless. *
:rtype: bool
%End
public slots:
virtual void deleteLater();
%Docstring
Safely delete the item:
- disconnects parent
- unsets parent (but does not remove itself)
- deletes all its descendants recursively
- waits until Populating state (createChildren() in thread) finished without blocking main thread
- calls QObject.deleteLater()
%End
virtual void populate( bool foreground = false );
virtual void depopulate();
%Docstring
Remove children recursively and set as not populated. This is used when refreshing collapsed items.
%End
virtual void refresh();
virtual void refreshConnections();
%Docstring
Refresh connections: update GUI and emit signal
%End
virtual void childrenCreated();
signals:
void beginInsertItems( QgsDataItem *parent, int first, int last );
void endInsertItems();
void beginRemoveItems( QgsDataItem *parent, int first, int last );
void endRemoveItems();
void dataChanged( QgsDataItem *item );
void stateChanged( QgsDataItem *item, QgsDataItem::State oldState );
void connectionsChanged();
%Docstring
Emitted when the provider's connections of the child items have changed
This signal is normally forwarded to the app in order to refresh the connection
item in the provider dialogs and to refresh the connection items in the other
open browsers
%End
protected slots:
void updateIcon();
%Docstring
Will request a repaint of this icon.
.. versionadded:: 3.0
%End
};
QFlags<QgsDataItem::Capability> operator|(QgsDataItem::Capability f1, QFlags<QgsDataItem::Capability> f2);
class QgsLayerItem : QgsDataItem
{
%Docstring
Item that represents a layer that can be opened with one of the providers
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
public:
enum LayerType
{
NoType,
Vector,
Raster,
Point,
Line,
Polygon,
TableLayer,
Database,
Table,
Plugin
};
QgsLayerItem( QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, LayerType layerType, const QString &providerKey );
virtual bool equal( const QgsDataItem *other );
virtual bool hasDragEnabled() const;
virtual QgsMimeDataUtils::Uri mimeUri() const;
QgsMapLayer::LayerType mapLayerType() const;
%Docstring
Returns QgsMapLayer.LayerType
:rtype: QgsMapLayer.LayerType
%End
QString uri() const;
%Docstring
Returns layer uri or empty string if layer cannot be created
:rtype: str
%End
QString providerKey() const;
%Docstring
Returns provider key
:rtype: str
%End
QStringList supportedCrs() const;
%Docstring
Returns the supported CRS
.. versionadded:: 2.8
:rtype: list of str
%End
QStringList supportedFormats() const;
%Docstring
Returns the supported formats
.. versionadded:: 2.8
:rtype: list of str
%End
virtual QString comments() const;
%Docstring
Returns comments of the layer
.. versionadded:: 2.12
:rtype: str
%End
static QString layerTypeAsString( const LayerType &layerType );
%Docstring
Returns the string representation of the given ``layerType``
.. versionadded:: 3
:rtype: str
%End
static QString iconName( const LayerType &layerType );
%Docstring
Returns the icon name of the given ``layerType``
.. versionadded:: 3
:rtype: str
%End
protected:
public:
static QIcon iconPoint();
%Docstring
:rtype: QIcon
%End
static QIcon iconLine();
%Docstring
:rtype: QIcon
%End
static QIcon iconPolygon();
%Docstring
:rtype: QIcon
%End
static QIcon iconTable();
%Docstring
:rtype: QIcon
%End
static QIcon iconRaster();
%Docstring
:rtype: QIcon
%End
static QIcon iconDefault();
%Docstring
:rtype: QIcon
%End
virtual QString layerName() const;
%Docstring
:return: the layer name
:rtype: str
%End
};
class QgsDataCollectionItem : QgsDataItem
{
%Docstring
A Collection: logical collection of layers or subcollections, e.g. GRASS location/mapset, database? wms source?
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
public:
QgsDataCollectionItem( QgsDataItem *parent, const QString &name, const QString &path = QString() );
~QgsDataCollectionItem();
void addChild( QgsDataItem *item /Transfer/ );
static QIcon iconDir(); // shared icon: open/closed directory
static QIcon iconDataCollection(); // default icon for data collection
};
class QgsDirectoryItem : QgsDataCollectionItem
{
%Docstring
A directory: contains subdirectories and layers
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
public:
enum Column
{
Name,
Size,
Date,
Permissions,
Owner,
Group,
Type
};
QgsDirectoryItem( QgsDataItem *parent, const QString &name, const QString &path );
QgsDirectoryItem( QgsDataItem *parent, const QString &name, const QString &dirPath, const QString &path );
%Docstring
Constructor.
\param parent
\param name directory name
\param dirPath path to directory in file system
\param path item path in the tree, it may be dirPath or dirPath with some prefix, e.g. favorites: *
%End
virtual void setState( State state );
virtual QVector<QgsDataItem *> createChildren();
QString dirPath() const;
%Docstring
:rtype: str
%End
virtual bool equal( const QgsDataItem *other );
virtual QIcon icon();
virtual QWidget *paramWidget() /Factory/;
static bool hiddenPath( const QString &path );
%Docstring
Check if the given path is hidden from the browser model
:rtype: bool
%End
virtual QList<QAction *> actions( QWidget *parent );
public slots:
virtual void childrenCreated();
void directoryChanged();
protected:
void init();
};
class QgsProjectItem : QgsDataItem
{
%Docstring
Data item that can be used to represent QGIS projects.
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
public:
QgsProjectItem( QgsDataItem *parent, const QString &name, const QString &path );
%Docstring
A data item holding a reference to a QGIS project file.
\param parent The parent data item.
\param name The name of the of the project. Displayed to the user.
\param path The full path to the project.
%End
virtual bool hasDragEnabled() const;
};
class QgsErrorItem : QgsDataItem
{
%Docstring
Data item that can be used to report problems (e.g. network error)
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
public:
QgsErrorItem( QgsDataItem *parent, const QString &error, const QString &path );
};
class QgsDirectoryParamWidget : QTreeWidget
{
%TypeHeaderCode
#include "qgsdataitem.h"
%End
public:
QgsDirectoryParamWidget( const QString &path, QWidget *parent /TransferThis/ = 0 );
protected:
virtual void mousePressEvent( QMouseEvent *event );
public slots:
void showHideColumn();
};
class QgsFavoritesItem : QgsDataCollectionItem
{
%Docstring
Contains various Favorites directories
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
public:
QgsFavoritesItem( QgsDataItem *parent, const QString &name, const QString &path = QString() );
%Docstring
Constructor for QgsFavoritesItem. Accepts a path argument specifying the file path associated with
the item.
%End
virtual QVector<QgsDataItem *> createChildren();
void addDirectory( const QString &directory );
%Docstring
Adds a new directory to the favorites group.
.. seealso:: :py:func:`removeDirectory()`
%End
void removeDirectory( QgsDirectoryItem *item );
%Docstring
Removes an existing directory from the favorites group.
.. seealso:: :py:func:`addDirectory()`
%End
static QIcon iconFavorites();
%Docstring
Icon for favorites group
:rtype: QIcon
%End
virtual QVariant sortKey() const;
};
class QgsZipItem : QgsDataCollectionItem
{
%Docstring
A zip file: contains layers, using GDAL/OGR VSIFILE mechanism
%End
%TypeHeaderCode
#include "qgsdataitem.h"
%End
protected:
public:
QgsZipItem( QgsDataItem *parent, const QString &name, const QString &path );
QgsZipItem( QgsDataItem *parent, const QString &name, const QString &filePath, const QString &path );
virtual QVector<QgsDataItem *> createChildren();
QStringList getZipFileList();
%Docstring
:rtype: list of str
%End
static QStringList sProviderNames;
static QString vsiPrefix( const QString &uri );
%Docstring
:rtype: str
%End
static QgsDataItem *itemFromPath( QgsDataItem *parent, const QString &path, const QString &name ) /Factory/;
%Docstring
Creates a new data item from the specified path.
:rtype: QgsDataItem
%End
static QgsDataItem *itemFromPath( QgsDataItem *parent, const QString &filePath, const QString &name, const QString &path ) /Factory,PyName=itemFromFilePath/;
%Docstring
Creates a new data item from the specified path.
.. note::
available in Python as itemFromFilePath
:rtype: QgsDataItem
%End
static QIcon iconZip();
%Docstring
:rtype: QIcon
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsdataitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/