Editing Mbarcode Plugin Tutorial

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

This tutorial will give you a quick introduction to writing plugins for [[mBarcode]]. We will try to guide you from your very first steps all the way to a full fledged plugin.

The plugin we are going to create will show a quick dialog with info about the data contained in the barcode.

== Prerequisites ==

In this tutorial we'll be using Qt together with C++ to connect to the mBarcode plugin framework. To make the process very easy we are also using Qt Creator to write our code and Scratchbox to test and compile it. You don't have to use Scratchbox or Qt Creator if you don't want to, but this is not covered by this tutorial.

Heck, you can even get through this without Qt installed, but bare in mind that you are on your own then.

You must have:
* Some basic knowledge about C++ and Qt
* Scratchbox installed
* Qt
* Access to a terminal
* An OS with dpkg

You could use:
* Qt Creator

Using [[MADDE]] for development is currently a bit of a pain since it lacks an option for third party libraries. This might be unnecessary for plugins, but MADDE is in any case not covered by this tutorial as of yet.

== Writing the plugin ==

Using Scratchbox is the easiest way to get started. Log in to Scratchbox by typing

/scratchbox/login

Install the <code>mbarcode-dev</code> package

apt-get install mbarcode-dev

Next, create a new "Empty Qt project" using Qt Creator and store this in <code>/scratchbox/users/<your username>/home/<your username>/</code>. For the sake of simplicity, we'll name our project "plugin".

Alternatively, create an empty folder using the terminal and add an empty plugin.pro file.

=== The project file ===

Add the following to your plugin.pro file:

<pre>
TEMPLATE = lib
CONFIG += plugin
INCLUDEPATH += ../..

HEADERS = plugin.h \
    showdialogaction.h
SOURCES = plugin.cpp \
    showdialogaction.cpp
TARGET = $$qtLibraryTarget(mbarcode_myplugin)

unix {
    # VARIABLES
    isEmpty(PREFIX):PREFIX = /usr
    BINDIR = $$PREFIX/bin
    DATADIR = $$PREFIX/share
    DEFINES += DATADIR=\"$$DATADIR\" \
        PKGDATADIR=\"$$PKGDATADIR\"

# MAKE INSTALL
    INSTALLS += target
    target.path = $$DATADIR/mbarcode/plugins
}
OTHER_FILES += debian/changelog \
    debian/control
</pre>

=== The plugin actions ===

Let's add some actions for our plugin! In Qt Creator, right click on your project and select "Add New...". Choose "C++ Class" and name it <code>ShowDialogAction</code>.

Open the <code>showdialogaction.h</code> file and overwrite it with the following:

<source lang="cpp">
#ifndef SHOWDIALOGACTION_H
#define SHOWDIALOGACTION_H

#include <mbarcode-qt/plugininterfaces.h>
#include <mbarcode-qt/pluginaction.h>

class ShowDialogAction : public QObject, public PluginAction
{
    Q_OBJECT
public:
    ShowDialogAction(const PluginInterface *interface);

QString getName() { return "My Plugin Action"; } // This name is just for convenience
    QString getText(); // This is the text that will show in the list
    bool isReady() { return ready; } // Tells the list wether this plugin is ready to be shown or not
    void clickAction(QWidget *parentWindow); // The action which is called whenever we are clicked

private slots:
    void barcodeAnalysed(QString barcodeType, QString barcodeData); // The slot where all the processing goes down

private:
    bool ready;
    QString barcodeType;
    QString barcodeData;
};

#endif // SHOWDIALOGACTION_H
</source>

Open the <code>showdialogaction.cpp</code> file and overwrite it with the following:

<source lang="cpp">
#include "showdialogaction.h"

#include <QMessageBox>

ShowDialogAction::ShowDialogAction(const PluginInterface *interface) : PluginAction(interface)
{
    // Do your initialization here.
    // Remember to set ready to false.
    // This keeps the plugin from appearing in the list before it is ready

ready = false;
}

QString ShowDialogAction::getText() {
    // This is the text which will show in the list of results.

return "Show Dialog";
}

void ShowDialogAction::clickAction(QWidget* parentWindow)
{
    // This is what happens when the user clicks our button.
    // In this example we only show a message box

QMessageBox *msgBox = new QMessageBox(parentWindow);
    msgBox->setWindowTitle("My Plugin");
    msgBox->setText("The barcode was of type " + barcodeType + " and contained the data " + barcodeData);
    msgBox->exec();
}

void ShowDialogAction::barcodeAnalysed(QString barcodeType, QString barcodeData) {

// In this function you process the data. This could be used for early web lookups or whatever.
    // We just store the data in memory for now.

this->barcodeType = barcodeType;
    this->barcodeData = barcodeData;

// We've done what we need to and are ready to show ourselves

ready = true;
}
</source>

You could add more classes like this if you want different buttons with different actions, but for now, this will do.

=== Plugin interface ===

Let's connect to mBarcode's plugin interface. In Qt Creator, right click on your project and select "Add New...". Choose "C++ Class" and name it <code>Plugin</code>.

Open your <code>plugin.h</code> file and overwrite it with the following:

<source lang="cpp">
#ifndef PLUGIN_H
#define PLUGIN_H

#include <QObject>

#include <mbarcode-qt/plugininterfaces.h>
#include <mbarcode-qt/pluginaction.h>

class Plugin : public QObject, public PluginInterface
{
    Q_OBJECT
    Q_INTERFACES(PluginInterface)
public:
    void initInterface(QWidget *parent);

QSet<PluginAction*> getPluginActions(); // returns a list of actions this plugin provides
    QString getName() { return "My Plugin"; } // a name of your choosing

private:
    QWidget *parent;
    QSet<PluginAction*> pluginActions;

};

