• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KTextEditor

  • interfaces
  • ktexteditor
loadsavefiltercheckplugin.h
Go to the documentation of this file.
1 /* This file is part of the KDE libraries
2  Copyright (C) 2001,2006 Joseph Wenninger <jowenn@kde.org>
3  [katedocument.cpp, LGPL v2 only]
4 
5 ================RELICENSED=================
6 
7  This file is part of the KDE libraries
8  Copyright (C) 2008 Joseph Wenninger <jowenn@kde.org>
9 
10  This library is free software; you can redistribute it and/or
11  modify it under the terms of the GNU Library General Public
12  License as published by the Free Software Foundation; either
13  version 2 of the License, or (at your option) any later version.
14 
15  This library is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  Library General Public License for more details.
19 
20  You should have received a copy of the GNU Library General Public License
21  along with this library; see the file COPYING.LIB. If not, write to
22  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  Boston, MA 02110-1301, USA.
24 */
25 
26 #ifndef KDELIBS_KTEXTEDITOR_LOADSAVEFILTERCHECKPLUGIN_H
27 #define KDELIBS_KTEXTEDITOR_LOADSAVEFILTERCHECKPLUGIN_H
28 
29 //BEGIN includes
30 #include <ktexteditor/document.h>
31 #include <QtCore/QObject>
32 //END includes
33 
34 namespace KTextEditor
35 {
36 
37 class LoadSaveFilterCheckPluginPrivate;
38 
42 class KTEXTEDITOR_EXPORT LoadSaveFilterCheckPlugin:public QObject {
43  Q_OBJECT
44  public:
45  LoadSaveFilterCheckPlugin(QObject *parent); //expect parent to be 0
46  virtual ~LoadSaveFilterCheckPlugin();
47  /*this one is called once everything is set up for saving (especially the encoding has been determind (example: used for checking python source encoding headers))
48  return true if saving should continue, false to abort
49  */
50  virtual bool preSavePostDialogFilterCheck(KTextEditor::Document *document) =0;
51  /*this one is called after the file has been saved
52  return true if following plugins should be handled*/
53  virtual bool postSaveFilterCheck(KTextEditor::Document *document, bool saveas) =0;
54  /*this one is called once the document has been completely loaded and configured (encoding,highlighting, ...))*/
55  virtual void postLoadFilter(KTextEditor::Document *document) =0;
56  private:
57  class LoadSaveFilterCheckPluginPrivate* const d;
58 };
59 
60 }
61 
62 #endif
63 
64 // kate: space-indent on; indent-width 2; replace-tabs on;
QObject
KTextEditor::Document
A KParts derived class representing a text document.
Definition: document.h:111
document.h
KTextEditor::LoadSaveFilterCheckPlugin
Plugin for load/save filtering.
Definition: loadsavefiltercheckplugin.h:42
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Sat May 31 2014 00:05:49 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal