Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update Composer Manager's template functionality 
- Add specific template path support
- Add user templates directory support
- Add buttons to open user or default template directory
- Add selection of list item for newly added composers
- Update GUI with collapsible group box
- Use unique title dialog for composer rename function
  • Loading branch information
@dakcarto
dakcarto committed Mar 2, 2013
1 parent 808547e commit b1f1cbd
Show file tree
Hide file tree
Showing 4 changed files with 288 additions and 42 deletions.
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposer.cpp
View file
Expand Up @@ -1419,7 +1419,7 @@ void QgsComposer::on_mActionSaveAsTemplate_triggered()
QString saveFileNameWithSuffix = saveFileName.append( ".qpt" );
saveFileInfo = QFileInfo( saveFileNameWithSuffix );
}
settings.setValue( "UI/LastComposerTemplateDir", saveFileInfo.absolutePath() );
settings.setValue( "UI/lastComposerTemplateDir", saveFileInfo.absolutePath() );

QFile templateFile( saveFileName );
if ( !templateFile.open( QIODevice::WriteOnly ) )
Expand Down
153 changes: 135 additions & 18 deletions src/app/composer/qgscomposermanager.cpp
View file
Expand Up @@ -20,11 +20,14 @@
#include "qgscomposer.h"
#include "qgslogger.h"

#include <QDesktopServices>
#include <QDialog>
#include <QDir>
#include <QFileDialog>
#include <QInputDialog>
#include <QListWidgetItem>
#include <QMessageBox>
#include <QUrl>
#include <QSettings>

QgsComposerManager::QgsComposerManager( QWidget * parent, Qt::WindowFlags f ): QDialog( parent, f )
Expand Down Expand Up @@ -65,6 +68,7 @@ QgsComposerManager::~QgsComposerManager()

void QgsComposerManager::initialize()
{
QSettings settings;
QSet<QgsComposer*> composers = QgisApp::instance()->printComposers();
QSet<QgsComposer*>::const_iterator it = composers.constBegin();
for ( ; it != composers.constEnd(); ++it )
Expand All @@ -75,24 +79,42 @@ void QgsComposerManager::initialize()
}

mTemplate->addItem( tr( "Empty composer" ) );
mTemplate->addItem( tr( "Specific" ) );

mUserTemplatesDir = QgsApplication::qgisSettingsDirPath() + "/composer_templates";
QMap<QString, QString> userTemplateMap = defaultTemplates( true );
if ( userTemplateMap.size() > 0 )
{
mTemplate->insertSeparator( mTemplate->count() );
QMap<QString, QString>::const_iterator templateIt = userTemplateMap.constBegin();
for ( ; templateIt != userTemplateMap.constEnd(); ++templateIt )
{
mTemplate->addItem( templateIt.key(), templateIt.value() );
}
}

QMap<QString, QString> templateMap = defaultTemplates();
if ( templateMap.size() > 0 )
mDefaultTemplatesDir = QgsApplication::pkgDataPath() + "/composer_templates";
QMap<QString, QString> defaultTemplateMap = defaultTemplates( false );
if ( defaultTemplateMap.size() > 0 )
{
QMap<QString, QString>::const_iterator templateIt = templateMap.constBegin();
for ( ; templateIt != templateMap.constEnd(); ++templateIt )
mTemplate->insertSeparator( mTemplate->count() );
QMap<QString, QString>::const_iterator templateIt = defaultTemplateMap.constBegin();
for ( ; templateIt != defaultTemplateMap.constEnd(); ++templateIt )
{
mTemplate->addItem( templateIt.key(), templateIt.value() );
}
}

mTemplatePathLineEdit->setText( settings.value( "/UI/ComposerManager/templatePath", QString( "" ) ).toString() );
}

