1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
|
// This is the SIP interface definition for QsciScintilla.
//
// Copyright (c) 2015 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
};
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,
};
enum {
MoNone,
MoSublineSelect,
};
enum MarginType {
SymbolMargin,
SymbolMarginDefaultForegroundColor,
SymbolMarginDefaultBackgroundColor,
NumberMargin,
TextMargin,
TextMarginRightJustified
};
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 WhitespaceVisibility {
WsInvisible,
WsVisible,
WsVisibleAfterIndent
};
enum WrapMode {
WrapNone,
WrapWord,
WrapCharacter,
WrapWhitespace,
};
enum WrapVisualFlag {
WrapFlagNone,
WrapFlagByText,
WrapFlagByBorder,
WrapFlagInMargin,
};
enum WrapIndentMode {
WrapIndentFixed,
WrapIndentSame,
WrapIndentIndented,
};
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;
CallTipsPosition callTipsPosition() const;
CallTipsStyle callTipsStyle() const;
int callTipsVisible() const;
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);
virtual bool findFirstInSelection(const QString &expr, bool re, bool cs,
bool wo, bool forward = true, bool show = true,
bool posix = false);
virtual bool findNext();
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;
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 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();
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 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 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 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;
bool tabIndents() const;
int tabWidth() const;
QString text() const;
QString text(int line) 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 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 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);
private:
QsciScintilla(const QsciScintilla &);
};
|