#endif // PLUGIN_H
</source>

Open your <code>plugin.cpp</code> file and add the following:

<source lang="cpp">
#include "plugin.h"
#include "showdialogaction.h"

void Plugin::initInterface(QWidget *parent)
{
    this->parent = parent;

// Create an action

ShowDialogAction *showDialogAction = new ShowDialogAction(this);

// Add our action to the list

pluginActions.insert(showDialogAction);

// Connect the signal from the MaemoBarcodeWindow to our Action classes.

connect(parent, SIGNAL(barcodeAnalysedSignal(QString,QString)),
            showDialogAction, SLOT(barcodeAnalysed(QString,QString)));

// If you like to, you can connect this to whatever you want.
    // This means that you could even connect it to a slot in this class.
    // We've only chosen to do it this way for convenience.
}

QSet<PluginAction*> Plugin::getPluginActions() {
    return pluginActions;
}

Q_EXPORT_PLUGIN2(mbqt_myplugin, Plugin) // Please change this name
</source>

=== Testing your fancy new plugin ===

There you go! You are now ready to build your plugin and test it out. Before we build a complete Debian package, let's see if everything works.

Build your plugin by issuing this command in your project folder in Scratchbox:

qmake && make

Go to your directory and pick up the new file named <code>libmbarcode_myplugin.so</code>. Copy this to your device and place it in <code>/home/user/.config/mbarcode/plugins</code>.

Start mBarcode and scan a barcode as usual. Your plugin should now show up.

==== Troubleshooting ====

If your plugin doesn't load, please run mbarcode from terminal and look for error messages during the loading of the application.

== Creating a Debian package ==

To be continued...

[[Category:Development]]
[[Category:mBarcode]]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Retrieved from "http://wiki.maemo.org/Mbarcode_Plugin_Tutorial"

Personal tools

Navigation

Views

Editing Mbarcode Plugin Tutorial

@@ Line 19: / Line 19: @@
 * Qt Creator
-Using [[MADDE]] for development is currently a bit of a pain since it lacks an option for third party libraries. There is a tutorial that covers writing these plugins using the Nokia Qt SDK available here [[Mbarcode_Plugin_Tutorial_MADDE]]
+Using [[MADDE]] for development is currently a bit of a pain since it lacks an option for third party libraries. This might be unnecessary for plugins, but MADDE is in any case not covered by this tutorial as of yet.
 == Writing the plugin ==
@@ Line 76: / Line 76: @@
 #define SHOWDIALOGACTION_H
-#include <QtCore>
 #include <mbarcode-qt/plugininterfaces.h>
 #include <mbarcode-qt/pluginaction.h>
-class ShowDialogAction : public PluginAction
+class ShowDialogAction : public QObject, public PluginAction
 {
      Q_OBJECT
 public:
      ShowDialogAction(const PluginInterface *interface);
-     QString getName() { return "EAN Local Analyser"; } // This name is just for convenience
+     QString getName() { return "My Plugin Action"; } // This name is just for convenience
      QString getText(); // This is the text that will show in the list
+    bool isReady() { return ready; } // Tells the list wether this plugin is ready to be shown or not
      void clickAction(QWidget *parentWindow); // The action which is called whenever we are clicked
-signals:
-    void isReady();
 private slots:
      void barcodeAnalysed(QString barcodeType, QString barcodeData); // The slot where all the processing goes down
 private:
+    bool ready;
      QString barcodeType;
      QString barcodeData;
 };
-//Q_DECLARE_METATYPE(ShowDialogAction *);
 #endif // SHOWDIALOGACTION_H
@@ Line 112: / Line 112: @@
 {
      // Do your initialization here.
+    // Remember to set ready to false.
+    // This keeps the plugin from appearing in the list before it is ready
+    ready = false;
 }
 QString ShowDialogAction::getText() {
      // This is the text which will show in the list of results.
      return "Show Dialog";
 }
 void ShowDialogAction::clickAction(QWidget* parentWindow)
 {
      // This is what happens when the user clicks our button.
-     QMessageBox msg(parentWindow);
+     // In this example we only show a message box
-     msg.setWindowTitle("You clicked the button!");
-     msg.setText("A window should be a dynamic object. Otherwise it is removed at the end of this function. A message box, on the other hand, has the exec().");
+    QMessageBox *msgBox = new QMessageBox(parentWindow);
-     msg.exec();
+     msgBox->setWindowTitle("My Plugin");
+     msgBox->setText("The barcode was of type " + barcodeType + " and contained the data " + barcodeData);
+     msgBox->exec();
 }
 void ShowDialogAction::barcodeAnalysed(QString barcodeType, QString barcodeData) {
      // In this function you process the data. This could be used for early web lookups or whatever.
      // We just store the data in memory for now.
      this->barcodeType = barcodeType;
      this->barcodeData = barcodeData;
      // We've done what we need to and are ready to show ourselves
-     emit isReady();
+     ready = true;
 }
 </source>
@@ Line 144: / Line 158: @@
 <source lang="cpp">
-// This is a plugin used as an example in different tutorials.
 #ifndef PLUGIN_H
 #define PLUGIN_H
@@ Line 216: / Line 228: @@
   qmake && make
-Go to your directory and pick up the new file named <code>libmbarcode_myplugin.so</code>. Copy this to your device and place it in <code>/home/user/.config/mbarcode/plugins</code>. (Note: final plugins are stored in <code>/usr/share/mbarcode/plugins</code>. The former path with .config didn't work for me).
+Go to your directory and pick up the new file named <code>libmbarcode_myplugin.so</code>. Copy this to your device and place it in <code>/home/user/.config/mbarcode/plugins</code>.
 Start mBarcode and scan a barcode as usual. Your plugin should now show up.