Skip to content

Commit

Permalink
[needs-docs] Rework arrangement of buttons in categories tab in
Browse files Browse the repository at this point in the history 
metadata editor to make their operation more self-explanatory
for users.

Also add tooltips to the buttons describing their function, and
allow the buttons to operate on multiple selected rows at once.

Fixes #18090
  • Loading branch information
@nyalldawson
nyalldawson committed Feb 14, 2018
1 parent 2d24bbf commit cd24adb
Show file tree
Hide file tree
Showing 4 changed files with 185 additions and 99 deletions.
6 changes: 3 additions & 3 deletions python/gui/qgsmetadatawidget.sip.in
View file
Expand Up @@ -28,17 +28,17 @@ class QgsMetadataWidget : QWidget
Constructor for the wizard.
%End

void saveMetadata( QgsLayerMetadata &layerMetadata ) const;
void saveMetadata( QgsLayerMetadata &layerMetadata );
%Docstring
Save all fields in a QgsLayerMetadata object.
%End

bool checkMetadata() const;
bool checkMetadata();
%Docstring
Check if values in the wizard are correct.
%End

void crsChanged() const;
void crsChanged();
%Docstring
If the CRS is updated.
%End
Expand Down
93 changes: 46 additions & 47 deletions src/gui/qgsmetadatawidget.cpp
View file
Expand Up @@ -103,19 +103,19 @@ QgsMetadataWidget::QgsMetadataWidget( QWidget *parent, QgsMapLayer *layer )
connect( btnAddHistory, &QPushButton::clicked, this, &QgsMetadataWidget::addHistory );
connect( btnRemoveHistory, &QPushButton::clicked, this, &QgsMetadataWidget::removeSelectedHistory );
connect( btnNewCategory, &QPushButton::clicked, this, &QgsMetadataWidget::addNewCategory );
connect( btnAddDefaultCategory, &QPushButton::clicked, this, &QgsMetadataWidget::addDefaultCategory );
connect( btnRemoveCategory, &QPushButton::clicked, this, &QgsMetadataWidget::removeSelectedCategory );
connect( btnAddDefaultCategory, &QPushButton::clicked, this, &QgsMetadataWidget::addDefaultCategories );
connect( btnRemoveCategory, &QPushButton::clicked, this, &QgsMetadataWidget::removeSelectedCategories );

fillComboBox();
setPropertiesFromLayer();
}

void QgsMetadataWidget::fillSourceFromLayer() const
void QgsMetadataWidget::fillSourceFromLayer()
{
lineEditIdentifier->setText( mLayer->publicSource() );
}

void QgsMetadataWidget::addVocabulary() const
void QgsMetadataWidget::addVocabulary()
{
int row = tabKeywords->rowCount();
tabKeywords->setRowCount( row + 1 );
Expand All @@ -130,7 +130,7 @@ void QgsMetadataWidget::addVocabulary() const
tabKeywords->setItem( row, 1, pCell );
}

void QgsMetadataWidget::removeSelectedVocabulary() const
void QgsMetadataWidget::removeSelectedVocabulary()
{
QItemSelectionModel *selectionModel = tabKeywords->selectionModel();
const QModelIndexList selectedRows = selectionModel->selectedRows();
Expand All @@ -152,7 +152,7 @@ void QgsMetadataWidget::addLicence()
}
}

void QgsMetadataWidget::removeSelectedLicence() const
void QgsMetadataWidget::removeSelectedLicence()
{
QItemSelectionModel *selectionModel = tabLicenses->selectionModel();
const QModelIndexList selectedRows = selectionModel->selectedRows();
Expand All @@ -173,7 +173,7 @@ void QgsMetadataWidget::addRight()
}
}

void QgsMetadataWidget::removeSelectedRight() const
void QgsMetadataWidget::removeSelectedRight()
{
QItemSelectionModel *selection = listRights->selectionModel();
if ( selection->hasSelection() )
Expand All @@ -187,20 +187,20 @@ void QgsMetadataWidget::removeSelectedRight() const
}
}

void QgsMetadataWidget::addConstraint() const
void QgsMetadataWidget::addConstraint()
{
int row = mConstraintsModel->rowCount();
mConstraintsModel->setItem( row, 0, new QStandardItem( QString( tr( "undefined %1" ) ).arg( row + 1 ) ) );
mConstraintsModel->setItem( row, 1, new QStandardItem( QString( tr( "undefined %1" ) ).arg( row + 1 ) ) );
}

void QgsMetadataWidget::removeSelectedConstraint() const
void QgsMetadataWidget::removeSelectedConstraint()
{
const QModelIndexList selectedRows = tabConstraints->selectionModel()->selectedRows();
mConstraintsModel->removeRow( selectedRows[0].row() );
}

