Add icon support to actions

m-kuhn · 3nids · commit 089652e54938 · 2014-09-16T11:51:17.000+02:00
diff --git a/src/app/qgsattributeactiondialog.cpp b/src/app/qgsattributeactiondialog.cpp
@@ -31,6 +31,7 @@ back to QgsVectorLayer.
 #include <QHeaderView>
 #include <QMessageBox>
 #include <QSettings>
+#include <QImageWriter>
 
 QgsAttributeActionDialog::QgsAttributeActionDialog( QgsAttributeAction* actions,
     const QgsFields& fields,
@@ -61,6 +62,8 @@ QgsAttributeActionDialog::QgsAttributeActionDialog( QgsAttributeAction* actions,
   connect( insertFieldButton, SIGNAL( clicked() ), this, SLOT( insertField() ) );
   connect( insertExpressionButton, SIGNAL( clicked() ), this, SLOT( insertExpression() ) );
 
+  connect( chooseIconButton, SIGNAL(clicked()), this, SLOT( chooseIcon() ) );
+
   init();
   // Populate the combo box with the field names. Will the field names
   // change? If so, they need to be passed into the init() call, or
@@ -78,13 +81,13 @@ void QgsAttributeActionDialog::init()
   for ( int i = 0; i < mActions->size(); i++ )
   {
     const QgsAction action = ( *mActions )[i];
-    insertRow( i, action.type(), action.name(), action.action(), action.capture() );
+    insertRow( i, action.type(), action.name(), action.action(), action.iconPath(), action.capture() );
   }
 
   updateButtons();
 }
 
-void QgsAttributeActionDialog::insertRow( int row, QgsAction::ActionType type, const QString &name, const QString &action, bool capture )
+void QgsAttributeActionDialog::insertRow( int row, QgsAction::ActionType type, const QString &name, const QString &action, const QString& iconPath, bool capture )
 {
   QTableWidgetItem* item;
   attributeActionTable->insertRow( row );
@@ -97,6 +100,10 @@ void QgsAttributeActionDialog::insertRow( int row, QgsAction::ActionType type, c
   item->setFlags( item->flags() & ~( Qt::ItemIsEditable | Qt::ItemIsUserCheckable ) );
   item->setCheckState( capture ? Qt::Checked : Qt::Unchecked );
   attributeActionTable->setItem( row, 3, item );
+  QIcon icon = QIcon( iconPath );
+  QTableWidgetItem* headerItem = new QTableWidgetItem( icon, "" );
+  headerItem->setData( Qt::UserRole, iconPath );
+  attributeActionTable->setVerticalHeaderItem( row, headerItem );
 
   updateButtons();
 }
@@ -250,7 +257,7 @@ void QgsAttributeActionDialog::insert( int pos )
     if ( pos >= numRows )
     {
       // Expand the table to have a row with index pos
-      insertRow( pos, ( QgsAction::ActionType ) actionType->currentIndex(), name, actionAction->toPlainText(), captureCB->isChecked() );
+      insertRow( pos, ( QgsAction::ActionType ) actionType->currentIndex(), name, actionAction->toPlainText(), actionIcon->text(), captureCB->isChecked() );
     }
     else
     {
@@ -259,6 +266,8 @@ void QgsAttributeActionDialog::insert( int pos )
       attributeActionTable->item( pos, 1 )->setText( name );
       attributeActionTable->item( pos, 2 )->setText( actionAction->toPlainText() );
       attributeActionTable->item( pos, 3 )->setCheckState( captureCB->isChecked() ? Qt::Checked : Qt::Unchecked );
+      attributeActionTable->verticalHeaderItem( pos )->setIcon( QIcon( actionIcon->text() ) );
+      attributeActionTable->verticalHeaderItem( pos )->setData( Qt::UserRole, actionIcon->text() );
     }
   }
 }
@@ -299,6 +308,23 @@ void QgsAttributeActionDialog::updateButtons()
   updateButton->setEnabled( hasSelection && validNewAction );
 }
 
