558 lines
18 KiB
Plaintext
558 lines
18 KiB
Plaintext
// This is the SIP interface definition for QsciScintilla.
|
|
//
|
|
// Copyright (c) 2023 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.
|
|
|
|
|
|
class QsciScintilla : QsciScintillaBase
|
|
{
|
|
%TypeHeaderCode
|
|
#include <Qsci/qsciscintilla.h>
|
|
%End
|
|
|
|
public:
|
|
enum {
|
|
AiMaintain,
|
|
AiOpening,
|
|
AiClosing
|
|
};
|
|
|
|
enum AnnotationDisplay {
|
|
AnnotationHidden,
|
|
AnnotationStandard,
|
|
AnnotationBoxed,
|
|
AnnotationIndented,
|
|
};
|
|
|
|
enum AutoCompletionSource {
|
|
AcsNone,
|
|
AcsAll,
|
|
AcsDocument,
|
|
AcsAPIs
|
|
};
|
|
|
|
enum AutoCompletionUseSingle {
|
|
AcusNever,
|
|
AcusExplicit,
|
|
AcusAlways
|
|
};
|
|
|
|
enum BraceMatch {
|
|
NoBraceMatch,
|
|
StrictBraceMatch,
|
|
SloppyBraceMatch
|
|
};
|
|
|
|
enum CallTipsPosition {
|
|
CallTipsBelowText,
|
|
CallTipsAboveText,
|
|
};
|
|
|
|
enum CallTipsStyle {
|
|
CallTipsNone,
|
|
CallTipsNoContext,
|
|
CallTipsNoAutoCompletionContext,
|
|
CallTipsContext
|
|
};
|
|
|
|
enum EdgeMode {
|
|
EdgeNone,
|
|
EdgeLine,
|
|
EdgeBackground,
|
|
EdgeMultipleLines,
|
|
};
|
|
|
|
enum EolMode {
|
|
EolWindows,
|
|
EolUnix,
|
|
EolMac
|
|
};
|
|
|
|
enum FoldStyle {
|
|
NoFoldStyle,
|
|
PlainFoldStyle,
|
|
CircledFoldStyle,
|
|
BoxedFoldStyle,
|
|
CircledTreeFoldStyle,
|
|
BoxedTreeFoldStyle
|
|
};
|
|
|
|
enum IndicatorStyle {
|
|
PlainIndicator,
|
|
SquiggleIndicator,
|
|
TTIndicator,
|
|
DiagonalIndicator,
|
|
StrikeIndicator,
|
|
HiddenIndicator,
|
|
BoxIndicator,
|
|
RoundBoxIndicator,
|
|
StraightBoxIndicator,
|
|
FullBoxIndicator,
|
|
DashesIndicator,
|
|
DotsIndicator,
|
|
SquiggleLowIndicator,
|
|
DotBoxIndicator,
|
|
SquigglePixmapIndicator,
|
|
ThickCompositionIndicator,
|
|
ThinCompositionIndicator,
|
|
TextColorIndicator,
|
|
TriangleIndicator,
|
|
TriangleCharacterIndicator,
|
|
GradientIndicator,
|
|
CentreGradientIndicator,
|
|
};
|
|
|
|
enum {
|
|
MoNone,
|
|
MoSublineSelect,
|
|
};
|
|
|
|
enum MarginType {
|
|
SymbolMargin,
|
|
SymbolMarginDefaultForegroundColor,
|
|
SymbolMarginDefaultBackgroundColor,
|
|
NumberMargin,
|
|
TextMargin,
|
|
TextMarginRightJustified,
|
|
SymbolMarginColor,
|
|
};
|
|
|
|
enum MarkerSymbol {
|
|
Circle,
|
|
Rectangle,
|
|
RightTriangle,
|
|
SmallRectangle,
|
|
RightArrow,
|
|
Invisible,
|
|
DownTriangle,
|
|
Minus,
|
|
Plus,
|
|
VerticalLine,
|
|
BottomLeftCorner,
|
|
LeftSideSplitter,
|
|
BoxedPlus,
|
|
BoxedPlusConnected,
|
|
BoxedMinus,
|
|
BoxedMinusConnected,
|
|
RoundedBottomLeftCorner,
|
|
LeftSideRoundedSplitter,
|
|
CircledPlus,
|
|
CircledPlusConnected,
|
|
CircledMinus,
|
|
CircledMinusConnected,
|
|
Background,
|
|
ThreeDots,
|
|
ThreeRightArrows,
|
|
FullRectangle,
|
|
LeftRectangle,
|
|
Underline,
|
|
Bookmark
|
|
};
|
|
|
|
enum TabDrawMode {
|
|
TabLongArrow,
|
|
TabStrikeOut,
|
|
};
|
|
|
|
enum WhitespaceVisibility {
|
|
WsInvisible,
|
|
WsVisible,
|
|
WsVisibleAfterIndent,
|
|
WsVisibleOnlyInIndent,
|
|
};
|
|
|
|
enum WrapMode {
|
|
WrapNone,
|
|
WrapWord,
|
|
WrapCharacter,
|
|
WrapWhitespace,
|
|
};
|
|
|
|
enum WrapVisualFlag {
|
|
WrapFlagNone,
|
|
WrapFlagByText,
|
|
WrapFlagByBorder,
|
|
WrapFlagInMargin,
|
|
};
|
|
|
|
enum WrapIndentMode {
|
|
WrapIndentFixed,
|
|
WrapIndentSame,
|
|
WrapIndentIndented,
|
|
WrapIndentDeeplyIndented,
|
|
};
|
|
|
|
QsciScintilla(QWidget *parent /TransferThis/ = 0);
|
|
virtual ~QsciScintilla();
|
|
|
|
virtual QStringList apiContext(int pos, int &context_start,
|
|
int &last_word_start);
|
|
|
|
void annotate(int line, const QString &text, int style);
|
|
void annotate(int line, const QString &text, const QsciStyle &style);
|
|
void annotate(int line, const QsciStyledText &text);
|
|
void annotate(int line, const QList<QsciStyledText> &text);
|
|
QString annotation(int line) const;
|
|
AnnotationDisplay annotationDisplay() const;
|
|
void clearAnnotations(int line = -1);
|
|
|
|
bool autoCompletionCaseSensitivity() const;
|
|
bool autoCompletionFillupsEnabled() const;
|
|
bool autoCompletionReplaceWord() const;
|
|
bool autoCompletionShowSingle() const;
|
|
AutoCompletionSource autoCompletionSource() const;
|
|
int autoCompletionThreshold() const;
|
|
AutoCompletionUseSingle autoCompletionUseSingle() const;
|
|
bool autoIndent() const;
|
|
|
|
bool backspaceUnindents() const;
|
|
void beginUndoAction();
|
|
BraceMatch braceMatching() const;
|
|
QByteArray bytes(int start, int end) const;
|
|
|
|
CallTipsPosition callTipsPosition() const;
|
|
CallTipsStyle callTipsStyle() const;
|
|
int callTipsVisible() const;
|
|
void cancelFind();
|
|
void cancelList();
|
|
bool caseSensitive() const;
|
|
void clearRegisteredImages();
|
|
QColor color() const;
|
|
QList<int> contractedFolds() const;
|
|
void convertEols(EolMode mode);
|
|
QMenu *createStandardContextMenu() /Factory/;
|
|
|
|
QsciDocument document() const;
|
|
|
|
void endUndoAction();
|
|
QColor edgeColor() const;
|
|
int edgeColumn() const;
|
|
EdgeMode edgeMode() const;
|
|
EolMode eolMode() const;
|
|
bool eolVisibility() const;
|
|
|
|
int extraAscent() const;
|
|
int extraDescent() const;
|
|
|
|
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);
|
|
virtual bool findFirstInSelection(const QString &expr, bool re, bool cs,
|
|
bool wo, bool forward = true, bool show = true,
|
|
bool posix = false, bool cxx11 = false);
|
|
virtual bool findNext();
|
|
bool findMatchingBrace(long &brace, long &other, BraceMatch mode);
|
|
int firstVisibleLine() const;
|
|
FoldStyle folding() const;
|
|
|
|
void getCursorPosition(int *line, int *index) const;
|
|
void getSelection(int *lineFrom, int *indexFrom, int *lineTo,
|
|
int *indexTo) const;
|
|
|
|
bool hasSelectedText() const;
|
|
|
|
int indentation(int line) const;
|
|
bool indentationGuides() const;
|
|
bool indentationsUseTabs() const;
|
|
int indentationWidth() const;
|
|
|
|
void clearIndicatorRange(int lineFrom, int indexFrom, int lineTo,
|
|
int indexTo, int indicatorNumber);
|
|
void fillIndicatorRange(int lineFrom, int indexFrom, int lineTo,
|
|
int indexTo, int indicatorNumber);
|
|
int indicatorDefine(IndicatorStyle style, int indicatorNumber = -1);
|
|
bool indicatorDrawUnder(int indicatorNumber) const;
|
|
|
|
bool isCallTipActive() const;
|
|
bool isListActive() const;
|
|
bool isModified() const;
|
|
bool isReadOnly() const;
|
|
bool isRedoAvailable() const;
|
|
bool isUndoAvailable() const;
|
|
bool isUtf8() const;
|
|
bool isWordCharacter(char ch) const;
|
|
|
|
int lineAt(const QPoint &pos) const;
|
|
void lineIndexFromPosition(int position, int *line, int *index) const;
|
|
int lineLength(int line) const;
|
|
int lines() const;
|
|
int length() const;
|
|
QsciLexer *lexer() const;
|
|
|
|
QColor marginBackgroundColor(int margin) const;
|
|
bool marginLineNumbers(int margin) const;
|
|
int marginMarkerMask(int margin) const;
|
|
int marginOptions() const;
|
|
bool marginSensitivity(int margin) const;
|
|
MarginType marginType(int margin) const;
|
|
int marginWidth(int margin) const;
|
|
int margins() const;
|
|
|
|
int markerDefine(MarkerSymbol sym, int markerNumber = -1);
|
|
int markerDefine(char ch, int markerNumber = -1);
|
|
int markerDefine(const QPixmap &pm, int markerNumber = -1);
|
|
int markerDefine(const QImage &im, int markerNumber = -1);
|
|
int markerAdd(int linenr, int markerNumber);
|
|
unsigned markersAtLine(int linenr) const;
|
|
void markerDelete(int linenr, int markerNumber = -1);
|
|
void markerDeleteAll(int markerNumber = -1);
|
|
void markerDeleteHandle(int mhandle);
|
|
int markerLine(int mhandle) const;
|
|
int markerFindNext(int linenr, unsigned mask) const;
|
|
int markerFindPrevious(int linenr, unsigned mask) const;
|
|
|
|
bool overwriteMode() const;
|
|
|
|
QColor paper() const;
|
|
int positionFromLineIndex(int line, int index) const;
|
|
|
|
bool read(QIODevice *io) /ReleaseGIL/;
|
|
virtual void recolor(int start = 0, int end = -1);
|
|
void registerImage(int id, const QPixmap &pm);
|
|
void registerImage(int id, const QImage &im);
|
|
virtual void replace(const QString &replaceStr);
|
|
void resetFoldMarginColors();
|
|
void resetHotspotBackgroundColor();
|
|
void resetHotspotForegroundColor();
|
|
|
|
int scrollWidth() const;
|
|
void setScrollWidth(int pixelWidth);
|
|
bool scrollWidthTracking() const;
|
|
void setScrollWidthTracking(bool enabled);
|
|
|
|
void setFoldMarginColors(const QColor &fore, const QColor &back);
|
|
|
|
void setAnnotationDisplay(AnnotationDisplay display);
|
|
|
|
void setAutoCompletionFillupsEnabled(bool enabled);
|
|
void setAutoCompletionFillups(const char *fillups);
|
|
void setAutoCompletionWordSeparators(const QStringList &separators);
|
|
|
|
void setCallTipsBackgroundColor(const QColor &col);
|
|
void setCallTipsForegroundColor(const QColor &col);
|
|
void setCallTipsHighlightColor(const QColor &col);
|
|
void setCallTipsPosition(CallTipsPosition position);
|
|
void setCallTipsStyle(CallTipsStyle style);
|
|
void setCallTipsVisible(int nr);
|
|
void setContractedFolds(const QList<int> &folds);
|
|
|
|
void setDocument(const QsciDocument &document);
|
|
|
|
void addEdgeColumn(int colnr, const QColor &col);
|
|
void clearEdgeColumns();
|
|
void setEdgeColor(const QColor &col);
|
|
void setEdgeColumn(int colnr);
|
|
void setEdgeMode(EdgeMode mode);
|
|
|
|
void setFirstVisibleLine(int linenr);
|
|
void setFont(const QFont &f);
|
|
|
|
void setHotspotBackgroundColor(const QColor &col);
|
|
void setHotspotForegroundColor(const QColor &col);
|
|
void setHotspotUnderline(bool enable);
|
|
void setHotspotWrap(bool enable);
|
|
|
|
void setIndicatorDrawUnder(bool under, int indicatorNumber = -1);
|
|
void setIndicatorForegroundColor(const QColor &col,
|
|
int indicatorNumber = -1);
|
|
void setIndicatorHoverForegroundColor(const QColor &col,
|
|
int indicatorNumber = -1);
|
|
void setIndicatorHoverStyle(IndicatorStyle style,
|
|
int indicatorNumber = -1);
|
|
void setIndicatorOutlineColor(const QColor &col, int indicatorNumber = -1);
|
|
|
|
void setMarginBackgroundColor(int margin, const QColor &col);
|
|
void setMarginOptions(int options);
|
|
void setMarginText(int line, const QString &text, int style);
|
|
void setMarginText(int line, const QString &text, const QsciStyle &style);
|
|
void setMarginText(int line, const QsciStyledText &text);
|
|
void setMarginText(int line, const QList<QsciStyledText> &text);
|
|
void setMarginType(int margin, MarginType type);
|
|
void clearMarginText(int line = -1);
|
|
void setMargins(int margins);
|
|
|
|
void setMarkerBackgroundColor(const QColor &col, int markerNumber = -1);
|
|
void setMarkerForegroundColor(const QColor &col, int markerNumber = -1);
|
|
|
|
void setMatchedBraceBackgroundColor(const QColor &col);
|
|
void setMatchedBraceForegroundColor(const QColor &col);
|
|
void setMatchedBraceIndicator(int indicatorNumber);
|
|
void resetMatchedBraceIndicator();
|
|
void setUnmatchedBraceBackgroundColor(const QColor &col);
|
|
void setUnmatchedBraceForegroundColor(const QColor &col);
|
|
void setUnmatchedBraceIndicator(int indicatorNumber);
|
|
void resetUnmatchedBraceIndicator();
|
|
|
|
void setWrapVisualFlags(WrapVisualFlag endFlag,
|
|
WrapVisualFlag startFlag = QsciScintilla::WrapFlagNone,
|
|
int indent = 0);
|
|
|
|
QString selectedText() const;
|
|
bool selectionToEol() const;
|
|
void setSelectionToEol(bool filled);
|
|
|
|
void setExtraAscent(int extra);
|
|
void setExtraDescent(int extra);
|
|
|
|
void setOverwriteMode(bool overwrite);
|
|
|
|
void setWhitespaceBackgroundColor(const QColor &col);
|
|
void setWhitespaceForegroundColor(const QColor &col);
|
|
void setWhitespaceSize(int size);
|
|
|
|
void setWrapIndentMode(WrapIndentMode mode);
|
|
void showUserList(int id, const QStringList &list);
|
|
QsciCommandSet *standardCommands() const;
|
|
|
|
void setTabDrawMode(TabDrawMode mode);
|
|
TabDrawMode tabDrawMode() const;
|
|
|
|
bool tabIndents() const;
|
|
int tabWidth() const;
|
|
QString text() const;
|
|
QString text(int line) const;
|
|
QString text(int start, int end) const;
|
|
int textHeight(int linenr) const;
|
|
|
|
int whitespaceSize() const;
|
|
WhitespaceVisibility whitespaceVisibility() const;
|
|
|
|
QString wordAtLineIndex(int line, int index) const;
|
|
QString wordAtPoint(const QPoint &point) const;
|
|
const char *wordCharacters() const;
|
|
WrapMode wrapMode() const;
|
|
WrapIndentMode wrapIndentMode() const;
|
|
bool write(QIODevice *io) const /ReleaseGIL/;
|
|
|
|
public slots:
|
|
virtual void append(const QString &text);
|
|
virtual void autoCompleteFromAll();
|
|
virtual void autoCompleteFromAPIs();
|
|
virtual void autoCompleteFromDocument();
|
|
virtual void callTip();
|
|
virtual void clear();
|
|
virtual void copy();
|
|
virtual void cut();
|
|
|
|
virtual void ensureCursorVisible();
|
|
virtual void ensureLineVisible(int line);
|
|
virtual void foldAll(bool children = false);
|
|
virtual void foldLine(int line);
|
|
virtual void indent(int line);
|
|
virtual void insert(const QString &text);
|
|
virtual void insertAt(const QString &text, int line, int index);
|
|
virtual void moveToMatchingBrace();
|
|
virtual void paste();
|
|
virtual void redo();
|
|
virtual void removeSelectedText();
|
|
virtual void replaceSelectedText(const QString &text);
|
|
virtual void resetSelectionBackgroundColor();
|
|
virtual void resetSelectionForegroundColor();
|
|
virtual void selectAll(bool select = true);
|
|
virtual void selectToMatchingBrace();
|
|
|
|
virtual void setAutoCompletionCaseSensitivity(bool cs);
|
|
virtual void setAutoCompletionReplaceWord(bool replace);
|
|
virtual void setAutoCompletionShowSingle(bool single);
|
|
virtual void setAutoCompletionSource(AutoCompletionSource source);
|
|
virtual void setAutoCompletionThreshold(int thresh);
|
|
virtual void setAutoCompletionUseSingle(AutoCompletionUseSingle single);
|
|
virtual void setAutoIndent(bool autoindent);
|
|
virtual void setBraceMatching(BraceMatch bm);
|
|
virtual void setBackspaceUnindents(bool unindent);
|
|
virtual void setCaretForegroundColor(const QColor &col);
|
|
virtual void setCaretLineBackgroundColor(const QColor &col);
|
|
virtual void setCaretLineFrameWidth(int width);
|
|
virtual void setCaretLineVisible(bool enable);
|
|
virtual void setCaretWidth(int width);
|
|
virtual void setColor(const QColor &col);
|
|
virtual void setCursorPosition(int line, int index);
|
|
virtual void setEolMode(EolMode mode);
|
|
virtual void setEolVisibility(bool visible);
|
|
virtual void setFolding(FoldStyle fold, int margin=2);
|
|
void clearFolds();
|
|
|
|
virtual void setIndentation(int line, int indentation);
|
|
virtual void setIndentationGuides(bool enable);
|
|
virtual void setIndentationGuidesBackgroundColor(const QColor &col);
|
|
virtual void setIndentationGuidesForegroundColor(const QColor &col);
|
|
virtual void setIndentationsUseTabs(bool tabs);
|
|
virtual void setIndentationWidth(int width);
|
|
|
|
virtual void setLexer(QsciLexer *lexer = 0);
|
|
|
|
virtual void setMarginsBackgroundColor(const QColor &col);
|
|
virtual void setMarginsFont(const QFont &f);
|
|
virtual void setMarginsForegroundColor(const QColor &col);
|
|
|
|
virtual void setMarginLineNumbers(int margin, bool lnrs);
|
|
virtual void setMarginMarkerMask(int margin, int mask);
|
|
virtual void setMarginSensitivity(int margin, bool sens);
|
|
virtual void setMarginWidth(int margin, int width);
|
|
virtual void setMarginWidth(int margin, const QString &s);
|
|
|
|
virtual void setModified(bool m);
|
|
virtual void setPaper(const QColor &c);
|
|
virtual void setReadOnly(bool ro);
|
|
virtual void setSelection(int lineFrom, int indexFrom, int lineTo,
|
|
int indexTo);
|
|
virtual void setSelectionBackgroundColor(const QColor &col);
|
|
virtual void setSelectionForegroundColor(const QColor &col);
|
|
virtual void setTabIndents(bool indent);
|
|
virtual void setTabWidth(int width);
|
|
virtual void setText(const QString &text);
|
|
virtual void setUtf8(bool cp);
|
|
virtual void setWhitespaceVisibility(WhitespaceVisibility mode);
|
|
virtual void setWrapMode(WrapMode mode);
|
|
|
|
virtual void undo();
|
|
virtual void unindent(int line);
|
|
|
|
virtual void zoomIn(int range);
|
|
virtual void zoomIn();
|
|
virtual void zoomOut(int range);
|
|
virtual void zoomOut();
|
|
virtual void zoomTo(int size);
|
|
|
|
signals:
|
|
void cursorPositionChanged(int line, int index);
|
|
void copyAvailable(bool yes);
|
|
|
|
void indicatorClicked(int line, int index, Qt::KeyboardModifiers state);
|
|
void indicatorReleased(int line, int index, Qt::KeyboardModifiers state);
|
|
|
|
void linesChanged();
|
|
|
|
void marginClicked(int margin, int line, Qt::KeyboardModifiers state);
|
|
void marginRightClicked(int margin, int line, Qt::KeyboardModifiers state);
|
|
|
|
void modificationAttempted();
|
|
void modificationChanged(bool m);
|
|
void selectionChanged();
|
|
void textChanged();
|
|
void userListActivated(int id, const QString &string);
|
|
|
|
protected:
|
|
virtual bool event(QEvent *event);
|
|
virtual void changeEvent(QEvent *event);
|
|
virtual void contextMenuEvent(QContextMenuEvent *event);
|
|
virtual void wheelEvent(QWheelEvent *event);
|
|
|
|
private:
|
|
QsciScintilla(const QsciScintilla &);
|
|
};
|