wxWidgets/src/stc/stc.cpp
Artur Wieczorek f311807112 Handle EVT_CONTEXT_MENU directly in wxSTC (wxOSX)
A simulation of context menu event by handling directly EVT_RIGHT_UP was implemented in wxSTC in 451c5cc7b9, but later on, EVT_CONTEXT_MENU generation in wxOSX was fixed in 524c47aa3a so  simulation is no longer necessary and this event can be directly handled in wxSTC.
2017-07-02 13:02:13 +02:00

5640 lines
163 KiB
C++

////////////////////////////////////////////////////////////////////////////
// Name: stc.cpp
// 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, but instead
// delegates most things to the real Scintilla class.
// This allows the use of Scintilla without polluting the
// namespace with all the classes and identifiers from Scintilla.
//
// Author: Robin Dunn
//
// Created: 13-Jan-2000
// Copyright: (c) 2000 by Total Control Software
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/*
IMPORTANT: src/stc/stc.cpp is generated by src/stc/gen_iface.py from
src/stc/stc.cpp.in, don't edit stc.cpp file as your changes will be
lost after the next regeneration, edit stc.cpp.in and rerun the
gen_iface.py script instead!
Parts of this file generated by the script are found in between
the special "{{{" and "}}}" markers, the rest of it is copied
verbatim from src.h.in.
*/
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#if wxUSE_STC
#include "wx/stc/stc.h"
#include "wx/stc/private.h"
#ifndef WX_PRECOMP
#include "wx/wx.h"
#endif // WX_PRECOMP
#include <ctype.h>
#include "wx/tokenzr.h"
#include "wx/mstream.h"
#include "wx/image.h"
#if wxUSE_FFILE
#include "wx/ffile.h"
#elif wxUSE_FILE
#include "wx/file.h"
#endif
#ifdef __WXGTK__
#include "wx/dcbuffer.h"
#endif
#include "ScintillaWX.h"
//----------------------------------------------------------------------
const char wxSTCNameStr[] = "stcwindow";
#ifdef MAKELONG
#undef MAKELONG
#endif
#define MAKELONG(a, b) ((a) | ((b) << 16))
static long wxColourAsLong(const wxColour& co) {
return (((long)co.Blue() << 16) |
((long)co.Green() << 8) |
((long)co.Red()));
}
static wxColour wxColourFromLong(long c) {
wxColour clr;
clr.Set((unsigned char)(c & 0xff),
(unsigned char)((c >> 8) & 0xff),
(unsigned char)((c >> 16) & 0xff));
return clr;
}
static wxColour wxColourFromSpec(const wxString& spec) {
// spec should be a colour name or "#RRGGBB"
if (spec.GetChar(0) == wxT('#')) {
long red, green, blue;
red = green = blue = 0;
spec.Mid(1,2).ToLong(&red, 16);
spec.Mid(3,2).ToLong(&green, 16);
spec.Mid(5,2).ToLong(&blue, 16);
return wxColour((unsigned char)red,
(unsigned char)green,
(unsigned char)blue);
}
else
return wxColour(spec);
}
//----------------------------------------------------------------------
wxDEFINE_EVENT( wxEVT_STC_CHANGE, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_STYLENEEDED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_CHARADDED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_SAVEPOINTREACHED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_SAVEPOINTLEFT, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_ROMODIFYATTEMPT, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_KEY, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_DOUBLECLICK, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_UPDATEUI, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_MODIFIED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_MACRORECORD, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_MARGINCLICK, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_NEEDSHOWN, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_PAINTED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_USERLISTSELECTION, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_URIDROPPED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_DWELLSTART, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_DWELLEND, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_START_DRAG, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_DRAG_OVER, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_DO_DROP, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_ZOOM, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_HOTSPOT_CLICK, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_HOTSPOT_DCLICK, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_CALLTIP_CLICK, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_AUTOCOMP_SELECTION, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_INDICATOR_CLICK, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_INDICATOR_RELEASE, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_AUTOCOMP_CANCELLED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_AUTOCOMP_CHAR_DELETED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_HOTSPOT_RELEASE_CLICK, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_CLIPBOARD_COPY, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_CLIPBOARD_PASTE, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_AUTOCOMP_COMPLETED, wxStyledTextEvent );
wxDEFINE_EVENT( wxEVT_STC_MARGIN_RIGHT_CLICK, wxStyledTextEvent );
wxBEGIN_EVENT_TABLE(wxStyledTextCtrl, wxControl)
EVT_PAINT (wxStyledTextCtrl::OnPaint)
EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin)
EVT_SCROLL (wxStyledTextCtrl::OnScroll)
EVT_SIZE (wxStyledTextCtrl::OnSize)
EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown)
EVT_RIGHT_DOWN (wxStyledTextCtrl::OnMouseRightDown)
// Let Scintilla see the double click as a second click
EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown)
EVT_MOTION (wxStyledTextCtrl::OnMouseMove)
EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp)
EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu)
EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel)
EVT_MIDDLE_UP (wxStyledTextCtrl::OnMouseMiddleUp)
EVT_CHAR (wxStyledTextCtrl::OnChar)
EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown)
EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus)
EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus)
EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged)
EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground)
EVT_MENU_RANGE (10, 16, wxStyledTextCtrl::OnMenu)
EVT_LISTBOX_DCLICK (wxID_ANY, wxStyledTextCtrl::OnListBox)
wxEND_EVENT_TABLE()
wxIMPLEMENT_CLASS(wxStyledTextCtrl, wxControl);
wxIMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent, wxCommandEvent);
#ifdef LINK_LEXERS
// forces the linking of the lexer modules
int Scintilla_LinkLexers();
#endif
//----------------------------------------------------------------------
// Constructor and Destructor
wxStyledTextCtrl::wxStyledTextCtrl(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name)
{
m_swx = NULL;
Create(parent, id, pos, size, style, name);
}
bool wxStyledTextCtrl::Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name)
{
style |= wxVSCROLL | wxHSCROLL;
if (!wxControl::Create(parent, id, pos, size,
style | wxWANTS_CHARS | wxCLIP_CHILDREN,
wxDefaultValidator, name))
return false;
#ifdef LINK_LEXERS
Scintilla_LinkLexers();
#endif
m_swx = new ScintillaWX(this);
m_stopWatch.Start();
m_lastKeyDownConsumed = false;
m_vScrollBar = NULL;
m_hScrollBar = NULL;
#if wxUSE_UNICODE
// Put Scintilla into unicode (UTF-8) mode
SetCodePage(wxSTC_CP_UTF8);
#endif
SetInitialSize(size);
// Reduces flicker on GTK+/X11
SetBackgroundStyle(wxBG_STYLE_PAINT);
// Make sure it can take the focus
SetCanFocus(true);
// STC doesn't support RTL languages at all
SetLayoutDirection(wxLayout_LeftToRight);
return true;
}
wxStyledTextCtrl::~wxStyledTextCtrl() {
delete m_swx;
}
//----------------------------------------------------------------------
wxIntPtr wxStyledTextCtrl::SendMsg(int msg, wxUIntPtr wp, wxIntPtr lp) const
{
return m_swx->WndProc(msg, wp, lp);
}
//----------------------------------------------------------------------
// Set the vertical scrollbar to use instead of the one that's built-in.
void wxStyledTextCtrl::SetVScrollBar(wxScrollBar* bar) {
m_vScrollBar = bar;
if (bar != NULL) {
// ensure that the built-in scrollbar is not visible
SetScrollbar(wxVERTICAL, 0, 0, 0);
}
}
// Set the horizontal scrollbar to use instead of the one that's built-in.
void wxStyledTextCtrl::SetHScrollBar(wxScrollBar* bar) {
m_hScrollBar = bar;
if (bar != NULL) {
// ensure that the built-in scrollbar is not visible
SetScrollbar(wxHORIZONTAL, 0, 0, 0);
}
}
//----------------------------------------------------------------------
// Generated methods implementation section {{{
// Add text to the document at current position.
void wxStyledTextCtrl::AddText(const wxString& text) {
const wxWX2MBbuf buf = wx2stc(text);
SendMsg(SCI_ADDTEXT, wx2stclen(text, buf), (sptr_t)(const char*)buf);
}
// Add array of cells to document.
void wxStyledTextCtrl::AddStyledText(const wxMemoryBuffer& data) {
SendMsg(SCI_ADDSTYLEDTEXT, data.GetDataLen(), (sptr_t)data.GetData());
}
// Insert string at a position.
void wxStyledTextCtrl::InsertText(int pos, const wxString& text)
{
SendMsg(SCI_INSERTTEXT, pos, (sptr_t)(const char*)wx2stc(text));
}
// Change the text that is being inserted in response to wxSTC_MOD_INSERTCHECK
void wxStyledTextCtrl::ChangeInsertion(int length, const wxString& text)
{
SendMsg(SCI_CHANGEINSERTION, length, (sptr_t)(const char*)wx2stc(text));
}
// Delete all text in the document.
void wxStyledTextCtrl::ClearAll()
{
SendMsg(SCI_CLEARALL, 0, 0);
}
// Delete a range of text in the document.
void wxStyledTextCtrl::DeleteRange(int start, int lengthDelete)
{
SendMsg(SCI_DELETERANGE, start, lengthDelete);
}
// Set all style bytes to 0, remove all folding information.
void wxStyledTextCtrl::ClearDocumentStyle()
{
SendMsg(SCI_CLEARDOCUMENTSTYLE, 0, 0);
}
// Returns the number of bytes in the document.
int wxStyledTextCtrl::GetLength() const
{
return SendMsg(SCI_GETLENGTH, 0, 0);
}
// Returns the character byte at the position.
int wxStyledTextCtrl::GetCharAt(int pos) const {
return (unsigned char)SendMsg(SCI_GETCHARAT, pos, 0);
}
// Returns the position of the caret.
int wxStyledTextCtrl::GetCurrentPos() const
{
return SendMsg(SCI_GETCURRENTPOS, 0, 0);
}
// Returns the position of the opposite end of the selection to the caret.
int wxStyledTextCtrl::GetAnchor() const
{
return SendMsg(SCI_GETANCHOR, 0, 0);
}
// Returns the style byte at the position.
int wxStyledTextCtrl::GetStyleAt(int pos) const {
return (unsigned char)SendMsg(SCI_GETSTYLEAT, pos, 0);
}
// Redoes the next action on the undo history.
void wxStyledTextCtrl::Redo()
{
SendMsg(SCI_REDO, 0, 0);
}
// Choose between collecting actions into the undo
// history and discarding them.
void wxStyledTextCtrl::SetUndoCollection(bool collectUndo)
{
SendMsg(SCI_SETUNDOCOLLECTION, collectUndo, 0);
}
// Select all the text in the document.
void wxStyledTextCtrl::SelectAll()
{
SendMsg(SCI_SELECTALL, 0, 0);
}
// Remember the current position in the undo history as the position
// at which the document was saved.
void wxStyledTextCtrl::SetSavePoint()
{
SendMsg(SCI_SETSAVEPOINT, 0, 0);
}
// Retrieve a buffer of cells.
wxMemoryBuffer wxStyledTextCtrl::GetStyledText(int startPos, int endPos) {
wxMemoryBuffer buf;
if (endPos < startPos) {
wxSwap(startPos, endPos);
}
int len = endPos - startPos;
if (!len) return buf;
Sci_TextRange tr;
tr.lpstrText = (char*)buf.GetWriteBuf(len*2+1);
tr.chrg.cpMin = startPos;
tr.chrg.cpMax = endPos;
len = SendMsg(SCI_GETSTYLEDTEXT, 0, (sptr_t)&tr);
buf.UngetWriteBuf(len);
return buf;
}
// Are there any redoable actions in the undo history?
bool wxStyledTextCtrl::CanRedo() const
{
return SendMsg(SCI_CANREDO, 0, 0) != 0;
}
// Retrieve the line number at which a particular marker is located.
int wxStyledTextCtrl::MarkerLineFromHandle(int markerHandle)
{
return SendMsg(SCI_MARKERLINEFROMHANDLE, markerHandle, 0);
}
// Delete a marker.
void wxStyledTextCtrl::MarkerDeleteHandle(int markerHandle)
{
SendMsg(SCI_MARKERDELETEHANDLE, markerHandle, 0);
}
// Is undo history being collected?
bool wxStyledTextCtrl::GetUndoCollection() const
{
return SendMsg(SCI_GETUNDOCOLLECTION, 0, 0) != 0;
}
// Are white space characters currently visible?
// Returns one of wxSTC_WS_* constants.
int wxStyledTextCtrl::GetViewWhiteSpace() const
{
return SendMsg(SCI_GETVIEWWS, 0, 0);
}
// Make white space characters invisible, always visible or visible outside indentation.
void wxStyledTextCtrl::SetViewWhiteSpace(int viewWS)
{
SendMsg(SCI_SETVIEWWS, viewWS, 0);
}
// Retrieve the current tab draw mode.
// Returns one of wxSTC_TD_* constants.
int wxStyledTextCtrl::GetTabDrawMode() const
{
return SendMsg(SCI_GETTABDRAWMODE, 0, 0);
}
// Set how tabs are drawn when visible.
void wxStyledTextCtrl::SetTabDrawMode(int tabDrawMode)
{
SendMsg(SCI_SETTABDRAWMODE, tabDrawMode, 0);
}
// Find the position from a point within the window.
int wxStyledTextCtrl::PositionFromPoint(wxPoint pt) const {
return SendMsg(SCI_POSITIONFROMPOINT, pt.x, pt.y);
}
// Find the position from a point within the window but return
// wxSTC_INVALID_POSITION if not close to text.
int wxStyledTextCtrl::PositionFromPointClose(int x, int y)
{
return SendMsg(SCI_POSITIONFROMPOINTCLOSE, x, y);
}
// Set caret to start of a line and ensure it is visible.
void wxStyledTextCtrl::GotoLine(int line)
{
SendMsg(SCI_GOTOLINE, line, 0);
}
// Set caret to a position and ensure it is visible.
void wxStyledTextCtrl::GotoPos(int caret)
{
SendMsg(SCI_GOTOPOS, caret, 0);
}
// Set the selection anchor to a position. The anchor is the opposite
// end of the selection from the caret.
void wxStyledTextCtrl::SetAnchor(int anchor)
{
SendMsg(SCI_SETANCHOR, anchor, 0);
}
// Retrieve the text of the line containing the caret.
wxString wxStyledTextCtrl::GetCurLine(int* linePos) {
int len = LineLength(GetCurrentLine());
if (!len) {
if (linePos) *linePos = 0;
return wxEmptyString;
}
wxCharBuffer buf(len);
int pos = SendMsg(SCI_GETCURLINE, len+1, (sptr_t)buf.data());
if (linePos) *linePos = pos;
return stc2wx(buf);
}
// Retrieve the position of the last correctly styled character.
int wxStyledTextCtrl::GetEndStyled() const
{
return SendMsg(SCI_GETENDSTYLED, 0, 0);
}
// Convert all line endings in the document to one mode.
void wxStyledTextCtrl::ConvertEOLs(int eolMode)
{
SendMsg(SCI_CONVERTEOLS, eolMode, 0);
}
// Retrieve the current end of line mode - one of wxSTC_EOL_CRLF, wxSTC_EOL_CR, or wxSTC_EOL_LF.
int wxStyledTextCtrl::GetEOLMode() const
{
return SendMsg(SCI_GETEOLMODE, 0, 0);
}
// Set the current end of line mode.
void wxStyledTextCtrl::SetEOLMode(int eolMode)
{
SendMsg(SCI_SETEOLMODE, eolMode, 0);
}
// Set the current styling position to start.
void wxStyledTextCtrl::StartStyling(int start) {
SendMsg(SCI_STARTSTYLING, start, 0);
}
// Change style from current styling position for length characters to a style
// and move the current styling position to after this newly styled segment.
void wxStyledTextCtrl::SetStyling(int length, int style)
{
SendMsg(SCI_SETSTYLING, length, style);
}
// Is drawing done first into a buffer or direct to the screen?
bool wxStyledTextCtrl::GetBufferedDraw() const
{
return SendMsg(SCI_GETBUFFEREDDRAW, 0, 0) != 0;
}
// If drawing is buffered then each line of text is drawn into a bitmap buffer
// before drawing it to the screen to avoid flicker.
void wxStyledTextCtrl::SetBufferedDraw(bool buffered)
{
SendMsg(SCI_SETBUFFEREDDRAW, buffered, 0);
}
// Change the visible size of a tab to be a multiple of the width of a space character.
void wxStyledTextCtrl::SetTabWidth(int tabWidth)
{
SendMsg(SCI_SETTABWIDTH, tabWidth, 0);
}
// Retrieve the visible size of a tab.
int wxStyledTextCtrl::GetTabWidth() const
{
return SendMsg(SCI_GETTABWIDTH, 0, 0);
}
// Clear explicit tabstops on a line.
void wxStyledTextCtrl::ClearTabStops(int line)
{
SendMsg(SCI_CLEARTABSTOPS, line, 0);
}
// Add an explicit tab stop for a line.
void wxStyledTextCtrl::AddTabStop(int line, int x)
{
SendMsg(SCI_ADDTABSTOP, line, x);
}
// Find the next explicit tab stop position on a line after a position.
int wxStyledTextCtrl::GetNextTabStop(int line, int x)
{
return SendMsg(SCI_GETNEXTTABSTOP, line, x);
}
// Set the code page used to interpret the bytes of the document as characters.
void wxStyledTextCtrl::SetCodePage(int codePage) {
#if wxUSE_UNICODE
wxASSERT_MSG(codePage == wxSTC_CP_UTF8,
wxT("Only wxSTC_CP_UTF8 may be used when wxUSE_UNICODE is on."));
#else
wxASSERT_MSG(codePage != wxSTC_CP_UTF8,
wxT("wxSTC_CP_UTF8 may not be used when wxUSE_UNICODE is off."));
#endif
SendMsg(SCI_SETCODEPAGE, codePage);
}
// Is the IME displayed in a window or inline?
int wxStyledTextCtrl::GetIMEInteraction() const
{
return SendMsg(SCI_GETIMEINTERACTION, 0, 0);
}
// Choose to display the the IME in a winow or inline.
void wxStyledTextCtrl::SetIMEInteraction(int imeInteraction)
{
SendMsg(SCI_SETIMEINTERACTION, imeInteraction, 0);
}
// Set the symbol used for a particular marker number,
// and optionally the fore and background colours.
void wxStyledTextCtrl::MarkerDefine(int markerNumber, int markerSymbol,
const wxColour& foreground,
const wxColour& background) {
SendMsg(SCI_MARKERDEFINE, markerNumber, markerSymbol);
if (foreground.IsOk())
MarkerSetForeground(markerNumber, foreground);
if (background.IsOk())
MarkerSetBackground(markerNumber, background);
}
// Set the foreground colour used for a particular marker number.
void wxStyledTextCtrl::MarkerSetForeground(int markerNumber, const wxColour& fore)
{
SendMsg(SCI_MARKERSETFORE, markerNumber, wxColourAsLong(fore));
}
// Set the background colour used for a particular marker number.
void wxStyledTextCtrl::MarkerSetBackground(int markerNumber, const wxColour& back)
{
SendMsg(SCI_MARKERSETBACK, markerNumber, wxColourAsLong(back));
}
// Set the background colour used for a particular marker number when its folding block is selected.
void wxStyledTextCtrl::MarkerSetBackgroundSelected(int markerNumber, const wxColour& back)
{
SendMsg(SCI_MARKERSETBACKSELECTED, markerNumber, wxColourAsLong(back));
}
// Enable/disable highlight for current folding bloc (smallest one that contains the caret)
void wxStyledTextCtrl::MarkerEnableHighlight(bool enabled)
{
SendMsg(SCI_MARKERENABLEHIGHLIGHT, enabled, 0);
}
// Add a marker to a line, returning an ID which can be used to find or delete the marker.
int wxStyledTextCtrl::MarkerAdd(int line, int markerNumber)
{
return SendMsg(SCI_MARKERADD, line, markerNumber);
}
// Delete a marker from a line.
void wxStyledTextCtrl::MarkerDelete(int line, int markerNumber)
{
SendMsg(SCI_MARKERDELETE, line, markerNumber);
}
// Delete all markers with a particular number from all lines.
void wxStyledTextCtrl::MarkerDeleteAll(int markerNumber)
{
SendMsg(SCI_MARKERDELETEALL, markerNumber, 0);
}
// Get a bit mask of all the markers set on a line.
int wxStyledTextCtrl::MarkerGet(int line)
{
return SendMsg(SCI_MARKERGET, line, 0);
}
// Find the next line at or after lineStart that includes a marker in mask.
// Return -1 when no more lines.
int wxStyledTextCtrl::MarkerNext(int lineStart, int markerMask)
{
return SendMsg(SCI_MARKERNEXT, lineStart, markerMask);
}
// Find the previous line before lineStart that includes a marker in mask.
int wxStyledTextCtrl::MarkerPrevious(int lineStart, int markerMask)
{
return SendMsg(SCI_MARKERPREVIOUS, lineStart, markerMask);
}
// Define a marker from a bitmap
void wxStyledTextCtrl::MarkerDefineBitmap(int markerNumber, const wxBitmap& bmp) {
// convert bmp to a xpm in a string
wxMemoryOutputStream strm;
wxImage img = bmp.ConvertToImage();
if (img.HasAlpha())
img.ConvertAlphaToMask();
img.SaveFile(strm, wxBITMAP_TYPE_XPM);
size_t len = strm.GetSize();
char* buff = new char[len+1];
strm.CopyTo(buff, len);
buff[len] = 0;
SendMsg(SCI_MARKERDEFINEPIXMAP, markerNumber, (sptr_t)buff);
delete [] buff;
}
// Add a set of markers to a line.
void wxStyledTextCtrl::MarkerAddSet(int line, int markerSet)
{
SendMsg(SCI_MARKERADDSET, line, markerSet);
}
// Set the alpha used for a marker that is drawn in the text area, not the margin.
void wxStyledTextCtrl::MarkerSetAlpha(int markerNumber, int alpha)
{
SendMsg(SCI_MARKERSETALPHA, markerNumber, alpha);
}
// Set a margin to be either numeric or symbolic.
void wxStyledTextCtrl::SetMarginType(int margin, int marginType)
{
SendMsg(SCI_SETMARGINTYPEN, margin, marginType);
}
// Retrieve the type of a margin.
int wxStyledTextCtrl::GetMarginType(int margin) const
{
return SendMsg(SCI_GETMARGINTYPEN, margin, 0);
}
// Set the width of a margin to a width expressed in pixels.
void wxStyledTextCtrl::SetMarginWidth(int margin, int pixelWidth)
{
SendMsg(SCI_SETMARGINWIDTHN, margin, pixelWidth);
}
// Retrieve the width of a margin in pixels.
int wxStyledTextCtrl::GetMarginWidth(int margin) const
{
return SendMsg(SCI_GETMARGINWIDTHN, margin, 0);
}
// Set a mask that determines which markers are displayed in a margin.
void wxStyledTextCtrl::SetMarginMask(int margin, int mask)
{
SendMsg(SCI_SETMARGINMASKN, margin, mask);
}
// Retrieve the marker mask of a margin.
int wxStyledTextCtrl::GetMarginMask(int margin) const
{
return SendMsg(SCI_GETMARGINMASKN, margin, 0);
}
// Make a margin sensitive or insensitive to mouse clicks.
void wxStyledTextCtrl::SetMarginSensitive(int margin, bool sensitive)
{
SendMsg(SCI_SETMARGINSENSITIVEN, margin, sensitive);
}
// Retrieve the mouse click sensitivity of a margin.
bool wxStyledTextCtrl::GetMarginSensitive(int margin) const
{
return SendMsg(SCI_GETMARGINSENSITIVEN, margin, 0) != 0;
}
// Set the cursor shown when the mouse is inside a margin.
void wxStyledTextCtrl::SetMarginCursor(int margin, int cursor)
{
SendMsg(SCI_SETMARGINCURSORN, margin, cursor);
}
// Retrieve the cursor shown in a margin.
int wxStyledTextCtrl::GetMarginCursor(int margin) const
{
return SendMsg(SCI_GETMARGINCURSORN, margin, 0);
}
// Set the background colour of a margin. Only visible for wxSTC_MARGIN_COLOUR.
void wxStyledTextCtrl::SetMarginBackground(int margin, const wxColour& back)
{
SendMsg(SCI_SETMARGINBACKN, margin, wxColourAsLong(back));
}
// Retrieve the background colour of a margin
wxColour wxStyledTextCtrl::GetMarginBackground(int margin) const
{
long c = SendMsg(SCI_GETMARGINBACKN, margin, 0);
return wxColourFromLong(c);
}
// Allocate a non-standard number of margins.
void wxStyledTextCtrl::SetMarginCount(int margins)
{
SendMsg(SCI_SETMARGINS, margins, 0);
}
// How many margins are there?.
int wxStyledTextCtrl::GetMarginCount() const
{
return SendMsg(SCI_GETMARGINS, 0, 0);
}
// Clear all the styles and make equivalent to the global default style.
void wxStyledTextCtrl::StyleClearAll()
{
SendMsg(SCI_STYLECLEARALL, 0, 0);
}
// Set the foreground colour of a style.
void wxStyledTextCtrl::StyleSetForeground(int style, const wxColour& fore)
{
SendMsg(SCI_STYLESETFORE, style, wxColourAsLong(fore));
}
// Set the background colour of a style.
void wxStyledTextCtrl::StyleSetBackground(int style, const wxColour& back)
{
SendMsg(SCI_STYLESETBACK, style, wxColourAsLong(back));
}
// Set a style to be bold or not.
void wxStyledTextCtrl::StyleSetBold(int style, bool bold)
{
SendMsg(SCI_STYLESETBOLD, style, bold);
}
// Set a style to be italic or not.
void wxStyledTextCtrl::StyleSetItalic(int style, bool italic)
{
SendMsg(SCI_STYLESETITALIC, style, italic);
}
// Set the size of characters of a style.
void wxStyledTextCtrl::StyleSetSize(int style, int sizePoints)
{
SendMsg(SCI_STYLESETSIZE, style, sizePoints);
}
// Set the font of a style.
void wxStyledTextCtrl::StyleSetFaceName(int style, const wxString& fontName)
{
SendMsg(SCI_STYLESETFONT, style, (sptr_t)(const char*)wx2stc(fontName));
}
// Set a style to have its end of line filled or not.
void wxStyledTextCtrl::StyleSetEOLFilled(int style, bool eolFilled)
{
SendMsg(SCI_STYLESETEOLFILLED, style, eolFilled);
}
// Reset the default style to its state at startup
void wxStyledTextCtrl::StyleResetDefault()
{
SendMsg(SCI_STYLERESETDEFAULT, 0, 0);
}
// Set a style to be underlined or not.
void wxStyledTextCtrl::StyleSetUnderline(int style, bool underline)
{
SendMsg(SCI_STYLESETUNDERLINE, style, underline);
}
// Get the foreground colour of a style.
wxColour wxStyledTextCtrl::StyleGetForeground(int style) const
{
long c = SendMsg(SCI_STYLEGETFORE, style, 0);
return wxColourFromLong(c);
}
// Get the background colour of a style.
wxColour wxStyledTextCtrl::StyleGetBackground(int style) const
{
long c = SendMsg(SCI_STYLEGETBACK, style, 0);
return wxColourFromLong(c);
}
// Get is a style bold or not.
bool wxStyledTextCtrl::StyleGetBold(int style) const
{
return SendMsg(SCI_STYLEGETBOLD, style, 0) != 0;
}
// Get is a style italic or not.
bool wxStyledTextCtrl::StyleGetItalic(int style) const
{
return SendMsg(SCI_STYLEGETITALIC, style, 0) != 0;
}
// Get the size of characters of a style.
int wxStyledTextCtrl::StyleGetSize(int style) const
{
return SendMsg(SCI_STYLEGETSIZE, style, 0);
}
// Get the font facename of a style
wxString wxStyledTextCtrl::StyleGetFaceName(int style) {
const int msg = SCI_STYLEGETFONT;
long len = SendMsg(msg, style, 0);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, style, (sptr_t)buf.data());
return stc2wx(buf);
}
// Get is a style to have its end of line filled or not.
bool wxStyledTextCtrl::StyleGetEOLFilled(int style) const
{
return SendMsg(SCI_STYLEGETEOLFILLED, style, 0) != 0;
}
// Get is a style underlined or not.
bool wxStyledTextCtrl::StyleGetUnderline(int style) const
{
return SendMsg(SCI_STYLEGETUNDERLINE, style, 0) != 0;
}
// Get is a style mixed case, or to force upper or lower case.
int wxStyledTextCtrl::StyleGetCase(int style) const
{
return SendMsg(SCI_STYLEGETCASE, style, 0);
}
// Get the character get of the font in a style.
int wxStyledTextCtrl::StyleGetCharacterSet(int style) const
{
return SendMsg(SCI_STYLEGETCHARACTERSET, style, 0);
}
// Get is a style visible or not.
bool wxStyledTextCtrl::StyleGetVisible(int style) const
{
return SendMsg(SCI_STYLEGETVISIBLE, style, 0) != 0;
}
// Get is a style changeable or not (read only).
// Experimental feature, currently buggy.
bool wxStyledTextCtrl::StyleGetChangeable(int style) const
{
return SendMsg(SCI_STYLEGETCHANGEABLE, style, 0) != 0;
}
// Get is a style a hotspot or not.
bool wxStyledTextCtrl::StyleGetHotSpot(int style) const
{
return SendMsg(SCI_STYLEGETHOTSPOT, style, 0) != 0;
}
// Set a style to be mixed case, or to force upper or lower case.
void wxStyledTextCtrl::StyleSetCase(int style, int caseVisible)
{
SendMsg(SCI_STYLESETCASE, style, caseVisible);
}
// Set the size of characters of a style. Size is in points multiplied by 100.
void wxStyledTextCtrl::StyleSetSizeFractional(int style, int sizeHundredthPoints)
{
SendMsg(SCI_STYLESETSIZEFRACTIONAL, style, sizeHundredthPoints);
}
// Get the size of characters of a style in points multiplied by 100
int wxStyledTextCtrl::StyleGetSizeFractional(int style) const
{
return SendMsg(SCI_STYLEGETSIZEFRACTIONAL, style, 0);
}
// Set the weight of characters of a style.
void wxStyledTextCtrl::StyleSetWeight(int style, int weight)
{
SendMsg(SCI_STYLESETWEIGHT, style, weight);
}
// Get the weight of characters of a style.
int wxStyledTextCtrl::StyleGetWeight(int style) const
{
return SendMsg(SCI_STYLEGETWEIGHT, style, 0);
}
// Set the character set of the font in a style.
void wxStyledTextCtrl::StyleSetCharacterSet(int style, int characterSet) {
wxFontEncoding encoding;
// Translate the Scintilla characterSet to a wxFontEncoding
switch (characterSet) {
default:
case wxSTC_CHARSET_ANSI:
case wxSTC_CHARSET_DEFAULT:
encoding = wxFONTENCODING_DEFAULT;
break;
case wxSTC_CHARSET_BALTIC:
encoding = wxFONTENCODING_ISO8859_13;
break;
case wxSTC_CHARSET_CHINESEBIG5:
encoding = wxFONTENCODING_CP950;
break;
case wxSTC_CHARSET_EASTEUROPE:
encoding = wxFONTENCODING_ISO8859_2;
break;
case wxSTC_CHARSET_GB2312:
encoding = wxFONTENCODING_CP936;
break;
case wxSTC_CHARSET_GREEK:
encoding = wxFONTENCODING_ISO8859_7;
break;
case wxSTC_CHARSET_HANGUL:
encoding = wxFONTENCODING_CP949;
break;
case wxSTC_CHARSET_MAC:
encoding = wxFONTENCODING_DEFAULT;
break;
case wxSTC_CHARSET_OEM:
encoding = wxFONTENCODING_DEFAULT;
break;
case wxSTC_CHARSET_RUSSIAN:
encoding = wxFONTENCODING_KOI8;
break;
case wxSTC_CHARSET_SHIFTJIS:
encoding = wxFONTENCODING_CP932;
break;
case wxSTC_CHARSET_SYMBOL:
encoding = wxFONTENCODING_DEFAULT;
break;
case wxSTC_CHARSET_TURKISH:
encoding = wxFONTENCODING_ISO8859_9;
break;
case wxSTC_CHARSET_JOHAB:
encoding = wxFONTENCODING_DEFAULT;
break;
case wxSTC_CHARSET_HEBREW:
encoding = wxFONTENCODING_ISO8859_8;
break;
case wxSTC_CHARSET_ARABIC:
encoding = wxFONTENCODING_ISO8859_6;
break;
case wxSTC_CHARSET_VIETNAMESE:
encoding = wxFONTENCODING_DEFAULT;
break;
case wxSTC_CHARSET_THAI:
encoding = wxFONTENCODING_ISO8859_11;
break;
case wxSTC_CHARSET_CYRILLIC:
encoding = wxFONTENCODING_ISO8859_5;
break;
case wxSTC_CHARSET_8859_15:
encoding = wxFONTENCODING_ISO8859_15;
break;
}
// We just have Scintilla track the wxFontEncoding for us. It gets used
// in Font::Create in PlatWX.cpp. We add one to the value so that the
// effective wxFONENCODING_DEFAULT == SC_SHARSET_DEFAULT and so when
// Scintilla internally uses SC_CHARSET_DEFAULT we will translate it back
// to wxFONENCODING_DEFAULT in Font::Create.
SendMsg(SCI_STYLESETCHARACTERSET, style, encoding+1);
}
// Set a style to be a hotspot or not.
void wxStyledTextCtrl::StyleSetHotSpot(int style, bool hotspot)
{
SendMsg(SCI_STYLESETHOTSPOT, style, hotspot);
}
// Set the foreground colour of the main and additional selections and whether to use this setting.
void wxStyledTextCtrl::SetSelForeground(bool useSetting, const wxColour& fore)
{
SendMsg(SCI_SETSELFORE, useSetting, wxColourAsLong(fore));
}
// Set the background colour of the main and additional selections and whether to use this setting.
void wxStyledTextCtrl::SetSelBackground(bool useSetting, const wxColour& back)
{
SendMsg(SCI_SETSELBACK, useSetting, wxColourAsLong(back));
}
// Get the alpha of the selection.
int wxStyledTextCtrl::GetSelAlpha() const
{
return SendMsg(SCI_GETSELALPHA, 0, 0);
}
// Set the alpha of the selection.
void wxStyledTextCtrl::SetSelAlpha(int alpha)
{
SendMsg(SCI_SETSELALPHA, alpha, 0);
}
// Is the selection end of line filled?
bool wxStyledTextCtrl::GetSelEOLFilled() const
{
return SendMsg(SCI_GETSELEOLFILLED, 0, 0) != 0;
}
// Set the selection to have its end of line filled or not.
void wxStyledTextCtrl::SetSelEOLFilled(bool filled)
{
SendMsg(SCI_SETSELEOLFILLED, filled, 0);
}
// Set the foreground colour of the caret.
void wxStyledTextCtrl::SetCaretForeground(const wxColour& fore)
{
SendMsg(SCI_SETCARETFORE, wxColourAsLong(fore), 0);
}
// When key+modifier combination keyDefinition is pressed perform sciCommand.
void wxStyledTextCtrl::CmdKeyAssign(int key, int modifiers, int cmd) {
SendMsg(SCI_ASSIGNCMDKEY, MAKELONG(key, modifiers), cmd);
}
// When key+modifier combination keyDefinition is pressed do nothing.
void wxStyledTextCtrl::CmdKeyClear(int key, int modifiers) {
SendMsg(SCI_CLEARCMDKEY, MAKELONG(key, modifiers));
}
// Drop all key mappings.
void wxStyledTextCtrl::CmdKeyClearAll()
{
SendMsg(SCI_CLEARALLCMDKEYS, 0, 0);
}
// Set the styles for a segment of the document.
void wxStyledTextCtrl::SetStyleBytes(int length, char* styleBytes) {
SendMsg(SCI_SETSTYLINGEX, length, (sptr_t)styleBytes);
}
// Set a style to be visible or not.
void wxStyledTextCtrl::StyleSetVisible(int style, bool visible)
{
SendMsg(SCI_STYLESETVISIBLE, style, visible);
}
// Get the time in milliseconds that the caret is on and off.
int wxStyledTextCtrl::GetCaretPeriod() const
{
return SendMsg(SCI_GETCARETPERIOD, 0, 0);
}
// Get the time in milliseconds that the caret is on and off. 0 = steady on.
void wxStyledTextCtrl::SetCaretPeriod(int periodMilliseconds)
{
SendMsg(SCI_SETCARETPERIOD, periodMilliseconds, 0);
}
// Set the set of characters making up words for when moving or selecting by word.
// First sets defaults like SetCharsDefault.
void wxStyledTextCtrl::SetWordChars(const wxString& characters)
{
SendMsg(SCI_SETWORDCHARS, 0, (sptr_t)(const char*)wx2stc(characters));
}
// Get the set of characters making up words for when moving or selecting by word.
wxString wxStyledTextCtrl::GetWordChars() const {
const int msg = SCI_GETWORDCHARS;
int len = SendMsg(msg, 0, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxMemoryBuffer mbuf(len+1);
char* buf = (char*)mbuf.GetWriteBuf(len+1);
SendMsg(msg, 0, (sptr_t)buf);
mbuf.UngetWriteBuf(len);
mbuf.AppendByte(0);
return stc2wx(buf);
}
// Start a sequence of actions that is undone and redone as a unit.
// May be nested.
void wxStyledTextCtrl::BeginUndoAction()
{
SendMsg(SCI_BEGINUNDOACTION, 0, 0);
}
// End a sequence of actions that is undone and redone as a unit.
void wxStyledTextCtrl::EndUndoAction()
{
SendMsg(SCI_ENDUNDOACTION, 0, 0);
}
// Set an indicator to plain, squiggle or TT.
void wxStyledTextCtrl::IndicatorSetStyle(int indicator, int indicatorStyle)
{
SendMsg(SCI_INDICSETSTYLE, indicator, indicatorStyle);
}
// Retrieve the style of an indicator.
int wxStyledTextCtrl::IndicatorGetStyle(int indicator) const
{
return SendMsg(SCI_INDICGETSTYLE, indicator, 0);
}
// Set the foreground colour of an indicator.
void wxStyledTextCtrl::IndicatorSetForeground(int indicator, const wxColour& fore)
{
SendMsg(SCI_INDICSETFORE, indicator, wxColourAsLong(fore));
}
// Retrieve the foreground colour of an indicator.
wxColour wxStyledTextCtrl::IndicatorGetForeground(int indicator) const
{
long c = SendMsg(SCI_INDICGETFORE, indicator, 0);
return wxColourFromLong(c);
}
// Set an indicator to draw under text or over(default).
void wxStyledTextCtrl::IndicatorSetUnder(int indicator, bool under)
{
SendMsg(SCI_INDICSETUNDER, indicator, under);
}
// Retrieve whether indicator drawn under or over text.
bool wxStyledTextCtrl::IndicatorGetUnder(int indicator) const
{
return SendMsg(SCI_INDICGETUNDER, indicator, 0) != 0;
}
// Set a hover indicator to plain, squiggle or TT.
void wxStyledTextCtrl::IndicatorSetHoverStyle(int indicator, int indicatorStyle)
{
SendMsg(SCI_INDICSETHOVERSTYLE, indicator, indicatorStyle);
}
// Retrieve the hover style of an indicator.
int wxStyledTextCtrl::IndicatorGetHoverStyle(int indicator) const
{
return SendMsg(SCI_INDICGETHOVERSTYLE, indicator, 0);
}
// Set the foreground hover colour of an indicator.
void wxStyledTextCtrl::IndicatorSetHoverForeground(int indicator, const wxColour& fore)
{
SendMsg(SCI_INDICSETHOVERFORE, indicator, wxColourAsLong(fore));
}
// Retrieve the foreground hover colour of an indicator.
wxColour wxStyledTextCtrl::IndicatorGetHoverForeground(int indicator) const
{
long c = SendMsg(SCI_INDICGETHOVERFORE, indicator, 0);
return wxColourFromLong(c);
}
// Set the attributes of an indicator.
void wxStyledTextCtrl::IndicatorSetFlags(int indicator, int flags)
{
SendMsg(SCI_INDICSETFLAGS, indicator, flags);
}
// Retrieve the attributes of an indicator.
int wxStyledTextCtrl::IndicatorGetFlags(int indicator) const
{
return SendMsg(SCI_INDICGETFLAGS, indicator, 0);
}
// Set the foreground colour of all whitespace and whether to use this setting.
void wxStyledTextCtrl::SetWhitespaceForeground(bool useSetting, const wxColour& fore)
{
SendMsg(SCI_SETWHITESPACEFORE, useSetting, wxColourAsLong(fore));
}
// Set the background colour of all whitespace and whether to use this setting.
void wxStyledTextCtrl::SetWhitespaceBackground(bool useSetting, const wxColour& back)
{
SendMsg(SCI_SETWHITESPACEBACK, useSetting, wxColourAsLong(back));
}
// Set the size of the dots used to mark space characters.
void wxStyledTextCtrl::SetWhitespaceSize(int size)
{
SendMsg(SCI_SETWHITESPACESIZE, size, 0);
}
// Get the size of the dots used to mark space characters.
int wxStyledTextCtrl::GetWhitespaceSize() const
{
return SendMsg(SCI_GETWHITESPACESIZE, 0, 0);
}
// Divide each styling byte into lexical class bits (default: 5) and indicator
// bits (default: 3). If a lexer requires more than 32 lexical states, then this
// is used to expand the possible states.
void wxStyledTextCtrl::SetStyleBits(int bits)
{
SendMsg(SCI_SETSTYLEBITS, bits, 0);
}
// Retrieve number of bits in style bytes used to hold the lexical state.
int wxStyledTextCtrl::GetStyleBits() const
{
return SendMsg(SCI_GETSTYLEBITS, 0, 0);
}
// Used to hold extra styling information for each line.
void wxStyledTextCtrl::SetLineState(int line, int state)
{
SendMsg(SCI_SETLINESTATE, line, state);
}
// Retrieve the extra styling information for a line.
int wxStyledTextCtrl::GetLineState(int line) const
{
return SendMsg(SCI_GETLINESTATE, line, 0);
}
// Retrieve the last line number that has line state.
int wxStyledTextCtrl::GetMaxLineState() const
{
return SendMsg(SCI_GETMAXLINESTATE, 0, 0);
}
// Is the background of the line containing the caret in a different colour?
bool wxStyledTextCtrl::GetCaretLineVisible() const
{
return SendMsg(SCI_GETCARETLINEVISIBLE, 0, 0) != 0;
}
// Display the background of the line containing the caret in a different colour.
void wxStyledTextCtrl::SetCaretLineVisible(bool show)
{
SendMsg(SCI_SETCARETLINEVISIBLE, show, 0);
}
// Get the colour of the background of the line containing the caret.
wxColour wxStyledTextCtrl::GetCaretLineBackground() const
{
long c = SendMsg(SCI_GETCARETLINEBACK, 0, 0);
return wxColourFromLong(c);
}
// Set the colour of the background of the line containing the caret.
void wxStyledTextCtrl::SetCaretLineBackground(const wxColour& back)
{
SendMsg(SCI_SETCARETLINEBACK, wxColourAsLong(back), 0);
}
// Set a style to be changeable or not (read only).
// Experimental feature, currently buggy.
void wxStyledTextCtrl::StyleSetChangeable(int style, bool changeable)
{
SendMsg(SCI_STYLESETCHANGEABLE, style, changeable);
}
// Display a auto-completion list.
// The lengthEntered parameter indicates how many characters before
// the caret should be used to provide context.
void wxStyledTextCtrl::AutoCompShow(int lengthEntered, const wxString& itemList)
{
SendMsg(SCI_AUTOCSHOW, lengthEntered, (sptr_t)(const char*)wx2stc(itemList));
}
// Remove the auto-completion list from the screen.
void wxStyledTextCtrl::AutoCompCancel()
{
SendMsg(SCI_AUTOCCANCEL, 0, 0);
}
// Is there an auto-completion list visible?
bool wxStyledTextCtrl::AutoCompActive()
{
return SendMsg(SCI_AUTOCACTIVE, 0, 0) != 0;
}
// Retrieve the position of the caret when the auto-completion list was displayed.
int wxStyledTextCtrl::AutoCompPosStart()
{
return SendMsg(SCI_AUTOCPOSSTART, 0, 0);
}
// User has selected an item so remove the list and insert the selection.
void wxStyledTextCtrl::AutoCompComplete()
{
SendMsg(SCI_AUTOCCOMPLETE, 0, 0);
}
// Define a set of character that when typed cancel the auto-completion list.
void wxStyledTextCtrl::AutoCompStops(const wxString& characterSet)
{
SendMsg(SCI_AUTOCSTOPS, 0, (sptr_t)(const char*)wx2stc(characterSet));
}
// Change the separator character in the string setting up an auto-completion list.
// Default is space but can be changed if items contain space.
void wxStyledTextCtrl::AutoCompSetSeparator(int separatorCharacter)
{
SendMsg(SCI_AUTOCSETSEPARATOR, separatorCharacter, 0);
}
// Retrieve the auto-completion list separator character.
int wxStyledTextCtrl::AutoCompGetSeparator() const
{
return SendMsg(SCI_AUTOCGETSEPARATOR, 0, 0);
}
// Select the item in the auto-completion list that starts with a string.
void wxStyledTextCtrl::AutoCompSelect(const wxString& select)
{
SendMsg(SCI_AUTOCSELECT, 0, (sptr_t)(const char*)wx2stc(select));
}
// Should the auto-completion list be cancelled if the user backspaces to a
// position before where the box was created.
void wxStyledTextCtrl::AutoCompSetCancelAtStart(bool cancel)
{
SendMsg(SCI_AUTOCSETCANCELATSTART, cancel, 0);
}
// Retrieve whether auto-completion cancelled by backspacing before start.
bool wxStyledTextCtrl::AutoCompGetCancelAtStart() const
{
return SendMsg(SCI_AUTOCGETCANCELATSTART, 0, 0) != 0;
}
// Define a set of characters that when typed will cause the autocompletion to
// choose the selected item.
void wxStyledTextCtrl::AutoCompSetFillUps(const wxString& characterSet)
{
SendMsg(SCI_AUTOCSETFILLUPS, 0, (sptr_t)(const char*)wx2stc(characterSet));
}
// Should a single item auto-completion list automatically choose the item.
void wxStyledTextCtrl::AutoCompSetChooseSingle(bool chooseSingle)
{
SendMsg(SCI_AUTOCSETCHOOSESINGLE, chooseSingle, 0);
}
// Retrieve whether a single item auto-completion list automatically choose the item.
bool wxStyledTextCtrl::AutoCompGetChooseSingle() const
{
return SendMsg(SCI_AUTOCGETCHOOSESINGLE, 0, 0) != 0;
}
// Set whether case is significant when performing auto-completion searches.
void wxStyledTextCtrl::AutoCompSetIgnoreCase(bool ignoreCase)
{
SendMsg(SCI_AUTOCSETIGNORECASE, ignoreCase, 0);
}
// Retrieve state of ignore case flag.
bool wxStyledTextCtrl::AutoCompGetIgnoreCase() const
{
return SendMsg(SCI_AUTOCGETIGNORECASE, 0, 0) != 0;
}
// Display a list of strings and send notification when user chooses one.
void wxStyledTextCtrl::UserListShow(int listType, const wxString& itemList)
{
SendMsg(SCI_USERLISTSHOW, listType, (sptr_t)(const char*)wx2stc(itemList));
}
// Set whether or not autocompletion is hidden automatically when nothing matches.
void wxStyledTextCtrl::AutoCompSetAutoHide(bool autoHide)
{
SendMsg(SCI_AUTOCSETAUTOHIDE, autoHide, 0);
}
// Retrieve whether or not autocompletion is hidden automatically when nothing matches.
bool wxStyledTextCtrl::AutoCompGetAutoHide() const
{
return SendMsg(SCI_AUTOCGETAUTOHIDE, 0, 0) != 0;
}
// Set whether or not autocompletion deletes any word characters
// after the inserted text upon completion.
void wxStyledTextCtrl::AutoCompSetDropRestOfWord(bool dropRestOfWord)
{
SendMsg(SCI_AUTOCSETDROPRESTOFWORD, dropRestOfWord, 0);
}
// Retrieve whether or not autocompletion deletes any word characters
// after the inserted text upon completion.
bool wxStyledTextCtrl::AutoCompGetDropRestOfWord() const
{
return SendMsg(SCI_AUTOCGETDROPRESTOFWORD, 0, 0) != 0;
}
// Register an image for use in autocompletion lists.
void wxStyledTextCtrl::RegisterImage(int type, const wxBitmap& bmp) {
// convert bmp to a xpm in a string
wxMemoryOutputStream strm;
wxImage img = bmp.ConvertToImage();
if (img.HasAlpha())
img.ConvertAlphaToMask();
img.SaveFile(strm, wxBITMAP_TYPE_XPM);
size_t len = strm.GetSize();
char* buff = new char[len+1];
strm.CopyTo(buff, len);
buff[len] = 0;
SendMsg(SCI_REGISTERIMAGE, type, (sptr_t)buff);
delete [] buff;
}
// Clear all the registered images.
void wxStyledTextCtrl::ClearRegisteredImages()
{
SendMsg(SCI_CLEARREGISTEREDIMAGES, 0, 0);
}
// Retrieve the auto-completion list type-separator character.
int wxStyledTextCtrl::AutoCompGetTypeSeparator() const
{
return SendMsg(SCI_AUTOCGETTYPESEPARATOR, 0, 0);
}
// Change the type-separator character in the string setting up an auto-completion list.
// Default is '?' but can be changed if items contain '?'.
void wxStyledTextCtrl::AutoCompSetTypeSeparator(int separatorCharacter)
{
SendMsg(SCI_AUTOCSETTYPESEPARATOR, separatorCharacter, 0);
}
// Set the maximum width, in characters, of auto-completion and user lists.
// Set to 0 to autosize to fit longest item, which is the default.
void wxStyledTextCtrl::AutoCompSetMaxWidth(int characterCount)
{
SendMsg(SCI_AUTOCSETMAXWIDTH, characterCount, 0);
}
// Get the maximum width, in characters, of auto-completion and user lists.
int wxStyledTextCtrl::AutoCompGetMaxWidth() const
{
return SendMsg(SCI_AUTOCGETMAXWIDTH, 0, 0);
}
// Set the maximum height, in rows, of auto-completion and user lists.
// The default is 5 rows.
void wxStyledTextCtrl::AutoCompSetMaxHeight(int rowCount)
{
SendMsg(SCI_AUTOCSETMAXHEIGHT, rowCount, 0);
}
// Set the maximum height, in rows, of auto-completion and user lists.
int wxStyledTextCtrl::AutoCompGetMaxHeight() const
{
return SendMsg(SCI_AUTOCGETMAXHEIGHT, 0, 0);
}
// Set the number of spaces used for one level of indentation.
void wxStyledTextCtrl::SetIndent(int indentSize)
{
SendMsg(SCI_SETINDENT, indentSize, 0);
}
// Retrieve indentation size.
int wxStyledTextCtrl::GetIndent() const
{
return SendMsg(SCI_GETINDENT, 0, 0);
}
// Indentation will only use space characters if useTabs is false, otherwise
// it will use a combination of tabs and spaces.
void wxStyledTextCtrl::SetUseTabs(bool useTabs)
{
SendMsg(SCI_SETUSETABS, useTabs, 0);
}
// Retrieve whether tabs will be used in indentation.
bool wxStyledTextCtrl::GetUseTabs() const
{
return SendMsg(SCI_GETUSETABS, 0, 0) != 0;
}
// Change the indentation of a line to a number of columns.
void wxStyledTextCtrl::SetLineIndentation(int line, int indentation)
{
SendMsg(SCI_SETLINEINDENTATION, line, indentation);
}
// Retrieve the number of columns that a line is indented.
int wxStyledTextCtrl::GetLineIndentation(int line) const
{
return SendMsg(SCI_GETLINEINDENTATION, line, 0);
}
// Retrieve the position before the first non indentation character on a line.
int wxStyledTextCtrl::GetLineIndentPosition(int line) const
{
return SendMsg(SCI_GETLINEINDENTPOSITION, line, 0);
}
// Retrieve the column number of a position, taking tab width into account.
int wxStyledTextCtrl::GetColumn(int pos) const
{
return SendMsg(SCI_GETCOLUMN, pos, 0);
}
// Count characters between two positions.
int wxStyledTextCtrl::CountCharacters(int start, int end)
{
return SendMsg(SCI_COUNTCHARACTERS, start, end);
}
// Show or hide the horizontal scroll bar.
void wxStyledTextCtrl::SetUseHorizontalScrollBar(bool visible)
{
SendMsg(SCI_SETHSCROLLBAR, visible, 0);
}
// Is the horizontal scroll bar visible?
bool wxStyledTextCtrl::GetUseHorizontalScrollBar() const
{
return SendMsg(SCI_GETHSCROLLBAR, 0, 0) != 0;
}
// Show or hide indentation guides.
void wxStyledTextCtrl::SetIndentationGuides(int indentView)
{
SendMsg(SCI_SETINDENTATIONGUIDES, indentView, 0);
}
// Are the indentation guides visible?
int wxStyledTextCtrl::GetIndentationGuides() const
{
return SendMsg(SCI_GETINDENTATIONGUIDES, 0, 0);
}
// Set the highlighted indentation guide column.
// 0 = no highlighted guide.
void wxStyledTextCtrl::SetHighlightGuide(int column)
{
SendMsg(SCI_SETHIGHLIGHTGUIDE, column, 0);
}
// Get the highlighted indentation guide column.
int wxStyledTextCtrl::GetHighlightGuide() const
{
return SendMsg(SCI_GETHIGHLIGHTGUIDE, 0, 0);
}
// Get the position after the last visible characters on a line.
int wxStyledTextCtrl::GetLineEndPosition(int line) const
{
return SendMsg(SCI_GETLINEENDPOSITION, line, 0);
}
// Get the code page used to interpret the bytes of the document as characters.
int wxStyledTextCtrl::GetCodePage() const
{
return SendMsg(SCI_GETCODEPAGE, 0, 0);
}
// Get the foreground colour of the caret.
wxColour wxStyledTextCtrl::GetCaretForeground() const
{
long c = SendMsg(SCI_GETCARETFORE, 0, 0);
return wxColourFromLong(c);
}
// In read-only mode?
bool wxStyledTextCtrl::GetReadOnly() const
{
return SendMsg(SCI_GETREADONLY, 0, 0) != 0;
}
// Sets the position of the caret.
void wxStyledTextCtrl::SetCurrentPos(int caret)
{
SendMsg(SCI_SETCURRENTPOS, caret, 0);
}
// Sets the position that starts the selection - this becomes the anchor.
void wxStyledTextCtrl::SetSelectionStart(int anchor)
{
SendMsg(SCI_SETSELECTIONSTART, anchor, 0);
}
// Returns the position at the start of the selection.
int wxStyledTextCtrl::GetSelectionStart() const
{
return SendMsg(SCI_GETSELECTIONSTART, 0, 0);
}
// Sets the position that ends the selection - this becomes the caret.
void wxStyledTextCtrl::SetSelectionEnd(int caret)
{
SendMsg(SCI_SETSELECTIONEND, caret, 0);
}
// Returns the position at the end of the selection.
int wxStyledTextCtrl::GetSelectionEnd() const
{
return SendMsg(SCI_GETSELECTIONEND, 0, 0);
}
// Set caret to a position, while removing any existing selection.
void wxStyledTextCtrl::SetEmptySelection(int caret)
{
SendMsg(SCI_SETEMPTYSELECTION, caret, 0);
}
// Sets the print magnification added to the point size of each style for printing.
void wxStyledTextCtrl::SetPrintMagnification(int magnification)
{
SendMsg(SCI_SETPRINTMAGNIFICATION, magnification, 0);
}
// Returns the print magnification.
int wxStyledTextCtrl::GetPrintMagnification() const
{
return SendMsg(SCI_GETPRINTMAGNIFICATION, 0, 0);
}
// Modify colours when printing for clearer printed text.
void wxStyledTextCtrl::SetPrintColourMode(int mode)
{
SendMsg(SCI_SETPRINTCOLOURMODE, mode, 0);
}
// Returns the print colour mode.
int wxStyledTextCtrl::GetPrintColourMode() const
{
return SendMsg(SCI_GETPRINTCOLOURMODE, 0, 0);
}
// Find some text in the document.
int wxStyledTextCtrl::FindText(int minPos, int maxPos, const wxString& text,
int flags, int* findEnd) {
Sci_TextToFind ft;
ft.chrg.cpMin = minPos;
ft.chrg.cpMax = maxPos;
const wxWX2MBbuf buf = wx2stc(text);
ft.lpstrText = (char*)(const char*)buf;
int pos = SendMsg(SCI_FINDTEXT, flags, (sptr_t)&ft);
if (findEnd) *findEnd=(pos==-1?wxSTC_INVALID_POSITION:ft.chrgText.cpMax);
return pos;
}
// On Windows, will draw the document into a display context such as a printer.
int wxStyledTextCtrl::FormatRange(bool doDraw,
int startPos,
int endPos,
wxDC* draw,
wxDC* target,
wxRect renderRect,
wxRect pageRect) {
Sci_RangeToFormat fr;
if (endPos < startPos) {
wxSwap(startPos, endPos);
}
fr.hdc = draw;
fr.hdcTarget = target;
fr.rc.top = renderRect.GetTop();
fr.rc.left = renderRect.GetLeft();
fr.rc.right = renderRect.GetRight();
fr.rc.bottom = renderRect.GetBottom();
fr.rcPage.top = pageRect.GetTop();
fr.rcPage.left = pageRect.GetLeft();
fr.rcPage.right = pageRect.GetRight();
fr.rcPage.bottom = pageRect.GetBottom();
fr.chrg.cpMin = startPos;
fr.chrg.cpMax = endPos;
return SendMsg(SCI_FORMATRANGE, doDraw, (sptr_t)&fr);
}
// Retrieve the display line at the top of the display.
int wxStyledTextCtrl::GetFirstVisibleLine() const
{
return SendMsg(SCI_GETFIRSTVISIBLELINE, 0, 0);
}
// Retrieve the contents of a line.
wxString wxStyledTextCtrl::GetLine(int line) const {
int len = LineLength(line);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(SCI_GETLINE, line, (sptr_t)buf.data());
return stc2wx(buf);
}
// Returns the number of lines in the document. There is always at least one.
int wxStyledTextCtrl::GetLineCount() const
{
return SendMsg(SCI_GETLINECOUNT, 0, 0);
}
// Sets the size in pixels of the left margin.
void wxStyledTextCtrl::SetMarginLeft(int pixelWidth)
{
SendMsg(SCI_SETMARGINLEFT, 0, pixelWidth);
}
// Returns the size in pixels of the left margin.
int wxStyledTextCtrl::GetMarginLeft() const
{
return SendMsg(SCI_GETMARGINLEFT, 0, 0);
}
// Sets the size in pixels of the right margin.
void wxStyledTextCtrl::SetMarginRight(int pixelWidth)
{
SendMsg(SCI_SETMARGINRIGHT, 0, pixelWidth);
}
// Returns the size in pixels of the right margin.
int wxStyledTextCtrl::GetMarginRight() const
{
return SendMsg(SCI_GETMARGINRIGHT, 0, 0);
}
// Is the document different from when it was last saved?
bool wxStyledTextCtrl::GetModify() const
{
return SendMsg(SCI_GETMODIFY, 0, 0) != 0;
}
// Retrieve the selected text.
wxString wxStyledTextCtrl::GetSelectedText() {
const int msg = SCI_GETSELTEXT;
long len = SendMsg(msg, 0, (sptr_t)0);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, 0, (sptr_t)buf.data());
return stc2wx(buf);
}
// Retrieve a range of text.
wxString wxStyledTextCtrl::GetTextRange(int startPos, int endPos) {
if (endPos < startPos) {
wxSwap(startPos, endPos);
}
int len = endPos - startPos;
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
Sci_TextRange tr;
tr.lpstrText = buf.data();
tr.chrg.cpMin = startPos;
tr.chrg.cpMax = endPos;
tr.lpstrText[0] = '\0'; // initialize with 0 in case the range is invalid
SendMsg(SCI_GETTEXTRANGE, 0, (sptr_t)&tr);
return stc2wx(buf);
}
// Draw the selection in normal style or with selection highlighted.
void wxStyledTextCtrl::HideSelection(bool hide)
{
SendMsg(SCI_HIDESELECTION, hide, 0);
}
// Retrieve the point in the window where a position is displayed.
wxPoint wxStyledTextCtrl::PointFromPosition(int pos) {
int x = SendMsg(SCI_POINTXFROMPOSITION, 0, pos);
int y = SendMsg(SCI_POINTYFROMPOSITION, 0, pos);
return wxPoint(x, y);
}
// Retrieve the line containing a position.
int wxStyledTextCtrl::LineFromPosition(int pos) const
{
return SendMsg(SCI_LINEFROMPOSITION, pos, 0);
}
// Retrieve the position at the start of a line.
int wxStyledTextCtrl::PositionFromLine(int line) const
{
return SendMsg(SCI_POSITIONFROMLINE, line, 0);
}
// Scroll horizontally and vertically.
void wxStyledTextCtrl::LineScroll(int columns, int lines)
{
SendMsg(SCI_LINESCROLL, columns, lines);
}
// Ensure the caret is visible.
void wxStyledTextCtrl::EnsureCaretVisible()
{
SendMsg(SCI_SCROLLCARET, 0, 0);
}
// Scroll the argument positions and the range between them into view giving
// priority to the primary position then the secondary position.
// This may be used to make a search match visible.
void wxStyledTextCtrl::ScrollRange(int secondary, int primary)
{
SendMsg(SCI_SCROLLRANGE, secondary, primary);
}
// Replace the selected text with the argument text.
void wxStyledTextCtrl::ReplaceSelection(const wxString& text)
{
SendMsg(SCI_REPLACESEL, 0, (sptr_t)(const char*)wx2stc(text));
}
// Set to read only or read write.
void wxStyledTextCtrl::SetReadOnly(bool readOnly)
{
SendMsg(SCI_SETREADONLY, readOnly, 0);
}
// Will a paste succeed?
bool wxStyledTextCtrl::CanPaste() const
{
return SendMsg(SCI_CANPASTE, 0, 0) != 0;
}
// Are there any undoable actions in the undo history?
bool wxStyledTextCtrl::CanUndo() const
{
return SendMsg(SCI_CANUNDO, 0, 0) != 0;
}
// Delete the undo history.
void wxStyledTextCtrl::EmptyUndoBuffer()
{
SendMsg(SCI_EMPTYUNDOBUFFER, 0, 0);
}
// Undo one action in the undo history.
void wxStyledTextCtrl::Undo()
{
SendMsg(SCI_UNDO, 0, 0);
}
// Cut the selection to the clipboard.
void wxStyledTextCtrl::Cut()
{
SendMsg(SCI_CUT, 0, 0);
}
// Copy the selection to the clipboard.
void wxStyledTextCtrl::Copy()
{
SendMsg(SCI_COPY, 0, 0);
}
// Paste the contents of the clipboard into the document replacing the selection.
void wxStyledTextCtrl::Paste()
{
SendMsg(SCI_PASTE, 0, 0);
}
// Clear the selection.
void wxStyledTextCtrl::Clear()
{
SendMsg(SCI_CLEAR, 0, 0);
}
// Replace the contents of the document with the argument text.
void wxStyledTextCtrl::SetText(const wxString& text)
{
SendMsg(SCI_SETTEXT, 0, (sptr_t)(const char*)wx2stc(text));
}
// Retrieve all the text in the document.
wxString wxStyledTextCtrl::GetText() const {
int len = GetTextLength();
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(SCI_GETTEXT, len+1, (sptr_t)buf.data());
return stc2wx(buf);
}
// Retrieve the number of characters in the document.
int wxStyledTextCtrl::GetTextLength() const
{
return SendMsg(SCI_GETTEXTLENGTH, 0, 0);
}
// Retrieve a pointer to a function that processes messages for this Scintilla.
void* wxStyledTextCtrl::GetDirectFunction() const {
return (void*)SendMsg(SCI_GETDIRECTFUNCTION);
}
// Retrieve a pointer value to use as the first argument when calling
// the function returned by GetDirectFunction.
void* wxStyledTextCtrl::GetDirectPointer() const {
return (void*)SendMsg(SCI_GETDIRECTPOINTER);
}
// Set to overtype (true) or insert mode.
void wxStyledTextCtrl::SetOvertype(bool overType)
{
SendMsg(SCI_SETOVERTYPE, overType, 0);
}
// Returns true if overtype mode is active otherwise false is returned.
bool wxStyledTextCtrl::GetOvertype() const
{
return SendMsg(SCI_GETOVERTYPE, 0, 0) != 0;
}
// Set the width of the insert mode caret.
void wxStyledTextCtrl::SetCaretWidth(int pixelWidth)
{
SendMsg(SCI_SETCARETWIDTH, pixelWidth, 0);
}
// Returns the width of the insert mode caret.
int wxStyledTextCtrl::GetCaretWidth() const
{
return SendMsg(SCI_GETCARETWIDTH, 0, 0);
}
// Sets the position that starts the target which is used for updating the
// document without affecting the scroll position.
void wxStyledTextCtrl::SetTargetStart(int start)
{
SendMsg(SCI_SETTARGETSTART, start, 0);
}
// Get the position that starts the target.
int wxStyledTextCtrl::GetTargetStart() const
{
return SendMsg(SCI_GETTARGETSTART, 0, 0);
}
// Sets the position that ends the target which is used for updating the
// document without affecting the scroll position.
void wxStyledTextCtrl::SetTargetEnd(int end)
{
SendMsg(SCI_SETTARGETEND, end, 0);
}
// Get the position that ends the target.
int wxStyledTextCtrl::GetTargetEnd() const
{
return SendMsg(SCI_GETTARGETEND, 0, 0);
}
// Sets both the start and end of the target in one call.
void wxStyledTextCtrl::SetTargetRange(int start, int end)
{
SendMsg(SCI_SETTARGETRANGE, start, end);
}
// Retrieve the text in the target.
wxString wxStyledTextCtrl::GetTargetText() const {
int len = GetTargetEnd() - GetTargetStart();
wxCharBuffer buf(len);
SendMsg(SCI_GETTARGETTEXT, 0, (sptr_t)buf.data());
return stc2wx(buf);
}
// Make the target range start and end be the same as the selection range start and end.
void wxStyledTextCtrl::TargetFromSelection()
{
SendMsg(SCI_TARGETFROMSELECTION, 0, 0);
}
// Sets the target to the whole document.
void wxStyledTextCtrl::TargetWholeDocument()
{
SendMsg(SCI_TARGETWHOLEDOCUMENT, 0, 0);
}
// Replace the target text with the argument text.
// Text is counted so it can contain NULs.
// Returns the length of the replacement text.
int wxStyledTextCtrl::ReplaceTarget(const wxString& text) {
const wxWX2MBbuf buf = wx2stc(text);
return SendMsg(SCI_REPLACETARGET, wx2stclen(text, buf), (sptr_t)(const char*)buf);
}
// Replace the target text with the argument text after \\d processing.
// Text is counted so it can contain NULs.
// Looks for \\d where d is between 1 and 9 and replaces these with the strings
// matched in the last search operation which were surrounded by \\( and \\).
// Returns the length of the replacement text including any change
// caused by processing the \\d patterns.
int wxStyledTextCtrl::ReplaceTargetRE(const wxString& text) {
const wxWX2MBbuf buf = wx2stc(text);
return SendMsg(SCI_REPLACETARGETRE, wx2stclen(text, buf), (sptr_t)(const char*)buf);
}
// Search for a counted string in the target and set the target to the found
// range. Text is counted so it can contain NULs.
// Returns length of range or -1 for failure in which case target is not moved.
int wxStyledTextCtrl::SearchInTarget(const wxString& text) {
const wxWX2MBbuf buf = wx2stc(text);
return SendMsg(SCI_SEARCHINTARGET, wx2stclen(text, buf), (sptr_t)(const char*)buf);
}
// Set the search flags used by SearchInTarget.
void wxStyledTextCtrl::SetSearchFlags(int searchFlags)
{
SendMsg(SCI_SETSEARCHFLAGS, searchFlags, 0);
}
// Get the search flags used by SearchInTarget.
int wxStyledTextCtrl::GetSearchFlags() const
{
return SendMsg(SCI_GETSEARCHFLAGS, 0, 0);
}
// Show a call tip containing a definition near position pos.
void wxStyledTextCtrl::CallTipShow(int pos, const wxString& definition)
{
SendMsg(SCI_CALLTIPSHOW, pos, (sptr_t)(const char*)wx2stc(definition));
}
// Remove the call tip from the screen.
void wxStyledTextCtrl::CallTipCancel()
{
SendMsg(SCI_CALLTIPCANCEL, 0, 0);
}
// Is there an active call tip?
bool wxStyledTextCtrl::CallTipActive()
{
return SendMsg(SCI_CALLTIPACTIVE, 0, 0) != 0;
}
// Retrieve the position where the caret was before displaying the call tip.
int wxStyledTextCtrl::CallTipPosAtStart()
{
return SendMsg(SCI_CALLTIPPOSSTART, 0, 0);
}
// Set the start position in order to change when backspacing removes the calltip.
void wxStyledTextCtrl::CallTipSetPosAtStart(int posStart)
{
SendMsg(SCI_CALLTIPSETPOSSTART, posStart, 0);
}
// Highlight a segment of the definition.
void wxStyledTextCtrl::CallTipSetHighlight(int highlightStart, int highlightEnd)
{
SendMsg(SCI_CALLTIPSETHLT, highlightStart, highlightEnd);
}
// Set the background colour for the call tip.
void wxStyledTextCtrl::CallTipSetBackground(const wxColour& back)
{
SendMsg(SCI_CALLTIPSETBACK, wxColourAsLong(back), 0);
}
// Set the foreground colour for the call tip.
void wxStyledTextCtrl::CallTipSetForeground(const wxColour& fore)
{
SendMsg(SCI_CALLTIPSETFORE, wxColourAsLong(fore), 0);
}
// Set the foreground colour for the highlighted part of the call tip.
void wxStyledTextCtrl::CallTipSetForegroundHighlight(const wxColour& fore)
{
SendMsg(SCI_CALLTIPSETFOREHLT, wxColourAsLong(fore), 0);
}
// Enable use of wxSTC_STYLE_CALLTIP and set call tip tab size in pixels.
void wxStyledTextCtrl::CallTipUseStyle(int tabSize)
{
SendMsg(SCI_CALLTIPUSESTYLE, tabSize, 0);
}
// Set position of calltip, above or below text.
void wxStyledTextCtrl::CallTipSetPosition(bool above)
{
SendMsg(SCI_CALLTIPSETPOSITION, above, 0);
}
// Find the display line of a document line taking hidden lines into account.
int wxStyledTextCtrl::VisibleFromDocLine(int docLine)
{
return SendMsg(SCI_VISIBLEFROMDOCLINE, docLine, 0);
}
// Find the document line of a display line taking hidden lines into account.
int wxStyledTextCtrl::DocLineFromVisible(int displayLine)
{
return SendMsg(SCI_DOCLINEFROMVISIBLE, displayLine, 0);
}
// The number of display lines needed to wrap a document line
int wxStyledTextCtrl::WrapCount(int docLine)
{
return SendMsg(SCI_WRAPCOUNT, docLine, 0);
}
// Set the fold level of a line.
// This encodes an integer level along with flags indicating whether the
// line is a header and whether it is effectively white space.
void wxStyledTextCtrl::SetFoldLevel(int line, int level)
{
SendMsg(SCI_SETFOLDLEVEL, line, level);
}
// Retrieve the fold level of a line.
int wxStyledTextCtrl::GetFoldLevel(int line) const
{
return SendMsg(SCI_GETFOLDLEVEL, line, 0);
}
// Find the last child line of a header line.
int wxStyledTextCtrl::GetLastChild(int line, int level) const
{
return SendMsg(SCI_GETLASTCHILD, line, level);
}
// Find the parent line of a child line.
int wxStyledTextCtrl::GetFoldParent(int line) const
{
return SendMsg(SCI_GETFOLDPARENT, line, 0);
}
// Make a range of lines visible.
void wxStyledTextCtrl::ShowLines(int lineStart, int lineEnd)
{
SendMsg(SCI_SHOWLINES, lineStart, lineEnd);
}
// Make a range of lines invisible.
void wxStyledTextCtrl::HideLines(int lineStart, int lineEnd)
{
SendMsg(SCI_HIDELINES, lineStart, lineEnd);
}
// Is a line visible?
bool wxStyledTextCtrl::GetLineVisible(int line) const
{
return SendMsg(SCI_GETLINEVISIBLE, line, 0) != 0;
}
// Are all lines visible?
bool wxStyledTextCtrl::GetAllLinesVisible() const
{
return SendMsg(SCI_GETALLLINESVISIBLE, 0, 0) != 0;
}
// Show the children of a header line.
void wxStyledTextCtrl::SetFoldExpanded(int line, bool expanded)
{
SendMsg(SCI_SETFOLDEXPANDED, line, expanded);
}
// Is a header line expanded?
bool wxStyledTextCtrl::GetFoldExpanded(int line) const
{
return SendMsg(SCI_GETFOLDEXPANDED, line, 0) != 0;
}
// Switch a header line between expanded and contracted.
void wxStyledTextCtrl::ToggleFold(int line)
{
SendMsg(SCI_TOGGLEFOLD, line, 0);
}
// Switch a header line between expanded and contracted and show some text after the line.
void wxStyledTextCtrl::ToggleFoldShowText(int line, const wxString& text)
{
SendMsg(SCI_TOGGLEFOLDSHOWTEXT, line, (sptr_t)(const char*)wx2stc(text));
}
// Set the style of fold display text
void wxStyledTextCtrl::FoldDisplayTextSetStyle(int style)
{
SendMsg(SCI_FOLDDISPLAYTEXTSETSTYLE, style, 0);
}
// Expand or contract a fold header.
void wxStyledTextCtrl::FoldLine(int line, int action)
{
SendMsg(SCI_FOLDLINE, line, action);
}
// Expand or contract a fold header and its children.
void wxStyledTextCtrl::FoldChildren(int line, int action)
{
SendMsg(SCI_FOLDCHILDREN, line, action);
}
// Expand a fold header and all children. Use the level argument instead of the line's current level.
void wxStyledTextCtrl::ExpandChildren(int line, int level)
{
SendMsg(SCI_EXPANDCHILDREN, line, level);
}
// Expand or contract all fold headers.
void wxStyledTextCtrl::FoldAll(int action)
{
SendMsg(SCI_FOLDALL, action, 0);
}
// Ensure a particular line is visible by expanding any header line hiding it.
void wxStyledTextCtrl::EnsureVisible(int line)
{
SendMsg(SCI_ENSUREVISIBLE, line, 0);
}
// Set automatic folding behaviours.
void wxStyledTextCtrl::SetAutomaticFold(int automaticFold)
{
SendMsg(SCI_SETAUTOMATICFOLD, automaticFold, 0);
}
// Get automatic folding behaviours.
int wxStyledTextCtrl::GetAutomaticFold() const
{
return SendMsg(SCI_GETAUTOMATICFOLD, 0, 0);
}
// Set some style options for folding.
void wxStyledTextCtrl::SetFoldFlags(int flags)
{
SendMsg(SCI_SETFOLDFLAGS, flags, 0);
}
// Ensure a particular line is visible by expanding any header line hiding it.
// Use the currently set visibility policy to determine which range to display.
void wxStyledTextCtrl::EnsureVisibleEnforcePolicy(int line)
{
SendMsg(SCI_ENSUREVISIBLEENFORCEPOLICY, line, 0);
}
// Sets whether a tab pressed when caret is within indentation indents.
void wxStyledTextCtrl::SetTabIndents(bool tabIndents)
{
SendMsg(SCI_SETTABINDENTS, tabIndents, 0);
}
// Does a tab pressed when caret is within indentation indent?
bool wxStyledTextCtrl::GetTabIndents() const
{
return SendMsg(SCI_GETTABINDENTS, 0, 0) != 0;
}
// Sets whether a backspace pressed when caret is within indentation unindents.
void wxStyledTextCtrl::SetBackSpaceUnIndents(bool bsUnIndents)
{
SendMsg(SCI_SETBACKSPACEUNINDENTS, bsUnIndents, 0);
}
// Does a backspace pressed when caret is within indentation unindent?
bool wxStyledTextCtrl::GetBackSpaceUnIndents() const
{
return SendMsg(SCI_GETBACKSPACEUNINDENTS, 0, 0) != 0;
}
// Sets the time the mouse must sit still to generate a mouse dwell event.
void wxStyledTextCtrl::SetMouseDwellTime(int periodMilliseconds)
{
SendMsg(SCI_SETMOUSEDWELLTIME, periodMilliseconds, 0);
}
// Retrieve the time the mouse must sit still to generate a mouse dwell event.
int wxStyledTextCtrl::GetMouseDwellTime() const
{
return SendMsg(SCI_GETMOUSEDWELLTIME, 0, 0);
}
// Get position of start of word.
int wxStyledTextCtrl::WordStartPosition(int pos, bool onlyWordCharacters)
{
return SendMsg(SCI_WORDSTARTPOSITION, pos, onlyWordCharacters);
}
// Get position of end of word.
int wxStyledTextCtrl::WordEndPosition(int pos, bool onlyWordCharacters)
{
return SendMsg(SCI_WORDENDPOSITION, pos, onlyWordCharacters);
}
// Is the range start..end considered a word?
bool wxStyledTextCtrl::IsRangeWord(int start, int end)
{
return SendMsg(SCI_ISRANGEWORD, start, end) != 0;
}
// Sets limits to idle styling.
void wxStyledTextCtrl::SetIdleStyling(int idleStyling)
{
SendMsg(SCI_SETIDLESTYLING, idleStyling, 0);
}
// Retrieve the limits to idle styling.
int wxStyledTextCtrl::GetIdleStyling() const
{
return SendMsg(SCI_GETIDLESTYLING, 0, 0);
}
// Sets whether text is word wrapped.
void wxStyledTextCtrl::SetWrapMode(int wrapMode)
{
SendMsg(SCI_SETWRAPMODE, wrapMode, 0);
}
// Retrieve whether text is word wrapped.
int wxStyledTextCtrl::GetWrapMode() const
{
return SendMsg(SCI_GETWRAPMODE, 0, 0);
}
// Set the display mode of visual flags for wrapped lines.
void wxStyledTextCtrl::SetWrapVisualFlags(int wrapVisualFlags)
{
SendMsg(SCI_SETWRAPVISUALFLAGS, wrapVisualFlags, 0);
}
// Retrive the display mode of visual flags for wrapped lines.
int wxStyledTextCtrl::GetWrapVisualFlags() const
{
return SendMsg(SCI_GETWRAPVISUALFLAGS, 0, 0);
}
// Set the location of visual flags for wrapped lines.
void wxStyledTextCtrl::SetWrapVisualFlagsLocation(int wrapVisualFlagsLocation)
{
SendMsg(SCI_SETWRAPVISUALFLAGSLOCATION, wrapVisualFlagsLocation, 0);
}
// Retrive the location of visual flags for wrapped lines.
int wxStyledTextCtrl::GetWrapVisualFlagsLocation() const
{
return SendMsg(SCI_GETWRAPVISUALFLAGSLOCATION, 0, 0);
}
// Set the start indent for wrapped lines.
void wxStyledTextCtrl::SetWrapStartIndent(int indent)
{
SendMsg(SCI_SETWRAPSTARTINDENT, indent, 0);
}
// Retrive the start indent for wrapped lines.
int wxStyledTextCtrl::GetWrapStartIndent() const
{
return SendMsg(SCI_GETWRAPSTARTINDENT, 0, 0);
}
// Sets how wrapped sublines are placed. Default is wxSTC_WRAPINDENT_FIXED.
void wxStyledTextCtrl::SetWrapIndentMode(int wrapIndentMode)
{
SendMsg(SCI_SETWRAPINDENTMODE, wrapIndentMode, 0);
}
// Retrieve how wrapped sublines are placed. Default is wxSTC_WRAPINDENT_FIXED.
int wxStyledTextCtrl::GetWrapIndentMode() const
{
return SendMsg(SCI_GETWRAPINDENTMODE, 0, 0);
}
// Sets the degree of caching of layout information.
void wxStyledTextCtrl::SetLayoutCache(int cacheMode)
{
SendMsg(SCI_SETLAYOUTCACHE, cacheMode, 0);
}
// Retrieve the degree of caching of layout information.
int wxStyledTextCtrl::GetLayoutCache() const
{
return SendMsg(SCI_GETLAYOUTCACHE, 0, 0);
}
// Sets the document width assumed for scrolling.
void wxStyledTextCtrl::SetScrollWidth(int pixelWidth)
{
SendMsg(SCI_SETSCROLLWIDTH, pixelWidth, 0);
}
// Retrieve the document width assumed for scrolling.
int wxStyledTextCtrl::GetScrollWidth() const
{
return SendMsg(SCI_GETSCROLLWIDTH, 0, 0);
}
// Sets whether the maximum width line displayed is used to set scroll width.
void wxStyledTextCtrl::SetScrollWidthTracking(bool tracking)
{
SendMsg(SCI_SETSCROLLWIDTHTRACKING, tracking, 0);
}
// Retrieve whether the scroll width tracks wide lines.
bool wxStyledTextCtrl::GetScrollWidthTracking() const
{
return SendMsg(SCI_GETSCROLLWIDTHTRACKING, 0, 0) != 0;
}
// Measure the pixel width of some text in a particular style.
// Does not handle tab or control characters.
int wxStyledTextCtrl::TextWidth(int style, const wxString& text)
{
return SendMsg(SCI_TEXTWIDTH, style, (sptr_t)(const char*)wx2stc(text));
}
// Sets the scroll range so that maximum scroll position has
// the last line at the bottom of the view (default).
// Setting this to false allows scrolling one page below the last line.
void wxStyledTextCtrl::SetEndAtLastLine(bool endAtLastLine)
{
SendMsg(SCI_SETENDATLASTLINE, endAtLastLine, 0);
}
// Retrieve whether the maximum scroll position has the last
// line at the bottom of the view.
bool wxStyledTextCtrl::GetEndAtLastLine() const
{
return SendMsg(SCI_GETENDATLASTLINE, 0, 0) != 0;
}
// Retrieve the height of a particular line of text in pixels.
int wxStyledTextCtrl::TextHeight(int line)
{
return SendMsg(SCI_TEXTHEIGHT, line, 0);
}
// Show or hide the vertical scroll bar.
void wxStyledTextCtrl::SetUseVerticalScrollBar(bool visible)
{
SendMsg(SCI_SETVSCROLLBAR, visible, 0);
}
// Is the vertical scroll bar visible?
bool wxStyledTextCtrl::GetUseVerticalScrollBar() const
{
return SendMsg(SCI_GETVSCROLLBAR, 0, 0) != 0;
}
// Append a string to the end of the document without changing the selection.
void wxStyledTextCtrl::AppendText(const wxString& text) {
const wxWX2MBbuf buf = wx2stc(text);
SendMsg(SCI_APPENDTEXT, wx2stclen(text, buf), (sptr_t)(const char*)buf);
}
// Is drawing done in two phases with backgrounds drawn before foregrounds?
bool wxStyledTextCtrl::GetTwoPhaseDraw() const
{
return SendMsg(SCI_GETTWOPHASEDRAW, 0, 0) != 0;
}
// In twoPhaseDraw mode, drawing is performed in two phases, first the background
// and then the foreground. This avoids chopping off characters that overlap the next run.
void wxStyledTextCtrl::SetTwoPhaseDraw(bool twoPhase)
{
SendMsg(SCI_SETTWOPHASEDRAW, twoPhase, 0);
}
// How many phases is drawing done in?
int wxStyledTextCtrl::GetPhasesDraw() const
{
return SendMsg(SCI_GETPHASESDRAW, 0, 0);
}
// In one phase draw, text is drawn in a series of rectangular blocks with no overlap.
// In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally.
// In multiple phase draw, each element is drawn over the whole drawing area, allowing text
// to overlap from one line to the next.
void wxStyledTextCtrl::SetPhasesDraw(int phases)
{
SendMsg(SCI_SETPHASESDRAW, phases, 0);
}
// Scroll so that a display line is at the top of the display.
void wxStyledTextCtrl::SetFirstVisibleLine(int displayLine)
{
SendMsg(SCI_SETFIRSTVISIBLELINE, displayLine, 0);
}
// Change the effect of pasting when there are multiple selections.
void wxStyledTextCtrl::SetMultiPaste(int multiPaste)
{
SendMsg(SCI_SETMULTIPASTE, multiPaste, 0);
}
// Retrieve the effect of pasting when there are multiple selections.
int wxStyledTextCtrl::GetMultiPaste() const
{
return SendMsg(SCI_GETMULTIPASTE, 0, 0);
}
// Retrieve the value of a tag from a regular expression search.
wxString wxStyledTextCtrl::GetTag(int tagNumber) const {
const int msg = SCI_GETTAG;
long len = SendMsg(msg, tagNumber, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, tagNumber, (sptr_t)buf.data());
return stc2wx(buf);
}
// Join the lines in the target.
void wxStyledTextCtrl::LinesJoin()
{
SendMsg(SCI_LINESJOIN, 0, 0);
}
// Split the lines in the target into lines that are less wide than pixelWidth
// where possible.
void wxStyledTextCtrl::LinesSplit(int pixelWidth)
{
SendMsg(SCI_LINESSPLIT, pixelWidth, 0);
}
// Set one of the colours used as a chequerboard pattern in the fold margin
void wxStyledTextCtrl::SetFoldMarginColour(bool useSetting, const wxColour& back)
{
SendMsg(SCI_SETFOLDMARGINCOLOUR, useSetting, wxColourAsLong(back));
}
// Set the other colour used as a chequerboard pattern in the fold margin
void wxStyledTextCtrl::SetFoldMarginHiColour(bool useSetting, const wxColour& fore)
{
SendMsg(SCI_SETFOLDMARGINHICOLOUR, useSetting, wxColourAsLong(fore));
}
// Move caret down one line.
void wxStyledTextCtrl::LineDown()
{
SendMsg(SCI_LINEDOWN, 0, 0);
}
// Move caret down one line extending selection to new caret position.
void wxStyledTextCtrl::LineDownExtend()
{
SendMsg(SCI_LINEDOWNEXTEND, 0, 0);
}
// Move caret up one line.
void wxStyledTextCtrl::LineUp()
{
SendMsg(SCI_LINEUP, 0, 0);
}
// Move caret up one line extending selection to new caret position.
void wxStyledTextCtrl::LineUpExtend()
{
SendMsg(SCI_LINEUPEXTEND, 0, 0);
}
// Move caret left one character.
void wxStyledTextCtrl::CharLeft()
{
SendMsg(SCI_CHARLEFT, 0, 0);
}
// Move caret left one character extending selection to new caret position.
void wxStyledTextCtrl::CharLeftExtend()
{
SendMsg(SCI_CHARLEFTEXTEND, 0, 0);
}
// Move caret right one character.
void wxStyledTextCtrl::CharRight()
{
SendMsg(SCI_CHARRIGHT, 0, 0);
}
// Move caret right one character extending selection to new caret position.
void wxStyledTextCtrl::CharRightExtend()
{
SendMsg(SCI_CHARRIGHTEXTEND, 0, 0);
}
// Move caret left one word.
void wxStyledTextCtrl::WordLeft()
{
SendMsg(SCI_WORDLEFT, 0, 0);
}
// Move caret left one word extending selection to new caret position.
void wxStyledTextCtrl::WordLeftExtend()
{
SendMsg(SCI_WORDLEFTEXTEND, 0, 0);
}
// Move caret right one word.
void wxStyledTextCtrl::WordRight()
{
SendMsg(SCI_WORDRIGHT, 0, 0);
}
// Move caret right one word extending selection to new caret position.
void wxStyledTextCtrl::WordRightExtend()
{
SendMsg(SCI_WORDRIGHTEXTEND, 0, 0);
}
// Move caret to first position on line.
void wxStyledTextCtrl::Home()
{
SendMsg(SCI_HOME, 0, 0);
}
// Move caret to first position on line extending selection to new caret position.
void wxStyledTextCtrl::HomeExtend()
{
SendMsg(SCI_HOMEEXTEND, 0, 0);
}
// Move caret to last position on line.
void wxStyledTextCtrl::LineEnd()
{
SendMsg(SCI_LINEEND, 0, 0);
}
// Move caret to last position on line extending selection to new caret position.
void wxStyledTextCtrl::LineEndExtend()
{
SendMsg(SCI_LINEENDEXTEND, 0, 0);
}
// Move caret to first position in document.
void wxStyledTextCtrl::DocumentStart()
{
SendMsg(SCI_DOCUMENTSTART, 0, 0);
}
// Move caret to first position in document extending selection to new caret position.
void wxStyledTextCtrl::DocumentStartExtend()
{
SendMsg(SCI_DOCUMENTSTARTEXTEND, 0, 0);
}
// Move caret to last position in document.
void wxStyledTextCtrl::DocumentEnd()
{
SendMsg(SCI_DOCUMENTEND, 0, 0);
}
// Move caret to last position in document extending selection to new caret position.
void wxStyledTextCtrl::DocumentEndExtend()
{
SendMsg(SCI_DOCUMENTENDEXTEND, 0, 0);
}
// Move caret one page up.
void wxStyledTextCtrl::PageUp()
{
SendMsg(SCI_PAGEUP, 0, 0);
}
// Move caret one page up extending selection to new caret position.
void wxStyledTextCtrl::PageUpExtend()
{
SendMsg(SCI_PAGEUPEXTEND, 0, 0);
}
// Move caret one page down.
void wxStyledTextCtrl::PageDown()
{
SendMsg(SCI_PAGEDOWN, 0, 0);
}
// Move caret one page down extending selection to new caret position.
void wxStyledTextCtrl::PageDownExtend()
{
SendMsg(SCI_PAGEDOWNEXTEND, 0, 0);
}
// Switch from insert to overtype mode or the reverse.
void wxStyledTextCtrl::EditToggleOvertype()
{
SendMsg(SCI_EDITTOGGLEOVERTYPE, 0, 0);
}
// Cancel any modes such as call tip or auto-completion list display.
void wxStyledTextCtrl::Cancel()
{
SendMsg(SCI_CANCEL, 0, 0);
}
// Delete the selection or if no selection, the character before the caret.
void wxStyledTextCtrl::DeleteBack()
{
SendMsg(SCI_DELETEBACK, 0, 0);
}
// 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 wxStyledTextCtrl::Tab()
{
SendMsg(SCI_TAB, 0, 0);
}
// Dedent the selected lines.
void wxStyledTextCtrl::BackTab()
{
SendMsg(SCI_BACKTAB, 0, 0);
}
// Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
void wxStyledTextCtrl::NewLine()
{
SendMsg(SCI_NEWLINE, 0, 0);
}
// Insert a Form Feed character.
void wxStyledTextCtrl::FormFeed()
{
SendMsg(SCI_FORMFEED, 0, 0);
}
// Move caret to before first visible character on line.
// If already there move to first character on line.
void wxStyledTextCtrl::VCHome()
{
SendMsg(SCI_VCHOME, 0, 0);
}
// Like VCHome but extending selection to new caret position.
void wxStyledTextCtrl::VCHomeExtend()
{
SendMsg(SCI_VCHOMEEXTEND, 0, 0);
}
// Magnify the displayed text by increasing the sizes by 1 point.
void wxStyledTextCtrl::ZoomIn()
{
SendMsg(SCI_ZOOMIN, 0, 0);
}
// Make the displayed text smaller by decreasing the sizes by 1 point.
void wxStyledTextCtrl::ZoomOut()
{
SendMsg(SCI_ZOOMOUT, 0, 0);
}
// Delete the word to the left of the caret.
void wxStyledTextCtrl::DelWordLeft()
{
SendMsg(SCI_DELWORDLEFT, 0, 0);
}
// Delete the word to the right of the caret.
void wxStyledTextCtrl::DelWordRight()
{
SendMsg(SCI_DELWORDRIGHT, 0, 0);
}
// Delete the word to the right of the caret, but not the trailing non-word characters.
void wxStyledTextCtrl::DelWordRightEnd()
{
SendMsg(SCI_DELWORDRIGHTEND, 0, 0);
}
// Cut the line containing the caret.
void wxStyledTextCtrl::LineCut()
{
SendMsg(SCI_LINECUT, 0, 0);
}
// Delete the line containing the caret.
void wxStyledTextCtrl::LineDelete()
{
SendMsg(SCI_LINEDELETE, 0, 0);
}
// Switch the current line with the previous.
void wxStyledTextCtrl::LineTranspose()
{
SendMsg(SCI_LINETRANSPOSE, 0, 0);
}
// Duplicate the current line.
void wxStyledTextCtrl::LineDuplicate()
{
SendMsg(SCI_LINEDUPLICATE, 0, 0);
}
// Transform the selection to lower case.
void wxStyledTextCtrl::LowerCase()
{
SendMsg(SCI_LOWERCASE, 0, 0);
}
// Transform the selection to upper case.
void wxStyledTextCtrl::UpperCase()
{
SendMsg(SCI_UPPERCASE, 0, 0);
}
// Scroll the document down, keeping the caret visible.
void wxStyledTextCtrl::LineScrollDown()
{
SendMsg(SCI_LINESCROLLDOWN, 0, 0);
}
// Scroll the document up, keeping the caret visible.
void wxStyledTextCtrl::LineScrollUp()
{
SendMsg(SCI_LINESCROLLUP, 0, 0);
}
// 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 wxStyledTextCtrl::DeleteBackNotLine()
{
SendMsg(SCI_DELETEBACKNOTLINE, 0, 0);
}
// Move caret to first position on display line.
void wxStyledTextCtrl::HomeDisplay()
{
SendMsg(SCI_HOMEDISPLAY, 0, 0);
}
// Move caret to first position on display line extending selection to
// new caret position.
void wxStyledTextCtrl::HomeDisplayExtend()
{
SendMsg(SCI_HOMEDISPLAYEXTEND, 0, 0);
}
// Move caret to last position on display line.
void wxStyledTextCtrl::LineEndDisplay()
{
SendMsg(SCI_LINEENDDISPLAY, 0, 0);
}
// Move caret to last position on display line extending selection to new
// caret position.
void wxStyledTextCtrl::LineEndDisplayExtend()
{
SendMsg(SCI_LINEENDDISPLAYEXTEND, 0, 0);
}
// Like Home but when word-wrap is enabled goes first to start of display line
// HomeDisplay, then to start of document line Home.
void wxStyledTextCtrl::HomeWrap()
{
SendMsg(SCI_HOMEWRAP, 0, 0);
}
// Like HomeExtend but when word-wrap is enabled extends first to start of display line
// HomeDisplayExtend, then to start of document line HomeExtend.
void wxStyledTextCtrl::HomeWrapExtend()
{
SendMsg(SCI_HOMEWRAPEXTEND, 0, 0);
}
// Like LineEnd but when word-wrap is enabled goes first to end of display line
// LineEndDisplay, then to start of document line LineEnd.
void wxStyledTextCtrl::LineEndWrap()
{
SendMsg(SCI_LINEENDWRAP, 0, 0);
}
// Like LineEndExtend but when word-wrap is enabled extends first to end of display line
// LineEndDisplayExtend, then to start of document line LineEndExtend.
void wxStyledTextCtrl::LineEndWrapExtend()
{
SendMsg(SCI_LINEENDWRAPEXTEND, 0, 0);
}
// Like VCHome but when word-wrap is enabled goes first to start of display line
// VCHomeDisplay, then behaves like VCHome.
void wxStyledTextCtrl::VCHomeWrap()
{
SendMsg(SCI_VCHOMEWRAP, 0, 0);
}
// Like VCHomeExtend but when word-wrap is enabled extends first to start of display line
// VCHomeDisplayExtend, then behaves like VCHomeExtend.
void wxStyledTextCtrl::VCHomeWrapExtend()
{
SendMsg(SCI_VCHOMEWRAPEXTEND, 0, 0);
}
// Copy the line containing the caret.
void wxStyledTextCtrl::LineCopy()
{
SendMsg(SCI_LINECOPY, 0, 0);
}
// Move the caret inside current view if it's not there already.
void wxStyledTextCtrl::MoveCaretInsideView()
{
SendMsg(SCI_MOVECARETINSIDEVIEW, 0, 0);
}
// How many characters are on a line, including end of line characters?
int wxStyledTextCtrl::LineLength(int line) const
{
return SendMsg(SCI_LINELENGTH, line, 0);
}
// Highlight the characters at two positions.
void wxStyledTextCtrl::BraceHighlight(int posA, int posB)
{
SendMsg(SCI_BRACEHIGHLIGHT, posA, posB);
}
// Use specified indicator to highlight matching braces instead of changing their style.
void wxStyledTextCtrl::BraceHighlightIndicator(bool useSetting, int indicator)
{
SendMsg(SCI_BRACEHIGHLIGHTINDICATOR, useSetting, indicator);
}
// Highlight the character at a position indicating there is no matching brace.
void wxStyledTextCtrl::BraceBadLight(int pos)
{
SendMsg(SCI_BRACEBADLIGHT, pos, 0);
}
// Use specified indicator to highlight non matching brace instead of changing its style.
void wxStyledTextCtrl::BraceBadLightIndicator(bool useSetting, int indicator)
{
SendMsg(SCI_BRACEBADLIGHTINDICATOR, useSetting, indicator);
}
// Find the position of a matching brace or wxSTC_INVALID_POSITION if no match.
// The maxReStyle must be 0 for now. It may be defined in a future release.
int wxStyledTextCtrl::BraceMatch(int pos, int maxReStyle){
wxASSERT_MSG(maxReStyle==0,
"The second argument passed to BraceMatch should be 0");
return SendMsg(SCI_BRACEMATCH, pos, maxReStyle);
}
// Are the end of line characters visible?
bool wxStyledTextCtrl::GetViewEOL() const
{
return SendMsg(SCI_GETVIEWEOL, 0, 0) != 0;
}
// Make the end of line characters visible or invisible.
void wxStyledTextCtrl::SetViewEOL(bool visible)
{
SendMsg(SCI_SETVIEWEOL, visible, 0);
}
// Retrieve a pointer to the document object.
void* wxStyledTextCtrl::GetDocPointer() {
return (void*)SendMsg(SCI_GETDOCPOINTER);
}
// Change the document object used.
void wxStyledTextCtrl::SetDocPointer(void* docPointer) {
SendMsg(SCI_SETDOCPOINTER, 0, (sptr_t)docPointer);
}
// Set which document modification events are sent to the container.
void wxStyledTextCtrl::SetModEventMask(int eventMask)
{
SendMsg(SCI_SETMODEVENTMASK, eventMask, 0);
}
// Retrieve the column number which text should be kept within.
int wxStyledTextCtrl::GetEdgeColumn() const
{
return SendMsg(SCI_GETEDGECOLUMN, 0, 0);
}
// Set the column number of the edge.
// If text goes past the edge then it is highlighted.
void wxStyledTextCtrl::SetEdgeColumn(int column)
{
SendMsg(SCI_SETEDGECOLUMN, column, 0);
}
// Retrieve the edge highlight mode.
int wxStyledTextCtrl::GetEdgeMode() const
{
return SendMsg(SCI_GETEDGEMODE, 0, 0);
}
// The edge may be displayed by a line (wxSTC_EDGE_LINE/wxSTC_EDGE_MULTILINE) or by highlighting text that
// goes beyond it (wxSTC_EDGE_BACKGROUND) or not displayed at all (wxSTC_EDGE_NONE).
void wxStyledTextCtrl::SetEdgeMode(int edgeMode)
{
SendMsg(SCI_SETEDGEMODE, edgeMode, 0);
}
// Retrieve the colour used in edge indication.
wxColour wxStyledTextCtrl::GetEdgeColour() const
{
long c = SendMsg(SCI_GETEDGECOLOUR, 0, 0);
return wxColourFromLong(c);
}
// Change the colour used in edge indication.
void wxStyledTextCtrl::SetEdgeColour(const wxColour& edgeColour)
{
SendMsg(SCI_SETEDGECOLOUR, wxColourAsLong(edgeColour), 0);
}
// Add a new vertical edge to the view.
void wxStyledTextCtrl::MultiEdgeAddLine(int column, const wxColour& edgeColour)
{
SendMsg(SCI_MULTIEDGEADDLINE, column, wxColourAsLong(edgeColour));
}
// Clear all vertical edges.
void wxStyledTextCtrl::MultiEdgeClearAll()
{
SendMsg(SCI_MULTIEDGECLEARALL, 0, 0);
}
// Sets the current caret position to be the search anchor.
void wxStyledTextCtrl::SearchAnchor()
{
SendMsg(SCI_SEARCHANCHOR, 0, 0);
}
// Find some text starting at the search anchor.
// Does not ensure the selection is visible.
int wxStyledTextCtrl::SearchNext(int searchFlags, const wxString& text)
{
return SendMsg(SCI_SEARCHNEXT, searchFlags, (sptr_t)(const char*)wx2stc(text));
}
// Find some text starting at the search anchor and moving backwards.
// Does not ensure the selection is visible.
int wxStyledTextCtrl::SearchPrev(int searchFlags, const wxString& text)
{
return SendMsg(SCI_SEARCHPREV, searchFlags, (sptr_t)(const char*)wx2stc(text));
}
// Retrieves the number of lines completely visible.
int wxStyledTextCtrl::LinesOnScreen() const
{
return SendMsg(SCI_LINESONSCREEN, 0, 0);
}
// Set whether a pop up menu is displayed automatically when the user presses
// the wrong mouse button on certain areas.
void wxStyledTextCtrl::UsePopUp(int popUpMode)
{
SendMsg(SCI_USEPOPUP, popUpMode, 0);
}
// Is the selection rectangular? The alternative is the more common stream selection.
bool wxStyledTextCtrl::SelectionIsRectangle() const
{
return SendMsg(SCI_SELECTIONISRECTANGLE, 0, 0) != 0;
}
// Set the zoom level. This number of points is added to the size of all fonts.
// It may be positive to magnify or negative to reduce.
void wxStyledTextCtrl::SetZoom(int zoomInPoints)
{
SendMsg(SCI_SETZOOM, zoomInPoints, 0);
}
// Retrieve the zoom level.
int wxStyledTextCtrl::GetZoom() const
{
return SendMsg(SCI_GETZOOM, 0, 0);
}
// Create a new document object.
// Starts with reference count of 1 and not selected into editor.
void* wxStyledTextCtrl::CreateDocument() {
return (void*)SendMsg(SCI_CREATEDOCUMENT);
}
// Extend life of document.
void wxStyledTextCtrl::AddRefDocument(void* docPointer) {
SendMsg(SCI_ADDREFDOCUMENT, 0, (sptr_t)docPointer);
}
// Release a reference to the document, deleting document if it fades to black.
void wxStyledTextCtrl::ReleaseDocument(void* docPointer) {
SendMsg(SCI_RELEASEDOCUMENT, 0, (sptr_t)docPointer);
}
// Get which document modification events are sent to the container.
int wxStyledTextCtrl::GetModEventMask() const
{
return SendMsg(SCI_GETMODEVENTMASK, 0, 0);
}
// Change internal focus flag.
void wxStyledTextCtrl::SetSTCFocus(bool focus)
{
SendMsg(SCI_SETFOCUS, focus, 0);
}
// Get internal focus flag.
bool wxStyledTextCtrl::GetSTCFocus() const
{
return SendMsg(SCI_GETFOCUS, 0, 0) != 0;
}
// Change error status - 0 = OK.
void wxStyledTextCtrl::SetStatus(int status)
{
SendMsg(SCI_SETSTATUS, status, 0);
}
// Get error status.
int wxStyledTextCtrl::GetStatus() const
{
return SendMsg(SCI_GETSTATUS, 0, 0);
}
// Set whether the mouse is captured when its button is pressed.
void wxStyledTextCtrl::SetMouseDownCaptures(bool captures)
{
SendMsg(SCI_SETMOUSEDOWNCAPTURES, captures, 0);
}
// Get whether mouse gets captured.
bool wxStyledTextCtrl::GetMouseDownCaptures() const
{
return SendMsg(SCI_GETMOUSEDOWNCAPTURES, 0, 0) != 0;
}
// Set whether the mouse wheel can be active outside the window.
void wxStyledTextCtrl::SetMouseWheelCaptures(bool captures)
{
SendMsg(SCI_SETMOUSEWHEELCAPTURES, captures, 0);
}
// Get whether mouse wheel can be active outside the window.
bool wxStyledTextCtrl::GetMouseWheelCaptures() const
{
return SendMsg(SCI_GETMOUSEWHEELCAPTURES, 0, 0) != 0;
}
// Sets the cursor to one of the wxSTC_CURSOR* values.
void wxStyledTextCtrl::SetSTCCursor(int cursorType)
{
SendMsg(SCI_SETCURSOR, cursorType, 0);
}
// Get cursor type.
int wxStyledTextCtrl::GetSTCCursor() const
{
return SendMsg(SCI_GETCURSOR, 0, 0);
}
// Change the way control characters are displayed:
// If symbol is < 32, keep the drawn way, else, use the given character.
void wxStyledTextCtrl::SetControlCharSymbol(int symbol)
{
SendMsg(SCI_SETCONTROLCHARSYMBOL, symbol, 0);
}
// Get the way control characters are displayed.
int wxStyledTextCtrl::GetControlCharSymbol() const
{
return SendMsg(SCI_GETCONTROLCHARSYMBOL, 0, 0);
}
// Move to the previous change in capitalisation.
void wxStyledTextCtrl::WordPartLeft()
{
SendMsg(SCI_WORDPARTLEFT, 0, 0);
}
// Move to the previous change in capitalisation extending selection
// to new caret position.
void wxStyledTextCtrl::WordPartLeftExtend()
{
SendMsg(SCI_WORDPARTLEFTEXTEND, 0, 0);
}
// Move to the change next in capitalisation.
void wxStyledTextCtrl::WordPartRight()
{
SendMsg(SCI_WORDPARTRIGHT, 0, 0);
}
// Move to the next change in capitalisation extending selection
// to new caret position.
void wxStyledTextCtrl::WordPartRightExtend()
{
SendMsg(SCI_WORDPARTRIGHTEXTEND, 0, 0);
}
// Set the way the display area is determined when a particular line
// is to be moved to by Find, FindNext, GotoLine, etc.
void wxStyledTextCtrl::SetVisiblePolicy(int visiblePolicy, int visibleSlop)
{
SendMsg(SCI_SETVISIBLEPOLICY, visiblePolicy, visibleSlop);
}
// Delete back from the current position to the start of the line.
void wxStyledTextCtrl::DelLineLeft()
{
SendMsg(SCI_DELLINELEFT, 0, 0);
}
// Delete forwards from the current position to the end of the line.
void wxStyledTextCtrl::DelLineRight()
{
SendMsg(SCI_DELLINERIGHT, 0, 0);
}
// Set the xOffset (ie, horizontal scroll position).
void wxStyledTextCtrl::SetXOffset(int xOffset)
{
SendMsg(SCI_SETXOFFSET, xOffset, 0);
}
// Get the xOffset (ie, horizontal scroll position).
int wxStyledTextCtrl::GetXOffset() const
{
return SendMsg(SCI_GETXOFFSET, 0, 0);
}
// Set the last x chosen value to be the caret x position.
void wxStyledTextCtrl::ChooseCaretX()
{
SendMsg(SCI_CHOOSECARETX, 0, 0);
}
// Set the way the caret is kept visible when going sideways.
// The exclusion zone is given in pixels.
void wxStyledTextCtrl::SetXCaretPolicy(int caretPolicy, int caretSlop)
{
SendMsg(SCI_SETXCARETPOLICY, caretPolicy, caretSlop);
}
// Set the way the line the caret is on is kept visible.
// The exclusion zone is given in lines.
void wxStyledTextCtrl::SetYCaretPolicy(int caretPolicy, int caretSlop)
{
SendMsg(SCI_SETYCARETPOLICY, caretPolicy, caretSlop);
}
// Set printing to line wrapped (wxSTC_WRAP_WORD) or not line wrapped (wxSTC_WRAP_NONE).
void wxStyledTextCtrl::SetPrintWrapMode(int wrapMode)
{
SendMsg(SCI_SETPRINTWRAPMODE, wrapMode, 0);
}
// Is printing line wrapped?
int wxStyledTextCtrl::GetPrintWrapMode() const
{
return SendMsg(SCI_GETPRINTWRAPMODE, 0, 0);
}
// Set a fore colour for active hotspots.
void wxStyledTextCtrl::SetHotspotActiveForeground(bool useSetting, const wxColour& fore)
{
SendMsg(SCI_SETHOTSPOTACTIVEFORE, useSetting, wxColourAsLong(fore));
}
// Get the fore colour for active hotspots.
wxColour wxStyledTextCtrl::GetHotspotActiveForeground() const
{
long c = SendMsg(SCI_GETHOTSPOTACTIVEFORE, 0, 0);
return wxColourFromLong(c);
}
// Set a back colour for active hotspots.
void wxStyledTextCtrl::SetHotspotActiveBackground(bool useSetting, const wxColour& back)
{
SendMsg(SCI_SETHOTSPOTACTIVEBACK, useSetting, wxColourAsLong(back));
}
// Get the back colour for active hotspots.
wxColour wxStyledTextCtrl::GetHotspotActiveBackground() const
{
long c = SendMsg(SCI_GETHOTSPOTACTIVEBACK, 0, 0);
return wxColourFromLong(c);
}
// Enable / Disable underlining active hotspots.
void wxStyledTextCtrl::SetHotspotActiveUnderline(bool underline)
{
SendMsg(SCI_SETHOTSPOTACTIVEUNDERLINE, underline, 0);
}
// Get whether underlining for active hotspots.
bool wxStyledTextCtrl::GetHotspotActiveUnderline() const
{
return SendMsg(SCI_GETHOTSPOTACTIVEUNDERLINE, 0, 0) != 0;
}
// Limit hotspots to single line so hotspots on two lines don't merge.
void wxStyledTextCtrl::SetHotspotSingleLine(bool singleLine)
{
SendMsg(SCI_SETHOTSPOTSINGLELINE, singleLine, 0);
}
// Get the HotspotSingleLine property
bool wxStyledTextCtrl::GetHotspotSingleLine() const
{
return SendMsg(SCI_GETHOTSPOTSINGLELINE, 0, 0) != 0;
}
// Move caret down one paragraph (delimited by empty lines).
void wxStyledTextCtrl::ParaDown()
{
SendMsg(SCI_PARADOWN, 0, 0);
}
// Extend selection down one paragraph (delimited by empty lines).
void wxStyledTextCtrl::ParaDownExtend()
{
SendMsg(SCI_PARADOWNEXTEND, 0, 0);
}
// Move caret up one paragraph (delimited by empty lines).
void wxStyledTextCtrl::ParaUp()
{
SendMsg(SCI_PARAUP, 0, 0);
}
// Extend selection up one paragraph (delimited by empty lines).
void wxStyledTextCtrl::ParaUpExtend()
{
SendMsg(SCI_PARAUPEXTEND, 0, 0);
}
// Given a valid document position, return the previous position taking code
// page into account. Returns 0 if passed 0.
int wxStyledTextCtrl::PositionBefore(int pos)
{
return SendMsg(SCI_POSITIONBEFORE, pos, 0);
}
// Given a valid document position, return the next position taking code
// page into account. Maximum value returned is the last position in the document.
int wxStyledTextCtrl::PositionAfter(int pos)
{
return SendMsg(SCI_POSITIONAFTER, pos, 0);
}
// Given a valid document position, return a position that differs in a number
// of characters. Returned value is always between 0 and last position in document.
int wxStyledTextCtrl::PositionRelative(int pos, int relative)
{
return SendMsg(SCI_POSITIONRELATIVE, pos, relative);
}
// Copy a range of text to the clipboard. Positions are clipped into the document.
void wxStyledTextCtrl::CopyRange(int start, int end)
{
SendMsg(SCI_COPYRANGE, start, end);
}
// Copy argument text to the clipboard.
void wxStyledTextCtrl::CopyText(int length, const wxString& text)
{
SendMsg(SCI_COPYTEXT, length, (sptr_t)(const char*)wx2stc(text));
}
// Set the selection mode to stream (wxSTC_SEL_STREAM) or rectangular (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN) or
// by lines (wxSTC_SEL_LINES).
void wxStyledTextCtrl::SetSelectionMode(int selectionMode)
{
SendMsg(SCI_SETSELECTIONMODE, selectionMode, 0);
}
// Get the mode of the current selection.
int wxStyledTextCtrl::GetSelectionMode() const
{
return SendMsg(SCI_GETSELECTIONMODE, 0, 0);
}
// Retrieve the position of the start of the selection at the given line (wxSTC_INVALID_POSITION if no selection on this line).
int wxStyledTextCtrl::GetLineSelStartPosition(int line)
{
return SendMsg(SCI_GETLINESELSTARTPOSITION, line, 0);
}
// Retrieve the position of the end of the selection at the given line (wxSTC_INVALID_POSITION if no selection on this line).
int wxStyledTextCtrl::GetLineSelEndPosition(int line)
{
return SendMsg(SCI_GETLINESELENDPOSITION, line, 0);
}
// Move caret down one line, extending rectangular selection to new caret position.
void wxStyledTextCtrl::LineDownRectExtend()
{
SendMsg(SCI_LINEDOWNRECTEXTEND, 0, 0);
}
// Move caret up one line, extending rectangular selection to new caret position.
void wxStyledTextCtrl::LineUpRectExtend()
{
SendMsg(SCI_LINEUPRECTEXTEND, 0, 0);
}
// Move caret left one character, extending rectangular selection to new caret position.
void wxStyledTextCtrl::CharLeftRectExtend()
{
SendMsg(SCI_CHARLEFTRECTEXTEND, 0, 0);
}
// Move caret right one character, extending rectangular selection to new caret position.
void wxStyledTextCtrl::CharRightRectExtend()
{
SendMsg(SCI_CHARRIGHTRECTEXTEND, 0, 0);
}
// Move caret to first position on line, extending rectangular selection to new caret position.
void wxStyledTextCtrl::HomeRectExtend()
{
SendMsg(SCI_HOMERECTEXTEND, 0, 0);
}
// 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 wxStyledTextCtrl::VCHomeRectExtend()
{
SendMsg(SCI_VCHOMERECTEXTEND, 0, 0);
}
// Move caret to last position on line, extending rectangular selection to new caret position.
void wxStyledTextCtrl::LineEndRectExtend()
{
SendMsg(SCI_LINEENDRECTEXTEND, 0, 0);
}
// Move caret one page up, extending rectangular selection to new caret position.
void wxStyledTextCtrl::PageUpRectExtend()
{
SendMsg(SCI_PAGEUPRECTEXTEND, 0, 0);
}
// Move caret one page down, extending rectangular selection to new caret position.
void wxStyledTextCtrl::PageDownRectExtend()
{
SendMsg(SCI_PAGEDOWNRECTEXTEND, 0, 0);
}
// Move caret to top of page, or one page up if already at top of page.
void wxStyledTextCtrl::StutteredPageUp()
{
SendMsg(SCI_STUTTEREDPAGEUP, 0, 0);
}
// Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
void wxStyledTextCtrl::StutteredPageUpExtend()
{
SendMsg(SCI_STUTTEREDPAGEUPEXTEND, 0, 0);
}
// Move caret to bottom of page, or one page down if already at bottom of page.
void wxStyledTextCtrl::StutteredPageDown()
{
SendMsg(SCI_STUTTEREDPAGEDOWN, 0, 0);
}
// Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
void wxStyledTextCtrl::StutteredPageDownExtend()
{
SendMsg(SCI_STUTTEREDPAGEDOWNEXTEND, 0, 0);
}
// Move caret left one word, position cursor at end of word.
void wxStyledTextCtrl::WordLeftEnd()
{
SendMsg(SCI_WORDLEFTEND, 0, 0);
}
// Move caret left one word, position cursor at end of word, extending selection to new caret position.
void wxStyledTextCtrl::WordLeftEndExtend()
{
SendMsg(SCI_WORDLEFTENDEXTEND, 0, 0);
}
// Move caret right one word, position cursor at end of word.
void wxStyledTextCtrl::WordRightEnd()
{
SendMsg(SCI_WORDRIGHTEND, 0, 0);
}
// Move caret right one word, position cursor at end of word, extending selection to new caret position.
void wxStyledTextCtrl::WordRightEndExtend()
{
SendMsg(SCI_WORDRIGHTENDEXTEND, 0, 0);
}
// Set the set of characters making up whitespace for when moving or selecting by word.
// Should be called after SetWordChars.
void wxStyledTextCtrl::SetWhitespaceChars(const wxString& characters)
{
SendMsg(SCI_SETWHITESPACECHARS, 0, (sptr_t)(const char*)wx2stc(characters));
}
// Get the set of characters making up whitespace for when moving or selecting by word.
wxString wxStyledTextCtrl::GetWhitespaceChars() const {
const int msg = SCI_GETWHITESPACECHARS;
int len = SendMsg(msg, 0, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxMemoryBuffer mbuf(len+1);
char* buf = (char*)mbuf.GetWriteBuf(len+1);
SendMsg(msg, 0, (sptr_t)buf);
mbuf.UngetWriteBuf(len);
mbuf.AppendByte(0);
return stc2wx(buf);
}
// Set the set of characters making up punctuation characters
// Should be called after SetWordChars.
void wxStyledTextCtrl::SetPunctuationChars(const wxString& characters)
{
SendMsg(SCI_SETPUNCTUATIONCHARS, 0, (sptr_t)(const char*)wx2stc(characters));
}
// Get the set of characters making up punctuation characters
wxString wxStyledTextCtrl::GetPunctuationChars() const {
const int msg = SCI_GETPUNCTUATIONCHARS;
int len = SendMsg(msg, 0, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxMemoryBuffer mbuf(len+1);
char* buf = (char*)mbuf.GetWriteBuf(len+1);
SendMsg(msg, 0, (sptr_t)buf);
mbuf.UngetWriteBuf(len);
mbuf.AppendByte(0);
return stc2wx(buf);
}
// Reset the set of characters for whitespace and word characters to the defaults.
void wxStyledTextCtrl::SetCharsDefault()
{
SendMsg(SCI_SETCHARSDEFAULT, 0, 0);
}
// Get currently selected item position in the auto-completion list
int wxStyledTextCtrl::AutoCompGetCurrent() const
{
return SendMsg(SCI_AUTOCGETCURRENT, 0, 0);
}
// Get currently selected item text in the auto-completion list
wxString wxStyledTextCtrl::AutoCompGetCurrentText() const {
const int msg = SCI_AUTOCGETCURRENTTEXT;
long len = SendMsg(msg, 0, 0);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, 0, (sptr_t)buf.data());
return stc2wx(buf);
}
// Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.
void wxStyledTextCtrl::AutoCompSetCaseInsensitiveBehaviour(int behaviour)
{
SendMsg(SCI_AUTOCSETCASEINSENSITIVEBEHAVIOUR, behaviour, 0);
}
// Get auto-completion case insensitive behaviour.
int wxStyledTextCtrl::AutoCompGetCaseInsensitiveBehaviour() const
{
return SendMsg(SCI_AUTOCGETCASEINSENSITIVEBEHAVIOUR, 0, 0);
}
// Change the effect of autocompleting when there are multiple selections.
void wxStyledTextCtrl::AutoCompSetMulti(int multi)
{
SendMsg(SCI_AUTOCSETMULTI, multi, 0);
}
// Retrieve the effect of autocompleting when there are multiple selections.
int wxStyledTextCtrl::AutoCompGetMulti() const
{
return SendMsg(SCI_AUTOCGETMULTI, 0, 0);
}
// Set the way autocompletion lists are ordered.
void wxStyledTextCtrl::AutoCompSetOrder(int order)
{
SendMsg(SCI_AUTOCSETORDER, order, 0);
}
// Get the way autocompletion lists are ordered.
int wxStyledTextCtrl::AutoCompGetOrder() const
{
return SendMsg(SCI_AUTOCGETORDER, 0, 0);
}
// Enlarge the document to a particular size of text bytes.
void wxStyledTextCtrl::Allocate(int bytes)
{
SendMsg(SCI_ALLOCATE, bytes, 0);
}
// Find the position of a column on a line taking into account tabs and
// multi-byte characters. If beyond end of line, return line end position.
int wxStyledTextCtrl::FindColumn(int line, int column)
{
return SendMsg(SCI_FINDCOLUMN, line, column);
}
// Can the caret preferred x position only be changed by explicit movement commands?
int wxStyledTextCtrl::GetCaretSticky() const
{
return SendMsg(SCI_GETCARETSTICKY, 0, 0);
}
// Stop the caret preferred x position changing when the user types.
void wxStyledTextCtrl::SetCaretSticky(int useCaretStickyBehaviour)
{
SendMsg(SCI_SETCARETSTICKY, useCaretStickyBehaviour, 0);
}
// Switch between sticky and non-sticky: meant to be bound to a key.
void wxStyledTextCtrl::ToggleCaretSticky()
{
SendMsg(SCI_TOGGLECARETSTICKY, 0, 0);
}
// Enable/Disable convert-on-paste for line endings
void wxStyledTextCtrl::SetPasteConvertEndings(bool convert)
{
SendMsg(SCI_SETPASTECONVERTENDINGS, convert, 0);
}
// Get convert-on-paste setting
bool wxStyledTextCtrl::GetPasteConvertEndings() const
{
return SendMsg(SCI_GETPASTECONVERTENDINGS, 0, 0) != 0;
}
// Duplicate the selection. If selection empty duplicate the line containing the caret.
void wxStyledTextCtrl::SelectionDuplicate()
{
SendMsg(SCI_SELECTIONDUPLICATE, 0, 0);
}
// Set background alpha of the caret line.
void wxStyledTextCtrl::SetCaretLineBackAlpha(int alpha)
{
SendMsg(SCI_SETCARETLINEBACKALPHA, alpha, 0);
}
// Get the background alpha of the caret line.
int wxStyledTextCtrl::GetCaretLineBackAlpha() const
{
return SendMsg(SCI_GETCARETLINEBACKALPHA, 0, 0);
}
// Set the style of the caret to be drawn.
void wxStyledTextCtrl::SetCaretStyle(int caretStyle)
{
SendMsg(SCI_SETCARETSTYLE, caretStyle, 0);
}
// Returns the current style of the caret.
int wxStyledTextCtrl::GetCaretStyle() const
{
return SendMsg(SCI_GETCARETSTYLE, 0, 0);
}
// Set the indicator used for IndicatorFillRange and IndicatorClearRange
void wxStyledTextCtrl::SetIndicatorCurrent(int indicator)
{
SendMsg(SCI_SETINDICATORCURRENT, indicator, 0);
}
// Get the current indicator
int wxStyledTextCtrl::GetIndicatorCurrent() const
{
return SendMsg(SCI_GETINDICATORCURRENT, 0, 0);
}
// Set the value used for IndicatorFillRange
void wxStyledTextCtrl::SetIndicatorValue(int value)
{
SendMsg(SCI_SETINDICATORVALUE, value, 0);
}
// Get the current indicator value
int wxStyledTextCtrl::GetIndicatorValue() const
{
return SendMsg(SCI_GETINDICATORVALUE, 0, 0);
}
// Turn a indicator on over a range.
void wxStyledTextCtrl::IndicatorFillRange(int start, int lengthFill)
{
SendMsg(SCI_INDICATORFILLRANGE, start, lengthFill);
}
// Turn a indicator off over a range.
void wxStyledTextCtrl::IndicatorClearRange(int start, int lengthClear)
{
SendMsg(SCI_INDICATORCLEARRANGE, start, lengthClear);
}
// Are any indicators present at pos?
int wxStyledTextCtrl::IndicatorAllOnFor(int pos)
{
return SendMsg(SCI_INDICATORALLONFOR, pos, 0);
}
// What value does a particular indicator have at a position?
int wxStyledTextCtrl::IndicatorValueAt(int indicator, int pos)
{
return SendMsg(SCI_INDICATORVALUEAT, indicator, pos);
}
// Where does a particular indicator start?
int wxStyledTextCtrl::IndicatorStart(int indicator, int pos)
{
return SendMsg(SCI_INDICATORSTART, indicator, pos);
}
// Where does a particular indicator end?
int wxStyledTextCtrl::IndicatorEnd(int indicator, int pos)
{
return SendMsg(SCI_INDICATOREND, indicator, pos);
}
// Set number of entries in position cache
void wxStyledTextCtrl::SetPositionCacheSize(int size)
{
SendMsg(SCI_SETPOSITIONCACHE, size, 0);
}
// How many entries are allocated to the position cache?
int wxStyledTextCtrl::GetPositionCacheSize() const
{
return SendMsg(SCI_GETPOSITIONCACHE, 0, 0);
}
// Copy the selection, if selection empty copy the line with the caret
void wxStyledTextCtrl::CopyAllowLine()
{
SendMsg(SCI_COPYALLOWLINE, 0, 0);
}
// Compact the document buffer and return a read-only pointer to the
// characters in the document.
const char* wxStyledTextCtrl::GetCharacterPointer() const {
return (const char*)SendMsg(SCI_GETCHARACTERPOINTER, 0, 0);
}
// Return a read-only pointer to a range of characters in the document.
// May move the gap so that the range is contiguous, but will only move up
// to lengthRange bytes.
const char* wxStyledTextCtrl::GetRangePointer(int position, int rangeLength) const {
return (const char*)SendMsg(SCI_GETRANGEPOINTER, position, rangeLength);
}
// Return a position which, to avoid performance costs, should not be within
// the range of a call to GetRangePointer.
int wxStyledTextCtrl::GetGapPosition() const
{
return SendMsg(SCI_GETGAPPOSITION, 0, 0);
}
// Set the alpha fill colour of the given indicator.
void wxStyledTextCtrl::IndicatorSetAlpha(int indicator, int alpha)
{
SendMsg(SCI_INDICSETALPHA, indicator, alpha);
}
// Get the alpha fill colour of the given indicator.
int wxStyledTextCtrl::IndicatorGetAlpha(int indicator) const
{
return SendMsg(SCI_INDICGETALPHA, indicator, 0);
}
// Set the alpha outline colour of the given indicator.
void wxStyledTextCtrl::IndicatorSetOutlineAlpha(int indicator, int alpha)
{
SendMsg(SCI_INDICSETOUTLINEALPHA, indicator, alpha);
}
// Get the alpha outline colour of the given indicator.
int wxStyledTextCtrl::IndicatorGetOutlineAlpha(int indicator) const
{
return SendMsg(SCI_INDICGETOUTLINEALPHA, indicator, 0);
}
// Set extra ascent for each line
void wxStyledTextCtrl::SetExtraAscent(int extraAscent)
{
SendMsg(SCI_SETEXTRAASCENT, extraAscent, 0);
}
// Get extra ascent for each line
int wxStyledTextCtrl::GetExtraAscent() const
{
return SendMsg(SCI_GETEXTRAASCENT, 0, 0);
}
// Set extra descent for each line
void wxStyledTextCtrl::SetExtraDescent(int extraDescent)
{
SendMsg(SCI_SETEXTRADESCENT, extraDescent, 0);
}
// Get extra descent for each line
int wxStyledTextCtrl::GetExtraDescent() const
{
return SendMsg(SCI_GETEXTRADESCENT, 0, 0);
}
// Which symbol was defined for markerNumber with MarkerDefine
int wxStyledTextCtrl::GetMarkerSymbolDefined(int markerNumber)
{
return SendMsg(SCI_MARKERSYMBOLDEFINED, markerNumber, 0);
}
// Set the text in the text margin for a line
void wxStyledTextCtrl::MarginSetText(int line, const wxString& text)
{
SendMsg(SCI_MARGINSETTEXT, line, (sptr_t)(const char*)wx2stc(text));
}
// Get the text in the text margin for a line
wxString wxStyledTextCtrl::MarginGetText(int line) const {
const int msg = SCI_MARGINGETTEXT;
long len = SendMsg(msg, line, 0);
wxCharBuffer buf(len);
SendMsg(msg, line, (sptr_t)buf.data());
return stc2wx(buf);
}
// Set the style number for the text margin for a line
void wxStyledTextCtrl::MarginSetStyle(int line, int style)
{
SendMsg(SCI_MARGINSETSTYLE, line, style);
}
// Get the style number for the text margin for a line
int wxStyledTextCtrl::MarginGetStyle(int line) const
{
return SendMsg(SCI_MARGINGETSTYLE, line, 0);
}
// Set the style in the text margin for a line
void wxStyledTextCtrl::MarginSetStyles(int line, const wxString& styles)
{
SendMsg(SCI_MARGINSETSTYLES, line, (sptr_t)(const char*)wx2stc(styles));
}
// Get the styles in the text margin for a line
wxString wxStyledTextCtrl::MarginGetStyles(int line) const {
const int msg = SCI_MARGINGETSTYLES;
long len = SendMsg(msg, line, 0);
wxMemoryBuffer mbuf(len+1);
char* buf = (char*)mbuf.GetWriteBuf(len+1);
SendMsg(msg, line, (sptr_t)buf);
mbuf.UngetWriteBuf(len);
mbuf.AppendByte(0);
return stc2wx(buf);
}
// Clear the margin text on all lines
void wxStyledTextCtrl::MarginTextClearAll()
{
SendMsg(SCI_MARGINTEXTCLEARALL, 0, 0);
}
// Get the start of the range of style numbers used for margin text
void wxStyledTextCtrl::MarginSetStyleOffset(int style)
{
SendMsg(SCI_MARGINSETSTYLEOFFSET, style, 0);
}
// Get the start of the range of style numbers used for margin text
int wxStyledTextCtrl::MarginGetStyleOffset() const
{
return SendMsg(SCI_MARGINGETSTYLEOFFSET, 0, 0);
}
// Set the margin options.
void wxStyledTextCtrl::SetMarginOptions(int marginOptions)
{
SendMsg(SCI_SETMARGINOPTIONS, marginOptions, 0);
}
// Get the margin options.
int wxStyledTextCtrl::GetMarginOptions() const
{
return SendMsg(SCI_GETMARGINOPTIONS, 0, 0);
}
// Set the annotation text for a line
void wxStyledTextCtrl::AnnotationSetText(int line, const wxString& text)
{
SendMsg(SCI_ANNOTATIONSETTEXT, line, (sptr_t)(const char*)wx2stc(text));
}
// Get the annotation text for a line
wxString wxStyledTextCtrl::AnnotationGetText(int line) const {
const int msg = SCI_ANNOTATIONGETTEXT;
long len = SendMsg(msg, line, 0);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, line, (sptr_t)buf.data());
return stc2wx(buf);
}
// Set the style number for the annotations for a line
void wxStyledTextCtrl::AnnotationSetStyle(int line, int style)
{
SendMsg(SCI_ANNOTATIONSETSTYLE, line, style);
}
// Get the style number for the annotations for a line
int wxStyledTextCtrl::AnnotationGetStyle(int line) const
{
return SendMsg(SCI_ANNOTATIONGETSTYLE, line, 0);
}
// Set the annotation styles for a line
void wxStyledTextCtrl::AnnotationSetStyles(int line, const wxString& styles)
{
SendMsg(SCI_ANNOTATIONSETSTYLES, line, (sptr_t)(const char*)wx2stc(styles));
}
// Get the annotation styles for a line
wxString wxStyledTextCtrl::AnnotationGetStyles(int line) const {
const int msg = SCI_ANNOTATIONGETSTYLES;
long len = SendMsg(msg, line, 0);
wxMemoryBuffer mbuf(len+1);
char* buf = (char*)mbuf.GetWriteBuf(len+1);
SendMsg(msg, line, (sptr_t)buf);
mbuf.UngetWriteBuf(len);
mbuf.AppendByte(0);
return stc2wx(buf);
}
// Get the number of annotation lines for a line
int wxStyledTextCtrl::AnnotationGetLines(int line) const
{
return SendMsg(SCI_ANNOTATIONGETLINES, line, 0);
}
// Clear the annotations from all lines
void wxStyledTextCtrl::AnnotationClearAll()
{
SendMsg(SCI_ANNOTATIONCLEARALL, 0, 0);
}
// Set the visibility for the annotations for a view
void wxStyledTextCtrl::AnnotationSetVisible(int visible)
{
SendMsg(SCI_ANNOTATIONSETVISIBLE, visible, 0);
}
// Get the visibility for the annotations for a view
int wxStyledTextCtrl::AnnotationGetVisible() const
{
return SendMsg(SCI_ANNOTATIONGETVISIBLE, 0, 0);
}
// Get the start of the range of style numbers used for annotations
void wxStyledTextCtrl::AnnotationSetStyleOffset(int style)
{
SendMsg(SCI_ANNOTATIONSETSTYLEOFFSET, style, 0);
}
// Get the start of the range of style numbers used for annotations
int wxStyledTextCtrl::AnnotationGetStyleOffset() const
{
return SendMsg(SCI_ANNOTATIONGETSTYLEOFFSET, 0, 0);
}
// Release all extended (>255) style numbers
void wxStyledTextCtrl::ReleaseAllExtendedStyles()
{
SendMsg(SCI_RELEASEALLEXTENDEDSTYLES, 0, 0);
}
// Allocate some extended (>255) style numbers and return the start of the range
int wxStyledTextCtrl::AllocateExtendedStyles(int numberStyles)
{
return SendMsg(SCI_ALLOCATEEXTENDEDSTYLES, numberStyles, 0);
}
// Add a container action to the undo stack
void wxStyledTextCtrl::AddUndoAction(int token, int flags)
{
SendMsg(SCI_ADDUNDOACTION, token, flags);
}
// Find the position of a character from a point within the window.
int wxStyledTextCtrl::CharPositionFromPoint(int x, int y)
{
return SendMsg(SCI_CHARPOSITIONFROMPOINT, x, y);
}
// Find the position of a character from a point within the window.
// Return wxSTC_INVALID_POSITION if not close to text.
int wxStyledTextCtrl::CharPositionFromPointClose(int x, int y)
{
return SendMsg(SCI_CHARPOSITIONFROMPOINTCLOSE, x, y);
}
// Set whether switching to rectangular mode while selecting with the mouse is allowed.
void wxStyledTextCtrl::SetMouseSelectionRectangularSwitch(bool mouseSelectionRectangularSwitch)
{
SendMsg(SCI_SETMOUSESELECTIONRECTANGULARSWITCH, mouseSelectionRectangularSwitch, 0);
}
// Whether switching to rectangular mode while selecting with the mouse is allowed.
bool wxStyledTextCtrl::GetMouseSelectionRectangularSwitch() const
{
return SendMsg(SCI_GETMOUSESELECTIONRECTANGULARSWITCH, 0, 0) != 0;
}
// Set whether multiple selections can be made
void wxStyledTextCtrl::SetMultipleSelection(bool multipleSelection)
{
SendMsg(SCI_SETMULTIPLESELECTION, multipleSelection, 0);
}
// Whether multiple selections can be made
bool wxStyledTextCtrl::GetMultipleSelection() const
{
return SendMsg(SCI_GETMULTIPLESELECTION, 0, 0) != 0;
}
// Set whether typing can be performed into multiple selections
void wxStyledTextCtrl::SetAdditionalSelectionTyping(bool additionalSelectionTyping)
{
SendMsg(SCI_SETADDITIONALSELECTIONTYPING, additionalSelectionTyping, 0);
}
// Whether typing can be performed into multiple selections
bool wxStyledTextCtrl::GetAdditionalSelectionTyping() const
{
return SendMsg(SCI_GETADDITIONALSELECTIONTYPING, 0, 0) != 0;
}
// Set whether additional carets will blink
void wxStyledTextCtrl::SetAdditionalCaretsBlink(bool additionalCaretsBlink)
{
SendMsg(SCI_SETADDITIONALCARETSBLINK, additionalCaretsBlink, 0);
}
// Whether additional carets will blink
bool wxStyledTextCtrl::GetAdditionalCaretsBlink() const
{
return SendMsg(SCI_GETADDITIONALCARETSBLINK, 0, 0) != 0;
}
// Set whether additional carets are visible
void wxStyledTextCtrl::SetAdditionalCaretsVisible(bool additionalCaretsVisible)
{
SendMsg(SCI_SETADDITIONALCARETSVISIBLE, additionalCaretsVisible, 0);
}
// Whether additional carets are visible
bool wxStyledTextCtrl::GetAdditionalCaretsVisible() const
{
return SendMsg(SCI_GETADDITIONALCARETSVISIBLE, 0, 0) != 0;
}
// How many selections are there?
int wxStyledTextCtrl::GetSelections() const
{
return SendMsg(SCI_GETSELECTIONS, 0, 0);
}
// Is every selected range empty?
bool wxStyledTextCtrl::GetSelectionEmpty() const
{
return SendMsg(SCI_GETSELECTIONEMPTY, 0, 0) != 0;
}
// Clear selections to a single empty stream selection
void wxStyledTextCtrl::ClearSelections()
{
SendMsg(SCI_CLEARSELECTIONS, 0, 0);
}
// Add a selection
int wxStyledTextCtrl::AddSelection(int caret, int anchor)
{
return SendMsg(SCI_ADDSELECTION, caret, anchor);
}
// Drop one selection
void wxStyledTextCtrl::DropSelectionN(int selection)
{
SendMsg(SCI_DROPSELECTIONN, selection, 0);
}
// Set the main selection
void wxStyledTextCtrl::SetMainSelection(int selection)
{
SendMsg(SCI_SETMAINSELECTION, selection, 0);
}
// Which selection is the main selection
int wxStyledTextCtrl::GetMainSelection() const
{
return SendMsg(SCI_GETMAINSELECTION, 0, 0);
}
// Set the caret position of the nth selection.
void wxStyledTextCtrl::SetSelectionNCaret(int selection, int caret)
{
SendMsg(SCI_SETSELECTIONNCARET, selection, caret);
}
// Return the caret position of the nth selection.
int wxStyledTextCtrl::GetSelectionNCaret(int selection) const
{
return SendMsg(SCI_GETSELECTIONNCARET, selection, 0);
}
// Set the anchor position of the nth selection.
void wxStyledTextCtrl::SetSelectionNAnchor(int selection, int anchor)
{
SendMsg(SCI_SETSELECTIONNANCHOR, selection, anchor);
}
// Return the anchor position of the nth selection.
int wxStyledTextCtrl::GetSelectionNAnchor(int selection) const
{
return SendMsg(SCI_GETSELECTIONNANCHOR, selection, 0);
}
// Set the virtual space of the caret of the nth selection.
void wxStyledTextCtrl::SetSelectionNCaretVirtualSpace(int selection, int space)
{
SendMsg(SCI_SETSELECTIONNCARETVIRTUALSPACE, selection, space);
}
// Return the virtual space of the caret of the nth selection.
int wxStyledTextCtrl::GetSelectionNCaretVirtualSpace(int selection) const
{
return SendMsg(SCI_GETSELECTIONNCARETVIRTUALSPACE, selection, 0);
}
// Set the virtual space of the anchor of the nth selection.
void wxStyledTextCtrl::SetSelectionNAnchorVirtualSpace(int selection, int space)
{
SendMsg(SCI_SETSELECTIONNANCHORVIRTUALSPACE, selection, space);
}
// Return the virtual space of the anchor of the nth selection.
int wxStyledTextCtrl::GetSelectionNAnchorVirtualSpace(int selection) const
{
return SendMsg(SCI_GETSELECTIONNANCHORVIRTUALSPACE, selection, 0);
}
// Sets the position that starts the selection - this becomes the anchor.
void wxStyledTextCtrl::SetSelectionNStart(int selection, int anchor)
{
SendMsg(SCI_SETSELECTIONNSTART, selection, anchor);
}
// Returns the position at the start of the selection.
int wxStyledTextCtrl::GetSelectionNStart(int selection) const
{
return SendMsg(SCI_GETSELECTIONNSTART, selection, 0);
}
// Sets the position that ends the selection - this becomes the currentPosition.
void wxStyledTextCtrl::SetSelectionNEnd(int selection, int caret)
{
SendMsg(SCI_SETSELECTIONNEND, selection, caret);
}
// Returns the position at the end of the selection.
int wxStyledTextCtrl::GetSelectionNEnd(int selection) const
{
return SendMsg(SCI_GETSELECTIONNEND, selection, 0);
}
// Set the caret position of the rectangular selection.
void wxStyledTextCtrl::SetRectangularSelectionCaret(int caret)
{
SendMsg(SCI_SETRECTANGULARSELECTIONCARET, caret, 0);
}
// Return the caret position of the rectangular selection.
int wxStyledTextCtrl::GetRectangularSelectionCaret() const
{
return SendMsg(SCI_GETRECTANGULARSELECTIONCARET, 0, 0);
}
// Set the anchor position of the rectangular selection.
void wxStyledTextCtrl::SetRectangularSelectionAnchor(int anchor)
{
SendMsg(SCI_SETRECTANGULARSELECTIONANCHOR, anchor, 0);
}
// Return the anchor position of the rectangular selection.
int wxStyledTextCtrl::GetRectangularSelectionAnchor() const
{
return SendMsg(SCI_GETRECTANGULARSELECTIONANCHOR, 0, 0);
}
// Set the virtual space of the caret of the rectangular selection.
void wxStyledTextCtrl::SetRectangularSelectionCaretVirtualSpace(int space)
{
SendMsg(SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE, space, 0);
}
// Return the virtual space of the caret of the rectangular selection.
int wxStyledTextCtrl::GetRectangularSelectionCaretVirtualSpace() const
{
return SendMsg(SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE, 0, 0);
}
// Set the virtual space of the anchor of the rectangular selection.
void wxStyledTextCtrl::SetRectangularSelectionAnchorVirtualSpace(int space)
{
SendMsg(SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE, space, 0);
}
// Return the virtual space of the anchor of the rectangular selection.
int wxStyledTextCtrl::GetRectangularSelectionAnchorVirtualSpace() const
{
return SendMsg(SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE, 0, 0);
}
// Set options for virtual space behaviour.
void wxStyledTextCtrl::SetVirtualSpaceOptions(int virtualSpaceOptions)
{
SendMsg(SCI_SETVIRTUALSPACEOPTIONS, virtualSpaceOptions, 0);
}
// Return options for virtual space behaviour.
int wxStyledTextCtrl::GetVirtualSpaceOptions() const
{
return SendMsg(SCI_GETVIRTUALSPACEOPTIONS, 0, 0);
}
// On GTK+, allow selecting the modifier key to use for mouse-based
// rectangular selection. Often the window manager requires Alt+Mouse Drag
// for moving windows.
// Valid values are wxSTC_KEYMOD_CTRL (default), wxSTC_KEYMOD_ALT, or wxSTC_KEYMOD_SUPER.
void wxStyledTextCtrl::SetRectangularSelectionModifier(int modifier)
{
SendMsg(SCI_SETRECTANGULARSELECTIONMODIFIER, modifier, 0);
}
// Get the modifier key used for rectangular selection.
int wxStyledTextCtrl::GetRectangularSelectionModifier() const
{
return SendMsg(SCI_GETRECTANGULARSELECTIONMODIFIER, 0, 0);
}
// Set the foreground colour of additional selections.
// Must have previously called SetSelFore with non-zero first argument for this to have an effect.
void wxStyledTextCtrl::SetAdditionalSelForeground(const wxColour& fore)
{
SendMsg(SCI_SETADDITIONALSELFORE, wxColourAsLong(fore), 0);
}
// Set the background colour of additional selections.
// Must have previously called SetSelBack with non-zero first argument for this to have an effect.
void wxStyledTextCtrl::SetAdditionalSelBackground(const wxColour& back)
{
SendMsg(SCI_SETADDITIONALSELBACK, wxColourAsLong(back), 0);
}
// Set the alpha of the selection.
void wxStyledTextCtrl::SetAdditionalSelAlpha(int alpha)
{
SendMsg(SCI_SETADDITIONALSELALPHA, alpha, 0);
}
// Get the alpha of the selection.
int wxStyledTextCtrl::GetAdditionalSelAlpha() const
{
return SendMsg(SCI_GETADDITIONALSELALPHA, 0, 0);
}
// Set the foreground colour of additional carets.
void wxStyledTextCtrl::SetAdditionalCaretForeground(const wxColour& fore)
{
SendMsg(SCI_SETADDITIONALCARETFORE, wxColourAsLong(fore), 0);
}
// Get the foreground colour of additional carets.
wxColour wxStyledTextCtrl::GetAdditionalCaretForeground() const
{
long c = SendMsg(SCI_GETADDITIONALCARETFORE, 0, 0);
return wxColourFromLong(c);
}
// Set the main selection to the next selection.
void wxStyledTextCtrl::RotateSelection()
{
SendMsg(SCI_ROTATESELECTION, 0, 0);
}
// Swap that caret and anchor of the main selection.
void wxStyledTextCtrl::SwapMainAnchorCaret()
{
SendMsg(SCI_SWAPMAINANCHORCARET, 0, 0);
}
// Add the next occurrence of the main selection to the set of selections as main.
// If the current selection is empty then select word around caret.
void wxStyledTextCtrl::MultipleSelectAddNext()
{
SendMsg(SCI_MULTIPLESELECTADDNEXT, 0, 0);
}
// Add each occurrence of the main selection in the target to the set of selections.
// If the current selection is empty then select word around caret.
void wxStyledTextCtrl::MultipleSelectAddEach()
{
SendMsg(SCI_MULTIPLESELECTADDEACH, 0, 0);
}
// Indicate that the internal state of a lexer has changed over a range and therefore
// there may be a need to redraw.
int wxStyledTextCtrl::ChangeLexerState(int start, int end)
{
return SendMsg(SCI_CHANGELEXERSTATE, start, end);
}
// Find the next line at or after lineStart that is a contracted fold header line.
// Return -1 when no more lines.
int wxStyledTextCtrl::ContractedFoldNext(int lineStart)
{
return SendMsg(SCI_CONTRACTEDFOLDNEXT, lineStart, 0);
}
// Centre current line in window.
void wxStyledTextCtrl::VerticalCentreCaret()
{
SendMsg(SCI_VERTICALCENTRECARET, 0, 0);
}
// Move the selected lines up one line, shifting the line above after the selection
void wxStyledTextCtrl::MoveSelectedLinesUp()
{
SendMsg(SCI_MOVESELECTEDLINESUP, 0, 0);
}
// Move the selected lines down one line, shifting the line below before the selection
void wxStyledTextCtrl::MoveSelectedLinesDown()
{
SendMsg(SCI_MOVESELECTEDLINESDOWN, 0, 0);
}
// Set the identifier reported as idFrom in notification messages.
void wxStyledTextCtrl::SetIdentifier(int identifier)
{
SendMsg(SCI_SETIDENTIFIER, identifier, 0);
}
// Get the identifier.
int wxStyledTextCtrl::GetIdentifier() const
{
return SendMsg(SCI_GETIDENTIFIER, 0, 0);
}
// Set the width for future RGBA image data.
void wxStyledTextCtrl::RGBAImageSetWidth(int width)
{
SendMsg(SCI_RGBAIMAGESETWIDTH, width, 0);
}
// Set the height for future RGBA image data.
void wxStyledTextCtrl::RGBAImageSetHeight(int height)
{
SendMsg(SCI_RGBAIMAGESETHEIGHT, height, 0);
}
// Set the scale factor in percent for future RGBA image data.
void wxStyledTextCtrl::RGBAImageSetScale(int scalePercent)
{
SendMsg(SCI_RGBAIMAGESETSCALE, scalePercent, 0);
}
// Define a marker from RGBA data.
// It has the width and height from RGBAImageSetWidth/Height
void wxStyledTextCtrl::MarkerDefineRGBAImage(int markerNumber, const unsigned char* pixels) {
SendMsg(SCI_MARKERDEFINERGBAIMAGE, markerNumber, (sptr_t)pixels);
}
// Register an RGBA image for use in autocompletion lists.
// It has the width and height from RGBAImageSetWidth/Height
void wxStyledTextCtrl::RegisterRGBAImage(int type, const unsigned char* pixels) {
SendMsg(SCI_REGISTERRGBAIMAGE, type, (sptr_t)pixels);
}
// Scroll to start of document.
void wxStyledTextCtrl::ScrollToStart()
{
SendMsg(SCI_SCROLLTOSTART, 0, 0);
}
// Scroll to end of document.
void wxStyledTextCtrl::ScrollToEnd()
{
SendMsg(SCI_SCROLLTOEND, 0, 0);
}
// Set the technology used.
void wxStyledTextCtrl::SetTechnology(int technology)
{
SendMsg(SCI_SETTECHNOLOGY, technology, 0);
}
// Get the tech.
int wxStyledTextCtrl::GetTechnology() const
{
return SendMsg(SCI_GETTECHNOLOGY, 0, 0);
}
// Create an ILoader*.
void* wxStyledTextCtrl::CreateLoader(int bytes) const {
return (void*)(sptr_t)SendMsg(SCI_CREATELOADER, bytes);
}
// Move caret to before first visible character on display line.
// If already there move to first character on display line.
void wxStyledTextCtrl::VCHomeDisplay()
{
SendMsg(SCI_VCHOMEDISPLAY, 0, 0);
}
// Like VCHomeDisplay but extending selection to new caret position.
void wxStyledTextCtrl::VCHomeDisplayExtend()
{
SendMsg(SCI_VCHOMEDISPLAYEXTEND, 0, 0);
}
// Is the caret line always visible?
bool wxStyledTextCtrl::GetCaretLineVisibleAlways() const
{
return SendMsg(SCI_GETCARETLINEVISIBLEALWAYS, 0, 0) != 0;
}
// Sets the caret line to always visible.
void wxStyledTextCtrl::SetCaretLineVisibleAlways(bool alwaysVisible)
{
SendMsg(SCI_SETCARETLINEVISIBLEALWAYS, alwaysVisible, 0);
}
// Set the line end types that the application wants to use. May not be used if incompatible with lexer or encoding.
void wxStyledTextCtrl::SetLineEndTypesAllowed(int lineEndBitSet)
{
SendMsg(SCI_SETLINEENDTYPESALLOWED, lineEndBitSet, 0);
}
// Get the line end types currently allowed.
int wxStyledTextCtrl::GetLineEndTypesAllowed() const
{
return SendMsg(SCI_GETLINEENDTYPESALLOWED, 0, 0);
}
// Get the line end types currently recognised. May be a subset of the allowed types due to lexer limitation.
int wxStyledTextCtrl::GetLineEndTypesActive() const
{
return SendMsg(SCI_GETLINEENDTYPESACTIVE, 0, 0);
}
// Set the way a character is drawn.
void wxStyledTextCtrl::SetRepresentation(const wxString& encodedCharacter, const wxString& representation)
{
SendMsg(SCI_SETREPRESENTATION, (sptr_t)(const char*)wx2stc(encodedCharacter), (sptr_t)(const char*)wx2stc(representation));
}
// Set the way a character is drawn.
wxString wxStyledTextCtrl::GetRepresentation(const wxString& encodedCharacter) const {
const int msg = SCI_GETREPRESENTATION;
const wxWX2MBbuf encCharBuf = wx2stc(encodedCharacter);
long len = SendMsg(msg, (sptr_t)(const char*)encCharBuf, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, (sptr_t)(const char*)encCharBuf, (sptr_t)buf.data());
return stc2wx(buf);
}
// Remove a character representation.
void wxStyledTextCtrl::ClearRepresentation(const wxString& encodedCharacter)
{
SendMsg(SCI_CLEARREPRESENTATION, (sptr_t)(const char*)wx2stc(encodedCharacter), 0);
}
// Start notifying the container of all key presses and commands.
void wxStyledTextCtrl::StartRecord()
{
SendMsg(SCI_STARTRECORD, 0, 0);
}
// Stop notifying the container of all key presses and commands.
void wxStyledTextCtrl::StopRecord()
{
SendMsg(SCI_STOPRECORD, 0, 0);
}
// Set the lexing language of the document.
void wxStyledTextCtrl::SetLexer(int lexer)
{
SendMsg(SCI_SETLEXER, lexer, 0);
}
// Retrieve the lexing language of the document.
int wxStyledTextCtrl::GetLexer() const
{
return SendMsg(SCI_GETLEXER, 0, 0);
}
// Colourise a segment of the document using the current lexing language.
void wxStyledTextCtrl::Colourise(int start, int end)
{
SendMsg(SCI_COLOURISE, start, end);
}
// Set up a value that may be used by a lexer for some optional feature.
void wxStyledTextCtrl::SetProperty(const wxString& key, const wxString& value)
{
SendMsg(SCI_SETPROPERTY, (sptr_t)(const char*)wx2stc(key), (sptr_t)(const char*)wx2stc(value));
}
// Set up the key words used by the lexer.
void wxStyledTextCtrl::SetKeyWords(int keyWordSet, const wxString& keyWords)
{
SendMsg(SCI_SETKEYWORDS, keyWordSet, (sptr_t)(const char*)wx2stc(keyWords));
}
// Set the lexing language of the document based on string name.
void wxStyledTextCtrl::SetLexerLanguage(const wxString& language)
{
SendMsg(SCI_SETLEXERLANGUAGE, 0, (sptr_t)(const char*)wx2stc(language));
}
// Load a lexer library (dll / so).
void wxStyledTextCtrl::LoadLexerLibrary(const wxString& path)
{
SendMsg(SCI_LOADLEXERLIBRARY, 0, (sptr_t)(const char*)wx2stc(path));
}
// Retrieve a "property" value previously set with SetProperty.
wxString wxStyledTextCtrl::GetProperty(const wxString& key) {
const int msg = SCI_GETPROPERTY;
const wxWX2MBbuf keyBuf = wx2stc(key);
long len = SendMsg(msg, (uptr_t)(const char*)keyBuf, 0);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, (uptr_t)(const char*)keyBuf, (sptr_t)buf.data());
return stc2wx(buf);
}
// Retrieve a "property" value previously set with SetProperty,
// with "$()" variable replacement on returned buffer.
wxString wxStyledTextCtrl::GetPropertyExpanded(const wxString& key) {
const int msg = SCI_GETPROPERTYEXPANDED;
const wxWX2MBbuf keyBuf = wx2stc(key);
long len = SendMsg(msg, (uptr_t)(const char*)keyBuf, 0);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, (uptr_t)(const char*)keyBuf, (sptr_t)buf.data());
return stc2wx(buf);
}
// Retrieve a "property" value previously set with SetProperty,
// interpreted as an int AFTER any "$()" variable replacement.
int wxStyledTextCtrl::GetPropertyInt(const wxString &key, int defaultValue) const {
return SendMsg(SCI_GETPROPERTYINT, (uptr_t)(const char*)wx2stc(key), defaultValue);
}
// Retrieve the number of bits the current lexer needs for styling.
int wxStyledTextCtrl::GetStyleBitsNeeded() const
{
return SendMsg(SCI_GETSTYLEBITSNEEDED, 0, 0);
}
// Retrieve the lexing language of the document.
wxString wxStyledTextCtrl::GetLexerLanguage() const {
const int msg = SCI_GETLEXERLANGUAGE;
int len = SendMsg(msg, 0, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, 0, (sptr_t)buf.data());
return stc2wx(buf);
}
// For private communication between an application and a known lexer.
void* wxStyledTextCtrl::PrivateLexerCall(int operation, void* pointer) {
return (void*)(sptr_t)SendMsg(SCI_PRIVATELEXERCALL, operation, (sptr_t)pointer);
}
// Retrieve a '\\n' separated list of properties understood by the current lexer.
wxString wxStyledTextCtrl::PropertyNames() const {
const int msg = SCI_PROPERTYNAMES;
long len = SendMsg(msg, 0, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, 0, (sptr_t)buf.data());
return stc2wx(buf);
}
// Retrieve the type of a property.
int wxStyledTextCtrl::PropertyType(const wxString& name)
{
return SendMsg(SCI_PROPERTYTYPE, (sptr_t)(const char*)wx2stc(name), 0);
}
// Describe a property.
wxString wxStyledTextCtrl::DescribeProperty(const wxString& name) const {
const int msg = SCI_DESCRIBEPROPERTY;
const wxWX2MBbuf nameBuf = wx2stc(name);
long len = SendMsg(msg, (uptr_t)(const char*)nameBuf, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, (uptr_t)(const char*)nameBuf, (sptr_t)buf.data());
return stc2wx(buf);
}
// Retrieve a '\\n' separated list of descriptions of the keyword sets understood by the current lexer.
wxString wxStyledTextCtrl::DescribeKeyWordSets() const {
const int msg = SCI_DESCRIBEKEYWORDSETS;
long len = SendMsg(msg, 0, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, 0, (sptr_t)buf.data());
return stc2wx(buf);
}
// Bit set of LineEndType enumertion for which line ends beyond the standard
// LF, CR, and CRLF are supported by the lexer.
int wxStyledTextCtrl::GetLineEndTypesSupported() const
{
return SendMsg(SCI_GETLINEENDTYPESSUPPORTED, 0, 0);
}
// Allocate a set of sub styles for a particular base style, returning start of range
int wxStyledTextCtrl::AllocateSubStyles(int styleBase, int numberStyles)
{
return SendMsg(SCI_ALLOCATESUBSTYLES, styleBase, numberStyles);
}
// The starting style number for the sub styles associated with a base style
int wxStyledTextCtrl::GetSubStylesStart(int styleBase) const
{
return SendMsg(SCI_GETSUBSTYLESSTART, styleBase, 0);
}
// The number of sub styles associated with a base style
int wxStyledTextCtrl::GetSubStylesLength(int styleBase) const
{
return SendMsg(SCI_GETSUBSTYLESLENGTH, styleBase, 0);
}
// For a sub style, return the base style, else return the argument.
int wxStyledTextCtrl::GetStyleFromSubStyle(int subStyle) const
{
return SendMsg(SCI_GETSTYLEFROMSUBSTYLE, subStyle, 0);
}
// For a secondary style, return the primary style, else return the argument.
int wxStyledTextCtrl::GetPrimaryStyleFromStyle(int style) const
{
return SendMsg(SCI_GETPRIMARYSTYLEFROMSTYLE, style, 0);
}
// Free allocated sub styles
void wxStyledTextCtrl::FreeSubStyles()
{
SendMsg(SCI_FREESUBSTYLES, 0, 0);
}
// Set the identifiers that are shown in a particular style
void wxStyledTextCtrl::SetIdentifiers(int style, const wxString& identifiers)
{
SendMsg(SCI_SETIDENTIFIERS, style, (sptr_t)(const char*)wx2stc(identifiers));
}
// Where styles are duplicated by a feature such as active/inactive code
// return the distance between the two types.
int wxStyledTextCtrl::DistanceToSecondaryStyles() const
{
return SendMsg(SCI_DISTANCETOSECONDARYSTYLES, 0, 0);
}
// Get the set of base styles that can be extended with sub styles
wxString wxStyledTextCtrl::GetSubStyleBases() const {
const int msg = SCI_GETSUBSTYLEBASES;
long len = SendMsg(msg, 0, (sptr_t)NULL);
if (!len) return wxEmptyString;
wxCharBuffer buf(len);
SendMsg(msg, 0, (sptr_t)buf.data());
return stc2wx(buf);
}
//}}}
//----------------------------------------------------------------------
// Returns the line number of the line with the caret.
int wxStyledTextCtrl::GetCurrentLine() {
int line = LineFromPosition(GetCurrentPos());
return line;
}
// Extract style settings from a spec-string which is composed of one or
// more of the following comma separated elements:
//
// bold turns on bold
// italic turns on italics
// 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
// underline turns on underlining
//
void wxStyledTextCtrl::StyleSetSpec(int styleNum, const wxString& spec) {
wxStringTokenizer tkz(spec, wxT(","));
while (tkz.HasMoreTokens()) {
wxString token = tkz.GetNextToken();
wxString option = token.BeforeFirst(':');
wxString val = token.AfterFirst(':');
if (option == wxT("bold"))
StyleSetBold(styleNum, true);
else if (option == wxT("italic"))
StyleSetItalic(styleNum, true);
else if (option == wxT("underline"))
StyleSetUnderline(styleNum, true);
else if (option == wxT("eol"))
StyleSetEOLFilled(styleNum, true);
else if (option == wxT("size")) {
long points;
if (val.ToLong(&points))
StyleSetSize(styleNum, points);
}
else if (option == wxT("face"))
StyleSetFaceName(styleNum, val);
else if (option == wxT("fore"))
StyleSetForeground(styleNum, wxColourFromSpec(val));
else if (option == wxT("back"))
StyleSetBackground(styleNum, wxColourFromSpec(val));
}
}
// Get the font of a style
wxFont wxStyledTextCtrl::StyleGetFont(int style) {
wxFont font;
font.SetPointSize(StyleGetSize(style));
font.SetFaceName(StyleGetFaceName(style));
if( StyleGetBold(style) )
font.SetWeight(wxFONTWEIGHT_BOLD);
else
font.SetWeight(wxFONTWEIGHT_NORMAL);
if( StyleGetItalic(style) )
font.SetStyle(wxFONTSTYLE_ITALIC);
else
font.SetStyle(wxFONTSTYLE_NORMAL);
return font;
}
// Set style size, face, bold, italic, and underline attributes from
// a wxFont's attributes.
void wxStyledTextCtrl::StyleSetFont(int styleNum, const wxFont& font) {
#ifdef __WXGTK__
// Ensure that the native font is initialized
int x, y;
GetTextExtent(wxT("X"), &x, &y, NULL, NULL, &font);
#endif
int size = font.GetPointSize();
wxString faceName = font.GetFaceName();
bool bold = font.GetWeight() == wxFONTWEIGHT_BOLD;
bool italic = font.GetStyle() != wxFONTSTYLE_NORMAL;
bool under = font.GetUnderlined();
wxFontEncoding encoding = font.GetEncoding();
StyleSetFontAttr(styleNum, size, faceName, bold, italic, under, encoding);
}
// Set all font style attributes at once.
void wxStyledTextCtrl::StyleSetFontAttr(int styleNum, int size,
const wxString& faceName,
bool bold, bool italic,
bool underline,
wxFontEncoding encoding) {
StyleSetSize(styleNum, size);
StyleSetFaceName(styleNum, faceName);
StyleSetBold(styleNum, bold);
StyleSetItalic(styleNum, italic);
StyleSetUnderline(styleNum, underline);
StyleSetFontEncoding(styleNum, encoding);
}
// Set the font encoding to be used by a style.
void wxStyledTextCtrl::StyleSetFontEncoding(int style, wxFontEncoding encoding)
{
SendMsg(SCI_STYLESETCHARACTERSET, style, encoding+1);
}
// Perform one of the operations defined by the wxSTC_CMD_* constants.
void wxStyledTextCtrl::CmdKeyExecute(int cmd) {
SendMsg(cmd);
}
// Set the left and right margin in the edit area, measured in pixels.
void wxStyledTextCtrl::SetMargins(int left, int right) {
SetMarginLeft(left);
SetMarginRight(right);
}
// Scroll enough to make the given line visible
void wxStyledTextCtrl::ScrollToLine(int line) {
m_swx->DoScrollToLine(line);
}
// Scroll enough to make the given column visible
void wxStyledTextCtrl::ScrollToColumn(int column) {
m_swx->DoScrollToColumn(column);
}
void wxStyledTextCtrl::DoSetValue(const wxString& value, int flags)
{
if ( flags & SetValue_SelectionOnly )
ReplaceSelection(value);
else
SetText(value);
// We don't send wxEVT_TEXT anyhow, so ignore the
// SetValue_SendEvent bit of the flags
}
bool
wxStyledTextCtrl::DoSaveFile(const wxString& filename, int WXUNUSED(fileType))
{
#if wxUSE_FFILE || wxUSE_FILE
#if wxUSE_FFILE
// Take care to use "b" to ensure that possibly non-native EOLs in the file
// contents are not mangled when saving it.
wxFFile file(filename, wxS("wb"));
#elif wxUSE_FILE
wxFile file(filename, wxFile::write);
#endif
if ( file.IsOpened() && file.Write(GetValue(), *wxConvCurrent) )
{
SetSavePoint();
return true;
}
#endif // !wxUSE_FFILE && !wxUSE_FILE
return false;
}
bool
wxStyledTextCtrl::DoLoadFile(const wxString& filename, int WXUNUSED(fileType))
{
#if wxUSE_FFILE || wxUSE_FILE
#if wxUSE_FFILE
// As above, we want to read the real EOLs from the file, e.g. without
// translating them to just LFs under Windows, so that the original CR LF
// are preserved when it's written back.
wxFFile file(filename, wxS("rb"));
#else
wxFile file(filename);
#endif
if ( file.IsOpened() )
{
wxString text;
if ( file.ReadAll(&text, wxConvAuto()) )
{
// Detect the EOL: we use just the first line because there is not
// much we can do if the file uses inconsistent EOLs anyhow, we'd
// need to ask the user about the one we should really use and we
// don't currently provide a way to do it.
//
// We also only check for Unix and DOS EOLs but not classic Mac
// CR-only one as it's obsolete by now.
const wxString::size_type posLF = text.find('\n');
if ( posLF != wxString::npos )
{
// Set EOL mode to ensure that the new lines inserted into the
// text use the same EOLs as the existing ones.
if ( posLF > 0 && text[posLF - 1] == '\r' )
SetEOLMode(wxSTC_EOL_CRLF);
else
SetEOLMode(wxSTC_EOL_LF);
}
//else: Use the default EOL for the current platform.
SetValue(text);
EmptyUndoBuffer();
SetSavePoint();
return true;
}
}
#endif // !wxUSE_FFILE && !wxUSE_FILE
return false;
}
// If we don't derive from wxTextAreaBase, we need to implement these methods
// ourselves, otherwise we already inherit them.
#if !wxUSE_TEXTCTRL
bool wxStyledTextCtrl::SaveFile(const wxString& filename)
{
if ( filename.empty() )
return false;
return DoSaveFile(filename, wxTEXT_TYPE_ANY);
}
bool wxStyledTextCtrl::LoadFile(const wxString& filename)
{
if ( filename.empty() )
return false;
return DoLoadFile(filename, wxTEXT_TYPE_ANY);
}
#endif // !wxUSE_TEXTCTRL
#if wxUSE_DRAG_AND_DROP
wxDragResult wxStyledTextCtrl::DoDragEnter(wxCoord x, wxCoord y, wxDragResult def) {
return m_swx->DoDragEnter(x, y, def);
}
wxDragResult wxStyledTextCtrl::DoDragOver(wxCoord x, wxCoord y, wxDragResult def) {
return m_swx->DoDragOver(x, y, def);
}
void wxStyledTextCtrl::DoDragLeave() {
m_swx->DoDragLeave();
}
bool wxStyledTextCtrl::DoDropText(long x, long y, const wxString& data) {
return m_swx->DoDropText(x, y, data);
}
#endif
void wxStyledTextCtrl::SetUseAntiAliasing(bool useAA) {
m_swx->SetUseAntiAliasing(useAA);
}
bool wxStyledTextCtrl::GetUseAntiAliasing() {
return m_swx->GetUseAntiAliasing();
}
void wxStyledTextCtrl::AnnotationClearLine(int line) {
SendMsg(SCI_ANNOTATIONSETTEXT, line, (sptr_t)NULL);
}
void wxStyledTextCtrl::AddTextRaw(const char* text, int length)
{
if (length == -1)
length = strlen(text);
SendMsg(SCI_ADDTEXT, length, (sptr_t)text);
}
void wxStyledTextCtrl::InsertTextRaw(int pos, const char* text)
{
SendMsg(SCI_INSERTTEXT, pos, (sptr_t)text);
}
wxCharBuffer wxStyledTextCtrl::GetCurLineRaw(int* linePos)
{
int len = LineLength(GetCurrentLine());
if (!len) {
if (linePos) *linePos = 0;
wxCharBuffer empty;
return empty;
}
wxCharBuffer buf(len);
int pos = SendMsg(SCI_GETCURLINE, len, (sptr_t)buf.data());
if (linePos) *linePos = pos;
return buf;
}
wxCharBuffer wxStyledTextCtrl::GetLineRaw(int line)
{
int len = LineLength(line);
if (!len) {
wxCharBuffer empty;
return empty;
}
wxCharBuffer buf(len);
SendMsg(SCI_GETLINE, line, (sptr_t)buf.data());
return buf;
}
wxCharBuffer wxStyledTextCtrl::GetSelectedTextRaw()
{
// Calculate the length needed first.
const int len = SendMsg(SCI_GETSELTEXT, 0, (sptr_t)0);
// And then really get the data.
wxCharBuffer buf(len);
SendMsg(SCI_GETSELTEXT, 0, (sptr_t)buf.data());
return buf;
}
wxCharBuffer wxStyledTextCtrl::GetTargetTextRaw()
{
// Calculate the length needed first.
const int len = SendMsg(SCI_GETTARGETEND, 0, 0) - SendMsg(SCI_GETTARGETSTART, 0, 0);
// And then really get the data.
wxCharBuffer buf(len);
SendMsg(SCI_GETTARGETTEXT, 0, (sptr_t)buf.data());
return buf;
}
wxCharBuffer wxStyledTextCtrl::GetTextRangeRaw(int startPos, int endPos)
{
if (endPos < startPos) {
wxSwap(startPos, endPos);
}
int len = endPos - startPos;
if (!len) {
wxCharBuffer empty;
return empty;
}
wxCharBuffer buf(len);
Sci_TextRange tr;
tr.lpstrText = buf.data();
tr.chrg.cpMin = startPos;
tr.chrg.cpMax = endPos;
tr.lpstrText[0] = '\0'; // initialize with 0 in case the range is invalid
SendMsg(SCI_GETTEXTRANGE, 0, (sptr_t)&tr);
return buf;
}
void wxStyledTextCtrl::SetTextRaw(const char* text)
{
SendMsg(SCI_SETTEXT, 0, (sptr_t)text);
}
wxCharBuffer wxStyledTextCtrl::GetTextRaw()
{
int len = GetTextLength();
wxCharBuffer buf(len); // adds 1 for NUL automatically
SendMsg(SCI_GETTEXT, len + 1, (sptr_t)buf.data());
return buf;
}
void wxStyledTextCtrl::AppendTextRaw(const char* text, int length)
{
if (length == -1)
length = strlen(text);
SendMsg(SCI_APPENDTEXT, length, (sptr_t)text);
}
#if WXWIN_COMPATIBILITY_3_0
// Deprecated since Scintilla 3.7.2
void wxStyledTextCtrl::UsePopUp(bool allowPopUp)
{
SendMsg(SCI_USEPOPUP, allowPopUp ? SC_POPUP_ALL : SC_POPUP_NEVER, 0);
}
void wxStyledTextCtrl::StartStyling(int start, int unused)
{
wxASSERT_MSG(unused==0,
"The second argument passed to StartStyling should be 0");
SendMsg(SCI_STARTSTYLING, start, unused);
}
#endif // WXWIN_COMPATIBILITY_3_0
//----------------------------------------------------------------------
// Event handlers
void wxStyledTextCtrl::OnPaint(wxPaintEvent& WXUNUSED(evt)) {
#ifdef __WXGTK__
wxBufferedPaintDC dc(this);
#else
wxPaintDC dc(this);
#endif
m_swx->DoPaint(&dc, GetUpdateRegion().GetBox());
}
void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent& evt) {
if (evt.GetOrientation() == wxHORIZONTAL)
m_swx->DoHScroll(evt.GetEventType(), evt.GetPosition());
else
m_swx->DoVScroll(evt.GetEventType(), evt.GetPosition());
}
void wxStyledTextCtrl::OnScroll(wxScrollEvent& evt) {
wxScrollBar* sb = wxDynamicCast(evt.GetEventObject(), wxScrollBar);
if (sb) {
if (sb->IsVertical())
m_swx->DoVScroll(evt.GetEventType(), evt.GetPosition());
else
m_swx->DoHScroll(evt.GetEventType(), evt.GetPosition());
}
}
void wxStyledTextCtrl::OnSize(wxSizeEvent& WXUNUSED(evt)) {
if (m_swx) {
wxSize sz = GetClientSize();
m_swx->DoSize(sz.x, sz.y);
}
}
void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent& evt) {
SetFocus();
wxPoint pt = evt.GetPosition();
m_swx->DoLeftButtonDown(Point(pt.x, pt.y), m_stopWatch.Time(),
evt.ShiftDown(), evt.ControlDown(), evt.AltDown());
}
void wxStyledTextCtrl::OnMouseRightDown(wxMouseEvent& evt) {
SetFocus();
wxPoint pt = evt.GetPosition();
m_swx->DoRightButtonDown(Point(pt.x, pt.y), m_stopWatch.Time(),
evt.ShiftDown(), evt.ControlDown(), evt.AltDown());
// We need to call evt.Skip() to allow generating EVT_CONTEXT_MENU
evt.Skip();
}
void wxStyledTextCtrl::OnMouseMove(wxMouseEvent& evt) {
wxPoint pt = evt.GetPosition();
m_swx->DoLeftButtonMove(Point(pt.x, pt.y));
}
void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent& evt) {
wxPoint pt = evt.GetPosition();
m_swx->DoLeftButtonUp(Point(pt.x, pt.y), m_stopWatch.Time(),
evt.ControlDown());
}
void wxStyledTextCtrl::OnMouseMiddleUp(wxMouseEvent& evt) {
wxPoint pt = evt.GetPosition();
m_swx->DoMiddleButtonUp(Point(pt.x, pt.y));
}
void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent& evt) {
wxPoint pt = evt.GetPosition();
ScreenToClient(&pt.x, &pt.y);
/*
Show context menu at event point if it's within the window,
or at caret location if not
*/
wxHitTest ht = this->HitTest(pt);
if (ht != wxHT_WINDOW_INSIDE) {
pt = this->PointFromPosition(this->GetCurrentPos());
}
if ( !m_swx->DoContextMenu(Point(pt.x, pt.y)) )
evt.Skip();
}
void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent& evt)
{
// if the mouse wheel is not captured, test if the mouse
// pointer is over the editor window and if not, don't
// handle the message but pass it on.
if ( !GetMouseWheelCaptures() ) {
if ( !GetRect().Contains(evt.GetPosition()) ) {
wxWindow* parent = GetParent();
if (parent != NULL) {
wxMouseEvent newevt(evt);
newevt.SetPosition(
parent->ScreenToClient(ClientToScreen(evt.GetPosition())));
parent->ProcessWindowEvent(newevt);
}
return;
}
}
m_swx->DoMouseWheel(evt.GetWheelAxis(),
evt.GetWheelRotation(),
evt.GetWheelDelta(),
evt.GetLinesPerAction(),
evt.GetColumnsPerAction(),
evt.ControlDown(),
evt.IsPageScroll());
}
void wxStyledTextCtrl::OnChar(wxKeyEvent& evt) {
// On (some?) non-US PC keyboards the AltGr key is required to enter some
// common characters. It comes to us as both Alt and Ctrl down so we need
// to let the char through in that case, otherwise if only ctrl or only
// alt let's skip it.
bool ctrl = evt.ControlDown();
#ifdef __WXMAC__
// On the Mac the Alt key is just a modifier key (like Shift) so we need
// to allow the char events to be processed when Alt is pressed.
// TODO: Should we check MetaDown instead in this case?
bool alt = false;
#else
bool alt = evt.AltDown();
#endif
bool skip = ((ctrl || alt) && ! (ctrl && alt));
#if wxUSE_UNICODE
// apparently if we don't do this, Unicode keys pressed after non-char
// ASCII ones (e.g. Enter, Tab) are not taken into account (patch 1615989)
if (m_lastKeyDownConsumed && evt.GetUnicodeKey() > 255)
m_lastKeyDownConsumed = false;
#endif
if (!m_lastKeyDownConsumed && !skip) {
#if wxUSE_UNICODE
int key = evt.GetUnicodeKey();
bool keyOk = true;
// if the unicode key code is not really a unicode character (it may
// be a function key or etc., the platforms appear to always give us a
// small value in this case) then fallback to the ascii key code but
// don't do anything for function keys or etc.
if (key <= 127) {
key = evt.GetKeyCode();
keyOk = (key <= 127);
}
if (keyOk) {
m_swx->DoAddChar(key);
return;
}
#else
int key = evt.GetKeyCode();
if (key < WXK_START) {
m_swx->DoAddChar(key);
return;
}
#endif
}
evt.Skip();
}
void wxStyledTextCtrl::OnKeyDown(wxKeyEvent& evt) {
int processed = m_swx->DoKeyDown(evt, &m_lastKeyDownConsumed);
if (!processed && !m_lastKeyDownConsumed)
evt.Skip();
}
void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent& evt) {
m_swx->DoLoseFocus();
evt.Skip();
}
void wxStyledTextCtrl::OnGainFocus(wxFocusEvent& evt) {
m_swx->DoGainFocus();
evt.Skip();
}
void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(evt)) {
m_swx->DoSysColourChange();
}
void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent& WXUNUSED(evt)) {
// do nothing to help avoid flashing
}
void wxStyledTextCtrl::OnMenu(wxCommandEvent& evt) {
m_swx->DoCommand(evt.GetId());
}
void wxStyledTextCtrl::OnListBox(wxCommandEvent& WXUNUSED(evt)) {
m_swx->DoOnListBox();
}
void wxStyledTextCtrl::OnIdle(wxIdleEvent& evt) {
m_swx->DoOnIdle(evt);
}
wxSize wxStyledTextCtrl::DoGetBestSize() const
{
// What would be the best size for a wxSTC?
// Just give a reasonable minimum until something else can be figured out.
return wxSize(200,100);
}
//----------------------------------------------------------------------
// Turn notifications from Scintilla into events
void wxStyledTextCtrl::NotifyChange() {
wxStyledTextEvent evt(wxEVT_STC_CHANGE, GetId());
evt.SetEventObject(this);
GetEventHandler()->ProcessEvent(evt);
}
static void SetEventText(wxStyledTextEvent& evt, const char* text,
size_t length) {
if(!text) return;
evt.SetString(stc2wx(text, length));
}
void wxStyledTextCtrl::NotifyParent(SCNotification* _scn) {
SCNotification& scn = *_scn;
wxStyledTextEvent evt(0, GetId());
evt.SetEventObject(this);
evt.SetPosition(scn.position);
evt.SetKey(scn.ch);
evt.SetModifiers(scn.modifiers);
switch (scn.nmhdr.code) {
case SCN_STYLENEEDED:
evt.SetEventType(wxEVT_STC_STYLENEEDED);
break;
case SCN_CHARADDED:
evt.SetEventType(wxEVT_STC_CHARADDED);
break;
case SCN_SAVEPOINTREACHED:
evt.SetEventType(wxEVT_STC_SAVEPOINTREACHED);
break;
case SCN_SAVEPOINTLEFT:
evt.SetEventType(wxEVT_STC_SAVEPOINTLEFT);
break;
case SCN_MODIFYATTEMPTRO:
evt.SetEventType(wxEVT_STC_ROMODIFYATTEMPT);
break;
case SCN_DOUBLECLICK:
evt.SetEventType(wxEVT_STC_DOUBLECLICK);
evt.SetLine(scn.line);
break;
case SCN_UPDATEUI:
evt.SetEventType(wxEVT_STC_UPDATEUI);
evt.SetUpdated(scn.updated);
break;
case SCN_MODIFIED:
evt.SetEventType(wxEVT_STC_MODIFIED);
evt.SetModificationType(scn.modificationType);
SetEventText(evt, scn.text, scn.length);
evt.SetLength(scn.length);
evt.SetLinesAdded(scn.linesAdded);
evt.SetLine(scn.line);
evt.SetFoldLevelNow(scn.foldLevelNow);
evt.SetFoldLevelPrev(scn.foldLevelPrev);
evt.SetToken(scn.token);
evt.SetAnnotationLinesAdded(scn.annotationLinesAdded);
break;
case SCN_MACRORECORD:
evt.SetEventType(wxEVT_STC_MACRORECORD);
evt.SetMessage(scn.message);
evt.SetWParam(scn.wParam);
evt.SetLParam(scn.lParam);
break;
case SCN_MARGINCLICK:
evt.SetEventType(wxEVT_STC_MARGINCLICK);
evt.SetMargin(scn.margin);
break;
case SCN_NEEDSHOWN:
evt.SetEventType(wxEVT_STC_NEEDSHOWN);
evt.SetLength(scn.length);
break;
case SCN_PAINTED:
evt.SetEventType(wxEVT_STC_PAINTED);
break;
case SCN_USERLISTSELECTION:
evt.SetEventType(wxEVT_STC_USERLISTSELECTION);
evt.SetListType(scn.listType);
SetEventText(evt, scn.text, strlen(scn.text));
evt.SetPosition(scn.lParam);
evt.SetListCompletionMethod(scn.listCompletionMethod);
break;
case SCN_DWELLSTART:
evt.SetEventType(wxEVT_STC_DWELLSTART);
evt.SetX(scn.x);
evt.SetY(scn.y);
break;
case SCN_DWELLEND:
evt.SetEventType(wxEVT_STC_DWELLEND);
evt.SetX(scn.x);
evt.SetY(scn.y);
break;
case SCN_ZOOM:
evt.SetEventType(wxEVT_STC_ZOOM);
break;
case SCN_HOTSPOTCLICK:
evt.SetEventType(wxEVT_STC_HOTSPOT_CLICK);
break;
case SCN_HOTSPOTDOUBLECLICK:
evt.SetEventType(wxEVT_STC_HOTSPOT_DCLICK);
break;
case SCN_HOTSPOTRELEASECLICK:
evt.SetEventType(wxEVT_STC_HOTSPOT_RELEASE_CLICK);
break;
case SCN_INDICATORCLICK:
evt.SetEventType(wxEVT_STC_INDICATOR_CLICK);
break;
case SCN_INDICATORRELEASE:
evt.SetEventType(wxEVT_STC_INDICATOR_RELEASE);
break;
case SCN_CALLTIPCLICK:
evt.SetEventType(wxEVT_STC_CALLTIP_CLICK);
break;
case SCN_AUTOCSELECTION:
evt.SetEventType(wxEVT_STC_AUTOCOMP_SELECTION);
evt.SetListType(scn.listType);
SetEventText(evt, scn.text, strlen(scn.text));
evt.SetPosition(scn.lParam);
evt.SetListCompletionMethod(scn.listCompletionMethod);
break;
case SCN_AUTOCCANCELLED:
evt.SetEventType(wxEVT_STC_AUTOCOMP_CANCELLED);
break;
case SCN_AUTOCCHARDELETED:
evt.SetEventType(wxEVT_STC_AUTOCOMP_CHAR_DELETED);
break;
case SCN_AUTOCCOMPLETED:
evt.SetEventType(wxEVT_STC_AUTOCOMP_COMPLETED);
evt.SetListType(scn.listType);
SetEventText(evt, scn.text, strlen(scn.text));
evt.SetPosition(scn.lParam);
evt.SetListCompletionMethod(scn.listCompletionMethod);
break;
case SCN_MARGINRIGHTCLICK:
evt.SetEventType(wxEVT_STC_MARGIN_RIGHT_CLICK);
evt.SetMargin(scn.margin);
break;
default:
return;
}
GetEventHandler()->ProcessEvent(evt);
}
//----------------------------------------------------------------------
//----------------------------------------------------------------------
//----------------------------------------------------------------------
wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType, int id)
: wxCommandEvent(commandType, id)
{
m_position = 0;
m_key = 0;
m_modifiers = 0;
m_modificationType = 0;
m_length = 0;
m_linesAdded = 0;
m_line = 0;
m_foldLevelNow = 0;
m_foldLevelPrev = 0;
m_margin = 0;
m_message = 0;
m_wParam = 0;
m_lParam = 0;
m_listType = 0;
m_x = 0;
m_y = 0;
m_token = 0;
m_annotationLinesAdded = 0;
m_updated = 0;
m_listCompletionMethod = 0;
#if wxUSE_DRAG_AND_DROP
m_dragFlags = wxDrag_CopyOnly;
m_dragResult = wxDragNone;
#endif
}
bool wxStyledTextEvent::GetShift() const { return (m_modifiers & SCI_SHIFT) != 0; }
bool wxStyledTextEvent::GetControl() const { return (m_modifiers & SCI_CTRL) != 0; }
bool wxStyledTextEvent::GetAlt() const { return (m_modifiers & SCI_ALT) != 0; }
wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent& event):
wxCommandEvent(event)
{
m_position = event.m_position;
m_key = event.m_key;
m_modifiers = event.m_modifiers;
m_modificationType = event.m_modificationType;
m_length = event.m_length;
m_linesAdded = event.m_linesAdded;
m_line = event.m_line;
m_foldLevelNow = event.m_foldLevelNow;
m_foldLevelPrev = event.m_foldLevelPrev;
m_margin = event.m_margin;
m_message = event.m_message;
m_wParam = event.m_wParam;
m_lParam = event.m_lParam;
m_listType = event.m_listType;
m_x = event.m_x;
m_y = event.m_y;
m_token = event.m_token;
m_annotationLinesAdded = event.m_annotationLinesAdded;
m_updated = event.m_updated;
m_listCompletionMethod = event.m_listCompletionMethod;
#if wxUSE_DRAG_AND_DROP
m_dragFlags = event.m_dragFlags;
m_dragResult = event.m_dragResult;
#endif
}
//----------------------------------------------------------------------
//----------------------------------------------------------------------
/*static*/ wxVersionInfo wxStyledTextCtrl::GetLibraryVersionInfo()
{
return wxVersionInfo("Scintilla", 3, 7, 2, "Scintilla 3.7.2");
}
#endif // wxUSE_STC