octave: libgui/languages/build_ts/octave-qsci/Qsci/qsciscintilla.h comparison

comparison libgui/languages/build_ts/octave-qsci/Qsci/qsciscintilla.h @ 31537:5ceb4bfcdb0f stable

add tools and files for updating the gui's language files for translation * libgui/languages/build_ts/README.md: readme for updating language files * libgui/languages/build_ts/octave-qsci: QScintilla source files for languages without translation provided by QScintilla * libgui/languages/build_ts/octave-qt: Qt source files for languages without translation provided by Qt

author	Torsten Lilge <ttl-octave@mailbox.org>
date	Thu, 24 Nov 2022 06:48:25 +0100
parents
children	dd5ece3664ed

comparison

equal deleted inserted replaced

-:4b80982e0af8
+:5ceb4bfcdb0f
+// This module defines the "official" high-level API of the Qt port of
+// Scintilla.
+//
+// Copyright (c) 2019 Riverbank Computing Limited <info@riverbankcomputing.com>
+//
+// This file is part of QScintilla.
+//
+// This file may be used under the terms of the GNU General Public License
+// version 3.0 as published by the Free Software Foundation and appearing in
+// the file LICENSE included in the packaging of this file.  Please review the
+// following information to ensure the GNU General Public License version 3.0
+// requirements will be met: http://www.gnu.org/copyleft/gpl.html.
+//
+// If you do not wish to use this file under the terms of the GPL version 3.0
+// then you may purchase a commercial license.  For more information contact
+// info@riverbankcomputing.com.
+//
+// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+#ifndef QSCISCINTILLA_H
+#define QSCISCINTILLA_H
+#include <QByteArray>
+#include <QList>
+#include <QObject>
+#include <QPointer>
+#include <QStringList>
+#include <Qsci/qsciglobal.h>
+#include <Qsci/qscicommand.h>
+#include <Qsci/qscidocument.h>
+#include <Qsci/qsciscintillabase.h>
+QT_BEGIN_NAMESPACE
+class QAction;
+class QImage;
+class QIODevice;
+class QMenu;
+class QPoint;
+QT_END_NAMESPACE
+class QsciCommandSet;
+class QsciLexer;
+class QsciStyle;
+class QsciStyledText;
+class QsciListBoxQt;
+//! \brief The QsciScintilla class implements a higher level, more Qt-like,
+//! API to the Scintilla editor widget.
+//!
+//! QsciScintilla implements methods, signals and slots similar to those found
+//! in other Qt editor classes. It also provides a higher level interface to
+//! features specific to Scintilla such as syntax styling, call tips,
+//! auto-indenting and auto-completion than that provided by QsciScintillaBase.
+class QSCINTILLA_EXPORT QsciScintilla : public QsciScintillaBase
+{
+Q_OBJECT
+public:
+//! This enum defines the different auto-indentation styles.
+enum {
+//! A line is automatically indented to match the previous line.
+AiMaintain = 0x01,
+//! If the language supported by the current lexer has a specific start
+//! of block character (e.g. { in C++), then a line that begins with
+//! that character is indented as well as the lines that make up the
+//! block.  It may be logically ored with AiClosing.
+AiOpening = 0x02,
+//! If the language supported by the current lexer has a specific end
+//! of block character (e.g. } in C++), then a line that begins with
+//! that character is indented as well as the lines that make up the
+//! block.  It may be logically ored with AiOpening.
+AiClosing = 0x04
+};
+//! This enum defines the different annotation display styles.
+enum AnnotationDisplay {
+//! Annotations are not displayed.
+AnnotationHidden = ANNOTATION_HIDDEN,
+//! Annotations are drawn left justified with no adornment.
+AnnotationStandard = ANNOTATION_STANDARD,
+//! Annotations are surrounded by a box.
+AnnotationBoxed = ANNOTATION_BOXED,
+//! Annotations are indented to match the text.
+AnnotationIndented = ANNOTATION_INDENTED,
+};
+//! This enum defines the behavior if an auto-completion list contains a
+//! single entry.
+enum AutoCompletionUseSingle {
+//! The single entry is not used automatically and the auto-completion
+//! list is displayed.
+AcusNever,
+//! The single entry is used automatically when auto-completion is
+//! explicitly requested (using autoCompleteFromAPIs() or
+//! autoCompleteFromDocument()) but not when auto-completion is
+//! triggered as the user types.
+AcusExplicit,
+//! The single entry is used automatically and the auto-completion list
+//! is not displayed.
+AcusAlways
+};
+//! This enum defines the different sources for auto-completion lists.
+enum AutoCompletionSource {
+//! No sources are used, ie. automatic auto-completion is disabled.
+AcsNone,
+//! The source is all available sources.
+AcsAll,
+//! The source is the current document.
+AcsDocument,
+//! The source is any installed APIs.
+AcsAPIs
+};
+//! This enum defines the different brace matching modes.  The character
+//! pairs {}, [] and () are treated as braces.  The Python lexer will also
+//! match a : with the end of the corresponding indented block.
+enum BraceMatch {
+//! Brace matching is disabled.
+NoBraceMatch,
+//! Brace matching is enabled for a brace immediately before the
+//! current position.
+StrictBraceMatch,
+//! Brace matching is enabled for a brace immediately before or after
+//! the current position.
+SloppyBraceMatch
+};
+//! This enum defines the different call tip positions.
+enum CallTipsPosition {
+//! Call tips are placed below the text.
+CallTipsBelowText,
+//! Call tips are placed above the text.
+CallTipsAboveText,
+};
+//! This enum defines the different call tip styles.
+enum CallTipsStyle {
+//! Call tips are disabled.
+CallTipsNone,
+//! Call tips are displayed without a context.  A context is any scope
+//! (e.g. a C++ namespace or a Python module) prior to the function
+//! name.
+CallTipsNoContext,
+//! Call tips are displayed with a context only if the user hasn't
+//! already implicitly identified the context using autocompletion.
+//! Note that this style may not always be able to align the call tip
+//! with the text being entered.
+CallTipsNoAutoCompletionContext,
+//! Call tips are displayed with a context.  Note that this style
+//! may not always be able to align the call tip with the text being
+//! entered.
+CallTipsContext
+};
+//! This enum defines the different edge modes for long lines.
+enum EdgeMode {
+//! Long lines are not marked.
+EdgeNone = EDGE_NONE,
+//! A vertical line is drawn at the column set by setEdgeColumn().
+//! This is recommended for monospace fonts.
+EdgeLine = EDGE_LINE,
+//! The background color of characters after the column limit is
+//! changed to the color set by setEdgeColor().  This is recommended
+//! for proportional fonts.
+EdgeBackground = EDGE_BACKGROUND,
+//! Multiple vertical lines are drawn at the columns defined by
+//! multiple calls to addEdgeColumn().
+EdgeMultipleLines = EDGE_MULTILINE,
+};
+//! This enum defines the different end-of-line modes.
+enum EolMode {
+//! A carriage return/line feed as used on Windows systems.
+EolWindows = SC_EOL_CRLF,
+//! A line feed as used on Unix systems, including OS/X.
+EolUnix = SC_EOL_LF,
+//! A carriage return as used on Mac systems prior to OS/X.
+EolMac = SC_EOL_CR
+};
+//! This enum defines the different styles for the folding margin.
+enum FoldStyle {
+//! Folding is disabled.
+NoFoldStyle,
+//! Plain folding style using plus and minus symbols.
+PlainFoldStyle,
+//! Circled folding style using circled plus and minus symbols.
+CircledFoldStyle,
+//! Boxed folding style using boxed plus and minus symbols.
+BoxedFoldStyle,
+//! Circled tree style using a flattened tree with circled plus and
+//! minus symbols and rounded corners.
+CircledTreeFoldStyle,
+//! Boxed tree style using a flattened tree with boxed plus and minus
+//! symbols and right-angled corners.
+BoxedTreeFoldStyle
+};
+//! This enum defines the different indicator styles.
+enum IndicatorStyle {
+//! A single straight underline.
+PlainIndicator = INDIC_PLAIN,
+//! A squiggly underline that requires 3 pixels of descender space.
+SquiggleIndicator = INDIC_SQUIGGLE,
+//! A line of small T shapes.
+TTIndicator = INDIC_TT,
+//! Diagonal hatching.
+DiagonalIndicator = INDIC_DIAGONAL,
+//! Strike out.
+StrikeIndicator = INDIC_STRIKE,
+//! An indicator with no visual appearence.
+HiddenIndicator = INDIC_HIDDEN,
+//! A rectangle around the text.
+BoxIndicator = INDIC_BOX,
+//! A rectangle with rounded corners around the text with the interior
+//! usually more transparent than the border.
+RoundBoxIndicator = INDIC_ROUNDBOX,
+//! A rectangle around the text with the interior usually more
+//! transparent than the border.  It does not colour the top pixel of
+//! the line so that indicators on contiguous lines are visually
+//! distinct and disconnected.
+StraightBoxIndicator = INDIC_STRAIGHTBOX,
+//! A rectangle around the text with the interior usually more
+//! transparent than the border.  Unlike StraightBoxIndicator it covers
+//! the entire character area.
+FullBoxIndicator = INDIC_FULLBOX,
+//! A dashed underline.
+DashesIndicator = INDIC_DASH,
+//! A dotted underline.
+DotsIndicator = INDIC_DOTS,
+//! A squiggly underline that requires 2 pixels of descender space and
+//! so will fit under smaller fonts.
+SquiggleLowIndicator = INDIC_SQUIGGLELOW,
+//! A dotted rectangle around the text with the interior usually more
+//! transparent than the border.
+DotBoxIndicator = INDIC_DOTBOX,
+//! A version of SquiggleIndicator that uses a pixmap.  This is quicker
+//! but may be of lower quality.
+SquigglePixmapIndicator = INDIC_SQUIGGLEPIXMAP,
+//! A thick underline typically used for the target during Asian
+//! language input composition.
+ThickCompositionIndicator = INDIC_COMPOSITIONTHICK,
+//! A thin underline typically used for non-target ranges during Asian
+//! language input composition.
+ThinCompositionIndicator = INDIC_COMPOSITIONTHIN,
+//! The color of the text is set to the color of the indicator's
+//! foreground.
+TextColorIndicator = INDIC_TEXTFORE,
+//! A triangle below the start of the indicator range.
+TriangleIndicator = INDIC_POINT,
+//! A triangle below the centre of the first character in the indicator
+//! range.
+TriangleCharacterIndicator = INDIC_POINTCHARACTER,
+//! A vertical gradient between the indicator's foreground colour at
+//! top to fully transparent at the bottom.
+GradientIndicator = INDIC_GRADIENT,
+//! A vertical gradient with the indicator's foreground colour in the
+//! middle and fading to fully transparent at the top and bottom.
+CentreGradientIndicator = INDIC_GRADIENTCENTRE,
+};
+//! This enum defines the different margin options.
+enum {
+//! Reset all margin options.
+MoNone = SC_MARGINOPTION_NONE,
+//! If this is set then only the first sub-line of a wrapped line will
+//! be selected when clicking on a margin.
+MoSublineSelect = SC_MARGINOPTION_SUBLINESELECT
+};
+//! This enum defines the different margin types.
+enum MarginType {
+//! The margin contains symbols, including those used for folding.
+SymbolMargin = SC_MARGIN_SYMBOL,
+//! The margin contains symbols and uses the default foreground color
+//! as its background color.
+SymbolMarginDefaultForegroundColor = SC_MARGIN_FORE,
+//! The margin contains symbols and uses the default background color
+//! as its background color.
+SymbolMarginDefaultBackgroundColor = SC_MARGIN_BACK,
+//! The margin contains line numbers.
+NumberMargin = SC_MARGIN_NUMBER,
+//! The margin contains styled text.
+TextMargin = SC_MARGIN_TEXT,
+//! The margin contains right justified styled text.
+TextMarginRightJustified = SC_MARGIN_RTEXT,
+//! The margin contains symbols and uses the color set by
+//! setMarginBackgroundColor() as its background color.
+SymbolMarginColor = SC_MARGIN_COLOUR,
+};
+//! This enum defines the different pre-defined marker symbols.
+enum MarkerSymbol {
+//! A circle.
+Circle = SC_MARK_CIRCLE,
+//! A rectangle.
+Rectangle = SC_MARK_ROUNDRECT,
+//! A triangle pointing to the right.
+RightTriangle = SC_MARK_ARROW,
+//! A smaller rectangle.
+SmallRectangle = SC_MARK_SMALLRECT,
+//! An arrow pointing to the right.
+RightArrow = SC_MARK_SHORTARROW,
+//! An invisible marker that allows code to track the movement
+//! of lines.
+Invisible = SC_MARK_EMPTY,
+//! A triangle pointing down.
+DownTriangle = SC_MARK_ARROWDOWN,
+//! A drawn minus sign.
+Minus = SC_MARK_MINUS,
+//! A drawn plus sign.
+Plus = SC_MARK_PLUS,
+//! A vertical line drawn in the background colour.
+VerticalLine = SC_MARK_VLINE,
+//! A bottom left corner drawn in the background colour.
+BottomLeftCorner = SC_MARK_LCORNER,
+//! A vertical line with a centre right horizontal line drawn
+//! in the background colour.
+LeftSideSplitter = SC_MARK_TCORNER,
+//! A drawn plus sign in a box.
+BoxedPlus = SC_MARK_BOXPLUS,
+//! A drawn plus sign in a connected box.
+BoxedPlusConnected = SC_MARK_BOXPLUSCONNECTED,
+//! A drawn minus sign in a box.
+BoxedMinus = SC_MARK_BOXMINUS,
+//! A drawn minus sign in a connected box.
+BoxedMinusConnected = SC_MARK_BOXMINUSCONNECTED,
+//! A rounded bottom left corner drawn in the background
+//! colour.
+RoundedBottomLeftCorner = SC_MARK_LCORNERCURVE,
+//! A vertical line with a centre right curved line drawn in the
+//! background colour.
+LeftSideRoundedSplitter = SC_MARK_TCORNERCURVE,
+//! A drawn plus sign in a circle.
+CircledPlus = SC_MARK_CIRCLEPLUS,
+//! A drawn plus sign in a connected box.
+CircledPlusConnected = SC_MARK_CIRCLEPLUSCONNECTED,
+//! A drawn minus sign in a circle.
+CircledMinus = SC_MARK_CIRCLEMINUS,
+//! A drawn minus sign in a connected circle.
+CircledMinusConnected = SC_MARK_CIRCLEMINUSCONNECTED,
+//! No symbol is drawn but the line is drawn with the same background
+//! color as the marker's.
+Background = SC_MARK_BACKGROUND,
+//! Three drawn dots.
+ThreeDots = SC_MARK_DOTDOTDOT,
+//! Three drawn arrows pointing right.
+ThreeRightArrows = SC_MARK_ARROWS,
+//! A full rectangle (ie. the margin background) using the marker's
+//! background color.
+FullRectangle = SC_MARK_FULLRECT,
+//! A left rectangle (ie. the left part of the margin background) using
+//! the marker's background color.
+LeftRectangle = SC_MARK_LEFTRECT,
+//! No symbol is drawn but the line is drawn underlined using the
+//! marker's background color.
+Underline = SC_MARK_UNDERLINE,
+//! A bookmark.
+Bookmark = SC_MARK_BOOKMARK,
+};
+//! This enum defines how tab characters are drawn when whitespace is
+//! visible.
+enum TabDrawMode {
+//! An arrow stretching to the tab stop.
+TabLongArrow = SCTD_LONGARROW,
+//! A horizontal line stretching to the tab stop.
+TabStrikeOut = SCTD_STRIKEOUT,
+};
+//! This enum defines the different whitespace visibility modes.  When
+//! whitespace is visible spaces are displayed as small centred dots and
+//! tabs are displayed as light arrows pointing to the right.
+enum WhitespaceVisibility {
+//! Whitespace is invisible.
+WsInvisible = SCWS_INVISIBLE,
+//! Whitespace is always visible.
+WsVisible = SCWS_VISIBLEALWAYS,
+//! Whitespace is visible after the whitespace used for indentation.
+WsVisibleAfterIndent = SCWS_VISIBLEAFTERINDENT,
+//! Whitespace used for indentation is visible.
+WsVisibleOnlyInIndent = SCWS_VISIBLEONLYININDENT,
+};
+//! This enum defines the different line wrap modes.
+enum WrapMode {
+//! Lines are not wrapped.
+WrapNone = SC_WRAP_NONE,
+//! Lines are wrapped at word boundaries.
+WrapWord = SC_WRAP_WORD,
+//! Lines are wrapped at character boundaries.
+WrapCharacter = SC_WRAP_CHAR,
+//! Lines are wrapped at whitespace boundaries.
+WrapWhitespace = SC_WRAP_WHITESPACE,
+};
+//! This enum defines the different line wrap visual flags.
+enum WrapVisualFlag {
+//! No wrap flag is displayed.
+WrapFlagNone,
+//! A wrap flag is displayed by the text.
+WrapFlagByText,
+//! A wrap flag is displayed by the border.
+WrapFlagByBorder,
+//! A wrap flag is displayed in the line number margin.
+WrapFlagInMargin
+};
+//! This enum defines the different line wrap indentation modes.
+enum WrapIndentMode {
+//! Wrapped sub-lines are indented by the amount set by
+//! setWrapVisualFlags().
+WrapIndentFixed = SC_WRAPINDENT_FIXED,
+//! Wrapped sub-lines are indented by the same amount as the first
+//! sub-line.
+WrapIndentSame = SC_WRAPINDENT_SAME,
+//! Wrapped sub-lines are indented by the same amount as the first
+//! sub-line plus one more level of indentation.
+WrapIndentIndented = SC_WRAPINDENT_INDENT,
+//! Wrapped sub-lines are indented by the same amount as the first
+//! sub-line plus two more level of indentation.
+WrapIndentDeeplyIndented = SC_WRAPINDENT_DEEPINDENT
+};
+//! Construct an empty QsciScintilla with parent \a parent.
+QsciScintilla(QWidget *parent = 0);
+//! Destroys the QsciScintilla instance.
+virtual ~QsciScintilla();
+//! Returns the API context, which is a list of words, before the position
+//! \a pos in the document.  The context can be used by auto-completion and
+//! call tips to help to identify which API call the user is referring to.
+//! In the default implementation the current lexer determines what
+//! characters make up a word, and what characters determine the boundaries
+//! of words (ie. the start characters).  If there is no current lexer then
+//! the context will consist of a single word.  On return \a context_start
+//! will contain the position in the document of the start of the context
+//! and \a last_word_start will contain the position in the document of the
+//! start of the last word of the context.
+virtual QStringList apiContext(int pos, int &context_start,
+int &last_word_start);
+//! Annotate the line \a line with the text \a text using the style number
+//! \a style.
+void annotate(int line, const QString &text, int style);
+//! Annotate the line \a line with the text \a text using the style \a
+//! style.
+void annotate(int line, const QString &text, const QsciStyle &style);
+//! Annotate the line \a line with the styled text \a text.
+void annotate(int line, const QsciStyledText &text);
+//! Annotate the line \a line with the list of styled text \a text.
+void annotate(int line, const QList<QsciStyledText> &text);
+//! Returns the annotation on line \a line, if any.
+QString annotation(int line) const;
+//! Returns the display style for annotations.
+//!
+//! \sa setAnnotationDisplay()
+AnnotationDisplay annotationDisplay() const;
+//! The annotations on line \a line are removed.  If \a line is negative
+//! then all annotations are removed.
+void clearAnnotations(int line = -1);
+//! Returns true if auto-completion lists are case sensitive.
+//!
+//! \sa setAutoCompletionCaseSensitivity()
+bool autoCompletionCaseSensitivity() const;
+//! Returns true if auto-completion fill-up characters are enabled.
+//!
+//! \sa setAutoCompletionFillups(), setAutoCompletionFillupsEnabled()
+bool autoCompletionFillupsEnabled() const;
+//! Returns true if the rest of the word to the right of the current cursor
+//! is removed when an item from an auto-completion list is selected.
+//!
+//! \sa setAutoCompletionReplaceWord()
+bool autoCompletionReplaceWord() const;
+//! Returns true if the only item in an auto-completion list with a single
+//! entry is automatically used and the list not displayed.  Note that this
+//! is deprecated and autoCompletionUseSingle() should be used instead.
+//!
+//! \sa setAutoCompletionShowSingle()
+bool autoCompletionShowSingle() const;
+//! Returns the current source for the auto-completion list when it is
+//! being displayed automatically as the user types.
+//!
+//! \sa setAutoCompletionSource()
+AutoCompletionSource autoCompletionSource() const {return acSource;}
+//! Returns the current threshold for the automatic display of the
+//! auto-completion list as the user types.
+//!
+//! \sa setAutoCompletionThreshold()
+int autoCompletionThreshold() const {return acThresh;}
+//! Returns the current behavior when an auto-completion list contains a
+//! single entry.
+//!
+//! \sa setAutoCompletionUseSingle()
+AutoCompletionUseSingle autoCompletionUseSingle() const;
+//! Returns true if auto-indentation is enabled.
+//!
+//! \sa setAutoIndent()
+bool autoIndent() const {return autoInd;}
+//! Returns true if the backspace key unindents a line instead of deleting
+//! a character.  The default is false.
+//!
+//! \sa setBackspaceUnindents(), tabIndents(), setTabIndents()
+bool backspaceUnindents() const;
+//! Mark the beginning of a sequence of actions that can be undone by a
+//! single call to undo().
+//!
+//! \sa endUndoAction(), undo()
+void beginUndoAction();
+//! Returns the brace matching mode.
+//!
+//! \sa setBraceMatching()
+BraceMatch braceMatching() const {return braceMode;}
+//! Returns the encoded text between positions \a start and \a end.  This
+//! is typically used by QsciLexerCustom::styleText().
+//!
+//! \sa text()
+QByteArray bytes(int start, int end) const;
+//! Returns the current call tip position.
+//!
+//! \sa setCallTipsPosition()
+CallTipsPosition callTipsPosition() const {return call_tips_position;}
+//! Returns the current call tip style.
+//!
+//! \sa setCallTipsStyle()
+CallTipsStyle callTipsStyle() const {return call_tips_style;}
+//! Returns the maximum number of call tips that are displayed.
+//!
+//! \sa setCallTipsVisible()
+int callTipsVisible() const {return maxCallTips;}
+//! Cancel any previous call to findFirst(), findFirstInSelection() or
+//! findNext() so that replace() does nothing.
+void cancelFind();
+//! Cancel any current auto-completion or user defined list.
+void cancelList();
+//! Returns true if the current language lexer is case sensitive.  If there
+//! is no current lexer then true is returned.
+bool caseSensitive() const;
+//! Clear all current folds, i.e. ensure that all lines are displayed
+//! unfolded.
+//!
+//! \sa setFolding()
+void clearFolds();
+//! Clears the range of text with indicator \a indicatorNumber starting at
+//! position \a indexFrom in line \a lineFrom and finishing at position
+//! \a indexTo in line \a lineTo.
+//!
+//! \sa fillIndicatorRange()
+void clearIndicatorRange(int lineFrom, int indexFrom, int lineTo,
+int indexTo, int indicatorNumber);
+//! Clear all registered images.
+//!
+//! \sa registerImage()
+void clearRegisteredImages();
+//! Returns the widget's text (ie. foreground) colour.
+//!
+//! \sa setColor()
+QColor color() const;
+//! Returns a list of the line numbers that have contracted folds.  This is
+//! typically used to save the fold state of a document.
+//!
+//! \sa setContractedFolds()
+QList<int> contractedFolds() const;
+//! All the lines of the text have their end-of-lines converted to mode
+//! \a mode.
+//!
+//! \sa eolMode(), setEolMode()
+void convertEols(EolMode mode);
+//! Create the standard context menu which is shown when the user clicks
+//! with the right mouse button.  It is called from contextMenuEvent().
+//! The menu's ownership is transferred to the caller.
+QMenu *createStandardContextMenu();
+//! Returns the attached document.
+//!
+//! \sa setDocument()
+QsciDocument document() const {return doc;}
+//! Mark the end of a sequence of actions that can be undone by a single
+//! call to undo().
+//!
+//! \sa beginUndoAction(), undo()
+void endUndoAction();
+//! Returns the color of the marker used to show that a line has exceeded
+//! the length set by setEdgeColumn().
+//!
+//! \sa setEdgeColor(), \sa setEdgeColumn
+QColor edgeColor() const;
+//! Returns the number of the column after which lines are considered to be
+//! long.
+//!
+//! \sa setEdgeColumn()
+int edgeColumn() const;
+//! Returns the edge mode which determines how long lines are marked.
+//!
+//! \sa setEdgeMode()
+EdgeMode edgeMode() const;
+//! Set the default font.  This has no effect if a language lexer has been
+//! set.
+void setFont(const QFont &f);
+//! Returns the end-of-line mode.
+//!
+//! \sa setEolMode()
+EolMode eolMode() const;
+//! Returns the visibility of end-of-lines.
+//!
+//! \sa setEolVisibility()
+bool eolVisibility() const;
+//! Returns the extra space added to the height of a line above the
+//! baseline of the text.
+//!
+//! \sa setExtraAscent(), extraDescent()
+int extraAscent() const;
+//! Returns the extra space added to the height of a line below the
+//! baseline of the text.
+//!
+//! \sa setExtraDescent(), extraAscent()
+int extraDescent() const;
+//! Fills the range of text with indicator \a indicatorNumber starting at
+//! position \a indexFrom in line \a lineFrom and finishing at position
+//! \a indexTo in line \a lineTo.
+//!
+//! \sa clearIndicatorRange()
+void fillIndicatorRange(int lineFrom, int indexFrom, int lineTo,
+int indexTo, int indicatorNumber);
+//! Find the first occurrence of the string \a expr and return true if
+//! \a expr was found, otherwise returns false.  If \a expr is found it
+//! becomes the current selection.
+//!
+//! If \a re is true then \a expr is interpreted as a regular expression
+//! rather than a simple string.
+//!
+//! If \a cs is true then the search is case sensitive.
+//!
+//! If \a wo is true then the search looks for whole word matches only,
+//! otherwise it searches for any matching text.
+//!
+//! If \a wrap is true then the search wraps around the end of the text.
+//!
+//! If \a forward is true (the default) then the search is forward from the
+//! starting position to the end of the text, otherwise it is backwards to
+//! the beginning of the text.
+//!
+//! If either \a line or \a index are negative (the default) then the
+//! search begins from the current cursor position.  Otherwise the search
+//! begins at position \a index of line \a line.
+//!
+//! If \a show is true (the default) then any text found is made visible
+//! (ie. it is unfolded).
+//!
+//! If \a posix is true then a regular expression is treated in a more
+//! POSIX compatible manner by interpreting bare ( and ) as tagged sections
+//! rather than \( and \).
+//!
+//! If \a cxx11 is true then a regular expression is treated as a Cxx11
+//! regular expression.
+//!
+//! \sa cancelFind(), findFirstInSelection(), findNext(), replace()
+virtual bool findFirst(const QString &expr, bool re, bool cs, bool wo,
+bool wrap, bool forward = true, int line = -1, int index = -1,
+bool show = true, bool posix = false, bool cxx11 = false);
+//! Find the first occurrence of the string \a expr in the current
+//! selection and return true if \a expr was found, otherwise returns
+//! false.  If \a expr is found it becomes the current selection.  The
+//! original selection is restored when a subsequent call to findNext()
+//! returns false.
+//!
+//! If \a re is true then \a expr is interpreted as a regular expression
+//! rather than a simple string.
+//!
+//! If \a cs is true then the search is case sensitive.
+//!
+//! If \a wo is true then the search looks for whole word matches only,
+//! otherwise it searches for any matching text.
+//!
+//! If \a forward is true (the default) then the search is forward from the
+//! start to the end of the selection, otherwise it is backwards from the
+//! end to the start of the selection.
+//!
+//! If \a show is true (the default) then any text found is made visible
+//! (ie. it is unfolded).
+//!
+//! If \a posix is true then a regular expression is treated in a more
+//! POSIX compatible manner by interpreting bare ( and ) as tagged sections
+//! rather than \( and \).
+//!
+//! If \a cxx11 is true then a regular expression is treated as a Cxx11
+//! regular expression.
+//!
+//! \sa cancelFind(), findFirst(), findNext(), replace()
+virtual bool findFirstInSelection(const QString &expr, bool re, bool cs,
+bool wo, bool forward = true, bool show = true,
+bool posix = false, bool cxx11 = false);
+//! Find the next occurence of the string found using findFirst() or
+//! findFirstInSelection().
+//!
+//! \sa cancelFind(), findFirst(), findFirstInSelection(), replace()
+virtual bool findNext();
+//! Find a brace and it's match.  \a brace is updated with the position of
+//! the brace and will be -1 if there is none.  \a is updated with the
+//! position of the matching brace and will be -1 if there is none.
+//! \a mode specifies how braces are matched.  true is returned if the
+//! current position is inside a pair of braces.
+bool findMatchingBrace(long &brace, long &other, BraceMatch mode);
+//! Returns the number of the first visible line.
+//!
+//! \sa setFirstVisibleLine()
+int firstVisibleLine() const;
+//! Returns the current folding style.
+//!
+//! \sa setFolding()
+FoldStyle folding() const {return fold;}
+//! Sets \a *line and \a *index to the line and index of the cursor.
+//!
+//! \sa setCursorPosition()
+void getCursorPosition(int *line, int *index) const;
+//! If there is a selection, \a *lineFrom is set to the line number in
+//! which the selection begins and \a *lineTo is set to the line number in
+//! which the selection ends.  (They could be the same.)  \a *indexFrom is
+//! set to the index at which the selection begins within \a *lineFrom, and
+//! \a *indexTo is set to the index at which the selection ends within
+//! \a *lineTo.  If there is no selection, \a *lineFrom, \a *indexFrom,
+//! \a *lineTo and \a *indexTo are all set to -1.
+//!
+//! \sa setSelection()
+void getSelection(int *lineFrom, int *indexFrom, int *lineTo,
+int *indexTo) const;
+//! Returns true if some text is selected.
+//!
+//! \sa selectedText()
+bool hasSelectedText() const {return selText;}
+//! Returns the number of characters that line \a line is indented by.
+//!
+//! \sa setIndentation()
+int indentation(int line) const;
+//! Returns true if the display of indentation guides is enabled.
+//!
+//! \sa setIndentationGuides()
+bool indentationGuides() const;
+//! Returns true if indentations are created using tabs and spaces, rather
+//! than just spaces.  The default is true.
+//!
+//! \sa setIndentationsUseTabs()
+bool indentationsUseTabs() const;
+//! Returns the indentation width in characters.  The default is 0 which
+//! means that the value returned by tabWidth() is actually used.
+//!
+//! \sa setIndentationWidth(), tabWidth()
+int indentationWidth() const;
+//! Define a type of indicator using the style \a style with the indicator
+//! number \a indicatorNumber.  If \a indicatorNumber is -1 then the
+//! indicator number is automatically allocated.  The indicator number is
+//! returned or -1 if too many types of indicator have been defined.
+//!
+//! Indicators are used to display additional information over the top of
+//! styling.  They can be used to show, for example, syntax errors,
+//! deprecated names and bad indentation by drawing lines under text or
+//! boxes around text.
+//!
+//! There may be up to 32 types of indicator defined at a time.  The first
+//! 8 are normally used by lexers.  By default indicator number 0 is a
+//! dark green SquiggleIndicator, 1 is a blue TTIndicator, and 2 is a red
+//! PlainIndicator.
+int indicatorDefine(IndicatorStyle style, int indicatorNumber = -1);
+//! Returns true if the indicator \a indicatorNumber is drawn under the
+//! text (i.e. in the background).  The default is false.
+//!
+//! \sa setIndicatorDrawUnder()
+bool indicatorDrawUnder(int indicatorNumber) const;
+//! Returns true if a call tip is currently active.
+bool isCallTipActive() const;
+//! Returns true if an auto-completion or user defined list is currently
+//! active.
+bool isListActive() const;
+//! Returns true if the text has been modified.
+//!
+//! \sa setModified(), modificationChanged()
+bool isModified() const;
+//! Returns true if the text edit is read-only.
+//!
+//! \sa setReadOnly()
+bool isReadOnly() const;
+//! Returns true if there is something that can be redone.
+//!
+//! \sa redo()
+bool isRedoAvailable() const;
+//! Returns true if there is something that can be undone.
+//!
+//! \sa undo()
+bool isUndoAvailable() const;
+//! Returns true if text is interpreted as being UTF8 encoded.  The default
+//! is to interpret the text as Latin1 encoded.
+//!
+//! \sa setUtf8()
+bool isUtf8() const;
+//! Returns true if character \a ch is a valid word character.
+//!
+//! \sa wordCharacters()
+bool isWordCharacter(char ch) const;
+//! Returns the line which is at \a point pixel coordinates or -1 if there
+//! is no line at that point.
+int lineAt(const QPoint &point) const;
+//! QScintilla uses the combination of a line number and a character index
+//! from the start of that line to specify the position of a character
+//! within the text.  The underlying Scintilla instead uses a byte index
+//! from the start of the text.  This will convert the \a position byte
+//! index to the \a *line line number and \a *index character index.
+//!
+//! \sa positionFromLineIndex()
+void lineIndexFromPosition(int position, int *line, int *index) const;
+//! Returns the length of line \a line int bytes or -1 if there is no such
+//! line.  In order to get the length in characters use text(line).length().
+int lineLength(int line) const;
+//! Returns the number of lines of text.
+int lines() const;
+//! Returns the length of the text edit's text in bytes.  In order to get
+//! the length in characters use text().length().
+int length() const;
+//! Returns the current language lexer used to style text.  If it is 0 then
+//! syntax styling is disabled.
+//!
+//! \sa setLexer()
+QsciLexer *lexer() const;
+//! Returns the background color of margin \a margin.
+//!
+//! \sa setMarginBackgroundColor()
+QColor marginBackgroundColor(int margin) const;
+//! Returns true if line numbers are enabled for margin \a margin.
+//!
+//! \sa setMarginLineNumbers(), marginType(), SCI_GETMARGINTYPEN
+bool marginLineNumbers(int margin) const;
+//! Returns the marker mask of margin \a margin.
+//!
+//! \sa setMarginMask(), QsciMarker, SCI_GETMARGINMASKN
+int marginMarkerMask(int margin) const;
+//! Returns the margin options.  The default is MoNone.
+//!
+//! \sa setMarginOptions(), MoNone, MoSublineSelect.
+int marginOptions() const;
+//! Returns true if margin \a margin is sensitive to mouse clicks.
+//!
+//! \sa setMarginSensitivity(), marginClicked(), SCI_GETMARGINTYPEN
+bool marginSensitivity(int margin) const;
+//! Returns the type of margin \a margin.
+//!
+//! \sa setMarginType(), SCI_GETMARGINTYPEN
+MarginType marginType(int margin) const;
+//! Returns the width in pixels of margin \a margin.
+//!
+//! \sa setMarginWidth(), SCI_GETMARGINWIDTHN
+int marginWidth(int margin) const;
+//! Returns the number of margins.
+//!
+//! \sa setMargins()
+int margins() const;
+//! Define a type of marker using the symbol \a sym with the marker number
+//! \a markerNumber.  If \a markerNumber is -1 then the marker number is
+//! automatically allocated.  The marker number is returned or -1 if too
+//! many types of marker have been defined.
+//!
+//! Markers are small geometric symbols and characters used, for example,
+//! to indicate the current line or, in debuggers, to indicate breakpoints.
+//! If a margin has a width of 0 then its markers are not drawn, but their
+//! background colours affect the background colour of the corresponding
+//! line of text.
+//!
+//! There may be up to 32 types of marker defined at a time and each line
+//! of text has a set of marker instances associated with it.  Markers are
+//! drawn according to their numerical identifier.  Markers try to move
+//! with their text by tracking where the start of their line moves to.
+//! For example, when a line is deleted its markers are added to previous
+//! line's markers.
+//!
+//! Each marker type is identified by a marker number.  Each instance of a
+//! marker is identified by a marker handle.
+int markerDefine(MarkerSymbol sym, int markerNumber = -1);
+//! Define a marker using the character \a ch with the marker number
+//! \a markerNumber.  If \a markerNumber is -1 then the marker number is
+//! automatically allocated.  The marker number is returned or -1 if too
+//! many markers have been defined.
+int markerDefine(char ch, int markerNumber = -1);
+//! Define a marker using a copy of the pixmap \a pm with the marker number
+//! \a markerNumber.  If \a markerNumber is -1 then the marker number is
+//! automatically allocated.  The marker number is returned or -1 if too
+//! many markers have been defined.
+int markerDefine(const QPixmap &pm, int markerNumber = -1);
+//! Define a marker using a copy of the image \a im with the marker number
+//! \a markerNumber.  If \a markerNumber is -1 then the marker number is
+//! automatically allocated.  The marker number is returned or -1 if too
+//! many markers have been defined.
+int markerDefine(const QImage &im, int markerNumber = -1);
+//! Add an instance of marker number \a markerNumber to line number
+//! \a linenr.  A handle for the marker is returned which can be used to
+//! track the marker's position, or -1 if the \a markerNumber was invalid.
+//!
+//! \sa markerDelete(), markerDeleteAll(), markerDeleteHandle()
+int markerAdd(int linenr, int markerNumber);
+//! Returns the 32 bit mask of marker numbers at line number \a linenr.
+//!
+//! \sa markerAdd()
+unsigned markersAtLine(int linenr) const;
+//! Delete all markers with the marker number \a markerNumber in the line
+//! \a linenr.  If \a markerNumber is -1 then delete all markers from line
+//! \a linenr.
+//!
+//! \sa markerAdd(), markerDeleteAll(), markerDeleteHandle()
+void markerDelete(int linenr, int markerNumber = -1);
+//! Delete the all markers with the marker number \a markerNumber.  If
+//! \a markerNumber is -1 then delete all markers.
+//!
+//! \sa markerAdd(), markerDelete(), markerDeleteHandle()
+void markerDeleteAll(int markerNumber = -1);
+//! Delete the the marker instance with the marker handle \a mhandle.
+//!
+//! \sa markerAdd(), markerDelete(), markerDeleteAll()
+void markerDeleteHandle(int mhandle);
+//! Return the line number that contains the marker instance with the
+//! marker handle \a mhandle.
+int markerLine(int mhandle) const;
+//! Return the number of the next line to contain at least one marker from
+//! a 32 bit mask of markers.  \a linenr is the line number to start the
+//! search from.  \a mask is the mask of markers to search for.
+//!
+//! \sa markerFindPrevious()
+int markerFindNext(int linenr, unsigned mask) const;
+//! Return the number of the previous line to contain at least one marker
+//! from a 32 bit mask of markers.  \a linenr is the line number to start
+//! the search from.  \a mask is the mask of markers to search for.
+//!
+//! \sa markerFindNext()
+int markerFindPrevious(int linenr, unsigned mask) const;
+//! Returns true if text entered by the user will overwrite existing text.
+//!
+//! \sa setOverwriteMode()
+bool overwriteMode() const;
+//! Returns the widget's paper (ie. background) colour.
+//!
+//! \sa setPaper()
+QColor paper() const;
+//! QScintilla uses the combination of a line number and a character index
+//! from the start of that line to specify the position of a character
+//! within the text.  The underlying Scintilla instead uses a byte index
+//! from the start of the text.  This will return the byte index
+//! corresponding to the \a line line number and \a index character index.
+//!
+//! \sa lineIndexFromPosition()
+int positionFromLineIndex(int line, int index) const;
+//! Reads the current document from the \a io device and returns true if
+//! there was no error.
+//!
+//! \sa write()
+bool read(QIODevice *io);
+//! Recolours the document between the \a start and \a end positions.
+//! \a start defaults to the start of the document and \a end defaults to
+//! the end of the document.
+virtual void recolor(int start = 0, int end = -1);
+//! Register an image \a pm with ID \a id.  Registered images can be
+//! displayed in auto-completion lists.
+//!
+//! \sa clearRegisteredImages(), QsciLexer::apiLoad()
+void registerImage(int id, const QPixmap &pm);
+//! Register an image \a im with ID \a id.  Registered images can be
+//! displayed in auto-completion lists.
+//!
+//! \sa clearRegisteredImages(), QsciLexer::apiLoad()
+void registerImage(int id, const QImage &im);
+//! Replace the current selection, set by a previous call to findFirst(),
+//! findFirstInSelection() or findNext(), with \a replaceStr.
+//!
+//! \sa cancelFind(), findFirst(), findFirstInSelection(), findNext()
+virtual void replace(const QString &replaceStr);
+//! Reset the fold margin colours to their defaults.
+//!
+//! \sa setFoldMarginColors()
+void resetFoldMarginColors();
+//! Resets the background colour of an active hotspot area to the default.
+//!
+//! \sa setHotspotBackgroundColor(), resetHotspotForegroundColor()
+void resetHotspotBackgroundColor();
+//! Resets the foreground colour of an active hotspot area to the default.
+//!
+//! \sa setHotspotForegroundColor(), resetHotspotBackgroundColor()
+void resetHotspotForegroundColor();
+//! Gets the assumed document width in pixels.
+//!
+//! \sa setScrollWidth(), setScrollWidthTracking()
+int scrollWidth() const;
+//! Returns true if scroll width tracking is enabled.
+//!
+//! \sa scrollWidth(), setScrollWidthTracking()
+bool scrollWidthTracking() const;
+//! The fold margin may be drawn as a one pixel sized checkerboard pattern
+//! of two colours, \a fore and \a back.
+//!
+//! \sa resetFoldMarginColors()
+void setFoldMarginColors(const QColor &fore, const QColor &back);
+//! Set the display style for annotations.  The default is
+//! AnnotationStandard.
+//!
+//! \sa annotationDisplay()
+void setAnnotationDisplay(AnnotationDisplay display);
+//! Enable the use of fill-up characters, either those explicitly set or
+//! those set by a lexer.  By default, fill-up characters are disabled.
+//!
+//! \sa autoCompletionFillupsEnabled(), setAutoCompletionFillups()
+void setAutoCompletionFillupsEnabled(bool enabled);
+//! A fill-up character is one that, when entered while an auto-completion
+//! list is being displayed, causes the currently selected item from the
+//! list to be added to the text followed by the fill-up character.
+//! \a fillups is the set of fill-up characters.  If a language lexer has
+//! been set then this is ignored and the lexer defines the fill-up
+//! characters.  The default is that no fill-up characters are set.
+//!
+//! \sa autoCompletionFillupsEnabled(), setAutoCompletionFillupsEnabled()
+void setAutoCompletionFillups(const char *fillups);
+//! A word separator is a sequence of characters that, when entered, causes
+//! the auto-completion list to be displayed.  If a language lexer has been
+//! set then this is ignored and the lexer defines the word separators.
+//! The default is that no word separators are set.
+//!
+//! \sa setAutoCompletionThreshold()
+void setAutoCompletionWordSeparators(const QStringList &separators);
+//! Set the background colour of call tips to \a col.  The default is
+//! white.
+void setCallTipsBackgroundColor(const QColor &col);
+//! Set the foreground colour of call tips to \a col.  The default is
+//! mid-gray.
+void setCallTipsForegroundColor(const QColor &col);
+//! Set the highlighted colour of call tip text to \a col.  The default is
+//! dark blue.
+void setCallTipsHighlightColor(const QColor &col);
+//! Set the current call tip position.  The default is CallTipsBelowText.
+//!
+//! \sa callTipsPosition()
+void setCallTipsPosition(CallTipsPosition position);
+//! Set the current call tip style.  The default is CallTipsNoContext.
+//!
+//! \sa callTipsStyle()
+void setCallTipsStyle(CallTipsStyle style);
+//! Set the maximum number of call tips that are displayed to \a nr.  If
+//! the maximum number is 0 then all applicable call tips are displayed.
+//! If the maximum number is -1 then one call tip will be displayed with up
+//! and down arrows that allow the use to scroll through the full list.
+//! The default is -1.
+//!
+//! \sa callTipsVisible()
+void setCallTipsVisible(int nr);
+//! Sets each line in the \a folds list of line numbers to be a contracted
+//! fold.  This is typically used to restore the fold state of a document.
+//!
+//! \sa contractedFolds()
+void setContractedFolds(const QList<int> &folds);
+//! Attach the document \a document, replacing the currently attached
+//! document.
+//!
+//! \sa document()
+void setDocument(const QsciDocument &document);
+//! Add \a colnr to the columns which are displayed with a vertical line.
+//! The edge mode must be set to EdgeMultipleLines.
+//!
+//! \sa clearEdgeColumns()
+void addEdgeColumn(int colnr, const QColor &col);
+//! Remove any columns added by previous calls to addEdgeColumn().
+//!
+//! \sa addEdgeColumn()
+void clearEdgeColumns();
+//! Set the color of the marker used to show that a line has exceeded the
+//! length set by setEdgeColumn().
+//!
+//! \sa edgeColor(), \sa setEdgeColumn
+void setEdgeColor(const QColor &col);
+//! Set the number of the column after which lines are considered to be
+//! long.
+//!
+//! \sa edgeColumn()
+void setEdgeColumn(int colnr);
+//! Set the edge mode which determines how long lines are marked.
+//!
+//! \sa edgeMode()
+void setEdgeMode(EdgeMode mode);
+//! Set the number of the first visible line to \a linenr.
+//!
+//! \sa firstVisibleLine()
+void setFirstVisibleLine(int linenr);
+//! Enables or disables, according to \a under, if the indicator
+//! \a indicatorNumber is drawn under or over the text (i.e. in the
+//! background or foreground).  If \a indicatorNumber is -1 then the state
+//! of all indicators is set.
+//!
+//! \sa indicatorDrawUnder()
+void setIndicatorDrawUnder(bool under, int indicatorNumber = -1);
+//! Set the foreground colour of indicator \a indicatorNumber to \a col.
+//! If \a indicatorNumber is -1 then the colour of all indicators is set.
+void setIndicatorForegroundColor(const QColor &col, int indicatorNumber = -1);
+//! Set the foreground colour of indicator \a indicatorNumber to \a col
+//! when the mouse is over it or the caret moved into it.  If
+//! \a indicatorNumber is -1 then the colour of all indicators is set.
+void setIndicatorHoverForegroundColor(const QColor &col, int indicatorNumber = -1);
+//! Set the style of indicator \a indicatorNumber to \a style when the
+//! mouse is over it or the caret moved into it.  If \a indicatorNumber is
+//! -1 then the style of all indicators is set.
+void setIndicatorHoverStyle(IndicatorStyle style, int indicatorNumber = -1);
+//! Set the outline colour of indicator \a indicatorNumber to \a col.
+//! If \a indicatorNumber is -1 then the colour of all indicators is set.
+//! At the moment only the alpha value of the colour has any affect.
+void setIndicatorOutlineColor(const QColor &col, int indicatorNumber = -1);
+//! Sets the background color of margin \a margin to \a col.
+//!
+//! \sa marginBackgroundColor()
+void setMarginBackgroundColor(int margin, const QColor &col);
+//! Set the margin options to \a options.
+//!
+//! \sa marginOptions(), MoNone, MoSublineSelect.
+void setMarginOptions(int options);
+//! Set the margin text of line \a line with the text \a text using the
+//! style number \a style.
+void setMarginText(int line, const QString &text, int style);
+//! Set the margin text of line \a line with the text \a text using the
+//! style \a style.
+void setMarginText(int line, const QString &text, const QsciStyle &style);
+//! Set the margin text of line \a line with the styled text \a text.
+void setMarginText(int line, const QsciStyledText &text);
+//! Set the margin text of line \a line with the list of styled text \a
+//! text.
+void setMarginText(int line, const QList<QsciStyledText> &text);
+//! Set the type of margin \a margin to type \a type.
+//!
+//! \sa marginType(), SCI_SETMARGINTYPEN
+void setMarginType(int margin, MarginType type);
+//! The margin text on line \a line is removed.  If \a line is negative
+//! then all margin text is removed.
+void clearMarginText(int line = -1);
+//! Set the number of margins to \a margins.
+//!
+//! \sa margins()
+void setMargins(int margins);
+//! Set the background colour, including the alpha component, of marker
+//! \a markerNumber to \a col.  If \a markerNumber is -1 then the colour of
+//! all markers is set.  The default is white.
+//!
+//! \sa setMarkerForegroundColor()
+void setMarkerBackgroundColor(const QColor &col, int markerNumber = -1);
+//! Set the foreground colour of marker \a markerNumber to \a col.  If
+//! \a markerNumber is -1 then the colour of all markers is set.  The
+//! default is black.
+//!
+//! \sa setMarkerBackgroundColor()
+void setMarkerForegroundColor(const QColor &col, int markerNumber = -1);
+//! Set the background colour used to display matched braces to \a col.  It
+//! is ignored if an indicator is being used.  The default is white.
+//!
+//! \sa setMatchedBraceForegroundColor(), setMatchedBraceIndicator()
+void setMatchedBraceBackgroundColor(const QColor &col);
+//! Set the foreground colour used to display matched braces to \a col.  It
+//! is ignored if an indicator is being used.  The default is red.
+//!
+//! \sa setMatchedBraceBackgroundColor(), setMatchedBraceIndicator()
+void setMatchedBraceForegroundColor(const QColor &col);
+//! Set the indicator used to display matched braces to \a indicatorNumber.
+//! The default is not to use an indicator.
+//!
+//! \sa resetMatchedBraceIndicator(), setMatchedBraceBackgroundColor()
+void setMatchedBraceIndicator(int indicatorNumber);
+//! Stop using an indicator to display matched braces.
+//!
+//! \sa setMatchedBraceIndicator()
+void resetMatchedBraceIndicator();
+//! For performance, QScintilla does not measure the display width of the
+//! document to determine the properties of the horizontal scroll bar.
+//! Instead, an assumed width is used.  This sets the document width in
+//! pixels assumed by QScintilla to \a pixelWidth.  The default value is
+//! 2000.
+//!
+//! \sa scrollWidth(), setScrollWidthTracking()
+void setScrollWidth(int pixelWidth);
+//! If scroll width tracking is enabled then the scroll width is adjusted
+//! to ensure that all of the lines currently displayed can be completely
+//! scrolled.  This mode never adjusts the scroll width to be narrower.
+//! This sets the scroll width tracking to \a enabled.
+//!
+//! \sa setScrollWidth(), scrollWidthTracking()
+void setScrollWidthTracking(bool enabled);
+//! Sets the mode used to draw tab characters when whitespace is visible to
+//! \a mode.  The default is to use an arrow.
+//!
+//! \sa tabDrawMode()
+void setTabDrawMode(TabDrawMode mode);
+//! Set the background colour used to display unmatched braces to \a col.
+//! It is ignored if an indicator is being used.  The default is white.
+//!
+//! \sa setUnmatchedBraceForegroundColor(), setUnmatchedBraceIndicator()
+void setUnmatchedBraceBackgroundColor(const QColor &col);
+//! Set the foreground colour used to display unmatched braces to \a col.
+//! It is ignored if an indicator is being used.  The default is blue.
+//!
+//! \sa setUnmatchedBraceBackgroundColor(), setUnmatchedBraceIndicator()
+void setUnmatchedBraceForegroundColor(const QColor &col);
+//! Set the indicator used to display unmatched braces to
+//! \a indicatorNumber.  The default is not to use an indicator.
+//!
+//! \sa resetUnmatchedBraceIndicator(), setUnmatchedBraceBackgroundColor()
+void setUnmatchedBraceIndicator(int indicatorNumber);
+//! Stop using an indicator to display unmatched braces.
+//!
+//! \sa setUnmatchedBraceIndicator()
+void resetUnmatchedBraceIndicator();
+//! Set the visual flags displayed when a line is wrapped.  \a endFlag
+//! determines if and where the flag at the end of a line is displayed.
+//! \a startFlag determines if and where the flag at the start of a line is
+//! displayed.  \a indent is the number of characters a wrapped line is
+//! indented by.  By default no visual flags are displayed.
+void setWrapVisualFlags(WrapVisualFlag endFlag,
+WrapVisualFlag startFlag = WrapFlagNone, int indent = 0);
+//! Returns the selected text or an empty string if there is no currently
+//! selected text.
+//!
+//! \sa hasSelectedText()
+QString selectedText() const;
+//! Returns whether or not the selection is drawn up to the right hand
+//! border.
+//!
+//! \sa setSelectionToEol()
+bool selectionToEol() const;
+//! Sets the background colour of an active hotspot area to \a col.
+//!
+//! \sa resetHotspotBackgroundColor(), setHotspotForegroundColor()
+void setHotspotBackgroundColor(const QColor &col);
+//! Sets the foreground colour of an active hotspot area to \a col.
+//!
+//! \sa resetHotspotForegroundColor(), setHotspotBackgroundColor()
+void setHotspotForegroundColor(const QColor &col);
+//! Enables or disables, according to \a enable, the underlining of an
+//! active hotspot area.  The default is false.
+void setHotspotUnderline(bool enable);
+//! Enables or disables, according to \a enable, the wrapping of a hotspot
+//! area to following lines.  The default is true.
+void setHotspotWrap(bool enable);
+//! Sets whether or not the selection is drawn up to the right hand border.
+//! \a filled is set if the selection is drawn to the border.
+//!
+//! \sa selectionToEol()
+void setSelectionToEol(bool filled);
+//! Sets the extra space added to the height of a line above the baseline
+//! of the text to \a extra.
+//!
+//! \sa extraAscent(), setExtraDescent()
+void setExtraAscent(int extra);
+//! Sets the extra space added to the height of a line below the baseline
+//! of the text to \a extra.
+//!
+//! \sa extraDescent(), setExtraAscent()
+void setExtraDescent(int extra);
+//! Text entered by the user will overwrite existing text if \a overwrite
+//! is true.
+//!
+//! \sa overwriteMode()
+void setOverwriteMode(bool overwrite);
+//! Sets the background colour of visible whitespace to \a col.  If \a col
+//! is an invalid color (the default) then the color specified by the
+//! current lexer is used.
+void setWhitespaceBackgroundColor(const QColor &col);
+//! Sets the foreground colour of visible whitespace to \a col.  If \a col
+//! is an invalid color (the default) then the color specified by the
+//! current lexer is used.
+void setWhitespaceForegroundColor(const QColor &col);
+//! Sets the size of the dots used to represent visible whitespace.
+//!
+//! \sa whitespaceSize()
+void setWhitespaceSize(int size);
+//! Sets the line wrap indentation mode to \a mode.  The default is
+//! WrapIndentFixed.
+//!
+//! \sa wrapIndentMode()
+void setWrapIndentMode(WrapIndentMode mode);
+//! Displays a user defined list which can be interacted with like an
+//! auto-completion list.  \a id is an identifier for the list which is
+//! passed as an argument to the userListActivated() signal and must be at
+//! least 1.  \a list is the text with which the list is populated.
+//!
+//! \sa cancelList(), isListActive(), userListActivated()
+void showUserList(int id, const QStringList &list);
+//! The standard command set is returned.
+QsciCommandSet *standardCommands() const {return stdCmds;}
+//! Returns the mode used to draw tab characters when whitespace is
+//! visible.
+//!
+//! \sa setTabDrawMode()
+TabDrawMode tabDrawMode() const;
+//! Returns true if the tab key indents a line instead of inserting a tab
+//! character.  The default is true.
+//!
+//! \sa setTabIndents(), backspaceUnindents(), setBackspaceUnindents()
+bool tabIndents() const;
+//! Returns the tab width in characters.  The default is 8.
+//!
+//! \sa setTabWidth()
+int tabWidth() const;
+//! Returns the text of the current document.
+//!
+//! \sa setText()
+QString text() const;
+//! \overload
+//!
+//! Returns the text of line \a line.
+//!
+//! \sa setText()
+QString text(int line) const;
+//! \overload
+//!
+//! Returns the text between positions \a start and \a end.  This is
+//! typically used by QsciLexerCustom::styleText().
+//!
+//! \sa bytes(), setText()
+QString text(int start, int end) const;
+//! Returns the height in pixels of the text in line number \a linenr.
+int textHeight(int linenr) const;
+//! Returns the size of the dots used to represent visible whitespace.
+//!
+//! \sa setWhitespaceSize()
+int whitespaceSize() const;
+//! Returns the visibility of whitespace.
+//!
+//! \sa setWhitespaceVisibility()
+WhitespaceVisibility whitespaceVisibility() const;
+//! Returns the word at the \a line line number and \a index character
+//! index.
+QString wordAtLineIndex(int line, int index) const;
+//! Returns the word at the \a point pixel coordinates.
+QString wordAtPoint(const QPoint &point) const;
+//! Returns the set of valid word character as defined by the current
+//! language lexer.  If there is no current lexer then the set contains an
+//! an underscore, numbers and all upper and lower case alphabetic
+//! characters.
+//!
+//! \sa isWordCharacter()
+const char *wordCharacters() const;
+//! Returns the line wrap mode.
+//!
+//! \sa setWrapMode()
+WrapMode wrapMode() const;
+//! Returns the line wrap indentation mode.
+//!
+//! \sa setWrapIndentMode()
+WrapIndentMode wrapIndentMode() const;
+//! Writes the current document to the \a io device and returns true if
+//! there was no error.
+//!
+//! \sa read()
+bool write(QIODevice *io) const;
+public slots:
+//! Appends the text \a text to the end of the text edit.  Note that the
+//! undo/redo history is cleared by this function.
+virtual void append(const QString &text);
+//! Display an auto-completion list based on any installed APIs, the
+//! current contents of the document and the characters immediately to the
+//! left of the cursor.
+//!
+//! \sa autoCompleteFromAPIs(), autoCompleteFromDocument()
+virtual void autoCompleteFromAll();
+//! Display an auto-completion list based on any installed APIs and the
+//! characters immediately to the left of the cursor.
+//!
+//! \sa autoCompleteFromAll(), autoCompleteFromDocument(),
+//! setAutoCompletionAPIs()
+virtual void autoCompleteFromAPIs();
+//! Display an auto-completion list based on the current contents of the
+//! document and the characters immediately to the left of the cursor.
+//!
+//! \sa autoCompleteFromAll(), autoCompleteFromAPIs()
+virtual void autoCompleteFromDocument();
+//! Display a call tip based on the the characters immediately to the left
+//! of the cursor.
+virtual void callTip();
+//! Deletes all the text in the text edit.
+virtual void clear();
+//! Copies any selected text to the clipboard.
+//!
+//! \sa copyAvailable(), cut(), paste()
+virtual void copy();
+//! Copies any selected text to the clipboard and then deletes the text.
+//!
+//! \sa copy(), paste()
+virtual void cut();
+//! Ensures that the cursor is visible.
+virtual void ensureCursorVisible();
+//! Ensures that the line number \a line is visible.
+virtual void ensureLineVisible(int line);
+//! If any lines are currently folded then they are all unfolded.
+//! Otherwise all lines are folded.  This has the same effect as clicking
+//! in the fold margin with the shift and control keys pressed.  If
+//! \a children is not set (the default) then only the top level fold
+//! points are affected, otherwise the state of all fold points are
+//! changed.
+virtual void foldAll(bool children = false);
+//! If the line \a line is folded then it is unfolded.  Otherwise it is
+//! folded.  This has the same effect as clicking in the fold margin.
+virtual void foldLine(int line);
+//! Increases the indentation of line \a line by an indentation width.
+//!
+//! \sa unindent()
+virtual void indent(int line);
+//! Insert the text \a text at the current position.
+virtual void insert(const QString &text);
+//! Insert the text \a text in the line \a line at the position
+//! \a index.
+virtual void insertAt(const QString &text, int line, int index);
+//! If the cursor is either side of a brace character then move it to the
+//! position of the corresponding brace.
+virtual void moveToMatchingBrace();
+//! Pastes any text from the clipboard into the text edit at the current
+//! cursor position.
+//!
+//! \sa copy(), cut()
+virtual void paste();
+//! Redo the last change or sequence of changes.
+//!
+//! \sa isRedoAvailable()
+virtual void redo();
+//! Removes any selected text.
+//!
+//! \sa replaceSelectedText()
+virtual void removeSelectedText();
+//! Replaces any selected text with \a text.
+//!
+//! \sa removeSelectedText()
+virtual void replaceSelectedText(const QString &text);
+//! Resets the background colour of selected text to the default.
+//!
+//! \sa setSelectionBackgroundColor(), resetSelectionForegroundColor()
+virtual void resetSelectionBackgroundColor();
+//! Resets the foreground colour of selected text to the default.
+//!
+//! \sa setSelectionForegroundColor(), resetSelectionBackgroundColor()
+virtual void resetSelectionForegroundColor();
+//! If \a select is true (the default) then all the text is selected.  If
+//! \a select is false then any currently selected text is deselected.
+virtual void selectAll(bool select = true);
+//! If the cursor is either side of a brace character then move it to the
+//! position of the corresponding brace and select the text between the
+//! braces.
+virtual void selectToMatchingBrace();
+//! If \a cs is true then auto-completion lists are case sensitive.  The
+//! default is true.  Note that setting a lexer may change the case
+//! sensitivity.
+//!
+//! \sa autoCompletionCaseSensitivity()
+virtual void setAutoCompletionCaseSensitivity(bool cs);
+//! If \a replace is true then when an item from an auto-completion list is
+//! selected, the rest of the word to the right of the current cursor is
+//! removed.  The default is false.
+//!
+//! \sa autoCompletionReplaceWord()
+virtual void setAutoCompletionReplaceWord(bool replace);
+//! If \a single is true then when there is only a single entry in an
+//! auto-completion list it is automatically used and the list is not
+//! displayed.  This only has an effect when auto-completion is explicitly
+//! requested (using autoCompleteFromAPIs() and autoCompleteFromDocument())
+//! and has no effect when auto-completion is triggered as the user types.
+//! The default is false.  Note that this is deprecated and
+//! setAutoCompletionUseSingle() should be used instead.
+//!
+//! \sa autoCompletionShowSingle()
+virtual void setAutoCompletionShowSingle(bool single);
+//! Sets the source for the auto-completion list when it is being displayed
+//! automatically as the user types to \a source.  The default is AcsNone,
+//! ie. it is disabled.
+//!
+//! \sa autoCompletionSource()
+virtual void setAutoCompletionSource(AutoCompletionSource source);
+//! Sets the threshold for the automatic display of the auto-completion
+//! list as the user types to \a thresh.  The threshold is the number of
+//! characters that the user must type before the list is displayed.  If
+//! the threshold is less than or equal to 0 then the list is disabled.
+//! The default is -1.
+//!
+//! \sa autoCompletionThreshold(), setAutoCompletionWordSeparators()
+virtual void setAutoCompletionThreshold(int thresh);
+//! Sets the behavior of the auto-completion list when it has a single
+//! entry.  The default is AcusNever.
+//!
+//! \sa autoCompletionUseSingle()
+virtual void setAutoCompletionUseSingle(AutoCompletionUseSingle single);
+//! If \a autoindent is true then auto-indentation is enabled.  The default
+//! is false.
+//!
+//! \sa autoIndent()
+virtual void setAutoIndent(bool autoindent);
+//! Sets the brace matching mode to \a bm.  The default is NoBraceMatching.
+//!
+//! \sa braceMatching()
+virtual void setBraceMatching(BraceMatch bm);
+//! If \a deindent is true then the backspace key will unindent a line
+//! rather then delete a character.
+//!
+//! \sa backspaceUnindents(), tabIndents(), setTabIndents()
+virtual void setBackspaceUnindents(bool unindent);
+//! Sets the foreground colour of the caret to \a col.
+virtual void setCaretForegroundColor(const QColor &col);
+//! Sets the background colour, including the alpha component, of the line
+//! containing the caret to \a col.
+//!
+//! \sa setCaretLineVisible()
+virtual void setCaretLineBackgroundColor(const QColor &col);
+//! Sets the width of the frame of the line containing the caret to \a
+//! width.
+virtual void setCaretLineFrameWidth(int width);
+//! Enables or disables, according to \a enable, the background color of
+//! the line containing the caret.
+//!
+//! \sa setCaretLineBackgroundColor()
+virtual void setCaretLineVisible(bool enable);
+//! Sets the width of the caret to \a width pixels.  A \a width of 0 makes
+//! the caret invisible.
+virtual void setCaretWidth(int width);
+//! The widget's text (ie. foreground) colour is set to \a c.  This has no
+//! effect if a language lexer has been set.
+//!
+//! \sa color()
+virtual void setColor(const QColor &c);
+//! Sets the cursor to the line \a line at the position \a index.
+//!
+//! \sa getCursorPosition()
+virtual void setCursorPosition(int line, int index);
+//! Sets the end-of-line mode to \a mode.  The default is the platform's
+//! natural mode.
+//!
+//! \sa eolMode()
+virtual void setEolMode(EolMode mode);
+//! If \a visible is true then end-of-lines are made visible.  The default
+//! is that they are invisible.
+//!
+//! \sa eolVisibility()
+virtual void setEolVisibility(bool visible);
+//! Sets the folding style for margin \a margin to \a fold.  The default
+//! style is NoFoldStyle (ie. folding is disabled) and the default margin
+//! is 2.
+//!
+//! \sa folding()
+virtual void setFolding(FoldStyle fold, int margin = 2);
+//! Sets the indentation of line \a line to \a indentation characters.
+//!
+//! \sa indentation()
+virtual void setIndentation(int line, int indentation);
+//! Enables or disables, according to \a enable, this display of
+//! indentation guides.
+//!
+//! \sa indentationGuides()
+virtual void setIndentationGuides(bool enable);
+//! Set the background colour of indentation guides to \a col.
+//!
+//! \sa setIndentationGuidesForegroundColor()
+virtual void setIndentationGuidesBackgroundColor(const QColor &col);
+//! Set the foreground colour of indentation guides to \a col.
+//!
+//! \sa setIndentationGuidesBackgroundColor()
+virtual void setIndentationGuidesForegroundColor(const QColor &col);
+//! If \a tabs is true then indentations are created using tabs and spaces,
+//! rather than just spaces.
+//!
+//! \sa indentationsUseTabs()
+virtual void setIndentationsUseTabs(bool tabs);
+//! Sets the indentation width to \a width characters.  If \a width is 0
+//! then the value returned by tabWidth() is used.
+//!
+//! \sa indentationWidth(), tabWidth()
+virtual void setIndentationWidth(int width);
+//! Sets the specific language lexer used to style text to \a lex.  If
+//! \a lex is 0 then syntax styling is disabled.
+//!
+//! \sa lexer()
+virtual void setLexer(QsciLexer *lexer = 0);
+//! Set the background colour of all margins to \a col.  The default is a
+//! gray.
+//!
+//! \sa setMarginsForegroundColor()
+virtual void setMarginsBackgroundColor(const QColor &col);
+//! Set the font used in all margins to \a f.
+virtual void setMarginsFont(const QFont &f);
+//! Set the foreground colour of all margins to \a col.  The default is
+//! black.
+//!
+//! \sa setMarginsBackgroundColor()
+virtual void setMarginsForegroundColor(const QColor &col);
+//! Enables or disables, according to \a lnrs, the display of line numbers
+//! in margin \a margin.
+//!
+//! \sa marginLineNumbers(), setMarginType(), SCI_SETMARGINTYPEN
+virtual void setMarginLineNumbers(int margin, bool lnrs);
+//! Sets the marker mask of margin \a margin to \a mask.  Only those
+//! markers whose bit is set in the mask are displayed in the margin.
+//!
+//! \sa marginMarkerMask(), QsciMarker, SCI_SETMARGINMASKN
+virtual void setMarginMarkerMask(int margin, int mask);
+//! Enables or disables, according to \a sens, the sensitivity of margin
+//! \a margin to mouse clicks.  If the user clicks in a sensitive margin
+//! the marginClicked() signal is emitted.
+//!
+//! \sa marginSensitivity(), marginClicked(), SCI_SETMARGINSENSITIVEN
+virtual void setMarginSensitivity(int margin, bool sens);
+//! Sets the width of margin \a margin to \a width pixels.  If the width of
+//! a margin is 0 then it is not displayed.
+//!
+//! \sa marginWidth(), SCI_SETMARGINWIDTHN
+virtual void setMarginWidth(int margin, int width);
+//! Sets the width of margin \a margin so that it is wide enough to display
+//! \a s in the current margin font.
+//!
+//! \sa marginWidth(), SCI_SETMARGINWIDTHN
+virtual void setMarginWidth(int margin, const QString &s);
+//! Sets the modified state of the text edit to \a m.  Note that it is only
+//! possible to clear the modified state (where \a m is false).  Attempts
+//! to set the modified state (where \a m is true) are ignored.
+//!
+//! \sa isModified(), modificationChanged()
+virtual void setModified(bool m);
+//! The widget's paper (ie. background) colour is set to \a c.  This has no
+//! effect if a language lexer has been set.
+//!
+//! \sa paper()
+virtual void setPaper(const QColor &c);
+//! Sets the read-only state of the text edit to \a ro.
+//!
+//! \sa isReadOnly()
+virtual void setReadOnly(bool ro);
+//! Sets the selection which starts at position \a indexFrom in line
+//! \a lineFrom and ends at position \a indexTo in line \a lineTo.  The
+//! cursor is moved to position \a indexTo in \a lineTo.
+//!
+//! \sa getSelection()
+virtual void setSelection(int lineFrom, int indexFrom, int lineTo,
+int indexTo);
+//! Sets the background colour, including the alpha component, of selected
+//! text to \a col.
+//!
+//! \sa resetSelectionBackgroundColor(), setSelectionForegroundColor()
+virtual void setSelectionBackgroundColor(const QColor &col);
+//! Sets the foreground colour of selected text to \a col.
+//!
+//! \sa resetSelectionForegroundColor(), setSelectionBackgroundColor()
+virtual void setSelectionForegroundColor(const QColor &col);
+//! If \a indent is true then the tab key will indent a line rather than
+//! insert a tab character.
+//!
+//! \sa tabIndents(), backspaceUnindents(), setBackspaceUnindents()
+virtual void setTabIndents(bool indent);
+//! Sets the tab width to \a width characters.
+//!
+//! \sa tabWidth()
+virtual void setTabWidth(int width);
+//! Replaces all of the current text with \a text.  Note that the
+//! undo/redo history is cleared by this function.
+//!
+//! \sa text()
+virtual void setText(const QString &text);
+//! Sets the current text encoding.  If \a cp is true then UTF8 is used,
+//! otherwise Latin1 is used.
+//!
+//! \sa isUtf8()
+virtual void setUtf8(bool cp);
+//! Sets the visibility of whitespace to mode \a mode.  The default is that
+//! whitespace is invisible.
+//!
+//! \sa whitespaceVisibility()
+virtual void setWhitespaceVisibility(WhitespaceVisibility mode);
+//! Sets the line wrap mode to \a mode.  The default is that lines are not
+//! wrapped.
+//!
+//! \sa wrapMode()
+virtual void setWrapMode(WrapMode mode);
+//! Undo the last change or sequence of changes.
+//!
+//! Scintilla has multiple level undo and redo.  It will continue to record
+//! undoable actions until memory runs out.  Sequences of typing or
+//! deleting are compressed into single actions to make it easier to undo
+//! and redo at a sensible level of detail.  Sequences of actions can be
+//! combined into actions that are undone as a unit.  These sequences occur
+//! between calls to beginUndoAction() and endUndoAction().  These
+//! sequences can be nested and only the top level sequences are undone as
+//! units.
+//!
+//! \sa beginUndoAction(), endUndoAction(), isUndoAvailable()
+virtual void undo();
+//! Decreases the indentation of line \a line by an indentation width.
+//!
+//! \sa indent()
+virtual void unindent(int line);
+//! Zooms in on the text by by making the base font size \a range points
+//! larger and recalculating all font sizes.
+//!
+//! \sa zoomOut(), zoomTo()
+virtual void zoomIn(int range);
+//! \overload
+//!
+//! Zooms in on the text by by making the base font size one point larger
+//! and recalculating all font sizes.
+virtual void zoomIn();
+//! Zooms out on the text by by making the base font size \a range points
+//! smaller and recalculating all font sizes.
+//!
+//! \sa zoomIn(), zoomTo()
+virtual void zoomOut(int range);
+//! \overload
+//!
+//! Zooms out on the text by by making the base font size one point larger
+//! and recalculating all font sizes.
+virtual void zoomOut();
+//! Zooms the text by making the base font size \a size points and
+//! recalculating all font sizes.
+//!
+//! \sa zoomIn(), zoomOut()
+virtual void zoomTo(int size);
+signals:
+//! This signal is emitted whenever the cursor position changes.  \a line
+//! contains the line number and \a index contains the character index
+//! within the line.
+void cursorPositionChanged(int line, int index);
+//! This signal is emitted whenever text is selected or de-selected.
+//! \a yes is true if text has been selected and false if text has been
+//! deselected.  If \a yes is true then copy() can be used to copy the
+//! selection to the clipboard.  If \a yes is false then copy() does
+//! nothing.
+//!
+//! \sa copy(), selectionChanged()
+void copyAvailable(bool yes);
+//! This signal is emitted whenever the user clicks on an indicator.  \a
+//! line is the number of the line where the user clicked.  \a index is the
+//! character index within the line.  \a state is the state of the modifier
+//! keys (Qt::ShiftModifier, Qt::ControlModifier, Qt::AltModifer and
+//! Qt::MetaModifier) when the user clicked.
+//!
+//! \sa indicatorReleased()
+void indicatorClicked(int line, int index, Qt::KeyboardModifiers state);
+//! This signal is emitted whenever the user releases the mouse on an
+//! indicator.  \a line is the number of the line where the user clicked.
+//! \a index is the character index within the line.  \a state is the state
+//! of the modifier keys (Qt::ShiftModifier, Qt::ControlModifier,
+//! Qt::AltModifer and Qt::MetaModifier) when the user released the mouse.
+//!
+//! \sa indicatorClicked()
+void indicatorReleased(int line, int index, Qt::KeyboardModifiers state);
+//! This signal is emitted whenever the number of lines of text changes.
+void linesChanged();
+//! This signal is emitted whenever the user clicks on a sensitive margin.
+//! \a margin is the margin.  \a line is the number of the line where the
+//! user clicked.  \a state is the state of the modifier keys
+//! (Qt::ShiftModifier, Qt::ControlModifier, Qt::AltModifer and
+//! Qt::MetaModifier) when the user clicked.
+//!
+//! \sa marginSensitivity(), setMarginSensitivity()
+void marginClicked(int margin, int line, Qt::KeyboardModifiers state);
+//! This signal is emitted whenever the user right-clicks on a sensitive
+//! margin.  \a margin is the margin.  \a line is the number of the line
+//! where the user clicked.  \a state is the state of the modifier keys
+//! (Qt::ShiftModifier, Qt::ControlModifier, Qt::AltModifer and
+//! Qt::MetaModifier) when the user clicked.
+//!
+//! \sa marginSensitivity(), setMarginSensitivity()
+void marginRightClicked(int margin, int line, Qt::KeyboardModifiers state);
+//! This signal is emitted whenever the user attempts to modify read-only
+//! text.
+//!
+//! \sa isReadOnly(), setReadOnly()
+void modificationAttempted();
+//! This signal is emitted whenever the modification state of the text
+//! changes.  \a m is true if the text has been modified.
+//!
+//! \sa isModified(), setModified()
+void modificationChanged(bool m);
+//! This signal is emitted whenever the selection changes.
+//!
+//! \sa copyAvailable()
+void selectionChanged();
+//! This signal is emitted whenever the text in the text edit changes.
+void textChanged();
+//! This signal is emitted when an item in a user defined list is activated
+//! (selected).  \a id is the list identifier.  \a string is the text of
+//! the item.
+//!
+//! \sa showUserList()
+void userListActivated(int id, const QString &string);
+protected:
+//! \reimp
+virtual bool event(QEvent *e);
+//! \reimp
+virtual void changeEvent(QEvent *e);
+//! \reimp
+virtual void contextMenuEvent(QContextMenuEvent *e);
+//! \reimp
+virtual void wheelEvent(QWheelEvent *e);
+private slots:
+void handleCallTipClick(int dir);
+void handleCharAdded(int charadded);
+void handleIndicatorClick(int pos, int modifiers);
+void handleIndicatorRelease(int pos, int modifiers);
+void handleMarginClick(int pos, int margin, int modifiers);
+void handleMarginRightClick(int pos, int margin, int modifiers);
+void handleModified(int pos, int mtype, const char *text, int len,
+int added, int line, int foldNow, int foldPrev, int token,
+int annotationLinesAdded);
+void handlePropertyChange(const char *prop, const char *val);
+void handleSavePointReached();
+void handleSavePointLeft();
+void handleSelectionChanged(bool yes);
+void handleAutoCompletionSelection();
+void handleUserListSelection(const char *text, int id);
+void handleStyleColorChange(const QColor &c, int style);
+void handleStyleEolFillChange(bool eolfill, int style);
+void handleStyleFontChange(const QFont &f, int style);
+void handleStylePaperChange(const QColor &c, int style);
+void handleUpdateUI(int updated);
+void delete_selection();
+private:
+void detachLexer();
+enum IndentState {
+isNone,
+isKeywordStart,
+isBlockStart,
+isBlockEnd
+};
+void maintainIndentation(char ch, long pos);
+void autoIndentation(char ch, long pos);
+void autoIndentLine(long pos, int line, int indent);
+int blockIndent(int line);
+IndentState getIndentState(int line);
+bool rangeIsWhitespace(long spos, long epos);
+int findStyledWord(const char *text, int style, const char *words);
+void checkMarker(int &markerNumber);
+void checkIndicator(int &indicatorNumber);
+static void allocateId(int &id, unsigned &allocated, int min, int max);
+int currentIndent() const;
+int indentWidth() const;
+bool doFind();
+int simpleFind();
+void foldClick(int lineClick, int bstate);
+void foldChanged(int line, int levelNow, int levelPrev);
+void foldExpand(int &line, bool doExpand, bool force = false,
+int visLevels = 0, int level = -1);
+void setFoldMarker(int marknr, int mark = SC_MARK_EMPTY);
+void setLexerStyle(int style);
+void setStylesFont(const QFont &f, int style);
+void setEnabledColors(int style, QColor &fore, QColor &back);
+void braceMatch();
+long checkBrace(long pos, int brace_style, bool &colonMode);
+void gotoMatchingBrace(bool select);
+void startAutoCompletion(AutoCompletionSource acs, bool checkThresh,
+bool choose_single);
+int adjustedCallTipPosition(int ctshift) const;
+bool getSeparator(int &pos) const;
+QString getWord(int &pos) const;
+char getCharacter(int &pos) const;
+bool isStartChar(char ch) const;
+bool ensureRW();
+void insertAtPos(const QString &text, int pos);
+static int mapModifiers(int modifiers);
+QString wordAtPosition(int position) const;
+ScintillaBytes styleText(const QList<QsciStyledText> &styled_text,
+char **styles, int style_offset = 0);
+struct FindState
+{
+enum Status
+{
+Finding,
+FindingInSelection,
+Idle
+};
+FindState() : status(Idle) {}
+Status status;
+QString expr;
+bool wrap;
+bool forward;
+int flags;
+long startpos, startpos_orig;
+long endpos, endpos_orig;
+bool show;
+};
+FindState findState;
+unsigned allocatedMarkers;
+unsigned allocatedIndicators;
+int oldPos;
+int ctPos;
+bool selText;
+FoldStyle fold;
+int foldmargin;
+bool autoInd;
+BraceMatch braceMode;
+AutoCompletionSource acSource;
+int acThresh;
+QStringList wseps;
+const char *wchars;
+CallTipsPosition call_tips_position;
+CallTipsStyle call_tips_style;
+int maxCallTips;
+QStringList ct_entries;
+int ct_cursor;
+QList<int> ct_shifts;
+AutoCompletionUseSingle use_single;
+QPointer<QsciLexer> lex;
+QsciCommandSet *stdCmds;
+QsciDocument doc;
+QColor nl_text_colour;
+QColor nl_paper_colour;
+QByteArray explicit_fillups;
+bool fillups_enabled;
+// The following allow QsciListBoxQt to distinguish between an
+// auto-completion list and a user list, and to return the full selection
+// of an auto-completion list.
+friend class QsciListBoxQt;
+QString acSelection;
+bool isAutoCompletionList() const;
+void set_shortcut(QAction *action, QsciCommand::Command cmd_id) const;
+QsciScintilla(const QsciScintilla &);
+QsciScintilla &operator=(const QsciScintilla &);
+};
+#endif

Mercurial > octave

comparison libgui/languages/build_ts/octave-qsci/Qsci/qsciscintilla.h @ 31537:5ceb4bfcdb0f stable