void QgsMetadataWidget::crsChanged() const
void QgsMetadataWidget::crsChanged()
{
if ( mCrs.isValid() )
{
Expand Down Expand Up @@ -233,7 +233,7 @@ void QgsMetadataWidget::crsChanged() const
}
}

void QgsMetadataWidget::addAddress() const
void QgsMetadataWidget::addAddress()
{
int row = tabAddresses->rowCount();
tabAddresses->setRowCount( row + 1 );
Expand All @@ -259,7 +259,7 @@ void QgsMetadataWidget::addAddress() const
tabAddresses->setItem( row, 5, new QTableWidgetItem() );
}

void QgsMetadataWidget::removeSelectedAddress() const
void QgsMetadataWidget::removeSelectedAddress()
{
QItemSelectionModel *selectionModel = tabAddresses->selectionModel();
const QModelIndexList selectedRows = selectionModel->selectedRows();
Expand All @@ -281,7 +281,7 @@ void QgsMetadataWidget::fillCrsFromProvider()
crsChanged();
}

void QgsMetadataWidget::addLink() const
void QgsMetadataWidget::addLink()
{
int row = mLinksModel->rowCount();
mLinksModel->setItem( row, 0, new QStandardItem( QString( tr( "undefined %1" ) ).arg( row + 1 ) ) );
Expand All @@ -293,7 +293,7 @@ void QgsMetadataWidget::addLink() const
mLinksModel->setItem( row, 6, new QStandardItem() );
}

void QgsMetadataWidget::removeSelectedLink() const
void QgsMetadataWidget::removeSelectedLink()
{
const QModelIndexList selectedRows = tabLinks->selectionModel()->selectedRows();
mLinksModel->removeRow( selectedRows[0].row() );
Expand All @@ -310,7 +310,7 @@ void QgsMetadataWidget::addHistory()
}
}

void QgsMetadataWidget::removeSelectedHistory() const
void QgsMetadataWidget::removeSelectedHistory()
{
QItemSelectionModel *selection = listHistory->selectionModel();
if ( selection->hasSelection() )
Expand All @@ -324,7 +324,7 @@ void QgsMetadataWidget::removeSelectedHistory() const
}
}

void QgsMetadataWidget::fillComboBox() const
void QgsMetadataWidget::fillComboBox()
{
// Set default values in type combobox
// It is advised to use the ISO 19115 MD_ScopeCode values. E.g. 'dataset' or 'series'.
Expand Down Expand Up @@ -522,7 +522,7 @@ void QgsMetadataWidget::setPropertiesFromLayer()
mHistoryModel->setStringList( mMetadata.history() );
}

void QgsMetadataWidget::saveMetadata( QgsLayerMetadata &layerMetadata ) const
void QgsMetadataWidget::saveMetadata( QgsLayerMetadata &layerMetadata )
{
layerMetadata.setParentIdentifier( lineEditParentId->text() );
layerMetadata.setIdentifier( lineEditIdentifier->text() );
Expand Down Expand Up @@ -635,7 +635,7 @@ void QgsMetadataWidget::saveMetadata( QgsLayerMetadata &layerMetadata ) const
layerMetadata.setHistory( mHistoryModel->stringList() );
}

bool QgsMetadataWidget::checkMetadata() const
bool QgsMetadataWidget::checkMetadata()
{
QgsLayerMetadata metadata = QgsLayerMetadata();
saveMetadata( metadata );
Expand Down Expand Up @@ -826,7 +826,7 @@ void QgsMetadataWidget::setMetadata( const QgsLayerMetadata &metadata )
setPropertiesFromLayer();
}

void QgsMetadataWidget::syncFromCategoriesTabToKeywordsTab() const
void QgsMetadataWidget::syncFromCategoriesTabToKeywordsTab()
{
if ( mCategoriesModel->rowCount() > 0 )
{
Expand All @@ -847,7 +847,7 @@ void QgsMetadataWidget::syncFromCategoriesTabToKeywordsTab() const
}
}

void QgsMetadataWidget::updatePanel() const
void QgsMetadataWidget::updatePanel()
{
int index = tabWidget->currentIndex();
QString currentTabText = tabWidget->widget( index )->objectName();
Expand Down Expand Up @@ -896,46 +896,45 @@ void QgsMetadataWidget::addNewCategory()
}
}

