kateexternaltools.h

/*
   This file is part of the Kate text editor of the KDE project.
   It describes a "external tools" action for kate and provides a dialog
   page to configure that.
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   This library 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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
 
   ---
   Copyright (C) 2004, Anders Lund <anders@alweb.dk>
*/
 
#ifndef _KATE_EXTERNAL_TOOLS_H_
#define _KATE_EXTERNAL_TOOLS_H_
 
#include <tdeaction.h>
#include <kdialogbase.h>
#include <kate/document.h>
#include <kmacroexpander.h>
#include <tqpixmap.h>

class KateExternalToolsMenuAction : public TDEActionMenu
{
  friend class KateExternalToolAction;
 
  TQ_OBJECT
  public:
    KateExternalToolsMenuAction( const TQString &text=TQString::null, TQObject *parent=0, const char* name=0, class KateMainWindow *mw=0 );
    ~KateExternalToolsMenuAction() {};

    void reload();
 
    class TDEActionCollection *actionCollection() { return m_actionCollection; }
 
  private slots:
    void slotDocumentChanged();
 
  private:
    class TDEActionCollection *m_actionCollection;
    class KateMainWindow *mainwindow; // for the actions to access view/doc managers
};

class KateExternalToolAction : public TDEAction, public KWordMacroExpander
{
  TQ_OBJECT
  public:
    KateExternalToolAction( TQObject *parent, const char *name, class KateExternalTool *t );
    ~KateExternalToolAction();
  protected:
    virtual bool expandMacro( const TQString &str, TQStringList &ret );
 
  private slots:
    void slotRun();
 
  public:
    class KateExternalTool *tool;
};

class KateExternalTool
{
  public:
    KateExternalTool( const TQString &name=TQString::null,
                      const TQString &command=TQString::null,
                      const TQString &icon=TQString::null,
                      const TQString &tryexec=TQString::null,
                      const TQStringList &mimetypes=TQStringList(),
                      const TQString &acname=TQString::null,
                      const TQString &cmdname=TQString::null,
                      int save=0 );
    ~KateExternalTool() {};
 
    TQString name; 
    TQString command; 
    TQString icon; 
    TQString tryexec; 
    TQStringList mimetypes; 
    bool hasexec; 
    TQString acname; 
    TQString cmdname; 
    int save; 

    bool valid( const TQString &mimetype ) const;
    bool checkExec();
 
  private:
    TQString m_exec; 
};

class KateExternalToolsConfigWidget : public Kate::ConfigPage
{
  TQ_OBJECT
  public:
    KateExternalToolsConfigWidget( TQWidget *parent, const char* name);
    virtual ~KateExternalToolsConfigWidget();
 
    virtual void apply();
    virtual void reload();
    virtual void reset() { reload(); } // sigh
    virtual void defaults() { reload(); } // double sigh
 
  private slots:
    void slotNew();
    void slotEdit();
    void slotRemove();
    void slotInsertSeparator();
 
    void slotMoveUp();
    void slotMoveDown();
 
    void slotSelectionChanged();
 
  private:
    TQPixmap blankIcon();
 
    TQStringList m_removed;
 
    class TDEListBox *lbTools;
    class TQPushButton *btnNew, *btnRemove, *btnEdit, *btnMoveUp, *btnMoveDwn;
 
    class TDEConfig *config;
 
    bool m_changed;
};

 class KateExternalToolsCommand : public Kate::Command {
 public:
    KateExternalToolsCommand ();
    virtual ~KateExternalToolsCommand () {};
    static KateExternalToolsCommand *self();
    void reload();
  public:
    virtual TQStringList cmds ();
    virtual bool exec (Kate::View *view, const TQString &cmd, TQString &msg);
    virtual bool help (Kate::View *view, const TQString &cmd, TQString &msg);
  private:
    static KateExternalToolsCommand *s_self;
    TQStringList m_list;
    TQMap<TQString,TQString> m_map;
    bool m_inited;
 };

class KateExternalToolServiceEditor : public KDialogBase
{
  TQ_OBJECT
 
  public:
 
    KateExternalToolServiceEditor( KateExternalTool *tool=0,
                       TQWidget *parent=0, const char *name=0 );
 
    class TQLineEdit *leName, *leExecutable, *leMimetypes,*leCmdLine;
    class TQTextEdit *teCommand;
    class TDEIconButton *btnIcon;
    class TQComboBox *cmbSave;
 
  private slots:
    void slotOk();
    void showMTDlg();
 
  private:
    KateExternalTool *tool;
};
#endif //_KATE_EXTERNAL_TOOLS_H_