Skip to content

Commit bd95061

Browse files
nyalldawsonnyalldawson
committedOct 30, 2016
Rename visible "favourite" strings to "favorite", change API to
use "favorite"
·
ltr-3_44final-3_0_0
1 parent 82312e1 commit bd95061

File tree

10 files changed

+134
-69
lines changed

10 files changed

+134
-69
lines changed
 

‎doc/api_break.dox‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Renamed Classes {#qgis_api_break_3_0_renamed_classes}
6161
<tr><td>QgsEditorWidgetV2<td>QgsEditorWidget
6262
<tr><td>QgsEllipseSymbolLayerV2<td>QgsEllipseSymbolLayer
6363
<tr><td>QgsEllipseSymbolLayerV2Widget<td>QgsEllipseSymbolLayerWidget
64+
<tr><td>QgsFavouritesItem<td>QgsFavoritesItem
6465
<tr><td>QgsFeatureRendererV2<td>QgsFeatureRenderer
6566
<tr><td>QgsFillSymbolLayerV2<td>QgsFillSymbolLayer
6667
<tr><td>QgsFillSymbolV2<td>QgsFillSymbol
@@ -352,6 +353,11 @@ QgsAuthMethod {#qgis_api_break_3_0_QgsAuthMethod}
352353
- DataSourceURI has been renamed to DataSourceUri
353354
- GenericDataSourceURI has been renamed to GenericDataSourceUri
354355

356+
QgsBrowserModel {#qgis_api_break_3_0_QgsBrowserModel}
357+
---------------
358+
359+
- addFavouriteDirectory has been renamed to addFavoriteDirectory
360+
- removeFavourite has been renamed to removeFavorite
355361

356362
QgsCachedFeatureIterator {#qgis_api_break_3_0_QgsQgsCachedFeatureIterator}
357363
------------------------
@@ -624,7 +630,7 @@ QgsDataItem {#qgis_api_break_3_0_QgsDataItem}
624630
- isPopulated() has been removed. Use state() instead.
625631
- capabilities() has been removed. Use capabilities2() instead (TODO: rename back to capabilities()).
626632
- emitBeginInsertItems(), emitEndInsertItems(), emitBeginRemoveItems(), emitEndRemoveItems(), emitDataChanged(), emitStateChanged() have been removed.
627-
633+
- Favourites was renamed to Favorites
628634

629635
QgsDataSourceURI {#qgis_api_break_3_0_QgsDatasourceUri}
630636
----------------

‎python/core/qgsbrowsermodel.sip‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,20 @@ class QgsBrowserModel : QAbstractItemModel
9595
void itemDataChanged( QgsDataItem * item );
9696
void itemStateChanged( QgsDataItem * item, QgsDataItem::State oldState );
9797

98-
void addFavouriteDirectory( const QString& favDir );
99-
void removeFavourite( const QModelIndex &index );
98+
/**
99+
* Adds a directory to the favorites group.
100+
* @note added in QGIS 3.0
101+
* @see removeFavorite()
102+
*/
103+
void addFavoriteDirectory( const QString& directory );
104+
105+
/**
106+
* Removes a favorite directory from its corresponding model index.
107+
* @note added in QGIS 3.0
108+
* @see addFavoriteDirectory()
109+
*/
110+
void removeFavorite( const QModelIndex &index );
111+
100112
void updateProjectHome();
101113

102114
/** Hide the given path in the browser model */

‎python/core/qgsdataitem.sip‎

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ class QgsDataItem : QObject
4343
sipType = sipType_QgsErrorItem;
4444
else if (qobject_cast<QgsDirectoryItem*>(sipCpp))
4545
sipType = sipType_QgsDirectoryItem;
46-
else if (qobject_cast<QgsFavouritesItem*>(sipCpp))
47-
sipType = sipType_QgsFavouritesItem;
46+
else if (qobject_cast<QgsFavoritesItem*>(sipCpp))
47+
sipType = sipType_QgsFavoritesItem;
4848
else if (qobject_cast<QgsZipItem*>(sipCpp))
4949
sipType = sipType_QgsZipItem;
5050
else if (qobject_cast<QgsDataCollectionItem*>(sipCpp))
@@ -61,8 +61,8 @@ class QgsDataItem : QObject
6161
Directory,
6262
Layer,
6363
Error,
64-
Favourites,
65-
Project //! Represents a QGIS project
64+
Favorites, //!< Represents a favorite item
65+
Project //!< Represents a QGIS project
6666
};
6767

6868
/** Create new data item. */
@@ -359,7 +359,7 @@ class QgsDirectoryItem : QgsDataCollectionItem
359359
* @param parent
360360
* @param name directory name
361361
* @param dirPath path to directory in file system
362-
* @param path item path in the tree, it may be dirPath or dirPath with some prefix, e.g. favourites: */
362+
* @param path item path in the tree, it may be dirPath or dirPath with some prefix, e.g. favorites: */
363363
QgsDirectoryItem( QgsDataItem* parent, const QString& name, const QString& dirPath, const QString& path );
364364

365365
~QgsDirectoryItem();
@@ -444,22 +444,40 @@ class QgsDirectoryParamWidget : QTreeWidget
444444
void showHideColumn();
445445
};
446446

447-
/** Contains various Favourites directories */
448-
class QgsFavouritesItem : QgsDataCollectionItem
447+
/** \ingroup core
448+
* Contains various Favorites directories
449+
* \note added in QGIS 3.0
450+
*/
451+
class QgsFavoritesItem : QgsDataCollectionItem
449452
{
450453
%TypeHeaderCode
451454
#include <qgsdataitem.h>
452455
%End
453456
public:
454-
QgsFavouritesItem( QgsDataItem* parent, const QString& name, const QString& path = QString() );
455-
~QgsFavouritesItem();
457+
458+
/**
459+
* Constructor for QgsFavoritesItem. Accepts a path argument specifying the file path associated with
460+
* the item.
461+
*/
462+
QgsFavoritesItem( QgsDataItem* parent, const QString& name, const QString& path = QString() );
463+
~QgsFavoritesItem();
456464

457465
QVector<QgsDataItem*> createChildren();
458466

459-
void addDirectory( const QString& favIcon );
467+
/**
468+
* Adds a new directory to the favorites group.
469+
* @see removeDirectory()
470+
*/
471+
void addDirectory( const QString& directory );
472+
473+
/**
474+
* Removes an existing directory from the favorites group.
475+
* @see addDirectory()
476+
*/
460477
void removeDirectory( QgsDirectoryItem *item );
461478

462-
static const QIcon &iconFavourites();
479+
//! Icon for favorites group
480+
static const QIcon &iconFavorites();
463481
};
464482

465483
/** A zip file: contains layers, using GDAL/OGR VSIFILE mechanism */

‎src/app/qgsbrowserdockwidget.cpp‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -385,17 +385,17 @@ void QgsBrowserDockWidget::showContextMenu( QPoint pt )
385385
{
386386
QSettings settings;
387387
QStringList favDirs = settings.value( QStringLiteral( "/browser/favourites" ) ).toStringList();
388-
bool inFavDirs = item->parent() && item->parent()->type() == QgsDataItem::Favourites;
388+
bool inFavDirs = item->parent() && item->parent()->type() == QgsDataItem::Favorites;
389389

390390
if ( item->parent() && !inFavDirs )
391391
{
392-
// only non-root directories can be added as favourites
393-
menu->addAction( tr( "Add as a Favourite" ), this, SLOT( addFavourite() ) );
392+
// only non-root directories can be added as favorites
393+
menu->addAction( tr( "Add as a Favorite" ), this, SLOT( addFavorite() ) );
394394
}
395395
else if ( inFavDirs )
396396
{
397-
// only favourites can be removed
398-
menu->addAction( tr( "Remove Favourite" ), this, SLOT( removeFavourite() ) );
397+
// only favorites can be removed
398+
menu->addAction( tr( "Remove Favorite" ), this, SLOT( removeFavorite() ) );
399399
}
400400
menu->addAction( tr( "Properties..." ), this, SLOT( showProperties() ) );
401401
menu->addAction( tr( "Hide from Browser" ), this, SLOT( hideItem() ) );
@@ -410,9 +410,9 @@ void QgsBrowserDockWidget::showContextMenu( QPoint pt )
410410
menu->addAction( tr( "Add Selected Layers" ), this, SLOT( addSelectedLayers() ) );
411411
menu->addAction( tr( "Properties..." ), this, SLOT( showProperties() ) );
412412
}
413-
else if ( item->type() == QgsDataItem::Favourites )
413+
else if ( item->type() == QgsDataItem::Favorites )
414414
{
415-
menu->addAction( tr( "Add a Directory..." ), this, SLOT( addFavouriteDirectory() ) );
415+
menu->addAction( tr( "Add a Directory..." ), this, SLOT( addFavoriteDirectory() ) );
416416

417417
}
418418

@@ -434,7 +434,7 @@ void QgsBrowserDockWidget::showContextMenu( QPoint pt )
434434
menu->popup( mBrowserView->mapToGlobal( pt ) );
435435
}
436436

437-
void QgsBrowserDockWidget::addFavourite()
437+
void QgsBrowserDockWidget::addFavorite()
438438
{
439439
QModelIndex index = mProxyModel->mapToSource( mBrowserView->currentIndex() );
440440
QgsDataItem* item = mModel->dataItem( index );
@@ -445,26 +445,26 @@ void QgsBrowserDockWidget::addFavourite()
445445
if ( !dirItem )
446446
return;
447447

448-
addFavouriteDirectory( dirItem->dirPath() );
448+
addFavoriteDirectory( dirItem->dirPath() );
449449
}
450450

451-
void QgsBrowserDockWidget::addFavouriteDirectory()
451+
void QgsBrowserDockWidget::addFavoriteDirectory()
452452
{
453-
QString directory = QFileDialog::getExistingDirectory( this, tr( "Add directory to favourites" ) );
453+
QString directory = QFileDialog::getExistingDirectory( this, tr( "Add directory to favorites" ) );
454454
if ( !directory.isEmpty() )
455455
{
456-
addFavouriteDirectory( directory );
456+
addFavoriteDirectory( directory );
457457
}
458458
}
459459

460-
void QgsBrowserDockWidget::addFavouriteDirectory( const QString& favDir )
460+
void QgsBrowserDockWidget::addFavoriteDirectory( const QString& favDir )
461461
{
462-
mModel->addFavouriteDirectory( favDir );
462+
mModel->addFavoriteDirectory( favDir );
463463
}
464464

465-
void QgsBrowserDockWidget::removeFavourite()
465+
void QgsBrowserDockWidget::removeFavorite()
466466
{
467-
mModel->removeFavourite( mProxyModel->mapToSource( mBrowserView->currentIndex() ) );
467+
mModel->removeFavorite( mProxyModel->mapToSource( mBrowserView->currentIndex() ) );
468468
}
469469

470470
void QgsBrowserDockWidget::refresh()

‎src/app/qgsbrowserdockwidget.h‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,15 @@ class APP_EXPORT QgsBrowserDockWidget : public QgsDockWidget, private Ui::QgsBro
106106
public:
107107
explicit QgsBrowserDockWidget( const QString& name, QWidget *parent = nullptr );
108108
~QgsBrowserDockWidget();
109-
void addFavouriteDirectory( const QString& favDir );
109+
void addFavoriteDirectory( const QString& favDir );
110110

111111
public slots:
112112
void addLayerAtIndex( const QModelIndex& index );
113113
void showContextMenu( QPoint );
114114

115-
void addFavourite();
116-
void addFavouriteDirectory();
117-
void removeFavourite();
115+
void addFavorite();
116+
void addFavoriteDirectory();
117+
void removeFavorite();
118118

119119
void refresh();
120120

‎src/core/qgsbrowsermodel.cpp‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ static bool cmpByDataItemName_( QgsDataItem* a, QgsDataItem* b )
4949

5050
QgsBrowserModel::QgsBrowserModel( QObject *parent )
5151
: QAbstractItemModel( parent )
52-
, mFavourites( nullptr )
52+
, mFavorites( nullptr )
5353
, mProjectHome( nullptr )
5454
{
5555
connect( QgsProject::instance(), SIGNAL( readProject( const QDomDocument & ) ), this, SLOT( updateProjectHome() ) );
@@ -101,12 +101,12 @@ void QgsBrowserModel::addRootItems()
101101
connectItem( item );
102102
mRootItems << item;
103103

104-
// add favourite directories
105-
mFavourites = new QgsFavouritesItem( nullptr, tr( "Favourites" ) );
106-
if ( mFavourites )
104+
// add favorite directories
105+
mFavorites = new QgsFavoritesItem( nullptr, tr( "Favorites" ) );
106+
if ( mFavorites )
107107
{
108-
connectItem( mFavourites );
109-
mRootItems << mFavourites;
108+
connectItem( mFavorites );
109+
mRootItems << mFavorites;
110110
}
111111

112112
// add drives
@@ -530,19 +530,19 @@ void QgsBrowserModel::refresh( const QModelIndex& theIndex )
530530
item->refresh();
531531
}
532532

533-
void QgsBrowserModel::addFavouriteDirectory( const QString& favDir )
533+
void QgsBrowserModel::addFavoriteDirectory( const QString& directory )
534534
{
535-
Q_ASSERT( mFavourites );
536-
mFavourites->addDirectory( favDir );
535+
Q_ASSERT( mFavorites );
536+
mFavorites->addDirectory( directory );
537537
}
538538

539-
void QgsBrowserModel::removeFavourite( const QModelIndex &index )
539+
void QgsBrowserModel::removeFavorite( const QModelIndex &index )
540540
{
541541
QgsDirectoryItem *item = dynamic_cast<QgsDirectoryItem *>( dataItem( index ) );
542542
if ( !item )
543543
return;
544544

545-
mFavourites->removeDirectory( item );
545+
mFavorites->removeDirectory( item );
546546
}
547547

548548
void QgsBrowserModel::hidePath( QgsDataItem *item )

‎src/core/qgsbrowsermodel.h‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,20 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
143143
void itemDataChanged( QgsDataItem * item );
144144
void itemStateChanged( QgsDataItem * item, QgsDataItem::State oldState );
145145

146-
void addFavouriteDirectory( const QString& favDir );
147-
void removeFavourite( const QModelIndex &index );
146+
/**
147+
* Adds a directory to the favorites group.
148+
* @note added in QGIS 3.0
149+
* @see removeFavorite()
150+
*/
151+
void addFavoriteDirectory( const QString& directory );
152+
153+
/**
154+
* Removes a favorite directory from its corresponding model index.
155+
* @note added in QGIS 3.0
156+
* @see addFavoriteDirectory()
157+
*/
158+
void removeFavorite( const QModelIndex &index );
159+
148160
void updateProjectHome();
149161

150162
//! Hide the given path in the browser model
@@ -156,7 +168,7 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
156168
void removeRootItems();
157169

158170
QVector<QgsDataItem*> mRootItems;
159-
QgsFavouritesItem *mFavourites;
171+
QgsFavoritesItem *mFavorites;
160172
QgsDirectoryItem *mProjectHome;
161173
};
162174

‎src/core/qgsdataitem.cpp‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ const QIcon &QgsDataCollectionItem::iconDir()
182182
return icon;
183183
}
184184

185-
const QIcon &QgsFavouritesItem::iconFavourites()
185+
const QIcon &QgsFavoritesItem::iconFavorites()
186186
{
187187
static QIcon icon;
188188

@@ -1100,21 +1100,21 @@ QgsErrorItem::~QgsErrorItem()
11001100
{
11011101
}
11021102

1103-
QgsFavouritesItem::QgsFavouritesItem( QgsDataItem* parent, const QString& name, const QString& path )
1104-
: QgsDataCollectionItem( parent, name, QStringLiteral( "favourites:" ) )
1103+
QgsFavoritesItem::QgsFavoritesItem( QgsDataItem* parent, const QString& name, const QString& path )
1104+
: QgsDataCollectionItem( parent, name, QStringLiteral( "favorites:" ) )
11051105
{
11061106
Q_UNUSED( path );
11071107
mCapabilities |= Fast;
1108-
mType = Favourites;
1108+
mType = Favorites;
11091109
mIconName = QStringLiteral( "/mIconFavourites.png" );
11101110
populate();
11111111
}
11121112

1113-
QgsFavouritesItem::~QgsFavouritesItem()
1113+
QgsFavoritesItem::~QgsFavoritesItem()
11141114
{
11151115
}
11161116

1117-
QVector<QgsDataItem*> QgsFavouritesItem::createChildren()
1117+
QVector<QgsDataItem*> QgsFavoritesItem::createChildren()
11181118
{
11191119
QVector<QgsDataItem*> children;
11201120

@@ -1129,7 +1129,7 @@ QVector<QgsDataItem*> QgsFavouritesItem::createChildren()
11291129
return children;
11301130
}
11311131

1132-
void QgsFavouritesItem::addDirectory( const QString& favDir )
1132+
void QgsFavoritesItem::addDirectory( const QString& favDir )
11331133
{
11341134
QSettings settings;
11351135
QStringList favDirs = settings.value( QStringLiteral( "/browser/favourites" ) ).toStringList();
@@ -1146,7 +1146,7 @@ void QgsFavouritesItem::addDirectory( const QString& favDir )
11461146
}
11471147
}
11481148

1149-
void QgsFavouritesItem::removeDirectory( QgsDirectoryItem *item )
1149+
void QgsFavoritesItem::removeDirectory( QgsDirectoryItem *item )
11501150
{
11511151
if ( !item )
11521152
return;
@@ -1159,15 +1159,15 @@ void QgsFavouritesItem::removeDirectory( QgsDirectoryItem *item )
11591159
int idx = findItem( mChildren, item );
11601160
if ( idx < 0 )
11611161
{
1162-
QgsDebugMsg( QString( "favourites item %1 not found" ).arg( item->path() ) );
1162+
QgsDebugMsg( QString( "favorites item %1 not found" ).arg( item->path() ) );
11631163
return;
11641164
}
11651165

11661166
if ( state() == Populated )
11671167
deleteChildItem( mChildren.at( idx ) );
11681168
}
11691169

1170-
QVector<QgsDataItem*> QgsFavouritesItem::createChildren( const QString& favDir )
1170+
QVector<QgsDataItem*> QgsFavoritesItem::createChildren( const QString& favDir )
11711171
{
11721172
QVector<QgsDataItem*> children;
11731173
QString pathName = pathComponent( favDir );

‎src/core/qgsdataitem.h‎

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ class CORE_EXPORT QgsDataItem : public QObject
8888
Directory,
8989
Layer,
9090
Error,
91-
Favourites,
92-
Project //! Represents a QGIS project
91+
Favorites, //!< Represents a favorite item
92+
Project //!< Represents a QGIS project
9393
};
9494

9595
//! Create new data item.
@@ -436,7 +436,7 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem
436436
* @param parent
437437
* @param name directory name
438438
* @param dirPath path to directory in file system
439-
* @param path item path in the tree, it may be dirPath or dirPath with some prefix, e.g. favourites: */
439+
* @param path item path in the tree, it may be dirPath or dirPath with some prefix, e.g. favorites: */
440440
QgsDirectoryItem( QgsDataItem* parent, const QString& name, const QString& dirPath, const QString& path );
441441
~QgsDirectoryItem();
442442

@@ -519,21 +519,38 @@ class CORE_EXPORT QgsDirectoryParamWidget : public QTreeWidget
519519
};
520520

