doc/pluginhowto/examples/htmleditor/htmleditor.h

   1 /***************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the documentation of Qt Creator.
   8 **
   9 ** You may use this file under the terms of the BSD license as follows:
  10 **
  11 ** "Redistribution and use in source and binary forms, with or without
  12 ** modification, are permitted provided that the following conditions are
  13 ** met:
  14 **   * Redistributions of source code must retain the above copyright
  15 **     notice, this list of conditions and the following disclaimer.
  16 **   * Redistributions in binary form must reproduce the above copyright
  17 **     notice, this list of conditions and the following disclaimer in
  18 **     the documentation and/or other materials provided with the
  19 **     distribution.
  20 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
  21 **     the names of its contributors may be used to endorse or promote
  22 **     products derived from this software without specific prior written
  23 **     permission.
  24 **
  25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  36 **
  37 ****************************************************************************/
  38
  39 #ifndef HTMLEDITOR_H
  40 #define HTMLEDITOR_H
  41
  42 #include "coreplugin/editormanager/ieditor.h"
  43
  44 #include <QToolBar>
  45
  46 class HTMLEditorWidget;
  47
  48 struct HTMLEditorData;
  49 class HTMLEditor : public Core::IEditor
  50 {
  51     Q_OBJECT
  52
  53 public:
  54     HTMLEditor(HTMLEditorWidget* editorWidget);
  55     ~HTMLEditor();
  56
  57     bool createNew(const QString& contents = QString());
  58     QString displayName() const;
  59     IEditor* duplicate(QWidget* parent);
  60     bool duplicateSupported() const;
  61     Core::IFile* file();
  62     bool isTemporary() const;
  63     const char* kind() const;
  64     bool open(const QString& fileName = QString()) ;
  65     bool restoreState(const QByteArray& state);
  66     QByteArray saveState() const;
  67     void setDisplayName(const QString &title);
  68     QToolBar* toolBar();
  69
  70     // From Core::IContext
  71     QWidget* widget();
  72     QList<int> context() const;
  73
  74 protected slots:
  75     void slotTitleChanged(const QString& title)
  76     { setDisplayName(title); }
  77
  78 private:
  79     HTMLEditorData* d;
  80 };
  81
  82 #endif // HTMLEDITOR_H