summaryrefslogtreecommitdiffstats
path: root/interfaces/ktexteditor/document.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /interfaces/ktexteditor/document.h
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'interfaces/ktexteditor/document.h')
-rw-r--r--interfaces/ktexteditor/document.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/interfaces/ktexteditor/document.h b/interfaces/ktexteditor/document.h
new file mode 100644
index 000000000..9260d596c
--- /dev/null
+++ b/interfaces/ktexteditor/document.h
@@ -0,0 +1,73 @@
+/* This file is part of the KDE libraries
+ Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License version 2 as published by the Free Software Foundation.
+
+ 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 __ktexteditor_document_h__
+#define __ktexteditor_document_h__
+
+#include "editor.h"
+
+namespace KTextEditor
+{
+
+/**
+ * The main class representing a text document.
+ * This class provides access to the document's views.
+ */
+class KTEXTEDITOR_EXPORT Document : public KTextEditor::Editor
+{
+ friend class PrivateDocument;
+
+ Q_OBJECT
+
+ public:
+ Document ( QObject *parent = 0, const char *name = 0 );
+ virtual ~Document ();
+
+ /**
+ * Returns the global number of this document in your app.
+ */
+ unsigned int documentNumber () const;
+
+ /**
+ * Returns this document's DCOP suffix for identifiying its DCOP interface.
+ */
+ QCString documentDCOPSuffix () const;
+
+ /**
+ * Create a view that will display the document data. You can create as many
+ * views as you like. When the user modifies data in one view then all other
+ * views will be updated as well.
+ */
+ virtual class View *createView ( QWidget *parent, const char *name = 0 ) = 0;
+
+ /*
+ * Returns a list of all views of this document.
+ */
+ virtual QPtrList<class View> views () const = 0;
+
+ private:
+ class PrivateDocument *d;
+ static unsigned int globalDocumentNumber;
+ unsigned int myDocumentNumber;
+};
+
+KTEXTEDITOR_EXPORT Document *createDocument ( const char* libname, QObject *parent = 0, const char *name = 0 );
+
+}
+
+#endif