kde-extraapps/kdevelop/formatters/customscript/customscript_plugin.h

/* This file is part of KDevelop
   Copyright (C) 2008 Cédric Pasteur <cedric.pasteur@free.fr>
   Copyright (C) 2011 David Nolden <david.nolden.kdevelop@art-master.de>

   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; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.

 */

#ifndef CUSTOMSCRIPTPLUGIN_H
#define CUSTOMSCRIPTPLUGIN_H

#include <interfaces/iplugin.h>
#include <interfaces/isourceformatter.h>
#include <QVBoxLayout>
#include <QLabel>
#include <QLineEdit>
#include <QTimer>
#include <QPushButton>

class CustomScriptPlugin : public KDevelop::IPlugin, public KDevelop::ISourceFormatter
{
		Q_OBJECT
		Q_INTERFACES(KDevelop::ISourceFormatter)

	public:
		explicit CustomScriptPlugin(QObject *parent, const QVariantList & = QVariantList());
		~CustomScriptPlugin();

		virtual QString name();
		virtual QString caption();
		virtual QString description();

		/** Formats using the current style.
		*/
		virtual QString formatSource(const QString &text, const KUrl& url, const KMimeType::Ptr &mime, const QString& leftContext, const QString& rightContext);

		virtual QString formatSourceWithStyle(KDevelop::SourceFormatterStyle, const QString& text,
											  const KUrl& url,
											  const KMimeType::Ptr &mime,
											  const QString& leftContext = QString(),
											  const QString& rightContext = QString() );
		
		/** \return A map of predefined styles (a key and a caption for each type)
		*/
		virtual QList<KDevelop::SourceFormatterStyle> predefinedStyles();

		/** \return The widget to edit a style.
		*/
		virtual KDevelop::SettingsWidget* editStyleWidget(const KMimeType::Ptr &mime);

		/** \return The text used in the config dialog to preview the current style.
		*/
		virtual QString previewText(const KDevelop::SourceFormatterStyle& style, const KMimeType::Ptr &mime);

		/** \return The indentation of the currently selected style.
		*/
		virtual Indentation indentation(const KUrl& url);

	private:
		QStringList computeIndentationFromSample(const KUrl& url);
		
		QStringList m_options;
		KDevelop::SourceFormatterStyle m_currentStyle;
		KDevelop::SourceFormatterStyle predefinedStyle(const QString& name);
};

class CustomScriptPreferences : public KDevelop::SettingsWidget {
Q_OBJECT
public:
	CustomScriptPreferences() ;
		
    virtual void load ( const KDevelop::SourceFormatterStyle& style ) ;
    
    virtual QString save() ;
private:
	QVBoxLayout* m_vLayout;
	QLabel* m_captionLabel;
	QHBoxLayout* m_hLayout;
	QLabel* m_commandLabel;
	QLineEdit* m_commandEdit;
	QLabel* m_bottomLabel;
	QTimer* m_updateTimer;
	QPushButton* m_moreVariablesButton;
	KDevelop::SourceFormatterStyle m_style;
	
private slots:
	void textEdited ( QString ) {
		m_updateTimer->start(1000);
	}
	
	void updateTimeout();
    void moreVariablesClicked ( bool );
};


#endif // CUSTOMSCRIPTPLUGIN_H

// kate: indent-mode cstyle; space-indent off; tab-width 4;