Utils.h

Go to the documentation of this file.

/*
  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

  This file is part of the TerraLib - a Framework for building GIS enabled applications.

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

  TerraLib 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 Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with TerraLib. See COPYING. If not, write to
  TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
  \file terralib/qsci/ceditor/Utils.h

  \brief Utility functions for dealing with code editor.
*/

#ifndef __TERRALIB_QSCI_CEDITOR_UTILS_H__
#define __TERRALIB_QSCI_CEDITOR_UTILS_H__

// TerraLib
#include "../Config.h"

// Qt
#include <QIcon>

// Qt Forward Declaration
class QObject;
class QString;

// QScintilla Forward Declaration
class QsciLexer;

namespace te
{
  namespace ce
  {
    /*!
      \brief A factory method for language lexers.
     */
    QsciLexer* LexerFactory(const QString& lang, QObject* parent = 0);

    /*!
      \brief A factory method for language icons.
     */
    QIcon ScriptIconFactory(const QString& lang);

    /*!
      \brief Returns the icon related to the extension of the file.

      \param fileName Name of the file that contains the script. Script allowed are written in Python and Lua.
     */
    TECEDITOREXPORT QIcon CreateLangIcon(const QString& fileName);
  }
}

#endif // __TERRALIB_QSCI_CEDITOR_UTILS_H__