Win32::GUI::Scintilla - Add Scintilla edit control to Win32::GUI
use Win32::GUI; use Win32::GUI::Scintilla; # main Window $Window = new Win32::GUI::Window ( -name => "Window", -title => "Scintilla test", -pos => [100, 100], -size => [400, 400], ) or die "new Window"; # Create Scintilla Edit Window # $Edit = new Win32::GUI::Scintilla ( # -parent => $Window, # Or $Edit = $Window->AddScintilla ( -name => "Edit", -pos => [0, 0], -size => [400, 400], -text => "Test\n", ) or die "new Edit"; # Call Some method $Edit->AddText ("add\n"); $Edit->AppendText ("append\n"); # Event loop $Window->Show(); Win32::GUI::Dialog(); # Main window event handler sub Window_Terminate { # Call Some method print "GetText = ", $Edit->GetText(), "\n"; print "GetSelText = ", $Edit->GetSelText(), "\n"; print "GetTextRange(2) = ", $Edit->GetTextRange(2), "\n"; print "GetTextRange(2, 6) = ", $Edit->GetTextRange(2, 6), "\n"; return -1; } # Main window resize sub Window_Resize { if (defined $Window) { ($width, $height) = ($Window->GetClientRect)[2..3]; $Edit->Move (0, 0); $Edit->Resize ($width, $height); } } # Scintilla Event Notification sub Edit_Notify { my (%evt) = @_; print "Edit Notify = ", %evt, "\n"; }
Scintilla is a free source code editing component. See : http:/www.scintilla.org/
new
Create a new Scintilla control. Parameter : -name : Window name -parent : Parent window -left : Left position -top : Top position -width : Width -height : Height -pos : [x, y] position -size : [w, h] size -text : Text -visible : Visible -readonly : ReadOnly -hscroll : Horizontal scroll -vscroll : Vertical scroll -pushstyle : Push style -addstyle : Add style -popstyle : Pop style -remstyle : Remove style -notstyle : Not style -negstyle : Negation style -exstyle : Extended style -pushexstyle : Push extended style -addexstyle : Add extended style -popexstyle : Pop extended style -remexstyle : Remove extended style -notexstyle : Not extended style -negexstyle : Negation extended style
Win32::GUI::Window::AddScintilla
Add a scintilla control in a Win32::GUI::Window. Parent window is automaticly add to new method. See Win32::GUI::Scintilla new method for parameters.
Notify
-code : Event Code SCN_STYLENEEDED -position SCN_CHARADDED -ch : Character SCN_KEY -ch : Character -modifiers : Key mask -shift : Shift key -control : Control key -alt : Alt key SCN_MODIFIED -position : Position -modificationType : -length : Length -linesAdded : Line added -line : Line -foldLevelNow : -foldLevelPrev : SCN_MACRORECORD -message : Message SCN_MARGINCLICK -position -modifiers : Key mask -shift : Shift key -control : Control key -alt : Alt key -margin : Margin number SCN_USERLISTSELECTION -listType : List item SCN_DWELLSTART -position : Position -x : X position -y : Y position SCN_DWELLEND -position : Position -x : X position -y : Y position SCN_SAVEPOINTREACHED SCN_SAVEPOINTLEFT SCN_MODIFYATTEMPTRO SCN_DOUBLECLICK SCN_UPDATEUI SCN_ZOOM SCN_URIDROPPED SCN_NEEDSHOWN SCN_PAINTED SCN_HOTSPOTCLICK & SCN_HOTSPOTDOUBLECLICK -position : Position -modifiers : Key mask -shift : Shift key -control : Control key -alt : Alt key SCN_CALLTIPCLICK -position : Position
Change
Fire when Scintilla edit control text change. See also Notify SCN_MODIFIED event.
GotFocus
Fire when Scintilla edit control got focus.
LostFocus
Fire when Scintilla edit control lost focus.
NewFile
Clean control for editing a new file. - Clear Text - Clear Undo buffer - Set save point
LoadFile
Load a text file. - Clear undo buffer - Set save point Return : bool
SaveFile
Save text in file. - Set save point Return : bool
StyleSetSpec
Set a style from a string style. A string style is a comma separated property string. Each property, is compose a property name, an optional value separate by a ':'. Property : - fore:#RRGGBB = Set foreground color (RRGGBB is a hexadecimal value) - back:#RRGGBB = Set background color - face:name = Set font - size:N = Set font size (N is a numeric value) - bold = Bold font - notbold = Not Bold font - italic = Italic font - notitalic = Not Italic font - underline = Underline font - notunderline = Not Underline font - eolfilled = eolfilled - noteolfilled = Not eolfilled Sample : "face:Times New Roman,size:12,fore:#0000FF,back#FF0000,bold,italic"
BraceHighEvent
A standard brace highligthing event manager.
FolderEvent
A standard event manager. If Shift and Control are pressed, open or close all folder Else If Shift is pressed, Toggle 1 level of current folder Else If Control is pressed, expand all subfolder of current folder Else Toggle current folder
FolderAll
Folding or Unfolding all text.
FolderExpand
Manage Folder Expanding
FindAndSelect
Find a text and select it. Parameter: - text : Text to find (or regular expression). - flag : A Scintilla Find constante. SCFIND_WHOLEWORD SCFIND_MATCHCASE SCFIND_WORDSTART SCFIND_REGEXP - direction : ForWard >= 0, Backward < 0 - wrap : Use Wrap mode.
For full documentation off Scintilla control see http:\\www.scintilla.org\
AddText
Add text to the document.
AddStyledText
Add array of cells to document.
InsertText
Insert string at a position.
ClearAll
Delete all text in the document.
ClearDocumentStyle
Set all style bytes to 0, remove all folding information.
GetLength
Return the number of characters in the document.
GetCharAt
Returns the character byte at the position.
GetCurrentPos
Returns the position of the caret.
GetAnchor
Returns the position of the opposite end of the selection to the caret.
GetStyleAt
Returns the style byte at the position.
Redo
Redoes the next action on the undo history.
SetUndoCollection
Choose between collecting actions into the undo history and discarding them.
SelectAll
Select all the text in the document.
SetSavePoint
Remember the current position in the undo history as the position at which the document was saved.
GetStyledText
Returns the number of bytes in the buffer not including terminating NULs.
CanRedo
Are there any redoable actions in the undo history?
MarkerLineFromHandle
Retrieve the line number at which a particular marker is located.
MarkerDeleteHandle
Delete a marker.
GetUndoCollection
Is undo history being collected?
WS Constant
SCWS_INVISIBLE, SCWS_VISIBLEALWAYS, SCWS_VISIBLEAFTERINDENT
GetViewWS
Are white space characters currently visible?
SetViewWS
Make white space characters invisible, always visible or visible outside indentation.
PositionFromPoint
Find the position from a point within the window.
PositionFromPointClose
Find the position from a point within the window but return INVALID_POSITION if not close to text.
GotoLine
Set caret to start of a line and ensure it is visible.
GotoPos
Set caret to a position and ensure it is visible.
SetAnchor
Set the selection anchor to a position. The anchor is the opposite end of the selection from the caret.
GetCurLine
Return the text of the line containing the caret.
GetEndStyled
Retrieve the position of the last correctly styled character.
EOL constant
SC_EOL_CRLF, SC_EOL_CR, SC_EOL_LF.
ConvertEOLs
Convert all line endings in the document to one mode.
GetEOLMode
Retrieve the current end of line mode - one of CRLF, CR, or LF.
SetEOLMode
Set the current end of line mode.
StartStyling
Set the current styling position to pos and the styling mask to mask. The styling mask can be used to protect some bits in each styling byte from modification.
SetStyling
Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment.
GetBufferedDraw
Is drawing done first into a buffer or direct to the screen?
SetBufferedDraw
If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.
SetTabWidth
Change the visible size of a tab to be a multiple of the width of a space character.
GetTabWidth
Retrieve the visible size of a tab.
Constant code page
SC_CP_UTF8, SC_CP_DBCS
SetCodePage
Set the code page used to interpret the bytes of the document as characters.
SetUsePalette
In palette mode, Scintilla uses the environment's palette calls to display more colours. This may lead to ugly displays.
MARK constant
Shapes SC_MARK_CIRCLE SC_MARK_ROUNDRECT SC_MARK_ARROW SC_MARK_SMALLRECT SC_MARK_SHORTARROW SC_MARK_EMPTY SC_MARK_ARROWDOWN SC_MARK_MINUS SC_MARK_PLUS Shapes used for outlining column. SC_MARK_VLINE SC_MARK_LCORNER SC_MARK_TCORNER SC_MARK_BOXPLUS SC_MARK_BOXPLUSCONNECTED SC_MARK_BOXMINUS SC_MARK_BOXMINUSCONNECTED SC_MARK_LCORNERCURVE SC_MARK_TCORNERCURVE SC_MARK_CIRCLEPLUS SC_MARK_CIRCLEPLUSCONNECTED SC_MARK_CIRCLEMINUS SC_MARK_CIRCLEMINUSCONNECTED Invisible mark that only sets the line background color. SC_MARK_BACKGROUND SC_MARK_DOTDOTDOT SC_MARK_ARROWS SC_MARK_PIXMAP SC_MARK_CHARACTER Markers used for outlining column. SC_MARKNUM_FOLDEREND SC_MARKNUM_FOLDEROPENMID SC_MARKNUM_FOLDERMIDTAIL SC_MARKNUM_FOLDERTAIL SC_MARKNUM_FOLDERSUB SC_MARKNUM_FOLDER SC_MARKNUM_FOLDEROPEN Mask folder SC_MASK_FOLDERS
MarkerDefine
Set the symbol used for a particular marker number.
MarkerSetFore
Set the foreground colour used for a particular marker number.
MarkerSetBack
Set the background colour used for a particular marker number.
MarkerAdd
Add a marker to a line, returning an ID which can be used to find or delete the marker.
MarkerDelete
Delete a marker from a line.
MarkerDeleteAll
Delete all markers with a particular number from all lines.
MarkerGet
Get a bit mask of all the markers set on a line.
MarkerNext
Find the next line after lineStart that includes a marker in mask.
MarkerPrevious
Find the previous line before lineStart that includes a marker in mask.
MarkerDefinePixmap
Define a marker from a pixmap.
MARGIN constant
SC_MARGIN_SYMBOL, SC_MARGIN_NUMBER
SetMarginTypeN
Set a margin to be either numeric or symbolic.
GetMarginTypeN
Retrieve the type of a margin.
SetMarginWidthN
Set the width of a margin to a width expressed in pixels.
GetMarginWidthN
Retrieve the width of a margin in pixels.
SetMarginMaskN
Set a mask that determines which markers are displayed in a margin.
GetMarginMaskN
Retrieve the marker mask of a margin.
SetMarginSensitiveN
Make a margin sensitive or insensitive to mouse clicks.
GetMarginSensitiveN
Retrieve the mouse click sensitivity of a margin.
Style constant
Styles in range 32..37 are predefined for parts of the UI and are not used as normal styles. Styles 38 and 39 are for future use. STYLE_DEFAULT STYLE_LINENUMBER STYLE_BRACELIGHT STYLE_BRACEBAD STYLE_CONTROLCHAR STYLE_INDENTGUIDE STYLE_LASTPREDEFINED STYLE_MAX
StyleClearAll
Clear all the styles and make equivalent to the global default style.
StyleSetFore
Set the foreground colour of a style. Color format : '#RRGGBB'
StyleSetBack
Set the background colour of a style. Color format : '#RRGGBB'
StyleSetBold
Set a style to be bold or not.
StyleSetItalic
Set a style to be italic or not.
StyleSetSize
Set the size of characters of a style.
StyleSetFont
Set the font of a style.
StyleSetEOLFilled
Set a style to have its end of line filled or not.
StyleResetDefault
Reset the default style to its state at startup
StyleSetUnderline
Set a style to be underlined or not.
CASE constant
SC_CASE_MIXED SC_CASE_UPPER SC_CASE_LOWER
StyleSetCase
Set a style to be mixed case, or to force upper or lower case.
CHARSET constant
SC_CHARSET_ANSI SC_CHARSET_DEFAULT SC_CHARSET_BALTIC SC_CHARSET_CHINESEBIG5 SC_CHARSET_EASTEUROPE SC_CHARSET_GB2312 SC_CHARSET_GREEK SC_CHARSET_HANGUL SC_CHARSET_MAC SC_CHARSET_OEM SC_CHARSET_RUSSIAN SC_CHARSET_SHIFTJIS SC_CHARSET_SYMBOL SC_CHARSET_TURKISH SC_CHARSET_JOHAB SC_CHARSET_HEBREW SC_CHARSET_ARABIC SC_CHARSET_VIETNAMESE SC_CHARSET_THAI
StyleSetCharacterSet
Set the character set of the font in a style.
StyleSetHotSpot
Set a style to be a hotspot or not.
SetSelFore
Set the foreground colour of the selection and whether to use this setting.
SetSelBack
Set the background colour of the selection and whether to use this setting.
SetCaretFore
Set the foreground colour of the caret.
AssignCmdKey
When key+modifier combination km is pressed perform msg.
ClearCmdKey
When key+modifier combination km is pressed do nothing.
ClearAllCmdKeys
Drop all key mappings.
SetStylingEx
Set the styles for a segment of the document.
StyleSetVisible
Set a style to be visible or not.
GetCaretPeriod
Get the time in milliseconds that the caret is on and off.
SetCaretPeriod
Set the time in milliseconds that the caret is on and off. 0 = steady on.
SetWordChars
Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault.
BeginUndoAction
Start a sequence of actions that is undone and redone as a unit.
EndUndoAction
End a sequence of actions that is undone and redone as a unit.
STYLE constant
INDIC_PLAIN INDIC_SQUIGGLE INDIC_TT INDIC_DIAGONAL INDIC_STRIKE INDIC_HIDDEN INDIC_BOX INDIC0_MASK INDIC1_MASK INDIC2_MASK INDICS_MASK
IndicSetStyle
Set an indicator to plain, squiggle or TT.
IndicGetStyle
Retrieve the style of an indicator.
IndicSetFore
Set the foreground colour of an indicator
IndicGetFore
Retrieve the foreground colour of an indicator.
SetWhitespaceFore
Set the foreground colour of all whitespace and whether to use this setting.
SetWhitespaceBack
Set the background colour of all whitespace and whether to use this setting.
SetStyleBits
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.
GetStyleBits
Retrieve number of bits in style bytes used to hold the lexical state.
SetLineState
Used to hold extra styling information for each line.
GetLineState
Retrieve the extra styling information for a line.
GetMaxLineState
Retrieve the last line number that has line state.
GetCaretLineVisible
Is the background of the line containing the caret in a different colour?
SetCaretLineVisible
Display the background of the line containing the caret in a different colour.
GetCaretLineBack
Get the colour of the background of the line containing the caret.
SetCaretLineBack
Set the colour of the background of the line containing the caret.
StyleSetChangeable
Set a style to be changeable or not (read only).
AutoCShow
Display a auto-completion list. The lenEntered parameter indicates how many characters before the caret should be used to provide context.
AutoCCancel
Remove the auto-completion list from the screen.
AutoCActive
Is there an auto-completion list visible?
AutoCPosStart
Retrieve the position of the caret when the auto-completion list was displayed.
AutoCComplete
User has selected an item so remove the list and insert the selection.
AutoCStops
Define a set of character that when typed cancel the auto-completion list.
AutoCSetSeparator
Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space.
AutoCGetSeparator
Retrieve the auto-completion list separator character.
AutoCSelect
Select the item in the auto-completion list that starts with a string.
AutoCSetCancelAtStart
Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
AutoCGetCancelAtStart
Retrieve whether auto-completion cancelled by backspacing before start.
AutoCSetFillUps
Define a set of characters that when typed will cause the autocompletion to choose the selected item.
AutoCSetChooseSingle
Should a single item auto-completion list automatically choose the item.
AutoCGetChooseSingle
Retrieve whether a single item auto-completion list automatically choose the item.
AutoCSetIgnoreCase
Set whether case is significant when performing auto-completion searches.
AutoCGetIgnoreCase
Retrieve state of ignore case flag.
UserListShow
Display a list of strings and send notification when user chooses one.
AutoCSetAutoHide
Set whether or not autocompletion is hidden automatically when nothing matches.
AutoCGetAutoHide
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
AutoCSetDropRestOfWord
AutoCGetDropRestOfWord
RegisterImage
Register an XPM image for use in autocompletion lists.
ClearRegisteredImages
Clear all the registered XPM images.
AutoCGetTypeSeparator
Retrieve the auto-completion list type-separator character.
AutoCSetTypeSeparator
Change the type-separator character in the string setting up an auto-completion list. Default is '?' but can be changed if items contain '?'.
SetIndent
Set the number of spaces used for one level of indentation.
GetIndent
Retrieve indentation size.
SetUseTabs
Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
GetUseTabs
Retrieve whether tabs will be used in indentation.
SetLineIndentation
Change the indentation of a line to a number of columns.
GetLineIndentation
Retrieve the number of columns that a line is indented.
GetLineIndentPosition
Retrieve the position before the first non indentation character on a line.
GetColumn
Retrieve the column number of a position, taking tab width into account.
SetHScrollBar
Show or hide the horizontal scroll bar.
GetHScrollBar
Is the horizontal scroll bar visible?
SetIndentationGuides
Show or hide indentation guides.
GetIndentationGuides
Are the indentation guides visible?
SetHighlightGuide
Set the highlighted indentation guide column. 0 = no highlighted guide.
GetHighlightGuide
Get the highlighted indentation guide column.
GetLineEndPosition
Get the position after the last visible characters on a line.
GetCodePage
Get the code page used to interpret the bytes of the document as characters.
GetCaretFore
Get the foreground colour of the caret.
GetUsePalette
In palette mode?
GetReadOnly
In read-only mode?
SetCurrentPos
Sets the position of the caret.
SetSelectionStart
Sets the position that starts the selection - this becomes the anchor.
GetSelectionStart
Returns the position at the start of the selection.
SetSelectionEnd
Sets the position that ends the selection - this becomes the currentPosition.
GetSelectionEnd
SetPrintMagnification
Sets the print magnification added to the point size of each style for printing.
GetPrintMagnification
Returns the print magnification.
PRINT constant
PrintColourMode - use same colours as screen. SC_PRINT_NORMAL PrintColourMode - invert the light value of each style for printing. SC_PRINT_INVERTLIGHT PrintColourMode - force black text on white background for printing. SC_PRINT_BLACKONWHITE PrintColourMode - text stays coloured, but all background is forced to be white for printing. SC_PRINT_COLOURONWHITE PrintColourMode - only the default-background is forced to be white for printing. SC_PRINT_COLOURONWHITEDEFAULTBG
SetPrintColourMode
Modify colours when printing for clearer printed text.
GetPrintColourMode
Returns the print colour mode.
FIND constant
SCFIND_WHOLEWORD SCFIND_MATCHCASE SCFIND_WORDSTART SCFIND_REGEXP SCFIND_POSIX
FindText
Find some text in the document.
FormatRange
On Windows, will draw the document into a display context such as a printer.
GetFirstVisibleLine
Retrieve the display line at the top of the display.
GetLine
Return text of line.
GetLineCount
Returns the number of lines in the document. There is always at least one.
SetMarginLeft
Sets the size in pixels of the left margin.
GetMarginLeft
Returns the size in pixels of the left margin.
SetMarginRight
Sets the size in pixels of the right margin.
GetMarginRight
Returns the size in pixels of the right margin.
GetModify
Is the document different from when it was last saved?
SetSel
Select a range of text.
GetSelText
Retrieve the selected text.
GetTextRange
Retrieve a range of text.
HideSelection
Draw the selection in normal style or with selection highlighted.
PointXFromPosition
Retrieve the x value of the point in the window where a position is displayed.
PointYFromPosition
Retrieve the y value of the point in the window where a position is displayed.
LineFromPosition
Retrieve the line containing a position.
PositionFromLine
Retrieve the position at the start of a line.
LineScroll
Scroll horizontally and vertically.
ScrollCaret
Ensure the caret is visible.
ReplaceSel
Replace the selected text with the argument text.
SetReadOnly
Set to read only or read write.
Null
Null operation.
CanPaste
Will a paste succeed?
CanUndo
Are there any undoable actions in the undo history?
EmptyUndoBuffer
Delete the undo history.
Undo
Undo one action in the undo history.
Cut
Cut the selection to the clipboard.
Copy
Copy the selection to the clipboard.
Paste
Paste the contents of the clipboard into the document replacing the selection.
Clear
Clear the selection.
SetText
Replace the contents of the document with the argument text.
GetText
Retrieve all the text in the document.
GetTextLength
Retrieve the number of characters in the document.
GetDirectFunction
Retrieve a pointer to a function that processes messages for this Scintilla.
GetDirectPointer
SetOvertype
Set to overtype (true) or insert mode.
GetOvertype
Returns true if overtype mode is active otherwise false is returned.
SetCaretWidth
Set the width of the insert mode caret.
GetCaretWidth
Returns the width of the insert mode caret.
SetTargetStart
Sets the position that starts the target which is used for updating the document without affecting the scroll position.
GetTargetStart
Get the position that starts the target.
SetTargetEnd
Sets the position that ends the target which is used for updating the document without affecting the scroll position.
GetTargetEnd
Get the position that ends the target.
ReplaceTarget
Replace the target text with the argument text. Text is counted so it can contain NULs. Returns the length of the replacement text.
ReplaceTargetRE
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
SearchInTarget
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.
SetSearchFlags
Set the search flags used by SearchInTarget.
GetSearchFlags
Get the search flags used by SearchInTarget.
CallTipShow
Show a call tip containing a definition near position pos.
CallTipCancel
Remove the call tip from the screen.
CallTipActive
Is there an active call tip?
CallTipPosStart
Retrieve the position where the caret was before displaying the call tip.
CallTipSetHlt
Highlight a segment of the definition.
CallTipSetBack
Set the background colour for the call tip.
CallTipSetFore
Set the foreground colour for the call tip.
CallTipSetForeHlt
Set the foreground colour for the highlighted part of the call tip.
VisibleFromDocLine
Find the display line of a document line taking hidden lines into account.
DocLineFromVisible
Find the document line of a display line taking hidden lines into account.
FOLDERLEVEL constant
SC_FOLDLEVELBASE SC_FOLDLEVELWHITEFLAG SC_FOLDLEVELHEADERFLAG SC_FOLDLEVELBOXHEADERFLAG SC_FOLDLEVELBOXFOOTERFLAG SC_FOLDLEVELCONTRACTED SC_FOLDLEVELUNINDENT SC_FOLDLEVELNUMBERMASK
SetFoldLevel
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.
GetFoldLevel
Retrieve the fold level of a line.
GetLastChild
Find the last child line of a header line.
GetFoldParent
Find the parent line of a child line.
ShowLines
Make a range of lines visible.
HideLines
Make a range of lines invisible.
GetLineVisible
Is a line visible?
SetFoldExpanded
Show the children of a header line.
GetFoldExpanded
Is a header line expanded ?
ToggleFold
Switch a header line between expanded and contracted.
EnsureVisible
Ensure a particular line is visible by expanding any header line hiding it.
FOLDFLAG constant
SC_FOLDFLAG_LINEBEFORE_EXPANDED SC_FOLDFLAG_LINEBEFORE_CONTRACTED SC_FOLDFLAG_LINEAFTER_EXPANDED SC_FOLDFLAG_LINEAFTER_CONTRACTED SC_FOLDFLAG_LEVELNUMBERS SC_FOLDFLAG_BOX
SetFoldFlags
Set some style options for folding.
EnsureVisibleEnforcePolicy
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.
SetTabIndents
Sets whether a tab pressed when caret is within indentation indents.
GetTabIndents
Does a tab pressed when caret is within indentation indent?
SetBackSpaceUnIndents
Sets whether a backspace pressed when caret is within indentation unindents.
GetBackSpaceUnIndents
Does a backspace pressed when caret is within indentation unindent?
TIME constant
SC_TIME_FOREVER
SetMouseDwellTime
Sets the time the mouse must sit still to generate a mouse dwell event.
GetMouseDwellTime
Retrieve the time the mouse must sit still to generate a mouse dwell event.
WordStartPosition
Get position of start of word.
WordEndPosition
Get position of end of word.
WRAP constant
SC_WRAP_NONE SC_WRAP_WORD
SetWrapMode
Sets whether text is word wrapped.
GetWrapMode
Retrieve whether text is word wrapped.
CACHE constant
SC_CACHE_NONE SC_CACHE_CARET SC_CACHE_PAGE SC_CACHE_DOCUMENT
SetLayoutCache
Sets the degree of caching of layout information.
GetLayoutCache
Retrieve the degree of caching of layout information.
SetScrollWidth
Sets the document width assumed for scrolling.
GetScrollWidth
Retrieve the document width assumed for scrolling.
TextWidth
Measure the pixel width of some text in a particular style. NUL terminated text argument. Does not handle tab or control characters.
SetEndAtLastLine
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.
GetEndAtLastLine
Retrieve whether the maximum scroll position has the last line at the bottom of the view.
TextHeight
Retrieve the height of a particular line of text in pixels.
SetVScrollBar
Show or hide the vertical scroll bar.
GetVScrollBar
Is the vertical scroll bar visible?
AppendText
Append a string to the end of the document without changing the selection.
GetTwoPhaseDraw
Is drawing done in two phases with backgrounds drawn before faoregrounds?
SetTwoPhaseDraw
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.
TargetFromSelection
Make the target range start and end be the same as the selection range start and end.
LinesJoin
Join the lines in the target. This is an experimental feature and may be changed or removed.
LinesSplit
Split the lines in the target into lines that are less wide than pixelWidth where possible.
SetFoldMarginColour
Set the colours used as a chequerboard pattern in the fold margin
SetFoldMarginHiColour
LineDown
Move caret down one line.
LineDownExtend
Move caret down one line extending selection to new caret position.
LineUp
Move caret up one line.
LineUpExtend
Move caret up one line extending selection to new caret position.
CharLeft
Move caret left one character.
CharLeftExtend
Move caret left one character extending selection to new caret position.
CharRight
Move caret right one character.
CharRightExtend
Move caret right one character extending selection to new caret position.
WordLeft
Move caret left one word.
WordLeftExtend
Move caret left one word extending selection to new caret position.
WordRight
Move caret right one word.
WordRightExtend
Move caret right one word extending selection to new caret position.
Home
Move caret to first position on line.
HomeExtend
Move caret to first position on line extending selection to new caret position.
LineEnd
Move caret to last position on line.
LineEndExtend
Move caret to last position on line extending selection to new caret position.
DocumentStart
Move caret to first position in document.
DocumentStartExtend
Move caret to first position in document extending selection to new caret position.
DocumentEnd
Move caret to last position in document.
DocumentEndExtend
Move caret to last position in document extending selection to new caret position.
PageUp
Move caret one page up.
PageUpExtend
Move caret one page up extending selection to new caret position.
PageDown
Move caret one page down.
PageDownExtend
Move caret one page down extending selection to new caret position.
EditToggleOvertype
Switch from insert to overtype mode or the reverse.
Cancel
Cancel any modes such as call tip or auto-completion list display.
DeleteBack
Delete the selection or if no selection, the character before the caret.
Tab
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.
BackTab
Dedent the selected lines.
NewLine
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
FormFeed
Insert a Form Feed character.
VCHome
Move caret to before first visible character on line. If already there move to first character on line.
VCHomeExtend
Like VCHome but extending selection to new caret position.
ZoomIn
Magnify the displayed text by increasing the sizes by 1 point.
ZoomOut
Make the displayed text smaller by decreasing the sizes by 1 point.
DelWordLeft
Delete the word to the left of the caret.
DelWordRight
Delete the word to the right of the caret.
LineCut
Cut the line containing the caret.
LineDelete
Delete the line containing the caret.
LineTranspose
Switch the current line with the previous.
LineDuplicate
Duplicate the current line.
LowerCase
Transform the selection to lower case.
UpperCase
Transform the selection to upper case.
LineScrollDown
Scroll the document down, keeping the caret visible.
LineScrollUp
Scroll the document up, keeping the caret visible.
DeleteBackNotLine
Delete the selection or if no selection, the character before the caret. Will not delete the character before at the start of a line.
HomeDisplay
Move caret to first position on display line.
HomeDisplayExtend
Move caret to first position on display line extending selection to new caret position.
LineEndDisplay
Move caret to last position on display line.
LineEndDisplayExtend
Move caret to last position on display line extending selection to new caret position.
HomeWrap
These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.
HomeWrapExtend
See HomeWrap
LineEndWrap
LineEndWrapExtend
VCHomeWrap
VCHomeWrapExtend
LineCopy
Copy the line containing the caret.
MoveCaretInsideView
Move the caret inside current view if it's not there already.
LineLength
How many characters are on a line, not including end of line characters?
BraceHighlight
Highlight the characters at two positions.
BraceBadLight
Highlight the character at a position indicating there is no matching brace.
BraceMatch
Find the position of a matching brace or INVALID_POSITION if no match.
GetViewEOL
Are the end of line characters visible?
SetViewEOL
Make the end of line characters visible or invisible.
GetDocPointer
Retrieve a pointer to the document object.
SetDocPointer
Change the document object used.
SetModEventMask
Set which document modification events are sent to the container.
EDGE constant
EDGE_NONE EDGE_LINE EDGE_BACKGROUND
GetEdgeColumn
Retrieve the column number which text should be kept within.
SetEdgeColumn
Set the column number of the edge. If text goes past the edge then it is highlighted.
GetEdgeMode
Retrieve the edge highlight mode.
SetEdgeMode
The edge may be displayed by a line (EDGE_LINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
GetEdgeColour
Retrieve the colour used in edge indication.
SetEdgeColour
Change the colour used in edge indication.
SearchAnchor
Sets the current caret position to be the search anchor.
SearchNext
Find some text starting at the search anchor. Does not ensure the selection is visible.
SearchPrev
Find some text starting at the search anchor and moving backwards. Does not ensure the selection is visible.
LinesOnScreen
Retrieves the number of lines completely visible.
UsePopUp
Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button
SelectionIsRectangle
Is the selection rectangular? The alternative is the more common stream selection.
SetZoom
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.
GetZoom
Retrieve the zoom level.
CreateDocument
Create a new document object. Starts with reference count of 1 and not selected into editor.
AddRefDocument
Extend life of document.
ReleaseDocument
Release a reference to the document, deleting document if it fades to black.
GetModEventMask
Get which document modification events are sent to the container.
SetFocus
Change internal focus flag.
GetFocus
Get internal focus flag.
SetStatus
Change error status - 0 = OK.
GetStatus
Get error status.
SetMouseDownCaptures
Set whether the mouse is captured when its button is pressed.
GetMouseDownCaptures
Get whether mouse gets captured.
CURSOR constant
SC_CURSORNORMAL SC_CURSORWAIT
SetCursor
Sets the cursor to one of the SC_CURSOR* values.
GetCursor
Get cursor type.
SetControlCharSymbol
Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
GetControlCharSymbol
Get the way control characters are displayed.
WordPartLeft
Move to the previous change in capitalisation.
WordPartLeftExtend
Move to the previous change in capitalisation extending selection to new caret position.
WordPartRight
Move to the change next in capitalisation.
WordPartRightExtend
Move to the next change in capitalisation extending selection to new caret position.
VISIBLE constant
VISIBLE_SLOP VISIBLE_STRICT
SetVisiblePolicy
Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
DelLineLeft
Delete back from the current position to the start of the line.
DelLineRight
Delete forwards from the current position to the end of the line.
SetXOffset
Set the xOffset (ie, horizonal scroll position).
GetXOffset
Get the xOffset (ie, horizonal scroll position).
ChooseCaretX
Set the last x chosen value to be the caret x position.
GrabFocus
Set the focus to this Scintilla widget.
CARET constant
CARET_SLOP If CARET_SLOP is set, we can define a slop value: caretSlop. This value defines an unwanted zone (UZ) where the caret is... unwanted. This zone is defined as a number of pixels near the vertical margins, and as a number of lines near the horizontal margins. By keeping the caret away from the edges, it is seen within its context, so it is likely that the identifier that the caret is on can be completely seen, and that the current line is seen with some of the lines following it which are often dependent on that line. CARET_STRICT If CARET_STRICT is set, the policy is enforced... strictly. The caret is centred on the display if slop is not set, and cannot go in the UZ if slop is set. CARET_JUMPS If CARET_JUMPS is set, the display is moved more energetically so the caret can move in the same direction longer before the policy is applied again. CARET_EVEN If CARET_EVEN is not set, instead of having symmetrical UZs, the left and bottom UZs are extended up to right and top UZs respectively. This way, we favour the displaying of useful information: the begining of lines, where most code reside, and the lines after the caret, eg. the body of a function.
SetXCaretPolicy
Set the way the caret is kept visible when going sideway. The exclusion zone is given in pixels.
SetYCaretPolicy
Set the way the line the caret is on is kept visible. The exclusion zone is given in lines.
SetPrintWrapMode
Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
GetPrintWrapMode
Is printing line wrapped?
SetHotspotActiveFore
Set a fore colour for active hotspots.
SetHotspotActiveBack
Set a back colour for active hotspots.
SetHotspotActiveUnderline
Enable / Disable underlining active hotspots.
SetHotspotSingleLine
Limit hotspots to single line so hotspots on two lines don't merge.
ParaDown
Move caret between paragraphs (delimited by empty lines).
ParaDownExtend
ParaUp
ParaUpExtend
PositionBefore
Given a valid document position, return the previous position taking code page into account. Returns 0 if passed 0.
PositionAfter
Given a valid document position, return the next position taking code page into account. Maximum value returned is the last position in the document.
CopyRange
Copy a range of text to the clipboard. Positions are clipped into the document.
CopyText
Copy argument text to the clipboard.
SetSelectionMode
Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE) or by lines (SC_SEL_LINES).
GetSelectionMode
Get the mode of the current selection.
GetLineSelStartPosition
Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
GetLineSelEndPosition
Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
LineDownRectExtend
Move caret down one line, extending rectangular selection to new caret position.
LineUpRectExtend
Move caret up one line, extending rectangular selection to new caret position.
CharLeftRectExtend
Move caret left one character, extending rectangular selection to new caret position.
CharRightRectExtend
Move caret right one character, extending rectangular selection to new caret position.
HomeRectExtend
Move caret to first position on line, extending rectangular selection to new caret position.
VCHomeRectExtend
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.
LineEndRectExtend
Move caret to last position on line, extending rectangular selection to new caret position.
PageUpRectExtend
Move caret one page up, extending rectangular selection to new caret position.
PageDownRectExtend
Move caret one page down, extending rectangular selection to new caret position.
StutteredPageUp
Move caret to top of page, or one page up if already at top of page.
StutteredPageUpExtend
Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
StutteredPageDown
Move caret to bottom of page, or one page down if already at bottom of page.
StutteredPageDownExtend
Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
WordLeftEnd
Move caret left one word, position cursor at end of word.
WordLeftEndExtend
Move caret left one word, position cursor at end of word, extending selection to new caret position.
WordRightEnd
Move caret right one word, position cursor at end of word.
WordRightEndExtend
Move caret right one word, position cursor at end of word, extending selection to new caret position.
SetWhitespaceChars
Set the set of characters making up whitespace for when moving or selecting by word. Should be called after SetWordChars.
SetCharsDefault
Reset the set of characters for whitespace and word characters to the defaults.
AutoCGetCurrent
Get currently selected item position in the auto-completion list.
Allocate
Enlarge the document to a particular size of text bytes.
StartRecord
Start notifying the container of all key presses and commands.
StopRecord
Stop notifying the container of all key presses and commands.
SetLexer
Set the lexing language of the document.
GetLexer
Retrieve the lexing language of the document.
Colourise
Colourise a segment of the document using the current lexing language.
SetProperty
Set up a value that may be used by a lexer for some optional feature.
SetKeyWords
Set up the key words used by the lexer. Maximum value of keywordSet parameter of SetKeyWordsis defined by KEYWORDSET_MAX.
SetLexerLanguage
Set the lexing language of the document based on string name.
LoadLexerLibrary
Load a lexer library (dll / so).
Lexer constant
See Scintilla.pm SCLEX_* contante for lexer language. SCE_* for lexer constante. See comment for relation between Lexer language and lexer constante.
Laurent Rocher (lrocher@cpan.org) HomePage :http://perso.club-internet.fr/rocherl/Win32GUI.html
Win32::GUI
8 POD Errors
The following errors were encountered while parsing the POD:
'=item' outside of any '=over'
You forgot a '=back' before '=head2'
You forgot a '=back' before '=head1'
To install Win32::GUI::Scintilla, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Win32::GUI::Scintilla
CPAN shell
perl -MCPAN -e shell install Win32::GUI::Scintilla
For more information on module installation, please visit the detailed CPAN module installation guide.