src/plugins/coreplugin/editormanager/iexternaleditor.cpp

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #include "iexternaleditor.h"
  35
  36 /*!
  37     \class Core::IExternalEditor
  38     \mainclass
  39
  40     \brief Core::IExternalEditor allows for registering an external
  41     Editor in the \gui{Open With...} dialogs .
  42 */
  43
  44 /*!
  45     \fn IExternalEditor::IExternalEditor(QObject *parent)
  46     \internal
  47 */
  48
  49 /*!
  50     \fn IExternalEditor::~IExternalEditor()
  51     \internal
  52 */
  53
  54 /*!
  55     \fn QStringList IExternalEditor::mimeTypes() const
  56     Returns the mime type the editor supports
  57 */
  58
  59 /*!
  60     \fn QString IExternalEditor::kind() const
  61     Returns the editor kind (identifying string).
  62 */
  63
  64 /*!
  65
  66     \fn bool IExternalEditor::startEditor(const QString &fileName, QString *errorMessage) = 0;
  67
  68     Opens the editor with \param fileName. Returns true on success or false
  69     on failure along with the error in \param errorMessage.
  70 */