summaryrefslogtreecommitdiffstats
path: root/qt/qextscintillalexerbatch.h
diff options
context:
space:
mode:
Diffstat (limited to 'qt/qextscintillalexerbatch.h')
-rw-r--r--qt/qextscintillalexerbatch.h119
1 files changed, 119 insertions, 0 deletions
diff --git a/qt/qextscintillalexerbatch.h b/qt/qextscintillalexerbatch.h
new file mode 100644
index 0000000..517edfb
--- /dev/null
+++ b/qt/qextscintillalexerbatch.h
@@ -0,0 +1,119 @@
+// This defines the interface to the QextScintillaLexerBatch class.
+//
+// Copyright (c) 2006
+// Riverbank Computing Limited <info@riverbankcomputing.co.uk>
+//
+// This file is part of QScintilla.
+//
+// This copy of QScintilla is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2, or (at your option) any
+// later version.
+//
+// QScintilla is supplied 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 General Public License for more
+// details.
+//
+// You should have received a copy of the GNU General Public License along with
+// QScintilla; see the file LICENSE. If not, write to the Free Software
+// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+
+#ifndef QEXTSCINTILLALEXERBATCH_H
+#define QEXTSCINTILLALEXERBATCH_H
+
+
+#include <qobject.h>
+
+#include <qextscintillaglobal.h>
+#include <qextscintillalexer.h>
+
+
+//! \brief The QextScintillaLexerBatch class encapsulates the Scintilla batch
+//! file lexer.
+class QEXTSCINTILLA_EXPORT QextScintillaLexerBatch : public QextScintillaLexer
+{
+ Q_OBJECT
+
+public:
+ //! This enum defines the meanings of the different styles used by the
+ //! batch file lexer.
+ enum {
+ //! The default.
+ Default = 0,
+
+ //! A comment.
+ Comment = 1,
+
+ //! A keyword.
+ Keyword = 2,
+
+ //! A label.
+ Label = 3,
+
+ //! An hide command character.
+ HideCommandChar = 4,
+
+ //! An external command .
+ ExternalCommand = 5,
+
+ //! A variable.
+ Variable = 6,
+
+ //! An operator
+ Operator = 7
+ };
+
+ //! Construct a QextScintillaLexerBatch with parent \a parent and name
+ //! \a name. \a parent is typically the QextScintilla instance.
+ QextScintillaLexerBatch(QObject *parent = 0,const char *name = 0);
+
+ //! Destroys the QextScintillaLexerBatch instance.
+ virtual ~QextScintillaLexerBatch();
+
+ //! Returns the name of the language.
+ const char *language() const;
+
+ //! Returns the name of the lexer. Some lexers support a number of
+ //! languages.
+ const char *lexer() const;
+
+ //! \internal Returns the string of characters that comprise a word.
+ const char *wordCharacters() const;
+
+ //! Returns the foreground colour of the text for style number
+ //! \a style.
+ //!
+ //! \sa paper()
+ QColor color(int style) const;
+
+ //! Returns the end-of-line fill for style number \a style.
+ bool eolFill(int style) const;
+
+ //! Returns the font for style number \a style.
+ QFont font(int style) const;
+
+ //! Returns the set of keywords for the keyword set \a set recognised
+ //! by the lexer as a space separated string.
+ const char *keywords(int set) const;
+
+ //! Returns the descriptive name for style number \a style. If the
+ //! style is invalid for this language then QString::null is returned.
+ //! This is intended to be used in user preference dialogs.
+ QString description(int style) const;
+
+ //! Returns the background colour of the text for style number
+ //! \a style.
+ //!
+ //! \sa color()
+ QColor paper(int style) const;
+
+private:
+#if defined(Q_DISABLE_COPY)
+ QextScintillaLexerBatch(const QextScintillaLexerBatch &);
+ QextScintillaLexerBatch &operator=(const QextScintillaLexerBatch &);
+#endif
+};
+
+#endif