# QsciScintillaBase Class Reference

The QsciScintillaBase class implements the Scintilla editor widget and its low-level API. More...

`#include <qsciscintillabase.h>`

Inherited by QsciScintilla.

List of all members.

## Public Types

- enum {
  SCI_START = 2000, SCI_OPTIONAL_START = 3000, SCI_LEXER_START = 4000,
  SCI_ADDTEXT = 2001, SCI_ADDSTYLEDTEXT = 2002, SCI_INSERTTEXT = 2003,
  SCI_CLEARALL = 2004, SCI_CLEARDOCUMENTSTYLE = 2005, SCI_GETLENGTH = 2006,
  SCI_GETCHARAT = 2007, SCI_GETCURRENTPOS = 2008, SCI_GETANCHOR = 2009,
  SCI_GETSTYLEAT = 2010, SCI_REDO = 2011, SCI_SETUNDOCOLLECTION = 2012,
  SCI_SELECTALL = 2013, SCI_SETSAVEPOINT = 2014, SCI_GETSTYLEDTEXT = 2015,
  SCI_CANREDO = 2016, SCI_MARKERLINEFROMHANDLE = 2017, SCI_MARKERDELETEHANDLE = 2018,
  SCI_GETUNDOCOLLECTION = 2019, SCI_GETVIEWWS = 2020, SCI_SETVIEWWS = 2021,
  SCI_POSITIONFROMPOINT = 2022, SCI_POSITIONFROMPOINTCLOSE = 2023, SCI_GOTOLINE = 2024,
  SCI_GOTOPOS = 2025, SCI_SETANCHOR = 2026, SCI_GETCURLINE = 2027,
  SCI_GETENDSTYLED = 2028, SCI_CONVERTEOLS = 2029, SCI_GETEOLMODE = 2030,
  SCI_SETEOLMODE = 2031, SCI_STARTSTYLING = 2032, SCI_SETSTYLING = 2033,
  SCI_GETBUFFEREDDRAW = 2034, SCI_SETBUFFEREDDRAW = 2035, SCI_SETTABWIDTH = 2036,
  SCI_GETTABWIDTH = 2121, SCI_SETCODEPAGE = 2037, SCI_SETUSEPALETTE = 2039,
  SCI_MARKERDEFINE = 2040, SCI_MARKERSETFORE = 2041, SCI_MARKERSETBACK = 2042,
  SCI_MARKERADD = 2043, SCI_MARKERDELETE = 2044, SCI_MARKERDELETEALL = 2045,
  SCI_MARKERGET = 2046, SCI_MARKERNEXT = 2047, SCI_MARKERPREVIOUS = 2048,
  SCI_MARKERDEFINEPIXMAP = 2049, SCI_SETMARGINTYPEN = 2240, SCI_GETMARGINTYPEN = 2241,
  SCI_SETMARGINWIDTHN = 2242, SCI_GETMARGINWIDTHN = 2243, SCI_SETMARGINMASKN = 2244,
  SCI_GETMARGINMASKN = 2245, SCI_SETMARGINSENSITIVEN = 2246, SCI_GETMARGINSENSITIVEN = 2247,
  SCI_STYLECLEARALL = 2050, SCI_STYLESETFORE = 2051, SCI_STYLESETBACK = 2052,
  SCI_STYLESETBOLD = 2053, SCI_STYLESETITALIC = 2054, SCI_STYLESETSIZE = 2055,
  SCI_STYLESETFONT = 2056, SCI_STYLESETEOLFILLED = 2057, SCI_STYLERESETDEFAULT = 2058,
  SCI_STYLESETUNDERLINE = 2059, SCI_STYLESETCASE = 2060, SCI_STYLESETCHARACTERSET = 2066,
  SCI_SETSELFORE = 2067, SCI_SETSELBACK = 2068, SCI_SETCARETFORE = 2069,
  SCI_ASSIGNCMDKEY = 2070, SCI_CLEARCMDKEY = 2071, SCI_CLEARALLCMDKEYS = 2072,
  SCI_SETSTYLINGEX = 2073, SCI_STYLESETVISIBLE = 2074, SCI_GETCARETPERIOD = 2075,
  SCI_SETCARETPERIOD = 2076, SCI_SETWORDCHARS = 2077, SCI_BEGINUNDOACTION = 2078,
  SCI_ENDUNDOACTION = 2079, SCI_INDICSETSTYLE = 2080, SCI_INDICGETSTYLE = 2081,
  SCI_INDICSETFORE = 2082, SCI_INDICGETFORE = 2083, SCI_SETWHITESPACEFORE = 2084,
  SCI_SETWHITESPACEBACK = 2085, SCI_SETSTYLEBITS = 2090, SCI_GETSTYLEBITS = 2091,
  SCI_SETLINESTATE = 2092, SCI_GETLINESTATE = 2093, SCI_GETMAXLINESTATE = 2094,
  SCI_GETCARETLINEVISIBLE = 2095, SCI_SETCARETLINEVISIBLE = 2096, SCI_GETCARETLINEBACK = 2097,
  SCI_SETCARETLINEBACK = 2098, SCI_STYLESETCHANGEABLE = 2099, SCI_AUTOCSHOW = 2100,
  SCI_AUTOCCANCEL = 2101, SCI_AUTOCACTIVE = 2102, SCI_AUTOCPOSSTART = 2103,
  SCI_AUTOCCOMPLETE = 2104, SCI_AUTOCSTOPS = 2105, SCI_AUTOCSETSEPARATOR = 2106,
  SCI_AUTOCGETSEPARATOR = 2107, SCI_AUTOCSELECT = 2108, SCI_AUTOCSETCANCELATSTART = 2110,
  SCI_AUTOCGETCANCELATSTART = 2111, SCI_AUTOCSETFILLUPS = 2112, SCI_AUTOCSETCHOOSESINGLE = 2113,
  SCI_AUTOCGETCHOOSESINGLE = 2114, SCI_AUTOCSETIGNORECASE = 2115, SCI_AUTOCGETIGNORECASE = 2116,
  SCI_USERLISTSHOW = 2117, SCI_AUTOCSETAUTOHIDE = 2118, SCI_AUTOCGETAUTOHIDE = 2119,
  SCI_AUTOCSETDROPRESTOFWORD = 2270, SCI_AUTOCGETDROPRESTOFWORD = 2271, SCI_SETINDENT = 2122,
  SCI_GETINDENT = 2123, SCI_SETUSETABS = 2124, SCI_GETUSETABS = 2125,
  SCI_SETLINEINDENTATION = 2126, SCI_GETLINEINDENTATION = 2127, SCI_GETLINEINDENTPOSITION = 2128,
  SCI_GETCOLUMN = 2129, SCI_SETHSCROLLBAR = 2130, SCI_GETHSCROLLBAR = 2131,
  SCI_SETINDENTATIONGUIDES = 2132, SCI_GETINDENTATIONGUIDES = 2133, SCI_SETHIGHLIGHTGUIDE = 2134,
  SCI_GETHIGHLIGHTGUIDE = 2135, SCI_GETLINEENDPOSITION = 2136, SCI_GETCODEPAGE = 2137,
  SCI_GETCARETFORE = 2138, SCI_GETUSEPALETTE = 2139, SCI_GETREADONLY = 2140,
  SCI_SETCURRENTPOS = 2141, SCI_SETSELECTIONSTART = 2142, SCI_GETSELECTIONSTART = 2143,
  SCI_SETSELECTIONEND = 2144, SCI_GETSELECTIONEND = 2145, SCI_SETPRINTMAGNIFICATION = 2146,
  SCI_GETPRINTMAGNIFICATION = 2147, SCI_SETPRINTCOLOURMODE = 2148, SCI_GETPRINTCOLOURMODE = 2149,
  SCI_FINDTEXT = 2150, SCI_FORMATRANGE = 2151, SCI_GETFIRSTVISIBLELINE = 2152,
  SCI_GETLINE = 2153, SCI_GETLINECOUNT = 2154, SCI_SETMARGINLEFT = 2155,
  SCI_GETMARGINLEFT = 2156, SCI_SETMARGINRIGHT = 2157, SCI_GETMARGINRIGHT = 2158,
  SCI_GETMODIFY = 2159, SCI_SETSEL = 2160, SCI_GETSELTEXT = 2161,
  SCI_GETTEXTRANGE = 2162, SCI_HIDESELECTION = 2163, SCI_POINTXFROMPOSITION = 2164,
  SCI_POINTYFROMPOSITION = 2165, SCI_LINEFROMPOSITION = 2166, SCI_POSITIONFROMLINE = 2167,
  SCI_LINESCROLL = 2168, SCI_SCROLLCARET = 2169, SCI_REPLACESEL = 2170,
  SCI_SETREADONLY = 2171, SCI_NULL = 2172, SCI_CANPASTE = 2173,
  SCI_CANUNDO = 2174, SCI_EMPTYUNDOBUFFER = 2175, SCI_UNDO = 2176,
  SCI_CUT = 2177, SCI_COPY = 2178, SCI_PASTE = 2179,
  SCI_CLEAR = 2180, SCI_SETTEXT = 2181, SCI_GETTEXT = 2182,
  SCI_GETTEXTLENGTH = 2183, SCI_GETDIRECTFUNCTION = 2184, SCI_GETDIRECTPOINTER = 2185,
  SCI_SETOVERTYPE = 2186, SCI_GETOVERTYPE = 2187, SCI_SETCARETWIDTH = 2188,
  SCI_GETCARETWIDTH = 2189, SCI_SETTARGETSTART = 2190, SCI_GETTARGETSTART = 2191,
  SCI_SETTARGETEND = 2192, SCI_GETTARGETEND = 2193, SCI_REPLACETARGET = 2194,
  SCI_REPLACETARGETRE = 2195, SCI_SEARCHINTARGET = 2197, SCI_SETSEARCHFLAGS = 2198,
  SCI_GETSEARCHFLAGS = 2199, SCI_CALLTIPSHOW = 2200, SCI_CALLTIPCANCEL = 2201,
  SCI_CALLTIPACTIVE = 2202, SCI_CALLTIPPOSSTART = 2203, SCI_CALLTIPSETHLT = 2204,
  SCI_CALLTIPSETBACK = 2205, SCI_CALLTIPSETFORE = 2206, SCI_CALLTIPSETFOREHLT = 2207,
  SCI_AUTOCSETMAXWIDTH = 2208, SCI_AUTOCGETMAXWIDTH = 2209, SCI_AUTOCSETMAXHEIGHT = 2210,
  SCI_AUTOCGETMAXHEIGHT = 2211, SCI_CALLTIPUSESTYLE = 2212, SCI_VISIBLEFROMDOCLINE = 2220,
  SCI_DOCLINEFROMVISIBLE = 2221, SCI_SETFOLDLEVEL = 2222, SCI_GETFOLDLEVEL = 2223,
  SCI_GETLASTCHILD = 2224, SCI_GETFOLDPARENT = 2225, SCI_SHOWLINES = 2226,
  SCI_HIDELINES = 2227, SCI_GETLINEVISIBLE = 2228, SCI_SETFOLDEXPANDED = 2229,
  SCI_GETFOLDEXPANDED = 2230, SCI_TOGGLEFOLD = 2231, SCI_ENSUREVISIBLE = 2232,
  SCI_SETFOLDFLAGS = 2233, SCI_ENSUREVISIBLEENFORCEPOLICY = 2234, SCI_WRAPCOUNT = 2235,
  SCI_SETTABINDENTS = 2260, SCI_GETTABINDENTS = 2261, SCI_SETBACKSPACEUNINDENTS = 2262,
  SCI_GETBACKSPACEUNINDENTS = 2263, SCI_SETMOUSEDWELLTIME = 2264, SCI_GETMOUSEDWELLTIME = 2265,
  SCI_WORDSTARTPOSITION = 2266, SCI_WORDENDPOSITION = 2267, SCI_SETWRAPMODE = 2268,
  SCI_GETWRAPMODE = 2269, SCI_SETLAYOUTCACHE = 2272, SCI_GETLAYOUTCACHE = 2273,
  SCI_SETSCROLLWIDTH = 2274, SCI_GETSCROLLWIDTH = 2275, SCI_TEXTWIDTH = 2276,
  SCI_SETENDATLASTLINE = 2277, SCI_GETENDATLASTLINE = 2278, SCI_TEXTHEIGHT = 2279,
  SCI_SETVSCROLLBAR = 2280, SCI_GETVSCROLLBAR = 2281, SCI_APPENDTEXT = 2282,
  SCI_GETTWOPHASEDRAW = 2283, SCI_SETTWOPHASEDRAW = 2284, SCI_AUTOCGETTYPESEPARATOR = 2285,
  SCI_AUTOCSETTYPESEPARATOR = 2286, SCI_TARGETFROMSELECTION = 2287, SCI_LINESJOIN = 2288,
  SCI_LINESSPLIT = 2289, SCI_SETFOLDMARGINCOLOUR = 2290, SCI_SETFOLDMARGINHICOLOUR = 2291,
  SCI_LINEDOWN = 2300, SCI_LINEDOWNEXTEND = 2301, SCI_LINEUP = 2302,
  SCI_LINEUPEXTEND = 2303, SCI_CHARLEFT = 2304, SCI_CHARLEFTEXTEND = 2305,
  SCI_CHARRIGHT = 2306, SCI_CHARRIGHTEXTEND = 2307, SCI_WORDLEFT = 2308,
  SCI_WORDLEFTEXTEND = 2309, SCI_WORDRIGHT = 2310, SCI_WORDRIGHTEXTEND = 2311,
  SCI_HOME = 2312, SCI_HOMEEXTEND = 2313, SCI_LINEEND = 2314,
  SCI_LINEENDEXTEND = 2315, SCI_DOCUMENTSTART = 2316, SCI_DOCUMENTSTARTEXTEND = 2317,
  SCI_DOCUMENTEND = 2318, SCI_DOCUMENTENDEXTEND = 2319, SCI_PAGEUP = 2320,
  SCI_PAGEUPEXTEND = 2321, SCI_PAGEDOWN = 2322, SCI_PAGEDOWNEXTEND = 2323,
  SCI_EDITTOGGLEOVERTYPE = 2324, SCI_CANCEL = 2325, SCI_DELETEBACK = 2326,
  SCI_TAB = 2327, SCI_BACKTAB = 2328, SCI_NEWLINE = 2329,
  SCI_FORMFEED = 2330, SCI_VCHOME = 2331, SCI_VCHOMEEXTEND = 2332,
  SCI_ZOOMIN = 2333, SCI_ZOOMOUT = 2334, SCI_DELWORDLEFT = 2335,
  SCI_DELWORDRIGHT = 2336, SCI_LINECUT = 2337, SCI_LINEDELETE = 2338,
  SCI_LINETRANSPOSE = 2339, SCI_LOWERCASE = 2340, SCI_UPPERCASE = 2341,
  SCI_LINESCROLLDOWN = 2342, SCI_LINESCROLLUP = 2343, SCI_DELETEBACKNOTLINE = 2344,
  SCI_HOMEDISPLAY = 2345, SCI_HOMEDISPLAYEXTEND = 2346, SCI_LINEENDDISPLAY = 2347,
  SCI_LINEENDDISPLAYEXTEND = 2348, SCI_MOVECARETINSIDEVIEW = 2401, SCI_LINELENGTH = 2350,
  SCI_BRACEHIGHLIGHT = 2351, SCI_BRACEBADLIGHT = 2352, SCI_BRACEMATCH = 2353,
  SCI_GETVIEWEOL = 2355, SCI_SETVIEWEOL = 2356, SCI_GETDOCPOINTER = 2357,
  SCI_SETDOCPOINTER = 2358, SCI_SETMODEVENTMASK = 2359, SCI_GETEDGECOLUMN = 2360,
  SCI_SETEDGECOLUMN = 2361, SCI_GETEDGEMODE = 2362, SCI_SETEDGEMODE = 2363,
  SCI_GETEDGECOLOUR = 2364, SCI_SETEDGECOLOUR = 2365, SCI_SEARCHANCHOR = 2366,
  SCI_SEARCHNEXT = 2367, SCI_SEARCHPREV = 2368, SCI_LINESONSCREEN = 2370,
  SCI_USEPOPUP = 2371, SCI_SELECTIONISRECTANGLE = 2372, SCI_SETZOOM = 2373,
  SCI_GETZOOM = 2374, SCI_CREATEDOCUMENT = 2375, SCI_ADDREFDOCUMENT = 2376,
  SCI_RELEASEDOCUMENT = 2377, SCI_GETMODEVENTMASK = 2378, SCI_SETFOCUS = 2380,
  SCI_GETFOCUS = 2381, SCI_SETSTATUS = 2382, SCI_GETSTATUS = 2383,
  SCI_SETMOUSEDOWNCAPTURES = 2384, SCI_GETMOUSEDOWNCAPTURES = 2385, SCI_SETCURSOR = 2386,
  SCI_GETCURSOR = 2387, SCI_SETCONTROLCHARSYMBOL = 2388, SCI_GETCONTROLCHARSYMBOL = 2389,
  SCI_WORDPARTLEFT = 2390, SCI_WORDPARTLEFTEXTEND = 2391, SCI_WORDPARTRIGHT = 2392,
  SCI_WORDPARTRIGHTEXTEND = 2393, SCI_SETVISIBLEPOLICY = 2394, SCI_DELLINELEFT = 2395,
  SCI_DELLINERIGHT = 2396, SCI_SETXOFFSET = 2397, SCI_GETXOFFSET = 2398,
  SCI_CHOOSECARETX = 2399, SCI_GRABFOCUS = 2400, SCI_SETXCARETPOLICY = 2402,
  SCI_SETYCARETPOLICY = 2403, SCI_LINEDUPLICATE = 2404, SCI_REGISTERIMAGE = 2405,
  SCI_SETPRINTWRAPMODE = 2406, SCI_GETPRINTWRAPMODE = 2407, SCI_CLEARREGISTEREDIMAGES = 2408,
  SCI_STYLESETHOTSPOT = 2409, SCI_SETHOTSPOTACTIVEFORE = 2410, SCI_SETHOTSPOTACTIVEBACK = 2411,
  SCI_SETHOTSPOTACTIVEUNDERLINE = 2412, SCI_PARADOWN = 2413, SCI_PARADOWNEXTEND = 2414,
  SCI_PARAUP = 2415, SCI_PARAUPEXTEND = 2416, SCI_POSITIONBEFORE = 2417,
  SCI_POSITIONAFTER = 2418, SCI_COPYRANGE = 2419, SCI_COPYTEXT = 2420,
  SCI_SETSELECTIONMODE = 2422, SCI_GETSELECTIONMODE = 2423, SCI_GETLINESELSTARTPOSITION = 2424,
  SCI_GETLINESELENDPOSITION = 2425, SCI_LINEDOWNRECTEXTEND = 2426, SCI_LINEUPRECTEXTEND = 2427,
  SCI_CHARLEFTRECTEXTEND = 2428, SCI_CHARRIGHTRECTEXTEND = 2429, SCI_HOMERECTEXTEND = 2430,
  SCI_VCHOMERECTEXTEND = 2431, SCI_LINEENDRECTEXTEND = 2432, SCI_PAGEUPRECTEXTEND = 2433,
  SCI_PAGEDOWNRECTEXTEND = 2434, SCI_STUTTEREDPAGEUP = 2435, SCI_STUTTEREDPAGEUPEXTEND = 2436,
  SCI_STUTTEREDPAGEDOWN = 2437, SCI_STUTTEREDPAGEDOWNEXTEND = 2438, SCI_WORDLEFTEND = 2439,
  SCI_WORDLEFTENDEXTEND = 2440, SCI_WORDRIGHTEND = 2441, SCI_WORDRIGHTENDEXTEND = 2442,
  SCI_SETWHITESPACECHARS = 2443, SCI_SETCHARSDEFAULT = 2444, SCI_AUTOCGETCURRENT = 2445,
  SCI_ALLOCATE = 2446, SCI_HOMEWRAP = 2349, SCI_HOMEWRAPEXTEND = 2450,
  SCI_LINEENDWRAP = 2451, SCI_LINEENDWRAPEXTEND = 2452, SCI_VCHOMEWRAP = 2453,
  SCI_VCHOMEWRAPEXTEND = 2454, SCI_LINECOPY = 2455, SCI_FINDCOLUMN = 2456,
  SCI_GETCARETSTICKY = 2457, SCI_SETCARETSTICKY = 2458, SCI_TOGGLECARETSTICKY = 2459,
  SCI_SETWRAPVISUALFLAGS = 2460, SCI_GETWRAPVISUALFLAGS = 2461, SCI_SETWRAPVISUALFLAGSLOCATION = 2462,
  SCI_GETWRAPVISUALFLAGSLOCATION = 2463, SCI_SETWRAPSTARTINDENT = 2464, SCI_GETWRAPSTARTINDENT = 2465,
  SCI_MARKERADDSET = 2466, SCI_SETPASTECONVERTENDINGS = 2467, SCI_GETPASTECONVERTENDINGS = 2468,
  SCI_SELECTIONDUPLICATE = 2469, SCI_SETCARETLINEBACKALPHA = 2470, SCI_GETCARETLINEBACKALPHA = 2471,
  SCI_MARKERSETALPHA = 2476, SCI_GETSELALPHA = 2477, SCI_SETSELALPHA = 2478,
  SCI_GETSELEOLFILLED = 2479, SCI_SETSELEOLFILLED = 2480, SCI_STYLEGETFORE = 2481,
  SCI_STYLEGETBACK = 2482, SCI_STYLEGETBOLD = 2483, SCI_STYLEGETITALIC = 2484,
  SCI_STYLEGETSIZE = 2485, SCI_STYLEGETFONT = 2486, SCI_STYLEGETEOLFILLED = 2487,
  SCI_STYLEGETUNDERLINE = 2488, SCI_STYLEGETCASE = 2489, SCI_STYLEGETCHARACTERSET = 2490,
  SCI_STYLEGETVISIBLE = 2491, SCI_STYLEGETCHANGEABLE = 2492, SCI_STYLEGETHOTSPOT = 2493,
  SCI_GETHOTSPOTACTIVEFORE = 2494, SCI_GETHOTSPOTACTIVEBACK = 2495, SCI_GETHOTSPOTACTIVEUNDERLINE = 2496,
  SCI_GETHOTSPOTSINGLELINE = 2497, SCI_SETINDICATORCURRENT = 2500, SCI_GETINDICATORCURRENT = 2501,
  SCI_SETINDICATORVALUE = 2502, SCI_GETINDICATORVALUE = 2503, SCI_INDICATORFILLRANGE = 2504,
  SCI_INDICATORCLEARRANGE = 2505, SCI_INDICATORALLONFOR = 2506, SCI_INDICATORVALUEAT = 2507,
  SCI_INDICATORSTART = 2508, SCI_INDICATOREND = 2509, SCI_INDICSETUNDER = 2510,
  SCI_INDICGETUNDER = 2511, SCI_SETCARETSTYLE = 2512, SCI_GETCARETSTYLE = 2513,
  SCI_SETPOSITIONCACHE = 2514, SCI_GETPOSITIONCACHE = 2515, SCI_SETSCROLLWIDTHTRACKING = 2516,
  SCI_GETSCROLLWIDTHTRACKING = 2517, SCI_DELWORDRIGHTEND = 2518, SCI_COPYALLOWLINE = 2519,
  SCI_GETCHARACTERPOINTER = 2520, SCI_SETKEYSUNICODE = 2521, SCI_GETKEYSUNICODE = 2522,
  SCI_INDICSETALPHA = 2523, SCI_INDICGETALPHA = 2524, SCI_SETEXTRAASCENT = 2525,
  SCI_GETEXTRAASCENT = 2526, SCI_SETEXTRADESCENT = 2527, SCI_GETEXTRADESCENT = 2528,
  SCI_MARKERSYMBOLDEFINED = 2529, SCI_MARGINSETTEXT = 2530, SCI_MARGINGETTEXT = 2531,
  SCI_MARGINSETSTYLE = 2532, SCI_MARGINGETSTYLE = 2533, SCI_MARGINSETSTYLES = 2534,
  SCI_MARGINGETSTYLES = 2535, SCI_MARGINTEXTCLEARALL = 2536, SCI_MARGINSETSTYLEOFFSET = 2537,
  SCI_MARGINGETSTYLEOFFSET = 2538, SCI_ANNOTATIONSETTEXT = 2540, SCI_ANNOTATIONGETTEXT = 2541,
  SCI_ANNOTATIONSETSTYLE = 2542, SCI_ANNOTATIONGETSTYLE = 2543, SCI_ANNOTATIONSETSTYLES = 2544,
  SCI_ANNOTATIONGETSTYLES = 2545, SCI_ANNOTATIONGETLINES = 2546, SCI_ANNOTATIONCLEARALL = 2547,
  SCI_ANNOTATIONSETVISIBLE = 2548, SCI_ANNOTATIONGETVISIBLE = 2549, SCI_ANNOTATIONSETSTYLEOFFSET = 2550,
  SCI_ANNOTATIONGETSTYLEOFFSET = 2551, SCI_ADDUNDOACTION = 2560, SCI_STARTRECORD = 3001,
  SCI_STOPRECORD = 3002, SCI_SETLEXER = 4001, SCI_GETLEXER = 4002,
  SCI_COLOURISE = 4003, SCI_SETPROPERTY = 4004, SCI_SETKEYWORDS = 4005,
  SCI_SETLEXERLANGUAGE = 4006, SCI_LOADLEXERLIBRARY = 4007, SCI_GETPROPERTY = 4008,
  SCI_GETPROPERTYEXPANDED = 4009, SCI_GETPROPERTYINT = 4010, SCI_GETSTYLEBITSNEEDED = 4011
  }