521521
/** \ingroup core
522-
* Contains various Favourites directories
522+
* Contains various Favorites directories
523+
* \note added in QGIS 3.0
523524
*/
524-
class CORE_EXPORT QgsFavouritesItem : public QgsDataCollectionItem
525+
class CORE_EXPORT QgsFavoritesItem : public QgsDataCollectionItem
525526
{
526527
Q_OBJECT
527528
public:
528-
QgsFavouritesItem( QgsDataItem* parent, const QString& name, const QString& path = QString() );
529-
~QgsFavouritesItem();
529+
530+
/**
531+
* Constructor for QgsFavoritesItem. Accepts a path argument specifying the file path associated with
532+
* the item.
533+
*/
534+
QgsFavoritesItem( QgsDataItem* parent, const QString& name, const QString& path = QString() );
535+
536+
~QgsFavoritesItem();
530537

531538
QVector<QgsDataItem*> createChildren() override;
532539

533-
void addDirectory( const QString& favIcon );
540+
/**
541+
* Adds a new directory to the favorites group.
542+
* @see removeDirectory()
543+
*/
544+
void addDirectory( const QString& directory );
545+
546+
/**
547+
* Removes an existing directory from the favorites group.
548+
* @see addDirectory()
549+
*/
534550
void removeDirectory( QgsDirectoryItem *item );
535551

536-
static const QIcon &iconFavourites();
552+
//! Icon for favorites group
553+
static const QIcon &iconFavorites();
537554

538555
private:
539556
QVector<QgsDataItem*> createChildren( const QString& favDir );

‎src/gui/qgsbrowsertreeview.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ void QgsBrowserTreeView::restoreState()
9191
}
9292
else
9393
{
94-
// expand root favourites item
95-
QModelIndex index = QgsBrowserModel::findPath( model(), QStringLiteral( "favourites:" ) );
94+
// expand root favorites item
95+
QModelIndex index = QgsBrowserModel::findPath( model(), QStringLiteral( "favorites:" ) );
9696
expand( index );
9797
}
9898
}

0 commit comments

Comments
 (0)
Please sign in to comment.