+void QgsAttributeActionDialog::chooseIcon()
+{
+  QList<QByteArray> list = QImageWriter::supportedImageFormats();
+  QStringList formatList;
+  Q_FOREACH( const QByteArray& format, list )
+    formatList << QString( "*.%1" ).arg( QString( format ) );
+
+  QString filter = QString( "Images( %1 ); All( *.* )" ).arg( formatList.join( " " ) );
+  QString icon = QFileDialog::getOpenFileName( this, tr( "Choose Icon..." ), actionIcon->text(), filter );
+
+  if ( !icon.isNull() )
+  {
+    actionIcon->setText( icon );
+    iconPreview->setPixmap( QPixmap( icon ) );
+  }
+}
+
 void QgsAttributeActionDialog::insertField()
 {
   // Convert the selected field to an expression and
@@ -323,24 +349,25 @@ void QgsAttributeActionDialog::apply()
     const QgsAction::ActionType type = ( QgsAction::ActionType ) actionType->findText( attributeActionTable->item( i, 0 )->text() );
     const QString &name = attributeActionTable->item( i, 1 )->text();
     const QString &action = attributeActionTable->item( i, 2 )->text();
+    const QString icon = attributeActionTable->verticalHeaderItem( i )->data( Qt::UserRole ).toString();
     if ( !name.isEmpty() && !action.isEmpty() )
     {
       QTableWidgetItem *item = attributeActionTable->item( i, 3 );
-      mActions->addAction( type, name, action, item->checkState() == Qt::Checked );
+      mActions->addAction( type, name, action, icon, item->checkState() == Qt::Checked );
     }
   }
 }
 
 void QgsAttributeActionDialog::addDefaultActions()
 {
   int pos = 0;
-  insertRow( pos++, QgsAction::Generic, tr( "Echo attribute's value" ), "echo \"[% \"MY_FIELD\" %]\"", true );
-  insertRow( pos++, QgsAction::Generic, tr( "Run an application" ), "ogr2ogr -f \"ESRI Shapefile\" \"[% \"OUTPUT_PATH\" %]\" \"[% \"INPUT_FILE\" %]\"", true );
-  insertRow( pos++, QgsAction::GenericPython, tr( "Get feature id" ), "QtGui.QMessageBox.information(None, \"Feature id\", \"feature id is [% $id %]\")", false );
-  insertRow( pos++, QgsAction::GenericPython, tr( "Selected field's value (Identify features tool)" ), "QtGui.QMessageBox.information(None, \"Current field's value\", \"[% $currentfield %]\")", false );
-  insertRow( pos++, QgsAction::GenericPython, tr( "Clicked coordinates (Run feature actions tool)" ), "QtGui.QMessageBox.information(None, \"Clicked coords\", \"layer: [% $layerid %]\\ncoords: ([% $clickx %],[% $clicky %])\")", false );
-  insertRow( pos++, QgsAction::OpenUrl, tr( "Open file" ), "[% \"PATH\" %]", false );
-  insertRow( pos++, QgsAction::OpenUrl, tr( "Search on web based on attribute's value" ), "http://www.google.com/search?q=[% \"ATTRIBUTE\" %]", false );
+  insertRow( pos++, QgsAction::Generic, tr( "Echo attribute's value" ), "echo \"[% \"MY_FIELD\" %]\"", "", true );
+  insertRow( pos++, QgsAction::Generic, tr( "Run an application" ), "ogr2ogr -f \"ESRI Shapefile\" \"[% \"OUTPUT_PATH\" %]\" \"[% \"INPUT_FILE\" %]\"", "", true );
+  insertRow( pos++, QgsAction::GenericPython, tr( "Get feature id" ), "QtGui.QMessageBox.information(None, \"Feature id\", \"feature id is [% $id %]\")", "", false );
+  insertRow( pos++, QgsAction::GenericPython, tr( "Selected field's value (Identify features tool)" ), "QtGui.QMessageBox.information(None, \"Current field's value\", \"[% $currentfield %]\")", "", false );
+  insertRow( pos++, QgsAction::GenericPython, tr( "Clicked coordinates (Run feature actions tool)" ), "QtGui.QMessageBox.information(None, \"Clicked coords\", \"layer: [% $layerid %]\\ncoords: ([% $clickx %],[% $clicky %])\")", "", false );
+  insertRow( pos++, QgsAction::OpenUrl, tr( "Open file" ), "[% \"PATH\" %]", "", false );
+  insertRow( pos++, QgsAction::OpenUrl, tr( "Search on web based on attribute's value" ), "http://www.google.com/search?q=[% \"ATTRIBUTE\" %]", "", false );
 }
 
 void QgsAttributeActionDialog::itemSelectionChanged()