- enum { SC_ALPHA_TRANSPARENT = 0, SC_ALPHA_OPAQUE = 255, SC_ALPHA_NOALPHA = 256 }
- enum { SC_WRAPVISUALFLAG_NONE = 0x0000, SC_WRAPVISUALFLAG_END = 0x0001, SC_WRAPVISUALFLAG_START = 0x0002 }
- enum { SC_WRAPVISUALFLAGLOC_DEFAULT = 0x0000, SC_WRAPVISUALFLAGLOC_END_BY_TEXT = 0x0001, SC_WRAPVISUALFLAGLOC_START_BY_TEXT = 0x0002 }
- enum { SC_SEL_STREAM = 0, SC_SEL_RECTANGLE = 1, SC_SEL_LINES = 2 }
- enum { SCWS_INVISIBLE = 0, SCWS_VISIBLEALWAYS = 1, SCWS_VISIBLEAFTERINDENT = 2 }
- enum { SC_EOL_CRLF = 0, SC_EOL_CR = 1, SC_EOL_LF = 2 }
- enum { SC_CP_DBCS = 1, SC_CP_UTF8 = 65001 }
- enum {
  SC_MARK_CIRCLE = 0, SC_MARK_ROUNDRECT = 1, SC_MARK_ARROW = 2,
  SC_MARK_SMALLRECT = 3, SC_MARK_SHORTARROW = 4, SC_MARK_EMPTY = 5,
  SC_MARK_ARROWDOWN = 6, SC_MARK_MINUS = 7, SC_MARK_PLUS = 8,
  SC_MARK_VLINE = 9, SC_MARK_LCORNER = 10, SC_MARK_TCORNER = 11,
  SC_MARK_BOXPLUS = 12, SC_MARK_BOXPLUSCONNECTED = 13, SC_MARK_BOXMINUS = 14,
  SC_MARK_BOXMINUSCONNECTED = 15, SC_MARK_LCORNERCURVE = 16, SC_MARK_TCORNERCURVE = 17,
  SC_MARK_CIRCLEPLUS = 18, SC_MARK_CIRCLEPLUSCONNECTED = 19, SC_MARK_CIRCLEMINUS = 20,
  SC_MARK_CIRCLEMINUSCONNECTED = 21, SC_MARK_BACKGROUND = 22, SC_MARK_DOTDOTDOT = 23,
  SC_MARK_ARROWS = 24, SC_MARK_PIXMAP = 25, SC_MARK_FULLRECT = 26,
  SC_MARK_LEFTRECT = 27, SC_MARK_AVAILABLE = 28, SC_MARK_CHARACTER = 10000
  }
