summaryrefslogtreecommitdiffstats
path: root/interfaces/tdetexteditor/highlightinginterface.h
diff options
context:
space:
mode:
Diffstat (limited to 'interfaces/tdetexteditor/highlightinginterface.h')
-rw-r--r--interfaces/tdetexteditor/highlightinginterface.h92
1 files changed, 92 insertions, 0 deletions
diff --git a/interfaces/tdetexteditor/highlightinginterface.h b/interfaces/tdetexteditor/highlightinginterface.h
new file mode 100644
index 000000000..e7bd811e2
--- /dev/null
+++ b/interfaces/tdetexteditor/highlightinginterface.h
@@ -0,0 +1,92 @@
+/* This file is part of the KDE project
+ 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 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 __tdetexteditor_highlightinginterface_h__
+#define __tdetexteditor_highlightinginterface_h__
+
+#include <tdelibs_export.h>
+
+class TQString;
+class TQCString;
+
+namespace KTextEditor
+{
+
+/**
+* This is an interface for syntax highlighting of a Document.
+*/
+class KTEXTEDITOR_EXPORT HighlightingInterface
+{
+ friend class PrivateHighlightingInterface;
+
+ public:
+ HighlightingInterface ();
+ virtual ~HighlightingInterface ();
+
+ unsigned int highlightingInterfaceNumber () const;
+
+ protected:
+ void setHighlightingInterfaceDCOPSuffix (const TQCString &suffix);
+
+ //
+ // slots !!!
+ //
+ public:
+ /**
+ * returns the current active highlighting mode
+ */
+ virtual unsigned int hlMode () = 0;
+
+ /**
+ * set the current active highlighting mode
+ */
+ virtual bool setHlMode (unsigned int mode) = 0;
+
+ /**
+ * returns the number of available highlightings
+ */
+ virtual unsigned int hlModeCount () = 0;
+
+ /**
+ * returns the name of the highlighting with number "mode"
+ */
+ virtual TQString hlModeName (unsigned int mode) = 0;
+
+ /**
+ * returns the sectionname of the highlighting with number "mode"
+ */
+ virtual TQString hlModeSectionName (unsigned int mode) = 0;
+
+ //
+ // signals !!!
+ //
+ public:
+ virtual void hlChanged () = 0;
+
+ private:
+ class PrivateHighlightingInterface *d;
+ static unsigned int globalHighlightingInterfaceNumber;
+ unsigned int myHighlightingInterfaceNumber;
+};
+
+KTEXTEDITOR_EXPORT HighlightingInterface *highlightingInterface (class Document *doc);
+
+}
+
+#endif