src/plugins/coreplugin/editormanager/ieditor.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 (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #include "ieditor.h"
  34
  35 /*!
  36   \class Core::IEditor
  37   \brief The IEditor is an interface for providing different editors for different file types.
  38
  39   Classes that implement this interface are for example the editors for
  40   C++ files, ui-files and resource files.
  41
  42   Whenever a user wants to edit or create a file, the EditorManager scans all
  43   EditorFactoryInterfaces for suitable editors. The selected EditorFactory
  44   is then asked to create an editor, which must implement this interface.
  45
  46   Guidelines for implementing:
  47   \list
  48   \o displayName() is used as a user visible description of the document (usually filename w/o path).
  49   \o kind() must be the same value as the kind() of the corresponding EditorFactory.
  50   \o The changed() signal should be emitted when the modified state of the document changes
  51      (so /bold{not} every time the document changes, but /bold{only once}).
  52   \o If duplication is supported, you need to ensure that all duplicates
  53         return the same file().
  54   \o QString preferredMode() const is the mode the editor manager should activate.
  55      Some editors use a special mode (such as Design mode).
  56   \endlist
  57
  58   \sa Core::EditorFactoryInterface Core::IContext
  59
  60 */