Skip to content

Commit

Permalink
Use notify instead
Browse files Browse the repository at this point in the history
  • Loading branch information
@nyalldawson
nyalldawson committed Nov 21, 2020
1 parent 2c38169 commit d47a654
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 87 deletions.
6 changes: 5 additions & 1 deletion python/gui/auto_generated/qgsdataitemguiprovider.sip.in
View file
Expand Up @@ -158,12 +158,16 @@ The function is replacement of :py:func:`QgsDataItem.paramWidget()`
.. versionadded:: 3.10
%End

static void notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level = Qgis::Info );
static void notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level = Qgis::Info, int duration = -1, QWidget *parent = 0 );
%Docstring
Notify the user showing a ``message`` with ``title`` and ``level``
If the context has a message bar the message will be shown in the message bar
else a message dialog will be used.

Since QGIS 3.18, the optional ``duration`` argument can be used to specify the message timeout in seconds. If ``duration``
is set to 0, then the message must be manually dismissed by the user. A duration of -1 indicates that
the default timeout for the message ``level`` should be used.

.. versionadded:: 3.16
%End
};
Expand Down
56 changes: 12 additions & 44 deletions src/gui/providers/ogr/qgsgeopackageitemguiprovider.cpp
View file
Expand Up @@ -152,17 +152,11 @@ void QgsGeoPackageItemGuiProvider::deleteGpkg( const QString &itemPath, const QS

if ( !QFile::remove( path ) )
{
if ( context.messageBar() )
context.messageBar()->pushMessage( title, tr( "Could not delete GeoPackage." ), Qgis::Critical );
else
QMessageBox::warning( nullptr, title, tr( "Could not delete GeoPackage." ) );
notify( title, tr( "Could not delete GeoPackage." ), context, Qgis::Critical );
}
else
{
if ( context.messageBar() )
context.messageBar()->pushMessage( title, tr( "GeoPackage deleted successfully." ), Qgis::Success );
else
QMessageBox::information( nullptr, title, tr( "GeoPackage deleted successfully." ) );
notify( title, tr( "GeoPackage deleted successfully." ), context, Qgis::Success );
// If the deleted file was a stored connection, remove it too
if ( ! name.isEmpty() )
{
Expand All @@ -182,12 +176,8 @@ void QgsGeoPackageItemGuiProvider::deleteGpkg( const QString &itemPath, const QS
}
else
{
if ( context.messageBar() )
context.messageBar()->pushMessage( title, QObject::tr( "The GeoPackage '%1' cannot be deleted because it is in the current project as '%2',"
" remove it from the project and retry." ).arg( path, projectLayer->name() ), Qgis::Critical );
else
QMessageBox::warning( nullptr, title, QObject::tr( "The GeoPackage '%1' cannot be deleted because it is in the current project as '%2',"
" remove it from the project and retry." ).arg( path, projectLayer->name() ) );
notify( title, QObject::tr( "The GeoPackage '%1' cannot be deleted because it is in the current project as '%2',"
" remove it from the project and retry." ).arg( path, projectLayer->name() ), context, Qgis::Critical );
}
}
}
Expand Down Expand Up @@ -265,10 +255,7 @@ bool QgsGeoPackageItemGuiProvider::rename( QgsDataItem *item, const QString &new

if ( ! errCause.isEmpty() )
{
if ( context.messageBar() )
context.messageBar()->pushMessage( QObject::tr( "Error renaming layer" ), errCause, Qgis::Critical );
else
QMessageBox::critical( nullptr, QObject::tr( "Error renaming layer" ), errCause );
notify( QObject::tr( "Error renaming layer" ), errCause, context, Qgis::Critical );
}
else if ( layerItem->parent() )
{
Expand Down Expand Up @@ -333,10 +320,7 @@ bool QgsGeoPackageItemGuiProvider::deleteLayer( QgsLayerItem *layerItem, QgsData
bool res = item->executeDeleteLayer( errCause );
if ( !res )
{
if ( context.messageBar() )
context.messageBar()->pushMessage( tr( "Delete Layer" ), errCause, Qgis::Critical );
else
QMessageBox::warning( nullptr, tr( "Delete Layer" ), errCause );
notify( tr( "Delete Layer" ), errCause, context, Qgis::Critical );
}
else
{
Expand All @@ -352,10 +336,7 @@ bool QgsGeoPackageItemGuiProvider::deleteLayer( QgsLayerItem *layerItem, QgsData
}
else
{
if ( context.messageBar() )
context.messageBar()->pushMessage( tr( "Delete Layer" ), tr( "The layer <b>%1</b> was successfully deleted." ).arg( item->name() ), Qgis::Success );
else
QMessageBox::information( nullptr, tr( "Delete Layer" ), tr( "The layer <b>%1</b> was successfully deleted." ).arg( item->name() ) );
notify( tr( "Delete Layer" ), tr( "The layer <b>%1</b> was successfully deleted." ).arg( item->name() ), context, Qgis::Success );
}
if ( item->parent() )
{
Expand All @@ -377,10 +358,7 @@ void QgsGeoPackageItemGuiProvider::vacuumGeoPackageDbAction( const QString &path
bool result = QgsGeoPackageCollectionItem::vacuumGeoPackageDb( name, path, errCause );
if ( !result || !errCause.isEmpty() )
{
if ( context.messageBar() )
context.messageBar()->pushMessage( tr( "Database compact (VACUUM)" ), errCause, Qgis::Critical );
else
QMessageBox::warning( nullptr, tr( "Database compact (VACUUM)" ), errCause );
notify( tr( "Database compact (VACUUM)" ), errCause, context, Qgis::Critical );
}
else if ( context.messageBar() )
{
Expand Down Expand Up @@ -503,12 +481,8 @@ bool QgsGeoPackageItemGuiProvider::handleDropGeopackage( QgsGeoPackageCollection

if ( exists && !isVector )
{
if ( context.messageBar() )
context.messageBar()->pushMessage( tr( "Cannot Overwrite Layer" ),
tr( "Destination layer <b>%1</b> already exists. Overwriting with raster layers is not currently supported." ).arg( dropUri.name ), Qgis::Critical );
else
QMessageBox::warning( nullptr, tr( "Cannot Overwrite Layer" ),
tr( "Destination layer <b>%1</b> already exists. Overwriting with raster layers is not currently supported." ).arg( dropUri.name ) );
notify( tr( "Cannot Overwrite Layer" ),
tr( "Destination layer <b>%1</b> already exists. Overwriting with raster layers is not currently supported." ).arg( dropUri.name ), context, Qgis::Critical );
}
else if ( ! exists || QMessageBox::question( nullptr, tr( "Overwrite Layer" ),
tr( "Destination layer <b>%1</b> already exists. Do you want to overwrite it?" ).arg( dropUri.name ), QMessageBox::Yes | QMessageBox::No ) == QMessageBox::Yes )
Expand All @@ -527,10 +501,7 @@ bool QgsGeoPackageItemGuiProvider::handleDropGeopackage( QgsGeoPackageCollection
// when export is successful:
connect( exportTask, &QgsVectorLayerExporterTask::exportComplete, item, [ = ]()
{
if ( context.messageBar() )
context.messageBar()->pushMessage( tr( "Import to GeoPackage database" ), tr( "Import was successful." ), Qgis::Success );
else
QMessageBox::information( nullptr, tr( "Import to GeoPackage database" ), tr( "Import was successful." ) );
notify( tr( "Import to GeoPackage database" ), tr( "Import was successful." ), context, Qgis::Success );
item->refresh();
} );

Expand All @@ -555,10 +526,7 @@ bool QgsGeoPackageItemGuiProvider::handleDropGeopackage( QgsGeoPackageCollection
// when export is successful:
connect( exportTask, &QgsGeoPackageRasterWriterTask::writeComplete, item, [ = ]()
{
if ( context.messageBar() )
context.messageBar()->pushMessage( tr( "Import to GeoPackage database" ), tr( "Import was successful." ), Qgis::Success );
else
QMessageBox::information( nullptr, tr( "Import to GeoPackage database" ), tr( "Import was successful." ) );
notify( tr( "Import to GeoPackage database" ), tr( "Import was successful." ), context, Qgis::Success );
item->refresh();
} );

Expand Down
61 changes: 20 additions & 41 deletions src/gui/qgsdataitemguiprovider.cpp
View file
Expand Up @@ -73,59 +73,38 @@ QWidget *QgsDataItemGuiProvider::createParamWidget( QgsDataItem *, QgsDataItemGu
return nullptr;
}

void QgsDataItemGuiProvider::notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level )
void QgsDataItemGuiProvider::notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level, int duration, QWidget *parent )
{
switch ( level )
if ( QgsMessageBar *bar = context.messageBar() )
{
case Qgis::MessageLevel::Info:
case Qgis::MessageLevel::None:
{
if ( auto *lMessageBar = context.messageBar() )
{
lMessageBar->pushInfo( title, message );
}
else
{
QMessageBox::information( nullptr, title, message );
}
break;
}
case Qgis::MessageLevel::Warning:
{
if ( auto *lMessageBar = context.messageBar() )
{
lMessageBar->pushWarning( title, message );
}
else
{
QMessageBox::warning( nullptr, title, message );
}
break;
}
case Qgis::MessageLevel::Critical:
bar->pushMessage( title, message, level, duration );
}
else
{
switch ( level )
{
if ( auto *lMessageBar = context.messageBar() )
case Qgis::MessageLevel::Info:
case Qgis::MessageLevel::None:
{
lMessageBar->pushCritical( title, message );
QMessageBox::information( parent, title, message );
break;
}
else
case Qgis::MessageLevel::Warning:
{
QMessageBox::critical( nullptr, title, message );
QMessageBox::warning( parent, title, message );
break;
}
break;
}
case Qgis::MessageLevel::Success:
{
if ( auto *lMessageBar = context.messageBar() )
case Qgis::MessageLevel::Critical:
{
lMessageBar->pushSuccess( title, message );
QMessageBox::critical( parent, title, message );
break;
}
else
case Qgis::MessageLevel::Success:
{
// There is no "success" in message box, let's use information instead
QMessageBox::information( nullptr, title, message );
QMessageBox::information( parent, title, message );
break;
}
break;
}
}
}
7 changes: 6 additions & 1 deletion src/gui/qgsdataitemguiprovider.h
View file
Expand Up @@ -180,9 +180,14 @@ class GUI_EXPORT QgsDataItemGuiProvider
* Notify the user showing a \a message with \a title and \a level
* If the context has a message bar the message will be shown in the message bar
* else a message dialog will be used.
*
* Since QGIS 3.18, the optional \a duration argument can be used to specify the message timeout in seconds. If \a duration
* is set to 0, then the message must be manually dismissed by the user. A duration of -1 indicates that
* the default timeout for the message \a level should be used.
*
* \since QGIS 3.16
*/
static void notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level = Qgis::Info );
static void notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level = Qgis::Info, int duration = -1, QWidget *parent = nullptr );
};

#endif // QGSDATAITEMGUIPROVIDER_H

0 comments on commit d47a654

Please sign in to comment.