QMap<QString, QString> QgsComposerManager::defaultTemplates() const
QMap<QString, QString> QgsComposerManager::defaultTemplates( bool fromUser ) const
{
QMap<QString, QString> templateMap;

//search for default templates in $pkgDataPath/composer_templates
QDir defaultTemplateDir( QgsApplication::pkgDataPath() + "/composer_templates" );
// user templates in $qgisSettingsDirPath/composer_templates
QDir defaultTemplateDir( fromUser ? mUserTemplatesDir : mDefaultTemplatesDir );
if ( !defaultTemplateDir.exists() )
{
return templateMap;
Expand All @@ -109,7 +131,33 @@ QMap<QString, QString> QgsComposerManager::defaultTemplates() const

void QgsComposerManager::on_mAddButton_clicked()
{
QFile templateFile;
bool loadingTemplate = ( mTemplate->currentIndex() > 0 );
if ( loadingTemplate )
{
if ( mTemplate->currentIndex() == 1 )
{
templateFile.setFileName( mTemplatePathLineEdit->text() );
}
else
{
templateFile.setFileName( mTemplate->itemData( mTemplate->currentIndex() ).toString() );
}

if ( !templateFile.exists() )
{
QMessageBox::warning( this, tr( "Template error" ), tr( "Error, template file not found" ) );
return;
}
if ( !templateFile.open( QIODevice::ReadOnly ) )
{
QMessageBox::warning( this, tr( "Template error" ), tr( "Error, could not read file" ) );
return;
}
}

QgsComposer* newComposer = 0;
bool loadedOK = false;

QString title = QgisApp::instance()->uniqueComposerTitle( this, true );
if ( title.isNull() )
Expand All @@ -120,25 +168,94 @@ void QgsComposerManager::on_mAddButton_clicked()
newComposer = QgisApp::instance()->createNewComposer( title );
if ( !newComposer )
{
QMessageBox::warning( this, tr( "Composer error" ), tr( "Error, could not create composer" ) );
return;
}
else
{
loadedOK = true;
}

if ( mTemplate->currentIndex() > 0 )
if ( loadingTemplate )
{
QDomDocument templateDoc;
QFile templateFile( mTemplate->itemData( mTemplate->currentIndex() ).toString() );
if ( templateFile.open( QIODevice::ReadOnly ) )
if ( templateDoc.setContent( &templateFile, false ) )
{
if ( templateDoc.setContent( &templateFile, false ) )
{
newComposer->readXML( templateDoc );
}
// provide feedback, since composer will be hidden when loading template (much faster)
// (not needed for empty composer)
QDialog* dlg = newComposer->busyIndicatorDialog( tr( "Loading template into composer..." ), this );
dlg->show();
newComposer->hide();
loadedOK = newComposer->composition()->loadFromTemplate( templateDoc, 0, false );
newComposer->activate();
dlg->close();
}
}

QListWidgetItem* item = new QListWidgetItem( newComposer->title(), mComposerListWidget );
item->setFlags( Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemIsEditable );
mItemComposerMap.insert( item, newComposer );
if ( loadedOK )
{
// do not close on Add, since user may want to add multiple composers from templates
QListWidgetItem* item = new QListWidgetItem( newComposer->title(), mComposerListWidget );
item->setFlags( Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemIsEditable );
mItemComposerMap.insert( item, newComposer );
mComposerListWidget->setCurrentItem( item );
mComposerListWidget->setFocus();
}
else
{
if ( newComposer )
{
newComposer->close();
QgisApp::instance()->deleteComposer( newComposer );
newComposer = 0;
}
QMessageBox::warning( this, tr( "Template error" ), tr( "Error, could not load template file" ) );
}
}

void QgsComposerManager::on_mTemplate_currentIndexChanged( int indx )
{
bool specific = ( indx == 1 ); // comes just after empty template
mTemplatePathLineEdit->setEnabled( specific );
mTemplatePathBtn->setEnabled( specific );
}

void QgsComposerManager::on_mTemplatePathBtn_pressed()
{
QSettings settings;
QString lastTmplDir = settings.value( "/UI/lastComposerTemplateDir", "." ).toString();
QString tmplPath = QFileDialog::getOpenFileName( this,
tr( "Choose template" ),
lastTmplDir,
tr( "Composer templates" ) + " (*.qpt)" );
if ( !tmplPath.isNull() )
{
mTemplatePathLineEdit->setText( tmplPath );
settings.setValue( "UI/ComposerManager/templatePath", tmplPath );
QFileInfo tmplFileInfo( tmplPath );
settings.setValue( "UI/lastComposerTemplateDir", tmplFileInfo.absolutePath() );
}
}

void QgsComposerManager::on_mTemplatesDefaultDirBtn_pressed()
{
openLocalDirectory( mDefaultTemplatesDir );
}

void QgsComposerManager::on_mTemplatesUserDirBtn_pressed()
{
openLocalDirectory( mUserTemplatesDir );
}

void QgsComposerManager::openLocalDirectory( const QString& localDirPath )
{
QDir localDir;
if ( !localDir.mkpath( localDirPath ) )
{
QMessageBox::warning( this, tr( "File system error" ), tr( "Error, could not open or create local directory" ) );
return;
}
QDesktopServices::openUrl( QUrl::fromLocalFile( localDirPath ) );
}

void QgsComposerManager::remove_clicked()
Expand All @@ -150,7 +267,7 @@ void QgsComposerManager::remove_clicked()
}

//ask for confirmation
if ( QMessageBox::warning( 0, tr( "Remove composer" ), tr( "Do you really want to remove the map composer '%1'?" ).arg( item->text() ), QMessageBox::Ok | QMessageBox::Cancel ) != QMessageBox::Ok )
if ( QMessageBox::warning( this, tr( "Remove composer" ), tr( "Do you really want to remove the map composer '%1'?" ).arg( item->text() ), QMessageBox::Ok | QMessageBox::Cancel ) != QMessageBox::Ok )
{
return;
}
Expand Down Expand Up @@ -291,7 +408,7 @@ void QgsComposerManager::rename_clicked()
{
return;
}
QString newTitle = QInputDialog::getText( 0, tr( "Change title" ), tr( "Title" ), QLineEdit::Normal, currentTitle );
QString newTitle = QgisApp::instance()->uniqueComposerTitle( this, false, currentTitle );
if ( newTitle.isNull() )
{
return;
Expand Down
31 changes: 29 additions & 2 deletions src/app/composer/qgscomposermanager.h
View file
Expand Up @@ -40,11 +40,38 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase
/**Enters the composer instances and created the item-composer map*/
void initialize();

/**Returns the default templates (key: template name, value: absolute path to template file)*/
QMap<QString, QString> defaultTemplates() const;
/** Returns the default templates (key: template name, value: absolute path to template file)
* @param fromUser whether to return user templates from ~/.qgis/composer_templates (added in 1.9)
*/
QMap<QString, QString> defaultTemplates( bool fromUser = false ) const;

/** Open local directory with user's system, creating it if not present
* @note added in QGIS 1.9
*/
void openLocalDirectory( const QString& localDirPath );

QString mDefaultTemplatesDir;
QString mUserTemplatesDir;

private slots:
void on_mAddButton_clicked();
/** Slot to track combobox to use specific template path
* @note added in 1.9
*/
void on_mTemplate_currentIndexChanged( int indx );
/** Slot to choose path to template
* @note added in QGIS 1.9
*/
void on_mTemplatePathBtn_pressed();
/** Slot to open default templates dir with user's system
* @note added in QGIS 1.9
*/
void on_mTemplatesDefaultDirBtn_pressed();
/** Slot to open user templates dir with user's system
* @note added in QGIS 1.9
*/
void on_mTemplatesUserDirBtn_pressed();

void remove_clicked();
void show_clicked();
/** Duplicate composer
Expand Down

0 comments on commit b1f1cbd

Please sign in to comment.