backend.h

Go to the documentation of this file.

/*
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA  02110-1301, USA.

    ---
    Copyright (C) 2009 Alexander Rieder <alexanderrieder@gmail.com>
 */

#ifndef _BACKEND_H
#define _BACKEND_H

#include <QObject>
#include <QVariant>
#include <kxmlguiclient.h>
#include <kplugininfo.h>

#include "cantor_export.h"

class KConfigSkeleton;
class QWidget;

namespace Cantor
{
class Session;
class Extension;
class BackendPrivate;

class CANTOR_EXPORT Backend : public QObject, public KXMLGUIClient
{
  Q_OBJECT
  public:
    enum Capability{
        Nothing = 0x0,             
        LaTexOutput = 0x1,         
        InteractiveMode = 0x2,     
        SyntaxHighlighting = 0x4,  
        Completion = 0x8,          
        SyntaxHelp = 0x10,         
    VariableManagement= 0x20   
    };
    Q_DECLARE_FLAGS(Capabilities, Capability)

  protected:
    explicit Backend( QObject* parent = 0,const QList<QVariant> args=QList<QVariant>() );
    virtual ~Backend();
  public:
    
    virtual Session* createSession() = 0;
    virtual Capabilities capabilities() const = 0; 
    virtual bool requirementsFullfilled() const;

    virtual QString id() const = 0;

    //Stuff extracted from the .desktop file
    QString name() const;
    QString comment() const;
    QString icon() const;
    QString url() const;
    virtual KUrl helpUrl() const;
    bool isEnabled() const;
    void setEnabled(bool enabled);

    virtual QString description() const;
    virtual QWidget* settingsWidget(QWidget* parent) const;
    virtual KConfigSkeleton* config() const;
    QStringList extensions() const;
    Extension * extension(const QString& name) const;

    static QStringList listAvailableBackends();
    static QList<Backend*> availableBackends();
    static Backend* createBackend(const QString& name);
  private:
    BackendPrivate* d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(Backend::Capabilities)

}

#endif /* _BACKEND_H */