diff --git a/src/app/qgsattributeactiondialog.h b/src/app/qgsattributeactiondialog.h
@@ -58,10 +58,11 @@ class APP_EXPORT QgsAttributeActionDialog: public QWidget, private Ui::QgsAttrib
 
   private slots:
     void updateButtons();
+    void chooseIcon();
 
   private:
 
-    void insertRow( int row, QgsAction::ActionType type, const QString &name, const QString &action, bool capture );
+    void insertRow(int row, QgsAction::ActionType type, const QString &name, const QString &action, const QString& iconPath, bool capture );
     void swapRows( int row1, int row2 );
 
     void insert( int pos );
diff --git a/src/core/qgsattributeaction.cpp b/src/core/qgsattributeaction.cpp
@@ -45,6 +45,11 @@ void QgsAttributeAction::addAction( QgsAction::ActionType type, QString name, QS
   mActions << QgsAction( type, name, action, capture );
 }
 
+void QgsAttributeAction::addAction(QgsAction::ActionType type, QString name, QString action, const QString& icon, bool capture)
+{
+  mActions << QgsAction( type, name, action, icon, capture );
+}
+
 void QgsAttributeAction::removeAction( int index )
 {
   if ( index >= 0 && index < mActions.size() )
@@ -236,6 +241,7 @@ bool QgsAttributeAction::writeXML( QDomNode& layer_node, QDomDocument& doc ) con
     QDomElement actionSetting = doc.createElement( "actionsetting" );
     actionSetting.setAttribute( "type", mActions[i].type() );
     actionSetting.setAttribute( "name", mActions[i].name() );
+    actionSetting.setAttribute( "icon", mActions[i].iconPath() );
     actionSetting.setAttribute( "action", mActions[i].action() );
     actionSetting.setAttribute( "capture", mActions[i].capture() );
     aActions.appendChild( actionSetting );
@@ -260,6 +266,7 @@ bool QgsAttributeAction::readXML( const QDomNode& layer_node )
       addAction(( QgsAction::ActionType ) setting.attributeNode( "type" ).value().toInt(),
                 setting.attributeNode( "name" ).value(),
                 setting.attributeNode( "action" ).value(),
+                setting.attributeNode( "icon" ).value(),
                 setting.attributeNode( "capture" ).value().toInt() != 0 );
     }
   }
diff --git a/src/core/qgsattributeaction.h b/src/core/qgsattributeaction.h
@@ -25,7 +25,7 @@
 #define QGSATTRIBUTEACTION_H
 
 #include <QString>
-#include <QObject>
+#include <QIcon>
 
 #include <qgsfeature.h>
 
@@ -53,9 +53,18 @@ class CORE_EXPORT QgsAction
     QgsAction( ActionType type, QString name, QString action, bool capture ) :
         mType( type ), mName( name ), mAction( action ), mCaptureOutput( capture ) {}
 
+    QgsAction( ActionType type, QString name, QString action, const QString& icon, bool capture ) :
+        mType( type ), mName( name ), mIcon( icon ), mAction( action ), mCaptureOutput( capture ) {}
+
     //! The name of the action
     QString name() const { return mName; }
 
+    //! The path to the icon
+    const QString iconPath() const { return mIcon; }
+
+    //! The icon
+    const QIcon icon() const { return QIcon( mIcon ); }
+
     //! The action
     QString action() const { return mAction; }
 
@@ -84,6 +93,7 @@ class CORE_EXPORT QgsAction
   private:
     ActionType mType;
     QString mName;
+    QString mIcon;
     QString mAction;
     bool mCaptureOutput;
 };
@@ -102,13 +112,22 @@ class  CORE_EXPORT QgsAttributeAction
     //! Destructor
     virtual ~QgsAttributeAction() {}
 
-    //! Add an action with the given name and action details.
-    // Will happily have duplicate names and actions. If
-    // capture is true, when running the action using doAction(),
-    // any stdout from the process will be captured and displayed in a
-    // dialog box.
+    /** Add an action with the given name and action details.
+     * Will happily have duplicate names and actions. If
+     * capture is true, when running the action using doAction(),
+     * any stdout from the process will be captured and displayed in a
+     * dialog box.
+     */
     void addAction( QgsAction::ActionType type, QString name, QString action, bool capture = false );
 