- enum {
  SC_MARKNUM_FOLDEREND = 25, SC_MARKNUM_FOLDEROPENMID = 26, SC_MARKNUM_FOLDERMIDTAIL = 27,
  SC_MARKNUM_FOLDERTAIL = 28, SC_MARKNUM_FOLDERSUB = 29, SC_MARKNUM_FOLDER = 30,
  SC_MARKNUM_FOLDEROPEN = 31, SC_MASK_FOLDERS = 0xfe000000
  }
- enum {
  SC_MARGIN_SYMBOL = 0, SC_MARGIN_NUMBER = 1, SC_MARGIN_BACK = 2,
  SC_MARGIN_FORE = 3, SC_MARGIN_TEXT = 4, SC_MARGIN_RTEXT = 5
  }
- enum {
  STYLE_DEFAULT = 32, STYLE_LINENUMBER = 33, STYLE_BRACELIGHT = 34,
  STYLE_BRACEBAD = 35, STYLE_CONTROLCHAR = 36, STYLE_INDENTGUIDE = 37,
  STYLE_CALLTIP = 38, STYLE_LASTPREDEFINED = 39, STYLE_MAX = 255
  }
- enum {
  SC_CHARSET_ANSI = 0, SC_CHARSET_DEFAULT = 1, SC_CHARSET_BALTIC = 186,
  SC_CHARSET_CHINESEBIG5 = 136, SC_CHARSET_EASTEUROPE = 238, SC_CHARSET_GB2312 = 134,
  SC_CHARSET_GREEK = 161, SC_CHARSET_HANGUL = 129, SC_CHARSET_MAC = 77,
  SC_CHARSET_OEM = 255, SC_CHARSET_RUSSIAN = 204, SC_CHARSET_SHIFTJIS = 128,
  SC_CHARSET_SYMBOL = 2, SC_CHARSET_TURKISH = 162, SC_CHARSET_JOHAB = 130,
  SC_CHARSET_HEBREW = 177, SC_CHARSET_ARABIC = 178, SC_CHARSET_VIETNAMESE = 163,
  SC_CHARSET_THAI = 222, SC_CHARSET_8859_15 = 1000
  }
- enum { SC_CASE_MIXED = 0, SC_CASE_UPPER = 1, SC_CASE_LOWER = 2 }
- enum {
  SC_IV_NONE = 0, SC_IV_REAL = 1, SC_IV_LOOKFORWARD = 2,
  SC_IV_LOOKBOTH = 3
  }
- enum {
  INDIC_MAX = 31, INDIC_PLAIN = 0, INDIC_SQUIGGLE = 1,
  INDIC_TT = 2, INDIC_DIAGONAL = 3, INDIC_STRIKE = 4,
  INDIC_HIDDEN = 5, INDIC_BOX = 6, INDIC_ROUNDBOX = 7,
  INDIC_CONTAINER = 8, INDIC0_MASK = 0x20, INDIC1_MASK = 0x40,
  INDIC2_MASK = 0x80, INDICS_MASK = 0xe0
  }
- enum {
  SC_PRINT_NORMAL = 0, SC_PRINT_INVERTLIGHT = 1, SC_PRINT_BLACKONWHITE = 2,
  SC_PRINT_COLOURONWHITE = 3, SC_PRINT_COLOURONWHITEDEFAULTBG = 4
  }
- enum {
  SCFIND_WHOLEWORD = 2, SCFIND_MATCHCASE = 4, SCFIND_WORDSTART = 0x00100000,
  SCFIND_REGEXP = 0x00200000, SCFIND_POSIX = 0x00400000
  }
- enum {
  SC_FOLDLEVELBASE = 0x00400, SC_FOLDLEVELWHITEFLAG = 0x01000, SC_FOLDLEVELHEADERFLAG = 0x02000,
  SC_FOLDLEVELNUMBERMASK = 0x00fff
  }
- enum {
  SC_FOLDFLAG_LINEBEFORE_EXPANDED = 0x0002, SC_FOLDFLAG_LINEBEFORE_CONTRACTED = 0x0004, SC_FOLDFLAG_LINEAFTER_EXPANDED = 0x0008,
  SC_FOLDFLAG_LINEAFTER_CONTRACTED = 0x0010, SC_FOLDFLAG_LEVELNUMBERS = 0x0040
  }
- enum { SC_TIME_FOREVER = 10000000 }
- enum { SC_WRAP_NONE = 0, SC_WRAP_WORD = 1, SC_WRAP_CHAR = 2 }
- enum {
  SC_CACHE_NONE = 0, SC_CACHE_CARET = 1, SC_CACHE_PAGE = 2,
  SC_CACHE_DOCUMENT = 3
  }
- enum { ANNOTATION_HIDDEN = 0, ANNOTATION_STANDARD = 1, ANNOTATION_BOXED = 2 }
- enum { EDGE_NONE = 0, EDGE_LINE = 1, EDGE_BACKGROUND = 2 }
- enum { SC_CURSORNORMAL = -1, SC_CURSORWAIT = 4 }
- enum { UNDO_MAY_COALESCE = 1 }
- enum { VISIBLE_SLOP = 0x01, VISIBLE_STRICT = 0x04 }
- enum {
  CARET_SLOP = 0x01, CARET_STRICT = 0x04, CARET_JUMPS = 0x10,
  CARET_EVEN = 0x08
  }
- enum { CARETSTYLE_INVISIBLE = 0, CARETSTYLE_LINE = 1, CARETSTYLE_BLOCK = 2 }
- enum {
  SC_MOD_INSERTTEXT = 0x1, SC_MOD_DELETETEXT = 0x2, SC_MOD_CHANGESTYLE = 0x4,
  SC_MOD_CHANGEFOLD = 0x8, SC_PERFORMED_USER = 0x10, SC_PERFORMED_UNDO = 0x20,
  SC_PERFORMED_REDO = 0x40, SC_MULTISTEPUNDOREDO = 0x80, SC_LASTSTEPINUNDOREDO = 0x100,
  SC_MOD_CHANGEMARKER = 0x200, SC_MOD_BEFOREINSERT = 0x400, SC_MOD_BEFOREDELETE = 0x800,
  SC_MULTILINEUNDOREDO = 0x1000, SC_STARTACTION = 0x2000, SC_MOD_CHANGEINDICATOR = 0x4000,
  SC_MOD_CHANGELINESTATE = 0x8000, SC_MOD_CHANGEMARGIN = 0x10000, SC_MOD_CHANGEANNOTATION = 0x20000,
  SC_MOD_CONTAINER = 0x40000, SC_MODEVENTMASKALL = 0x7ffff
  }
- enum {
  SCK_DOWN = 300, SCK_UP = 301, SCK_LEFT = 302,
  SCK_RIGHT = 303, SCK_HOME = 304, SCK_END = 305,
  SCK_PRIOR = 306, SCK_NEXT = 307, SCK_DELETE = 308,
  SCK_INSERT = 309, SCK_ESCAPE = 7, SCK_BACK = 8,
  SCK_TAB = 9, SCK_RETURN = 13, SCK_ADD = 310,
  SCK_SUBTRACT = 311, SCK_DIVIDE = 312, SCK_WIN = 313,
  SCK_RWIN = 314, SCK_MENU = 315
  }
- enum {
  SCMOD_NORM = 0, SCMOD_SHIFT = 1, SCMOD_CTRL = 2,
  SCMOD_ALT = 4
  }
- enum {
  SCLEX_CONTAINER = 0, SCLEX_NULL = 1, SCLEX_PYTHON = 2,
  SCLEX_CPP = 3, SCLEX_HTML = 4, SCLEX_XML = 5,
  SCLEX_PERL = 6, SCLEX_SQL = 7, SCLEX_VB = 8,
  SCLEX_PROPERTIES = 9, SCLEX_ERRORLIST = 10, SCLEX_MAKEFILE = 11,
  SCLEX_BATCH = 12, SCLEX_LATEX = 14, SCLEX_LUA = 15,
  SCLEX_DIFF = 16, SCLEX_CONF = 17, SCLEX_PASCAL = 18,
  SCLEX_AVE = 19, SCLEX_ADA = 20, SCLEX_LISP = 21,
  SCLEX_RUBY = 22, SCLEX_EIFFEL = 23, SCLEX_EIFFELKW = 24,
  SCLEX_TCL = 25, SCLEX_NNCRONTAB = 26, SCLEX_BULLANT = 27,
  SCLEX_VBSCRIPT = 28, SCLEX_ASP = SCLEX_HTML, SCLEX_PHP = SCLEX_HTML,
  SCLEX_BAAN = 31, SCLEX_MATLAB = 32, SCLEX_SCRIPTOL = 33,
  SCLEX_ASM = 34, SCLEX_CPPNOCASE = 35, SCLEX_FORTRAN = 36,
  SCLEX_F77 = 37, SCLEX_CSS = 38, SCLEX_POV = 39,
  SCLEX_LOUT = 40, SCLEX_ESCRIPT = 41, SCLEX_PS = 42,
  SCLEX_NSIS = 43, SCLEX_MMIXAL = 44, SCLEX_CLW = 45,
  SCLEX_CLWNOCASE = 46, SCLEX_LOT = 47, SCLEX_YAML = 48,
  SCLEX_TEX = 49, SCLEX_METAPOST = 50, SCLEX_POWERBASIC = 51,
  SCLEX_FORTH = 52, SCLEX_ERLANG = 53, SCLEX_OCTAVE = 54,
  SCLEX_MSSQL = 55, SCLEX_VERILOG = 56, SCLEX_KIX = 57,
  SCLEX_GUI4CLI = 58, SCLEX_SPECMAN = 59, SCLEX_AU3 = 60,
  SCLEX_APDL = 61, SCLEX_BASH = 62, SCLEX_ASN1 = 63,
  SCLEX_VHDL = 64, SCLEX_CAML = 65, SCLEX_BLITZBASIC = 66,
  SCLEX_PUREBASIC = 67, SCLEX_HASKELL = 68, SCLEX_PHPSCRIPT = 69,
  SCLEX_TADS3 = 70, SCLEX_REBOL = 71, SCLEX_SMALLTALK = 72,
  SCLEX_FLAGSHIP = 73, SCLEX_CSOUND = 74, SCLEX_FREEBASIC = 75,
  SCLEX_INNOSETUP = 76, SCLEX_OPAL = 77, SCLEX_SPICE = 78,
  SCLEX_D = 79, SCLEX_CMAKE = 80, SCLEX_GAP = 81,
  SCLEX_PLM = 82, SCLEX_PROGRESS = 83, SCLEX_ABAQUS = 84,
  SCLEX_ASYMPTOTE = 85, SCLEX_R = 86, SCLEX_MAGIK = 87,
  SCLEX_POWERSHELL = 88, SCLEX_MYSQL = 89, SCLEX_PO = 90,
  SCLEX_TAL = 91, SCLEX_COBOL = 92, SCLEX_TACL = 93,
  SCLEX_SORCUS = 94, SCLEX_POWERPRO = 95, SCLEX_NIMROD = 96,
  SCLEX_SML = 97
  }

## Signals

- void QSCN_SELCHANGED (bool yes)
- void SCN_AUTOCCANCELLED ()
- void SCN_AUTOCCHARDELETED ()
- void SCN_AUTOCSELECTION (const char *selection, int position)
- void SCEN_CHANGE ()
- void SCN_CALLTIPCLICK (int direction)
- void SCN_CHARADDED (int charadded)
- void SCN_DOUBLECLICK (int position, int line, int modifiers)
- void SCN_DWELLEND (int, int, int)
- void SCN_DWELLSTART (int, int, int)
- void SCN_HOTSPOTCLICK (int position, int modifiers)
- void SCN_HOTSPOTDOUBLECLICK (int position, int modifiers)
- void SCN_INDICATORCLICK (int position, int modifiers)
- void SCN_INDICATORRELEASE (int position, int modifiers)
- void SCN_MACRORECORD (unsigned int, unsigned long, void *)
- void SCN_MARGINCLICK (int position, int modifiers, int margin)
- void SCN_MODIFIED (int, int, const char *, int, int, int, int, int, int, int)
- void SCN_MODIFYATTEMPTRO ()
- void SCN_NEEDSHOWN (int, int)
- void SCN_PAINTED ()
- void SCN_SAVEPOINTLEFT ()
- void SCN_SAVEPOINTREACHED ()
- void SCN_STYLENEEDED (int position)
- void SCN_UPDATEUI ()
- void SCN_USERLISTSELECTION (const char *, int)
- void SCN_ZOOM ()

## Public Member Functions

- QsciScintillaBase (QWidget *parent=0)
- virtual ~QsciScintillaBase ()
- long SendScintilla (unsigned int msg, unsigned long wParam=0, long lParam=0) const
- long SendScintilla (unsigned int msg, unsigned long wParam, void *lParam) const
- long SendScintilla (unsigned int msg, unsigned long wParam, const char *lParam) const
- long SendScintilla (unsigned int msg, const char *lParam) const
- long SendScintilla (unsigned int msg, const char *wParam, const char *lParam) const
- long SendScintilla (unsigned int msg, long wParam) const
- long SendScintilla (unsigned int msg, int wParam) const
- long SendScintilla (unsigned int msg, long cpMin, long cpMax, char *lpstrText) const
- long SendScintilla (unsigned int msg, unsigned long wParam, const QColor &col) const
- long SendScintilla (unsigned int msg, const QColor &col) const
- long SendScintilla (unsigned int msg, unsigned long wParam, QPainter *hdc, const QRect &rc, long cpMin, long cpMax) const
- long SendScintilla (unsigned int msg, unsigned long wParam, const QPixmap &lParam) const
- void * SendScintillaPtrResult (unsigned int msg) const

## Static Public Member Functions

- static QsciScintillaBase * pool ()

## Protected Member Functions

- virtual bool canInsertFromMimeData (const QMimeData *source) const
- virtual QString fromMimeData (const QMimeData *source) const
- virtual QMimeData * toMimeData (const QString &text) const
- virtual void contextMenuEvent (QContextMenuEvent *e)
- virtual void dragEnterEvent (QDragEnterEvent *e)
- virtual void dragLeaveEvent (QDragLeaveEvent *e)
- virtual void dragMoveEvent (QDragMoveEvent *e)
- virtual void dropEvent (QDropEvent *e)
- virtual void focusInEvent (QFocusEvent *e)
- virtual void focusOutEvent (QFocusEvent *e)
- virtual bool focusNextPrevChild (bool next)
- virtual void keyPressEvent (QKeyEvent *e)
- virtual void inputMethodEvent (QInputMethodEvent *e)
- virtual void mouseDoubleClickEvent (QMouseEvent *e)
- virtual void mouseMoveEvent (QMouseEvent *e)
- virtual void mousePressEvent (QMouseEvent *e)
- virtual void mouseReleaseEvent (QMouseEvent *e)
- virtual void paintEvent (QPaintEvent *e)
- virtual void resizeEvent (QResizeEvent *e)
- virtual void scrollContentsBy (int dx, int dy)

## Detailed Description

The QsciScintillaBase class implements the Scintilla editor widget and its low-level API.

