kate

documentmanager.h

00001 /* This file is part of the KDE project
00002    Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
00003 
00004    This library is free software; you can redistribute it and/or
00005    modify it under the terms of the GNU Library General Public
00006    License version 2 as published by the Free Software Foundation.
00007 
00008    This library is distributed in the hope that it will be useful,
00009    but WITHOUT ANY WARRANTY; without even the implied warranty of
00010    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011    Library General Public License for more details.
00012 
00013    You should have received a copy of the GNU Library General Public License
00014    along with this library; see the file COPYING.LIB.  If not, write to
00015    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00016    Boston, MA 02110-1301, USA.
00017 */
00018 
00019 #ifndef _KATE_DOCMANAGER_INCLUDE_
00020 #define _KATE_DOCMANAGER_INCLUDE_
00021 
00022 #include <qobject.h>
00023 #include <kurl.h>
00024 
00025 namespace Kate
00026 {
00029 class KDE_EXPORT DocumentManager : public QObject
00030 {
00031   friend class PrivateDocumentManager;
00032 
00033   Q_OBJECT
00034 
00035   public:
00036     DocumentManager ( void *documentManager  );
00037     virtual ~DocumentManager ();
00038 
00039   public:
00042     class Document *document (uint n = 0);
00045     class Document *activeDocument ();
00048     class Document *documentWithID (uint id);
00049 
00052     int findDocument (const KURL &url);
00055     bool isOpen (const KURL &url);
00056 
00059     uint documents ();
00060 
00064     class Document *openURL(const KURL&url,const QString &encoding=QString::null,uint *id =0);
00067     bool closeDocument(class Document *document);
00070     bool closeDocument(uint n = 0);
00073     bool closeDocumentWithID(uint id);
00076     bool closeAllDocuments();
00077 
00078   #undef signals
00079   #define signals public
00080   signals:
00081   #undef signals
00082   #define signals protected
00083 
00087     void documentChanged ();
00088     
00092     void documentCreated (Kate::Document *document);
00093     
00097     void documentDeleted (uint documentNumber);
00098 
00099   private:
00100     class PrivateDocumentManager *d;
00101 };
00102 
00107 KDE_EXPORT DocumentManager *documentManager ();
00108 
00109 }
00110 
00111 #endif
kate

documentmanager.h

kate

API Reference