+    /** Add an action with the given name and action details.
+     * Will happily have duplicate names and actions. If
+     * capture is true, when running the action using doAction(),
+     * any stdout from the process will be captured and displayed in a
+     * dialog box.
+     */
+    void addAction(QgsAction::ActionType type, QString name, QString action, const QString& icon, bool capture = false );
+
     //! Remove an action at given index
     void removeAction( int index );
 
diff --git a/src/gui/qgsactionmenu.cpp b/src/gui/qgsactionmenu.cpp
@@ -126,7 +126,7 @@ void QgsActionMenu::reloadActions()
   {
     const QgsAction& qaction( mActions->at( idx ) );
 
-    QAction* action = new QAction( qaction.name(), this );
+    QAction* action = new QAction( qaction.icon(), qaction.name(), this );
 
     // Only enable items on supported platforms
     if ( !qaction.runable() )
diff --git a/src/ui/qgsattributeactiondialogbase.ui b/src/ui/qgsattributeactiondialogbase.ui
@@ -291,6 +291,13 @@
        </widget>
       </item>
       <item row="2" column="0">
+       <widget class="QLabel" name="label_2">
+        <property name="text">
+         <string>Icon</string>
+        </property>
+       </widget>
+      </item>
+      <item row="3" column="0">
        <widget class="QLabel" name="textLabel2">
         <property name="whatsThis">
          <string>Enter the action here. This can be any program, script or command that is available on your system. When the action is invoked any set of characters that start with a % and then have the name of a field will be replaced by the value of that field. The special characters %% will be replaced by the value of the field that was selected. Double quote marks group text into single arguments to the program, script or command. Double quotes will be ignored if prefixed with a backslash</string>
@@ -303,7 +310,7 @@
         </property>
        </widget>
       </item>
-      <item row="2" column="1">
+      <item row="3" column="1">
        <layout class="QGridLayout" name="gridLayout_4">
         <item row="0" column="1">
          <widget class="QToolButton" name="browseButton">
@@ -356,7 +363,7 @@
         </item>
        </layout>
       </item>
-      <item row="3" column="1">
+      <item row="4" column="1">
        <layout class="QHBoxLayout" name="horizontalLayout_2">
         <item>
          <widget class="QPushButton" name="insertExpressionButton">
@@ -415,7 +422,7 @@
         </item>
        </layout>
       </item>
-      <item row="4" column="0" colspan="2">
+      <item row="5" column="0" colspan="2">
        <layout class="QHBoxLayout" name="horizontalLayout_3">
         <item>
          <spacer name="horizontalSpacer">
@@ -455,6 +462,39 @@
         </item>
        </layout>
       </item>
+      <item row="2" column="1">
+       <layout class="QHBoxLayout" name="horizontalLayout_5">
+        <item>
+         <widget class="QLabel" name="iconPreview">
+          <property name="sizePolicy">
+           <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+            <horstretch>24</horstretch>
+            <verstretch>24</verstretch>
+           </sizepolicy>
+          </property>
+          <property name="minimumSize">
+           <size>
+            <width>24</width>
+            <height>24</height>
+           </size>
+          </property>
+          <property name="text">
+           <string/>
+          </property>
+         </widget>
+        </item>
+        <item>
+         <widget class="QLineEdit" name="actionIcon"/>
+        </item>
+        <item>
+         <widget class="QToolButton" name="chooseIconButton">
+          <property name="text">
+           <string>...</string>
+          </property>
+         </widget>
+        </item>
+       </layout>
+      </item>
      </layout>
      <widget class="QLabel" name="label">
       <property name="geometry">

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ void QgsActionMenu::reloadActions()`
`126`	`126`	`{`
`127`	`127`	`const QgsAction& qaction( mActions->at( idx ) );`
`128`	`128`
`129`		`- QAction* action = new QAction( qaction.name(), this );`
	`129`	`+ QAction* action = new QAction( qaction.icon(), qaction.name(), this );`
`130`	`130`
`131`	`131`	`// Only enable items on supported platforms`
`132`	`132`	`if ( !qaction.runable() )`