sessionconfiginterface.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
   Copyright (C) 2005 Dominik Haumann (dhdev@gmx.de) (documentation)
   Copyright (C) 2009 Michel Ludwig (michel.ludwig@kdemail.net)

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

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KDELIBS_KTEXTEDITOR_SESSIONCONFIGINTERFACE_H
#define KDELIBS_KTEXTEDITOR_SESSIONCONFIGINTERFACE_H

#include <ktexteditor/ktexteditor_export.h>

class KConfigGroup;

#include <QtCore/QObject>

namespace KTextEditor
{

class KTEXTEDITOR_EXPORT SessionConfigInterface
{
  public:
    SessionConfigInterface();

    virtual ~SessionConfigInterface();

  //
  // SLOTS !!!
  //
  public:
    virtual void readSessionConfig (const KConfigGroup& config) = 0;

    virtual void writeSessionConfig (KConfigGroup& config) = 0;

  private:
    class SessionConfigInterfacePrivate* const d;
};


class KTEXTEDITOR_EXPORT ParameterizedSessionConfigInterface
{
  public:
    ParameterizedSessionConfigInterface();

    virtual ~ParameterizedSessionConfigInterface();

  public:

    enum SessionConfigParameter {
      SkipNone          = 0,
      SkipUrl           = 1 << 0,
      SkipMode          = 1 << 1,
      SkipHighlighting  = 1 << 2,
      SkipEncoding      = 1 << 3,

      // TODO KDE5: remove for KDE5, since text folding moved to the View
      SkipFolding       = 1 << 4
    };

    virtual void readParameterizedSessionConfig (const KConfigGroup& config,
                                                 unsigned long parameters) = 0;

    virtual void writeParameterizedSessionConfig (KConfigGroup& config,
                                                  unsigned long parameters) = 0;
};


}

Q_DECLARE_INTERFACE(KTextEditor::SessionConfigInterface, "org.kde.KTextEditor.SessionConfigInterface")
Q_DECLARE_INTERFACE(KTextEditor::ParameterizedSessionConfigInterface, "org.kde.KTextEditor.ParameterizedSessionConfigInterface")

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;