Scintilla (http://www.scintilla.org) is a powerful C++ editor class that supports many features including syntax styling, error indicators, code completion and call tips. It is particularly useful as a programmer's editor.

QsciScintillaBase is a port to Qt of Scintilla. It implements the standard Scintilla API which consists of a number of messages each taking up to two arguments.

See QsciScintilla for the implementation of a higher level API that is more consistent with the rest of the Qt toolkit.

## Member Enumeration Documentation

anonymous enum

The low-level Scintilla API is implemented as a set of messages each of which takes up to two parameters (wParam and lParam) and optionally return a value. This enum defines all the possible messages.

Enumerator:

  SCI_ADDTEXT | This message appends some text to the end of the document. wParam is the length of the text. lParam is the text to be appended.

  SCI_GETCURRENTPOS

  This message returns the current position.
  See also:
    SCI_SETCURRENTPOS

  SCI_GETANCHOR

  This message returns the anchor.
  See also:
    SCI_SETANCHOR

  SCI_SETSAVEPOINT

  This message marks the current state of the text as the the save point. This is usually done when the text is saved or loaded.
  See also:
    SCN_SAVEPOINTREACHED(), SCN_SAVEPOINTLEFT()

  SCI_MARKERLINEFROMHANDLE

  This message returns the line that contains a particular instance of a marker. wParam is the handle of the marker.
  See also:
    SCI_MARKERADD

  SCI_MARKERDELETEHANDLE

  This message removes a particular instance of a marker. wParam is the handle of the marker.
  See also:
    SCI_MARKERADD

  SCI_GOTOPOS

  This message clears the current selection and sets the current position. wParam is the new current position.
  See also:
    SCI_SETCURRENTPOS

  SCI_SETANCHOR

  This message sets the anchor. wParam is the new anchor.
  See also:
    SCI_GETANCHOR

  SCI_GETENDSTYLED

  This message returns the character position of the start of the text that needs to be syntax styled.
  See also:
    SCN_STYLENEEDED()

  SCI_MARKERDEFINE

  This message sets the symbol used to draw one of 32 markers. Some markers have pre-defined uses, see the SC_MARKNUM_* values. wParam is the number of the marker. lParam is the marker symbol and is one of the SC_MARK_* values.
  See also:
    SCI_MARKERADD, SCI_MARKERDEFINEPIXMAP

  SCI_MARKERSETFORE

  This message sets the foreground colour used to draw a marker. A colour is represented as a 24 bit value. The 8 least significant bits correspond to red, the middle 8 bits correspond to green, and the 8 most significant bits correspond to blue. The default value is 0x000000. wParam is the number of the marker. lParam is the colour.
  See also:
    SCI_MARKERSETBACK

  SCI_MARKERSETBACK

  This message sets the background colour used to draw a marker. A colour is represented as a 24 bit value. The 8 least significant bits correspond to red, the middle 8 bits correspond to green, and the 8 most significant bits correspond to blue. The default value is 0xffffff. wParam is the number of the marker. lParam is the colour.
  See also:
    SCI_MARKERSETFORE

  SCI_MARKERADD

  This message adds a marker to a line. A handle for the marker is returned which can be used to track the marker's position. wParam is the line number. lParam is the number of the marker.
  See also:
    SCI_MARKERDELETE, SCI_MARKERDELETEALL, SCI_MARKERDELETEHANDLE

  SCI_MARKERDELETE

  This message deletes a marker from a line. wParam is the line number. lParam is the number of the marker.
  See also:
    SCI_MARKERADD, SCI_MARKERDELETEALL

  SCI_MARKERDELETEALL

  This message deletes all occurences of a marker. wParam is the number of the marker. If wParam is -1 then all markers are removed.
  See also:
    SCI_MARKERADD, SCI_MARKERDELETE

  SCI_MARKERGET | This message returns the 32 bit mask of markers at a line. wParam is the line number.

  SCI_MARKERNEXT

  This message looks for the next line to contain at least one marker contained in a 32 bit mask of markers and returns the line number. wParam is the line number to start the search from. lParam is the mask of markers to search for.
  See also:
    SCI_MARKERPREVIOUS

  SCI_MARKERPREVIOUS

  This message looks for the previous line to contain at least one marker contained in a 32 bit mask of markers and returns the line number. wParam is the line number to start the search from. lParam is the mask of markers to search for.
  See also:
    SCI_MARKERNEXT

  SCI_MARKERDEFINEPIXMAP

  This message sets the symbol used to draw one of the 32 markers to a pixmap. Pixmaps use the SC_MARK_PIXMAP marker symbol. wParam is the number of the marker. lParam is a pointer to a QPixmap instance. Note that in other ports of Scintilla this is a pointer to either raw or textual XPM image data.
  See also:
    SCI_MARKERDEFINE

  SCI_SETMARGINTYPEN

  This message sets what can be displayed in a margin. wParam is the number of the margin: 0, 1 or 2. lParam is the logical or of the SC_MARGIN_* values.
  See also:
    SCI_GETMARGINTYPEN

  SCI_GETMARGINTYPEN

  This message returns what can be displayed in a margin. wParam is the number of the margin: 0, 1 or 2.
  See also:
    SCI_SETMARGINTYPEN

  SCI_SETMARGINWIDTHN

  This message sets the width of a margin in pixels. wParam is the number of the margin: 0, 1 or 2. lParam is the new margin width.
  See also:
    SCI_GETMARGINWIDTHN

  SCI_GETMARGINWIDTHN

  This message returns the width of a margin in pixels. wParam is the number of the margin: 0, 1 or 2.
  See also:
    SCI_SETMARGINWIDTHN

  SCI_SETMARGINMASKN

  This message sets the mask of a margin. The mask is a 32 value with one bit for each possible marker. If a bit is set then the corresponding marker is displayed. By default, all markers are displayed. wParam is the number of the margin: 0, 1 or 2. lParam is the new margin mask.
  See also:
    SCI_GETMARGINMASKN, SCI_MARKERDEFINE

  SCI_GETMARGINMASKN

  This message returns the mask of a margin. wParam is the number of the margin: 0, 1 or 2.
  See also:
    SCI_SETMARGINMASKN

  SCI_SETMARGINSENSITIVEN

  This message sets the sensitivity of a margin to mouse clicks. wParam is the number of the margin: 0, 1 or 2. lParam is non-zero to make the margin sensitive to mouse clicks. When the mouse is clicked the SCN_MARGINCLICK() signal is emitted.
  See also:
    SCI_GETMARGINSENSITIVEN, SCN_MARGINCLICK()

  SCI_GETMARGINSENSITIVEN

  This message returns the sensitivity of a margin to mouse clicks. wParam is the number of the margin: 0, 1 or 2.
  See also:
    SCI_SETMARGINSENSITIVEN, SCN_MARGINCLICK()

  SCI_GETREADONLY

  This message returns a non-zero value if the document is read-only.
  See also:
    SCI_SETREADONLY

  SCI_SETCURRENTPOS

  This message sets the current position. wParam is the new current position.
  See also:
    SCI_GETCURRENTPOS

  SCI_GETMODIFY | This message returns a non-zero value if the document has been modified.

  SCI_SETREADONLY

  This message sets the read-only state of the document. wParam is the new read-only state of the document.
  See also:
    SCI_GETREADONLY

  SCI_EMPTYUNDOBUFFER | This message empties the undo buffer.

  SCI_SETTEXT

  This message sets the text of the document. wParam is unused. lParam is the new text of the document.
  See also:
    SCI_GETTEXT

  SCI_GETTEXT

  This message gets the text of the document. wParam is size of the buffer that the text is copied to. lParam is the address of the buffer that the text is copied to.
  See also:
    SCI_SETTEXT

  SCI_GETTEXTLENGTH | This message returns the length of the document.
  SCI_AUTOCSETMAXHEIGHT | This message is not implemented.
  SCI_TEXTWIDTH | This message returns the width of some text when rendered in a particular style. wParam is the style number and is one of the STYLE_* values or one of the styles defined by a lexer. lParam is a pointer to the text.

  SCI_REGISTERIMAGE

  This message takes a copy of an image and registers it so that it can be refered to by a unique integer identifier. wParam is the image's identifier. lParam is a pointer to a QPixmap instance. Note that in other ports of Scintilla this is a pointer to either raw or textual XPM image data.
  See also:
    SCI_CLEARREGISTEREDIMAGES

  SCI_CLEARREGISTEREDIMAGES

  This message de-registers all currently registered images.
  See also:
    SCI_REGISTERIMAGE

  SCI_COPYALLOWLINE | This message copies the selection. If the selection is empty then copy the line with the caret.
  SCI_GETCHARACTERPOINTER | This message returns a pointer to the document text. Any subsequent message will invalidate the pointer.
  SCI_SETLEXER | This message sets the number of the lexer to use for syntax styling. wParam is the number of the lexer and is one of the SCLEX_* values.
  SCI_GETLEXER | This message returns the number of the lexer being used for syntax styling.
  SCI_SETLEXERLANGUAGE | This message sets the name of the lexer to use for syntax styling. wParam is unused. lParam is the name of the lexer.

anonymous enum

This enum defines the different selection modes.

See also:
  SCI_GETSELECTIONMODE, SCI_SETSELECTIONMODE

anonymous enum

This enum defines the different marker symbols.

See also:
  SCI_MARKERDEFINE

Enumerator:

  SC_MARK_CIRCLE | A circle.
  SC_MARK_ROUNDRECT | A rectangle.
  SC_MARK_ARROW | A triangle pointing to the right.
  SC_MARK_SMALLRECT | A smaller rectangle.
  SC_MARK_SHORTARROW | An arrow pointing to the right.
  SC_MARK_EMPTY | An invisible marker that allows code to track the movement of lines.
  SC_MARK_ARROWDOWN | A triangle pointing down.
  SC_MARK_MINUS | A drawn minus sign.
  SC_MARK_PLUS | A drawn plus sign.
  SC_MARK_VLINE | A vertical line drawn in the background colour.
  SC_MARK_LCORNER | A bottom left corner drawn in the background colour.
  SC_MARK_TCORNER | A vertical line with a centre right horizontal line drawn in the background colour.
  SC_MARK_BOXPLUS | A drawn plus sign in a box.
  SC_MARK_BOXPLUSCONNECTED | A drawn plus sign in a connected box.
  SC_MARK_BOXMINUS | A drawn minus sign in a box.
  SC_MARK_BOXMINUSCONNECTED | A drawn minus sign in a connected box.
  SC_MARK_LCORNERCURVE | A rounded bottom left corner drawn in the background colour.
  SC_MARK_TCORNERCURVE | A vertical line with a centre right curved line drawn in the background colour.
  SC_MARK_CIRCLEPLUS | A drawn plus sign in a circle.
  SC_MARK_CIRCLEPLUSCONNECTED | A drawn plus sign in a connected box.
  SC_MARK_CIRCLEMINUS | A drawn minus sign in a circle.
  SC_MARK_CIRCLEMINUSCONNECTED | A drawn minus sign in a connected circle.
  SC_MARK_BACKGROUND | No symbol is drawn but the line of text is drawn with the same background colour.
  SC_MARK_DOTDOTDOT | Three drawn dots.
  SC_MARK_ARROWS | Three drawn arrows pointing right.
  SC_MARK_PIXMAP | An XPM format pixmap.
  SC_MARK_FULLRECT | A full rectangle (ie. the margin background).
  SC_MARK_LEFTRECT | A left rectangle (ie. part of the margin background).
  SC_MARK_AVAILABLE | The value is available for plugins to use.
  SC_MARK_CHARACTER | Characters can be used as symbols by adding this to the ASCII value of the character.

anonymous enum

This enum defines what can be displayed in a margin.

See also:
  SCI_GETMARGINTYPEN, SCI_SETMARGINTYPEN

Enumerator:

  SC_MARGIN_SYMBOL | The margin can display symbols. Note that all margins can display symbols.
  SC_MARGIN_NUMBER | The margin will display line numbers.
  SC_MARGIN_BACK | The margin's background color will be set to the default background color.
  SC_MARGIN_FORE | The margin's background color will be set to the default foreground color.
  SC_MARGIN_TEXT | The margin will display text.
  SC_MARGIN_RTEXT | The margin will display right justified text.

anonymous enum

This enum defines the different indentation guide views.

See also:
  SCI_GETINDENTATIONGUIDES, SCI_SETINDENTATIONGUIDES

Enumerator:

  SC_IV_NONE | No indentation guides are shown.
  SC_IV_REAL | Indentation guides are shown inside real indentation white space.
  SC_IV_LOOKFORWARD | Indentation guides are shown beyond the actual indentation up to the level of the next non-empty line. If the previous non-empty line was a fold header then indentation guides are shown for one more level of indent than that line. This setting is good for Python.
  SC_IV_LOOKBOTH | Indentation guides are shown beyond the actual indentation up to the level of the next non-empty line or previous non-empty line whichever is the greater. This setting is good for most languages.

anonymous enum

This enum defines the different modifier keys.

Enumerator:

  SCMOD_NORM | No modifier key.
  SCMOD_SHIFT | Shift key.
  SCMOD_CTRL | Control key.
  SCMOD_ALT | Alt key.

anonymous enum

This enum defines the different language lexers.

See also:
  SCI_GETLEXER, SCI_SETLEXER

Enumerator:

  SCLEX_CONTAINER | No lexer is selected and the SCN_STYLENEEDED signal is emitted so that the application can style the text as needed. This is the default.
  SCLEX_NULL | Select the null lexer that does no syntax styling.
  SCLEX_PYTHON | Select the Python lexer.
  SCLEX_CPP | Select the C++ lexer.
  SCLEX_HTML | Select the HTML lexer.
  SCLEX_XML | Select the XML lexer.
  SCLEX_PERL | Select the Perl lexer.
  SCLEX_SQL | Select the SQL lexer.
  SCLEX_VB | Select the Visual Basic lexer.
  SCLEX_PROPERTIES | Select the lexer for properties style files.
  SCLEX_ERRORLIST | Select the lexer for error list style files.
  SCLEX_MAKEFILE | Select the Makefile lexer.
  SCLEX_BATCH | Select the Windows batch file lexer.
  SCLEX_LATEX | Select the LaTex lexer.
  SCLEX_LUA | Select the Lua lexer.
  SCLEX_DIFF | Select the lexer for diff output.
  SCLEX_CONF | Select the lexer for Apache configuration files.
  SCLEX_PASCAL | Select the Pascal lexer.
  SCLEX_AVE | Select the Avenue lexer.
  SCLEX_ADA | Select the Ada lexer.
  SCLEX_LISP | Select the Lisp lexer.
  SCLEX_RUBY | Select the Ruby lexer.
  SCLEX_EIFFEL | Select the Eiffel lexer.
  SCLEX_EIFFELKW | Select the Eiffel lexer folding at keywords.
  SCLEX_TCL | Select the Tcl lexer.
  SCLEX_NNCRONTAB | Select the lexer for nnCron files.
  SCLEX_BULLANT | Select the Bullant lexer.
  SCLEX_VBSCRIPT | Select the VBScript lexer.
  SCLEX_ASP | Select the ASP lexer.
  SCLEX_PHP | Select the PHP lexer.
  SCLEX_BAAN | Select the Baan lexer.
  SCLEX_MATLAB | Select the Matlab lexer.
  SCLEX_SCRIPTOL | Select the Scriptol lexer.
  SCLEX_ASM | Select the assembler lexer.
  SCLEX_CPPNOCASE | Select the C++ lexer with case insensitive keywords.
  SCLEX_FORTRAN | Select the FORTRAN lexer.
  SCLEX_F77 | Select the FORTRAN77 lexer.
  SCLEX_CSS | Select the CSS lexer.
  SCLEX_POV | Select the POV lexer.
  SCLEX_LOUT | Select the Basser Lout typesetting language lexer.
  SCLEX_ESCRIPT | Select the EScript lexer.
  SCLEX_PS | Select the PostScript lexer.
  SCLEX_NSIS | Select the NSIS lexer.
  SCLEX_MMIXAL | Select the MMIX assembly language lexer.
  SCLEX_CLW | Select the Clarion lexer.
  SCLEX_CLWNOCASE | Select the Clarion lexer with case insensitive keywords.
  SCLEX_LOT | Select the MPT text log file lexer.
  SCLEX_YAML | Select the YAML lexer.
  SCLEX_TEX | Select the TeX lexer.
  SCLEX_METAPOST | Select the Metapost lexer.
  SCLEX_POWERBASIC | Select the PowerBASIC lexer.
  SCLEX_FORTH | Select the Forth lexer.
  SCLEX_ERLANG | Select the Erlang lexer.
  SCLEX_OCTAVE | Select the Octave lexer.
  SCLEX_MSSQL | Select the MS SQL lexer.
  SCLEX_VERILOG | Select the Verilog lexer.
  SCLEX_KIX | Select the KIX-Scripts lexer.
  SCLEX_GUI4CLI | Select the Gui4Cli lexer.
  SCLEX_SPECMAN | Select the Specman E lexer.
  SCLEX_AU3 | Select the AutoIt3 lexer.
  SCLEX_APDL | Select the APDL lexer.
  SCLEX_BASH | Select the Bash lexer.
  SCLEX_ASN1 | Select the ASN.1 lexer.
  SCLEX_VHDL | Select the VHDL lexer.
  SCLEX_CAML | Select the Caml lexer.
  SCLEX_BLITZBASIC | Select the BlitzBasic lexer.
  SCLEX_PUREBASIC | Select the PureBasic lexer.
  SCLEX_HASKELL | Select the Haskell lexer.
  SCLEX_PHPSCRIPT | Select the PHPScript lexer.
  SCLEX_TADS3 | Select the TADS3 lexer.
  SCLEX_REBOL | Select the REBOL lexer.
  SCLEX_SMALLTALK | Select the Smalltalk lexer.
  SCLEX_FLAGSHIP | Select the FlagShip lexer.
  SCLEX_CSOUND | Select the Csound lexer.
  SCLEX_FREEBASIC | Select the FreeBasic lexer.
  SCLEX_INNOSETUP | Select the InnoSetup lexer.
  SCLEX_OPAL | Select the Opal lexer.
  SCLEX_SPICE | Select the Spice lexer.
  SCLEX_D | Select the D lexer.
  SCLEX_CMAKE | Select the CMake lexer.
  SCLEX_GAP | Select the GAP lexer.
  SCLEX_PLM | Select the PLM lexer.
  SCLEX_PROGRESS | Select the Progress lexer.
  SCLEX_ABAQUS | Select the Abaqus lexer.
  SCLEX_ASYMPTOTE | Select the Asymptote lexer.
  SCLEX_R | Select the R lexer.
  SCLEX_MAGIK | Select the MagikSF lexer.
  SCLEX_POWERSHELL | Select the PowerShell lexer.
  SCLEX_MYSQL | Select the MySQL lexer.
  SCLEX_PO | Select the gettext .po file lexer.
  SCLEX_TAL | Select the TAL lexer.
  SCLEX_COBOL | Select the COBOL lexer.
  SCLEX_TACL | Select the TACL lexer.
  SCLEX_SORCUS | Select the Sorcus lexer.
  SCLEX_POWERPRO | Select the PowerPro lexer.
  SCLEX_NIMROD | Select the Nimrod lexer.
  SCLEX_SML | Select the SML lexer.

## Member Function Documentation

static QsciScintillaBase* QsciScintillaBase::pool | ( |  | ) | `[static]`

Returns a pointer to a QsciScintillaBase instance, or 0 if there isn't one. This can be used by the higher level API to send messages that aren't associated with a particular instance.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | unsigned long | wParam = `0`,
|  | long | lParam = `0` |
| ) |  |  | const

