////////////////////////////////////////////////////////////////////////////
// Name: stc.h
-// Purpose: A wxWindows implementation of Scintilla. This class is the
+// Purpose: A wxWidgets implementation of Scintilla. This class is the
// one meant to be used directly by wx applications. It does not
// derive directly from the Scintilla classes, and in fact there
// is no mention of Scintilla classes at all in this header.
#define wxSTC_TIME_FOREVER 10000000
#define wxSTC_WRAP_NONE 0
#define wxSTC_WRAP_WORD 1
+#define wxSTC_WRAPVISUALFLAG_NONE 0x0000
+#define wxSTC_WRAPVISUALFLAG_END 0x0001
+#define wxSTC_WRAPVISUALFLAG_START 0x0002
+#define wxSTC_WRAPVISUALFLAGLOC_DEFAULT 0x0000
+#define wxSTC_WRAPVISUALFLAGLOC_END_BY_TEXT 0x0001
+#define wxSTC_WRAPVISUALFLAGLOC_START_BY_TEXT 0x0002
#define wxSTC_CACHE_NONE 0
#define wxSTC_CACHE_CARET 1
#define wxSTC_CACHE_PAGE 2
#define wxSTC_LEX_FORTH 52
#define wxSTC_LEX_ERLANG 53
#define wxSTC_LEX_OCTAVE 54
+#define wxSTC_LEX_MSSQL 55
+#define wxSTC_LEX_VERILOG 56
+#define wxSTC_LEX_KIX 57
+#define wxSTC_LEX_GUI4CLI 58
+#define wxSTC_LEX_SPECMAN 59
+#define wxSTC_LEX_AU3 60
+#define wxSTC_LEX_APDL 61
+#define wxSTC_LEX_BASH 62
// When a lexer specifies its language as SCLEX_AUTOMATIC it receives a
// value assigned in sequence from SCLEX_AUTOMATIC+1.
#define wxSTC_HP_OPERATOR 101
#define wxSTC_HP_IDENTIFIER 102
+// PHP
+#define wxSTC_HPHP_COMPLEX_VARIABLE 104
+
// ASP Python
#define wxSTC_HPA_START 105
#define wxSTC_HPA_DEFAULT 106
#define wxSTC_B_KEYWORD2 10
#define wxSTC_B_KEYWORD3 11
#define wxSTC_B_KEYWORD4 12
+#define wxSTC_B_CONSTANT 13
+#define wxSTC_B_ASM 14
// Lexical states for SCLEX_PROPERTIES
#define wxSTC_PROPS_DEFAULT 0
#define wxSTC_ERR_IFC 16
#define wxSTC_ERR_IFORT 17
#define wxSTC_ERR_ABSF 18
+#define wxSTC_ERR_TIDY 19
// Lexical states for SCLEX_BATCH
#define wxSTC_BAT_DEFAULT 0
#define wxSTC_NSIS_IFDEFINEDEF 11
#define wxSTC_NSIS_MACRODEF 12
#define wxSTC_NSIS_STRINGVAR 13
+#define wxSTC_NSIS_NUMBER 14
// Lexical states for SCLEX_MMIXAL
#define wxSTC_MMIXAL_LEADWS 0
#define wxSTC_ERLANG_NODE_NAME 13
#define wxSTC_ERLANG_UNKNOWN 31
+// Lexical states for SCLEX_OCTAVE are identical to MatLab
+// Lexical states for SCLEX_MSSQL
+#define wxSTC_MSSQL_DEFAULT 0
+#define wxSTC_MSSQL_COMMENT 1
+#define wxSTC_MSSQL_LINE_COMMENT 2
+#define wxSTC_MSSQL_NUMBER 3
+#define wxSTC_MSSQL_STRING 4
+#define wxSTC_MSSQL_OPERATOR 5
+#define wxSTC_MSSQL_IDENTIFIER 6
+#define wxSTC_MSSQL_VARIABLE 7
+#define wxSTC_MSSQL_COLUMN_NAME 8
+#define wxSTC_MSSQL_STATEMENT 9
+#define wxSTC_MSSQL_DATATYPE 10
+#define wxSTC_MSSQL_SYSTABLE 11
+#define wxSTC_MSSQL_GLOBAL_VARIABLE 12
+#define wxSTC_MSSQL_FUNCTION 13
+#define wxSTC_MSSQL_STORED_PROCEDURE 14
+#define wxSTC_MSSQL_DEFAULT_PREF_DATATYPE 15
+#define wxSTC_MSSQL_COLUMN_NAME_2 16
+
+// Lexical states for SCLEX_VERILOG
+#define wxSTC_V_DEFAULT 0
+#define wxSTC_V_COMMENT 1
+#define wxSTC_V_COMMENTLINE 2
+#define wxSTC_V_COMMENTLINEBANG 3
+#define wxSTC_V_NUMBER 4
+#define wxSTC_V_WORD 5
+#define wxSTC_V_STRING 6
+#define wxSTC_V_WORD2 7
+#define wxSTC_V_WORD3 8
+#define wxSTC_V_PREPROCESSOR 9
+#define wxSTC_V_OPERATOR 10
+#define wxSTC_V_IDENTIFIER 11
+#define wxSTC_V_STRINGEOL 12
+#define wxSTC_V_USER 19
+
+// Lexical states for SCLEX_KIX
+#define wxSTC_KIX_DEFAULT 0
+#define wxSTC_KIX_COMMENT 1
+#define wxSTC_KIX_STRING1 2
+#define wxSTC_KIX_STRING2 3
+#define wxSTC_KIX_NUMBER 4
+#define wxSTC_KIX_VAR 5
+#define wxSTC_KIX_MACRO 6
+#define wxSTC_KIX_KEYWORD 7
+#define wxSTC_KIX_FUNCTIONS 8
+#define wxSTC_KIX_OPERATOR 9
+#define wxSTC_KIX_IDENTIFIER 31
+
+// Lexical states for SCLEX_GUI4CLI
+#define wxSTC_GC_DEFAULT 0
+#define wxSTC_GC_COMMENTLINE 1
+#define wxSTC_GC_COMMENTBLOCK 2
+#define wxSTC_GC_GLOBAL 3
+#define wxSTC_GC_EVENT 4
+#define wxSTC_GC_ATTRIBUTE 5
+#define wxSTC_GC_CONTROL 6
+#define wxSTC_GC_COMMAND 7
+#define wxSTC_GC_STRING 8
+#define wxSTC_GC_OPERATOR 9
+
+// Lexical states for SCLEX_SPECMAN
+#define wxSTC_SN_DEFAULT 0
+#define wxSTC_SN_CODE 1
+#define wxSTC_SN_COMMENTLINE 2
+#define wxSTC_SN_COMMENTLINEBANG 3
+#define wxSTC_SN_NUMBER 4
+#define wxSTC_SN_WORD 5
+#define wxSTC_SN_STRING 6
+#define wxSTC_SN_WORD2 7
+#define wxSTC_SN_WORD3 8
+#define wxSTC_SN_PREPROCESSOR 9
+#define wxSTC_SN_OPERATOR 10
+#define wxSTC_SN_IDENTIFIER 11
+#define wxSTC_SN_STRINGEOL 12
+#define wxSTC_SN_REGEXTAG 13
+#define wxSTC_SN_SIGNAL 14
+#define wxSTC_SN_USER 19
+
+// Lexical states for SCLEX_AU3
+#define wxSTC_AU3_DEFAULT 0
+#define wxSTC_AU3_COMMENT 1
+#define wxSTC_AU3_COMMENTBLOCK 2
+#define wxSTC_AU3_NUMBER 3
+#define wxSTC_AU3_FUNCTION 4
+#define wxSTC_AU3_KEYWORD 5
+#define wxSTC_AU3_MACRO 6
+#define wxSTC_AU3_STRING 7
+#define wxSTC_AU3_OPERATOR 8
+#define wxSTC_AU3_VARIABLE 9
+#define wxSTC_AU3_SENT 10
+#define wxSTC_AU3_PREPROCESSOR 11
+
+// Lexical states for SCLEX_APDL
+#define wxSTC_APDL_DEFAULT 0
+#define wxSTC_APDL_COMMENT 1
+#define wxSTC_APDL_COMMENTBLOCK 2
+#define wxSTC_APDL_NUMBER 3
+#define wxSTC_APDL_STRING 4
+#define wxSTC_APDL_WORD 5
+#define wxSTC_APDL_COMMAND 6
+#define wxSTC_APDL_PROCESSOR 7
+#define wxSTC_APDL_FUNCTION 8
+
+// Lexical states for SCLEX_BASH
+#define wxSTC_SH_DEFAULT 0
+#define wxSTC_SH_ERROR 1
+#define wxSTC_SH_COMMENTLINE 2
+#define wxSTC_SH_NUMBER 3
+#define wxSTC_SH_WORD 4
+#define wxSTC_SH_STRING 5
+#define wxSTC_SH_CHARACTER 6
+#define wxSTC_SH_OPERATOR 7
+#define wxSTC_SH_IDENTIFIER 8
+#define wxSTC_SH_SCALAR 9
+#define wxSTC_SH_PARAM 10
+#define wxSTC_SH_BACKTICKS 11
+#define wxSTC_SH_HERE_DELIM 12
+#define wxSTC_SH_HERE_Q 13
+
//-----------------------------------------
// Commands that can be bound to keystrokes
#define wxSTC_CMD_VCHOMEWRAP 2453
#define wxSTC_CMD_VCHOMEWRAPEXTEND 2454
+// Copy the line containing the caret.
+#define wxSTC_CMD_LINECOPY 2455
+
// Move to the previous change in capitalisation.
#define wxSTC_CMD_WORDPARTLEFT 2390
%pythonAppend wxStyledTextCtrl "self._setOORInfo(self)"
%pythonAppend wxStyledTextCtrl() ""
- wxStyledTextCtrl(wxWindow *parent, wxWindowID id,
+ wxStyledTextCtrl(wxWindow *parent, wxWindowID id=wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, long style = 0,
const wxString& name = wxPySTCNameStr);
%name(PreStyledTextCtrl) wxStyledTextCtrl();
#else
- wxStyledTextCtrl(wxWindow *parent, wxWindowID id,
+ wxStyledTextCtrl(wxWindow *parent, wxWindowID id=wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, long style = 0,
const wxString& name = wxSTCNameStr);
#endif
- void Create(wxWindow *parent, wxWindowID id,
+ void Create(wxWindow *parent, wxWindowID id=wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, long style = 0,
const wxString& name = wxSTCNameStr);
// and regenerate
- // Add text to the document.
+ // Add text to the document at current position.
void AddText(const wxString& text);
// Add array of cells to document.
// Set all style bytes to 0, remove all folding information.
void ClearDocumentStyle();
- // The number of characters in the document.
+ // Returns the number of characters in the document.
int GetLength();
// Returns the character byte at the position.
// Retrieve whether text is word wrapped.
int GetWrapMode();
+ // Set the display mode of visual flags for wrapped lines.
+ void SetWrapVisualFlags(int wrapVisualFlags);
+
+ // Retrive the display mode of visual flags for wrapped lines.
+ int GetWrapVisualFlags();
+
+ // Set the location of visual flags for wrapped lines.
+ void SetWrapVisualFlagsLocation(int wrapVisualFlagsLocation);
+
+ // Retrive the location of visual flags for wrapped lines.
+ int GetWrapVisualFlagsLocation();
+
+ // Set the start indent for wrapped lines.
+ void SetWrapStartIndent(int indent);
+
+ // Retrive the start indent for wrapped lines.
+ int GetWrapStartIndent();
+
// Sets the degree of caching of layout information.
void SetLayoutCache(int mode);
void SetFoldMarginColour(bool useSetting, const wxColour& back);
void SetFoldMarginHiColour(bool useSetting, const wxColour& fore);
+ // Move caret down one line.
+ void LineDown();
+
+ // Move caret down one line extending selection to new caret position.
+ void LineDownExtend();
+
+ // Move caret up one line.
+ void LineUp();
+
+ // Move caret up one line extending selection to new caret position.
+ void LineUpExtend();
+
+ // Move caret left one character.
+ void CharLeft();
+
+ // Move caret left one character extending selection to new caret position.
+ void CharLeftExtend();
+
+ // Move caret right one character.
+ void CharRight();
+
+ // Move caret right one character extending selection to new caret position.
+ void CharRightExtend();
+
+ // Move caret left one word.
+ void WordLeft();
+
+ // Move caret left one word extending selection to new caret position.
+ void WordLeftExtend();
+
+ // Move caret right one word.
+ void WordRight();
+
+ // Move caret right one word extending selection to new caret position.
+ void WordRightExtend();
+
+ // Move caret to first position on line.
+ void Home();
+
+ // Move caret to first position on line extending selection to new caret position.
+ void HomeExtend();
+
+ // Move caret to last position on line.
+ void LineEnd();
+
+ // Move caret to last position on line extending selection to new caret position.
+ void LineEndExtend();
+
+ // Move caret to first position in document.
+ void DocumentStart();
+
+ // Move caret to first position in document extending selection to new caret position.
+ void DocumentStartExtend();
+
+ // Move caret to last position in document.
+ void DocumentEnd();
+
+ // Move caret to last position in document extending selection to new caret position.
+ void DocumentEndExtend();
+
+ // Move caret one page up.
+ void PageUp();
+
+ // Move caret one page up extending selection to new caret position.
+ void PageUpExtend();
+
+ // Move caret one page down.
+ void PageDown();
+
+ // Move caret one page down extending selection to new caret position.
+ void PageDownExtend();
+
+ // Switch from insert to overtype mode or the reverse.
+ void EditToggleOvertype();
+
+ // Cancel any modes such as call tip or auto-completion list display.
+ void Cancel();
+
+ // Delete the selection or if no selection, the character before the caret.
+ void DeleteBack();
+
+ // If selection is empty or all on one line replace the selection with a tab character.
+ // If more than one line selected, indent the lines.
+ void Tab();
+
+ // Dedent the selected lines.
+ void BackTab();
+
+ // Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
+ void NewLine();
+
+ // Insert a Form Feed character.
+ void FormFeed();
+
+ // Move caret to before first visible character on line.
+ // If already there move to first character on line.
+ void VCHome();
+
+ // Like VCHome but extending selection to new caret position.
+ void VCHomeExtend();
+
+ // Magnify the displayed text by increasing the sizes by 1 point.
+ void ZoomIn();
+
+ // Make the displayed text smaller by decreasing the sizes by 1 point.
+ void ZoomOut();
+
+ // Delete the word to the left of the caret.
+ void DelWordLeft();
+
+ // Delete the word to the right of the caret.
+ void DelWordRight();
+
+ // Cut the line containing the caret.
+ void LineCut();
+
+ // Delete the line containing the caret.
+ void LineDelete();
+
+ // Switch the current line with the previous.
+ void LineTranspose();
+
// Duplicate the current line.
void LineDuplicate();
+ // Transform the selection to lower case.
+ void LowerCase();
+
+ // Transform the selection to upper case.
+ void UpperCase();
+
+ // Scroll the document down, keeping the caret visible.
+ void LineScrollDown();
+
+ // Scroll the document up, keeping the caret visible.
+ void LineScrollUp();
+
+ // Delete the selection or if no selection, the character before the caret.
+ // Will not delete the character before at the start of a line.
+ void DeleteBackNotLine();
+
// Move caret to first position on display line.
void HomeDisplay();
// caret position.
void LineEndDisplayExtend();
+ // These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?
+ // except they behave differently when word-wrap is enabled:
+ // They go first to the start / end of the display line, like (Home|LineEnd)Display
+ // The difference is that, the cursor is already at the point, it goes on to the start
+ // or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.
+ void HomeWrap();
+ void HomeWrapExtend();
+ void LineEndWrap();
+ void LineEndWrapExtend();
+ void VCHomeWrap();
+ void VCHomeWrapExtend();
+
// Copy the line containing the caret.
void LineCopy();
// Limit hotspots to single line so hotspots on two lines don't merge.
void SetHotspotSingleLine(bool singleLine);
+ // Move caret between paragraphs (delimited by empty lines).
+ void ParaDown();
+ void ParaDownExtend();
+ void ParaUp();
+ void ParaUpExtend();
+
// Given a valid document position, return the previous position taking code
// page into account. Returns 0 if passed 0.
int PositionBefore(int pos);
// Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
int GetLineSelEndPosition(int line);
+ // Move caret down one line, extending rectangular selection to new caret position.
+ void LineDownRectExtend();
+
+ // Move caret up one line, extending rectangular selection to new caret position.
+ void LineUpRectExtend();
+
+ // Move caret left one character, extending rectangular selection to new caret position.
+ void CharLeftRectExtend();
+
+ // Move caret right one character, extending rectangular selection to new caret position.
+ void CharRightRectExtend();
+
+ // Move caret to first position on line, extending rectangular selection to new caret position.
+ void HomeRectExtend();
+
+ // Move caret to before first visible character on line.
+ // If already there move to first character on line.
+ // In either case, extend rectangular selection to new caret position.
+ void VCHomeRectExtend();
+
+ // Move caret to last position on line, extending rectangular selection to new caret position.
+ void LineEndRectExtend();
+
+ // Move caret one page up, extending rectangular selection to new caret position.
+ void PageUpRectExtend();
+
+ // Move caret one page down, extending rectangular selection to new caret position.
+ void PageDownRectExtend();
+
+ // Move caret to top of page, or one page up if already at top of page.
+ void StutteredPageUp();
+
+ // Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
+ void StutteredPageUpExtend();
+
+ // Move caret to bottom of page, or one page down if already at bottom of page.
+ void StutteredPageDown();
+
+ // Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
+ void StutteredPageDownExtend();
+
+ // Move caret left one word, position cursor at end of word.
+ void WordLeftEnd();
+
+ // Move caret left one word, position cursor at end of word, extending selection to new caret position.
+ void WordLeftEndExtend();
+
+ // Move caret right one word, position cursor at end of word.
+ void WordRightEnd();
+
+ // Move caret right one word, position cursor at end of word, extending selection to new caret position.
+ void WordRightEndExtend();
+
// Set the set of characters making up whitespace for when moving or selecting by word.
// Should be called after SetWordChars.
void SetWhitespaceChars(const wxString& characters);
// Get currently selected item position in the auto-completion list
int AutoCompGetCurrent();
+ // Enlarge the document to a particular size of text bytes.
+ void Allocate(int bytes);
+
// Start notifying the container of all key presses and commands.
void StartRecord();
//
// bold turns on bold
// italic turns on italics
- // fore:#RRGGBB sets the foreground colour
- // back:#RRGGBB sets the background colour
+ // fore:[name or #RRGGBB] sets the foreground colour
+ // back:[name or #RRGGBB] sets the background colour
// face:[facename] sets the font face name to use
// size:[num] sets the font size in points
// eol turns on eol filling
bool DoDropText(long x, long y, const wxString& data);
#endif
+ // Specify whether anti-aliased fonts should be used. Will have no effect
+ // on some platforms, but on some (wxMac for example) can greatly improve
+ // performance.
+ void SetUseAntiAliasing(bool useAA);
+ // Returns the current UseAntiAliasing setting.
+ bool GetUseAntiAliasing();
+
//----------------------------------------------------------------------
void OnListBox(wxCommandEvent& evt);
void OnIdle(wxIdleEvent& evt);
+ virtual wxSize DoGetBestSize() const;
// Turn notifications from Scintilla into events
void NotifyChange();
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC, wxEVT_STC_MACRORECORD, 1660)
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC, wxEVT_STC_MARGINCLICK, 1661)
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC, wxEVT_STC_NEEDSHOWN, 1662)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC, wxEVT_STC_POSCHANGED, 1663)
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC, wxEVT_STC_PAINTED, 1664)
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC, wxEVT_STC_USERLISTSELECTION, 1665)
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC, wxEVT_STC_URIDROPPED, 1666)
wxEVT_STC_MACRORECORD,
wxEVT_STC_MARGINCLICK,
wxEVT_STC_NEEDSHOWN,
- wxEVT_STC_POSCHANGED,
wxEVT_STC_PAINTED,
wxEVT_STC_USERLISTSELECTION,
wxEVT_STC_URIDROPPED,
#define EVT_STC_MACRORECORD(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MACRORECORD, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL ),
#define EVT_STC_MARGINCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MARGINCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL ),
#define EVT_STC_NEEDSHOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_NEEDSHOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL ),
-#define EVT_STC_POSCHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_POSCHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL ),
#define EVT_STC_PAINTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_PAINTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL ),
#define EVT_STC_USERLISTSELECTION(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_USERLISTSELECTION, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL ),
#define EVT_STC_URIDROPPED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_URIDROPPED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxStyledTextEventFunction, & fn ), (wxObject *) NULL ),