void QgsMetadataWidget::addDefaultCategory() const
void QgsMetadataWidget::addDefaultCategories()
{
QItemSelectionModel *selection = listDefaultCategories->selectionModel();
if ( selection->hasSelection() )
{
QModelIndex indexElementSelectionne = selection->currentIndex();
const QModelIndexList selectedIndexes = listDefaultCategories->selectionModel()->selectedIndexes();
QStringList defaultCategoriesList = mDefaultCategoriesModel->stringList();
QStringList selectedCategories = mCategoriesModel->stringList();

QVariant item = mDefaultCategoriesModel->data( indexElementSelectionne, Qt::DisplayRole );
QStringList list = mDefaultCategoriesModel->stringList();
list.removeOne( item.toString() );
mDefaultCategoriesModel->setStringList( list );
for ( const QModelIndex &selection : selectedIndexes )
{
QVariant item = mDefaultCategoriesModel->data( selection, Qt::DisplayRole );
defaultCategoriesList.removeOne( item.toString() );

list = mCategoriesModel->stringList();
list.append( item.toString() );
mCategoriesModel->setStringList( list );
mCategoriesModel->sort( 0 );
selectedCategories.append( item.toString() );
}
}

mDefaultCategoriesModel->setStringList( defaultCategoriesList );
mCategoriesModel->setStringList( selectedCategories );
mCategoriesModel->sort( 0 );
}

void QgsMetadataWidget::removeSelectedCategory() const
void QgsMetadataWidget::removeSelectedCategories()
{
QItemSelectionModel *selection = listCategories->selectionModel();
if ( selection->hasSelection() )
{
QModelIndex indexElementSelectionne = listCategories->selectionModel()->currentIndex();
const QModelIndexList selectedIndexes = listCategories->selectionModel()->selectedIndexes();
QStringList categories = mCategoriesModel->stringList();
QStringList defaultList = mDefaultCategoriesModel->stringList();

QVariant item = mCategoriesModel->data( indexElementSelectionne, Qt::DisplayRole );
QStringList list = mCategoriesModel->stringList();
list.removeOne( item.toString() );
mCategoriesModel->setStringList( list );
for ( const QModelIndex &selection : selectedIndexes )
{
QVariant item = mCategoriesModel->data( selection, Qt::DisplayRole );
categories.removeOne( item.toString() );

if ( mDefaultCategories.contains( item.toString() ) )
{
list = mDefaultCategoriesModel->stringList();
list.append( item.toString() );
mDefaultCategoriesModel->setStringList( list );
mDefaultCategoriesModel->sort( 0 );
defaultList.append( item.toString() );
}
}
mCategoriesModel->setStringList( categories );

mDefaultCategoriesModel->setStringList( defaultList );
mDefaultCategoriesModel->sort( 0 );
}

LinkItemDelegate::LinkItemDelegate( QObject *parent )
Expand Down
45 changes: 24 additions & 21 deletions src/gui/qgsmetadatawidget.h
View file
Expand Up @@ -49,17 +49,17 @@ class GUI_EXPORT QgsMetadataWidget : public QWidget, private Ui::QgsMetadataWidg
/**
* Save all fields in a QgsLayerMetadata object.
*/
void saveMetadata( QgsLayerMetadata &layerMetadata ) const;
void saveMetadata( QgsLayerMetadata &layerMetadata );

/**
* Check if values in the wizard are correct.
*/
bool checkMetadata() const;
bool checkMetadata();

/**
* If the CRS is updated.
*/
void crsChanged() const;
void crsChanged();

/**
* Saves the metadata to the layer.
Expand Down Expand Up @@ -103,31 +103,34 @@ class GUI_EXPORT QgsMetadataWidget : public QWidget, private Ui::QgsMetadataWidg
*/
void setMapCanvas( QgsMapCanvas *canvas );

private:
void updatePanel() const;
void fillSourceFromLayer() const;
private slots:
void removeSelectedCategories();
void updatePanel();
void fillSourceFromLayer();
void fillCrsFromLayer();
void fillCrsFromProvider();
void addDefaultCategory() const;
void addDefaultCategories();
void addNewCategory();
void removeSelectedCategory() const;
void addVocabulary() const;
void removeSelectedVocabulary() const;
void addVocabulary();
void removeSelectedVocabulary();
void addLicence();
void removeSelectedLicence() const;
void removeSelectedLicence();
void addRight();
void removeSelectedRight() const;
void addConstraint() const;
void removeSelectedConstraint() const;
void addAddress() const;
void removeSelectedAddress() const;
void addLink() const;
void removeSelectedLink() const;
void removeSelectedRight();
void addConstraint();
void removeSelectedConstraint();
void addAddress();
void removeSelectedAddress();
void addLink();
void removeSelectedLink();
void addHistory();
void removeSelectedHistory() const;
void fillComboBox() const;
void removeSelectedHistory();

private:

void fillComboBox();
void setPropertiesFromLayer();
void syncFromCategoriesTabToKeywordsTab() const;
void syncFromCategoriesTabToKeywordsTab();
QStringList mDefaultCategories;
QgsMapLayer *mLayer = nullptr;
QgsCoordinateReferenceSystem mCrs;
Expand Down

0 comments on commit cd24adb

Please sign in to comment.