Send the Scintilla message msg with the optional parameters wParam and lParam.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | unsigned long | wParam,
|  | void * | lParam |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | unsigned long | wParam,
|  | const char * | lParam |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | const char * | lParam |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | const char * | wParam,
|  | const char * | lParam |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | long | wParam |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | int | wParam |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | long | cpMin,
|  | long | cpMax,
|  | char * | lpstrText |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | unsigned long | wParam,
|  | const QColor & | col |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | const QColor & | col |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | unsigned long | wParam,
|  | QPainter * | hdc,
|  | const QRect & | rc,
|  | long | cpMin,
|  | long | cpMax |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

long QsciScintillaBase::SendScintilla | ( | unsigned int | msg,
|  | unsigned long | wParam,
|  | const QPixmap & | lParam |
| ) |  |  | const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void QsciScintillaBase::QSCN_SELCHANGED | ( | bool | yes | ) | `[signal]`

This signal is emitted when text is selected or de-selected. yes is true if text has been selected and false if text has been deselected.

void QsciScintillaBase::SCN_AUTOCCANCELLED | ( |  | ) | `[signal]`

This signal is emitted when the user cancels an auto-completion list.

See also:
  SCN_AUTOCSELECTION()

void QsciScintillaBase::SCN_AUTOCCHARDELETED | ( |  | ) | `[signal]`

This signal is emitted when the user deletes a character when an auto-completion list is active.

void QsciScintillaBase::SCN_AUTOCSELECTION | ( | const char * | selection,
|  | int | position |
| ) |  |  | `[signal]`

This signal is emitted when the user selects an item in an auto-completion list. It is emitted before the selection is inserted. The insertion can be cancelled by sending an SCI_AUTOCANCEL message from a connected slot. selection is the text of the selection. position is the start position of the word being completed.

See also:
  SCN_AUTOCCANCELLED()

void QsciScintillaBase::SCN_CALLTIPCLICK | ( | int | direction | ) | `[signal]`

This signal ir emitted when the user clicks on a calltip. direction is 1 if the user clicked on the up arrow, 2 if the user clicked on the down arrow, and 0 if the user clicked elsewhere.

void QsciScintillaBase::SCN_CHARADDED | ( | int | charadded | ) | `[signal]`

This signal is emitted whenever the user enters an ordinary character into the text. charadded is the character. It can be used to decide to display a call tip or an auto-completion list.

void QsciScintillaBase::SCN_DOUBLECLICK | ( | int | position,
|  | int | line,
|  | int | modifiers |
| ) |  |  | `[signal]`

This signal is emitted when the user double clicks. position is the position in the text where the click occured. line is the number of the line in the text where the click occured. modifiers is the logical or of the modifier keys that were pressed when the user double clicked.

void QsciScintillaBase::SCN_HOTSPOTCLICK | ( | int | position,
|  | int | modifiers |
| ) |  |  | `[signal]`

This signal is emitted when the user clicks on text in a style with the hotspot attribute set. position is the position in the text where the click occured. modifiers is the logical or of the modifier keys that were pressed when the user clicked.

void QsciScintillaBase::SCN_HOTSPOTDOUBLECLICK | ( | int | position,
|  | int | modifiers |
| ) |  |  | `[signal]`

This signal is emitted when the user double clicks on text in a style with the hotspot attribute set. position is the position in the text where the double click occured. modifiers is the logical or of the modifier keys that were pressed when the user double clicked.

void QsciScintillaBase::SCN_INDICATORCLICK | ( | int | position,
|  | int | modifiers |
| ) |  |  | `[signal]`

This signal is emitted when the user clicks on text that has an indicator. position is the position in the text where the click occured. modifiers is the logical or of the modifier keys that were pressed when the user clicked.

void QsciScintillaBase::SCN_INDICATORRELEASE | ( | int | position,
|  | int | modifiers |
| ) |  |  | `[signal]`

This signal is emitted when the user releases the mouse button on text that has an indicator. position is the position in the text where the release occured. modifiers is the logical or of the modifier keys that were pressed when the user released.

void QsciScintillaBase::SCN_MACRORECORD | ( | unsigned | int,
|  | unsigned | long,
|  | void * |  |
| ) |  |  | `[signal]`

This signal is emitted when a recordable editor command has been executed.

void QsciScintillaBase::SCN_MARGINCLICK | ( | int | position,
|  | int | modifiers,
|  | int | margin |
| ) |  |  | `[signal]`

This signal is emitted when the user clicks on a sensitive margin. position is the position of the start of the line against which the user clicked. modifiers is the logical or of the modifier keys that were pressed when the user clicked. margin is the number of the margin the user clicked in: 0, 1 or 2.

See also:
  SCI_GETMARGINSENSITIVEN, SCI_SETMARGINSENSITIVEN

void QsciScintillaBase::SCN_MODIFYATTEMPTRO | ( |  | ) | `[signal]`

This signal is emitted when the user attempts to modify read-only text.

void QsciScintillaBase::SCN_PAINTED | ( |  | ) | `[signal]`

This signal is emitted when painting has been completed. It is useful to trigger some other change but to have the paint be done first to appear more reponsive to the user.

void QsciScintillaBase::SCN_SAVEPOINTLEFT | ( |  | ) | `[signal]`

This signal is emitted when the current state of the text no longer corresponds to the state of the text at the save point.

See also:
  SCI_SETSAVEPOINT, SCN_SAVEPOINTREACHED()

void QsciScintillaBase::SCN_SAVEPOINTREACHED | ( |  | ) | `[signal]`

This signal is emitted when the current state of the text corresponds to the state of the text at the save point. This allows feedback to be given to the user as to whether the text has been modified since it was last saved.

See also:
  SCI_SETSAVEPOINT, SCN_SAVEPOINTLEFT()

void QsciScintillaBase::SCN_STYLENEEDED | ( | int | position | ) | `[signal]`

This signal is emitted when a range of text needs to be syntax styled. The range is from the value returned by the SCI_GETENDSTYLED message and position. It is only emitted if the currently selected lexer is SCLEX_CONTAINER.

See also:
  SCI_COLOURISE, SCI_GETENDSTYLED

virtual bool QsciScintillaBase::canInsertFromMimeData | ( | const QMimeData * | source | ) | const`[protected, virtual]`

Returns true if the contents of a MIME data object can be decoded and inserted into the document. It is called during drag and paste operations. source is the MIME data object.

See also:
  fromMimeData(), toMimeData()

virtual QString QsciScintillaBase::fromMimeData | ( | const QMimeData * | source | ) | const`[protected, virtual]`

Returns the text decoded from a MIME data object. It is called when a drag and drop is completed and when text is pasted from the clipboard. source is the MIME data object.

See also:
  canInsertFromMimeData(), toMimeData()

virtual QMimeData* QsciScintillaBase::toMimeData | ( | const QString & | text | ) | const`[protected, virtual]`

Returns a new MIME data object that encodes some text. It is called when a drag and drop is started and when the selection is copied to the clipboard. Ownership of the object is passed to the caller. text is the text to encode.

See also:
  canInsertFromMimeData(), fromMimeData()