diff --git a/PythonScript/src/Scintilla.iface b/PythonScript/src/Scintilla.iface index cea44acc..bde4017e 100644 --- a/PythonScript/src/Scintilla.iface +++ b/PythonScript/src/Scintilla.iface @@ -248,10 +248,10 @@ enu IMEInteraction=SC_IME_ val SC_IME_WINDOWED=0 val SC_IME_INLINE=1 -# Is the IME displayed in a winow or inline? +# Is the IME displayed in a window or inline? get int GetIMEInteraction=2678(,) -# Choose to display the the IME in a winow or inline. +# Choose to display the the IME in a window or inline. set void SetIMEInteraction=2679(int imeInteraction,) enu MarkerSymbol=SC_MARK_ @@ -1396,7 +1396,7 @@ val SC_MULTIPASTE_EACH=1 # Change the effect of pasting when there are multiple selections. set void SetMultiPaste=2614(int multiPaste,) -# Retrieve the effect of pasting when there are multiple selections.. +# Retrieve the effect of pasting when there are multiple selections. get int GetMultiPaste=2615(,) # Retrieve the value of a tag from a regular expression search. @@ -1413,8 +1413,9 @@ fun void LinesJoin=2288(,) # where possible. fun void LinesSplit=2289(int pixelWidth,) -# Set the colours used as a chequerboard pattern in the fold margin +# Set one of the colours used as a chequerboard pattern in the fold margin fun void SetFoldMarginColour=2290(bool useSetting, colour back) +# Set the other colour used as a chequerboard pattern in the fold margin fun void SetFoldMarginHiColour=2291(bool useSetting, colour fore) ## New messages go here @@ -1578,17 +1579,28 @@ fun void LineEndDisplay=2347(,) # caret position. fun void LineEndDisplayExtend=2348(,) -# 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)?. - +# Like Home but when word-wrap is enabled goes first to start of display line +# HomeDisplay, then to start of document line Home. fun void HomeWrap=2349(,) + +# Like HomeExtend but when word-wrap is enabled extends first to start of display line +# HomeDisplayExtend, then to start of document line HomeExtend. fun void HomeWrapExtend=2450(,) + +# Like LineEnd but when word-wrap is enabled goes first to end of display line +# LineEndDisplay, then to start of document line LineEnd. fun void LineEndWrap=2451(,) + +# Like LineEndExtend but when word-wrap is enabled extends first to end of display line +# LineEndDisplayExtend, then to start of document line LineEndExtend. fun void LineEndWrapExtend=2452(,) + +# Like VCHome but when word-wrap is enabled goes first to start of display line +# VCHomeDisplay, then behaves like VCHome. fun void VCHomeWrap=2453(,) + +# Like VCHomeExtend but when word-wrap is enabled extends first to start of display line +# VCHomeDisplayExtend, then behaves like VCHomeExtend. fun void VCHomeWrapExtend=2454(,) # Copy the line containing the caret. @@ -1755,8 +1767,10 @@ fun void DelLineLeft=2395(,) # Delete forwards from the current position to the end of the line. fun void DelLineRight=2396(,) -# Get and Set the xOffset (ie, horizontal scroll position). +# Set the xOffset (ie, horizontal scroll position). set void SetXOffset=2397(int newOffset,) + +# Get the xOffset (ie, horizontal scroll position). get int GetXOffset=2398(,) # Set the last x chosen value to be the caret x position. @@ -1785,7 +1799,7 @@ val CARET_STRICT=0x04 val CARET_JUMPS=0x10 # 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, +# This way, we favour the displaying of useful information: the beginning of lines, # where most code reside, and the lines after the caret, eg. the body of a function. val CARET_EVEN=0x08 @@ -1827,10 +1841,13 @@ set void SetHotspotSingleLine=2421(bool singleLine,) # Get the HotspotSingleLine property get bool GetHotspotSingleLine=2497(,) -# Move caret between paragraphs (delimited by empty lines). +# Move caret down one paragraph (delimited by empty lines). fun void ParaDown=2413(,) +# Extend selection down one paragraph (delimited by empty lines). fun void ParaDownExtend=2414(,) +# Move caret up one paragraph (delimited by empty lines). fun void ParaUp=2415(,) +# Extend selection up one paragraph (delimited by empty lines). fun void ParaUpExtend=2416(,) # Given a valid document position, return the previous position taking code @@ -1968,7 +1985,7 @@ val SC_MULTIAUTOC_EACH=1 # Change the effect of autocompleting when there are multiple selections. set void AutoCSetMulti=2636(int multi,) -# Retrieve the effect of autocompleting when there are multiple selections.. +# Retrieve the effect of autocompleting when there are multiple selections. get int AutoCGetMulti=2637(,) enu Ordering=SC_ORDER_ @@ -2276,13 +2293,21 @@ set void SetMainSelection=2574(int selection,) # Which selection is the main selection get int GetMainSelection=2575(,) +# Set the caret position of the nth selection. set void SetSelectionNCaret=2576(int selection, position pos) +# Return the caret position of the nth selection. get position GetSelectionNCaret=2577(int selection,) +# Set the anchor position of the nth selection. set void SetSelectionNAnchor=2578(int selection, position posAnchor) +# Return the anchor position of the nth selection. get position GetSelectionNAnchor=2579(int selection,) +# Set the virtual space of the caret of the nth selection. set void SetSelectionNCaretVirtualSpace=2580(int selection, int space) +# Return the virtual space of the caret of the nth selection. get int GetSelectionNCaretVirtualSpace=2581(int selection,) +# Set the virtual space of the anchor of the nth selection. set void SetSelectionNAnchorVirtualSpace=2582(int selection, int space) +# Return the virtual space of the anchor of the nth selection. get int GetSelectionNAnchorVirtualSpace=2583(int selection,) # Sets the position that starts the selection - this becomes the anchor. @@ -2297,13 +2322,21 @@ set void SetSelectionNEnd=2586(int selection, position pos) # Returns the position at the end of the selection. get position GetSelectionNEnd=2587(int selection,) +# Set the caret position of the rectangular selection. set void SetRectangularSelectionCaret=2588(position pos,) +# Return the caret position of the rectangular selection. get position GetRectangularSelectionCaret=2589(,) +# Set the anchor position of the rectangular selection. set void SetRectangularSelectionAnchor=2590(position posAnchor,) +# Return the anchor position of the rectangular selection. get position GetRectangularSelectionAnchor=2591(,) +# Set the virtual space of the caret of the rectangular selection. set void SetRectangularSelectionCaretVirtualSpace=2592(int space,) +# Return the virtual space of the caret of the rectangular selection. get int GetRectangularSelectionCaretVirtualSpace=2593(,) +# Set the virtual space of the anchor of the rectangular selection. set void SetRectangularSelectionAnchorVirtualSpace=2594(int space,) +# Return the virtual space of the anchor of the rectangular selection. get int GetRectangularSelectionAnchorVirtualSpace=2595(,) enu VirtualSpace=SCVS_ @@ -2311,7 +2344,9 @@ val SCVS_NONE=0 val SCVS_RECTANGULARSELECTION=1 val SCVS_USERACCESSIBLE=2 +# Set options for virtual space behaviour. set void SetVirtualSpaceOptions=2596(int virtualSpaceOptions,) +# Return options for virtual space behaviour. get int GetVirtualSpaceOptions=2597(,) # On GTK+, allow selecting the modifier key to use for mouse-based diff --git a/PythonScript/src/ScintillaPython.cpp b/PythonScript/src/ScintillaPython.cpp index 4dbbad2d..fbe2a068 100644 --- a/PythonScript/src/ScintillaPython.cpp +++ b/PythonScript/src/ScintillaPython.cpp @@ -154,8 +154,8 @@ BOOST_PYTHON_MODULE(Npp) .def("addTabStop", &ScintillaWrapper::AddTabStop, boost::python::args("line", "x"), "Add an explicit tab stop for a line.") .def("getNextTabStop", &ScintillaWrapper::GetNextTabStop, boost::python::args("line", "x"), "Find the next explicit tab stop position on a line after a position.") .def("setCodePage", &ScintillaWrapper::SetCodePage, boost::python::args("codePage"), "Set the code page used to interpret the bytes of the document as characters.\nThe SC_CP_UTF8 value can be used to enter Unicode mode.") - .def("getIMEInteraction", &ScintillaWrapper::GetIMEInteraction, "Is the IME displayed in a winow or inline?") - .def("setIMEInteraction", &ScintillaWrapper::SetIMEInteraction, boost::python::args("imeInteraction"), "Choose to display the the IME in a winow or inline.") + .def("getIMEInteraction", &ScintillaWrapper::GetIMEInteraction, "Is the IME displayed in a window or inline?") + .def("setIMEInteraction", &ScintillaWrapper::SetIMEInteraction, boost::python::args("imeInteraction"), "Choose to display the the IME in a window or inline.") .def("markerDefine", &ScintillaWrapper::MarkerDefine, boost::python::args("markerNumber", "markerSymbol"), "Set the symbol used for a particular marker number.") .def("markerSetFore", &ScintillaWrapper::MarkerSetFore, boost::python::args("markerNumber", "fore"), "Set the foreground colour used for a particular marker number.") .def("markerSetBack", &ScintillaWrapper::MarkerSetBack, boost::python::args("markerNumber", "back"), "Set the background colour used for a particular marker number.") @@ -436,13 +436,13 @@ BOOST_PYTHON_MODULE(Npp) .def("getFontQuality", &ScintillaWrapper::GetFontQuality, "Retrieve the quality level for text.") .def("setFirstVisibleLine", &ScintillaWrapper::SetFirstVisibleLine, boost::python::args("lineDisplay"), "Scroll so that a display line is at the top of the display.") .def("setMultiPaste", &ScintillaWrapper::SetMultiPaste, boost::python::args("multiPaste"), "Change the effect of pasting when there are multiple selections.") - .def("getMultiPaste", &ScintillaWrapper::GetMultiPaste, "Retrieve the effect of pasting when there are multiple selections..") + .def("getMultiPaste", &ScintillaWrapper::GetMultiPaste, "Retrieve the effect of pasting when there are multiple selections.") .def("getTag", &ScintillaWrapper::GetTag, boost::python::args("tagNumber"), "Retrieve the value of a tag from a regular expression search.\nResult is NUL-terminated.") .def("targetFromSelection", &ScintillaWrapper::TargetFromSelection, "Make the target range start and end be the same as the selection range start and end.") .def("linesJoin", &ScintillaWrapper::LinesJoin, "Join the lines in the target.") .def("linesSplit", &ScintillaWrapper::LinesSplit, boost::python::args("pixelWidth"), "Split the lines in the target into lines that are less wide than pixelWidth\nwhere possible.") - .def("setFoldMarginColour", &ScintillaWrapper::SetFoldMarginColour, boost::python::args("useSetting", "back"), "Set the colours used as a chequerboard pattern in the fold margin") - .def("setFoldMarginHiColour", &ScintillaWrapper::SetFoldMarginHiColour, boost::python::args("useSetting", "fore"), "Set the colours used as a chequerboard pattern in the fold margin") + .def("setFoldMarginColour", &ScintillaWrapper::SetFoldMarginColour, boost::python::args("useSetting", "back"), "Set one of the colours used as a chequerboard pattern in the fold margin") + .def("setFoldMarginHiColour", &ScintillaWrapper::SetFoldMarginHiColour, boost::python::args("useSetting", "fore"), "Set the other colour used as a chequerboard pattern in the fold margin") .def("lineDown", &ScintillaWrapper::LineDown, "Move caret down one line.") .def("lineDownExtend", &ScintillaWrapper::LineDownExtend, "Move caret down one line extending selection to new caret position.") .def("lineUp", &ScintillaWrapper::LineUp, "Move caret up one line.") @@ -494,12 +494,12 @@ BOOST_PYTHON_MODULE(Npp) .def("homeDisplayExtend", &ScintillaWrapper::HomeDisplayExtend, "Move caret to first position on display line extending selection to\nnew caret position.") .def("lineEndDisplay", &ScintillaWrapper::LineEndDisplay, "Move caret to last position on display line.") .def("lineEndDisplayExtend", &ScintillaWrapper::LineEndDisplayExtend, "Move caret to last position on display line extending selection to new\ncaret position.") - .def("homeWrap", &ScintillaWrapper::HomeWrap, "These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?\nexcept they behave differently when word-wrap is enabled:\nThey go first to the start / end of the display line, like (Home|LineEnd)Display\nThe difference is that, the cursor is already at the point, it goes on to the start\nor end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.") - .def("homeWrapExtend", &ScintillaWrapper::HomeWrapExtend, "These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?\nexcept they behave differently when word-wrap is enabled:\nThey go first to the start / end of the display line, like (Home|LineEnd)Display\nThe difference is that, the cursor is already at the point, it goes on to the start\nor end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.") - .def("lineEndWrap", &ScintillaWrapper::LineEndWrap, "These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?\nexcept they behave differently when word-wrap is enabled:\nThey go first to the start / end of the display line, like (Home|LineEnd)Display\nThe difference is that, the cursor is already at the point, it goes on to the start\nor end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.") - .def("lineEndWrapExtend", &ScintillaWrapper::LineEndWrapExtend, "These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?\nexcept they behave differently when word-wrap is enabled:\nThey go first to the start / end of the display line, like (Home|LineEnd)Display\nThe difference is that, the cursor is already at the point, it goes on to the start\nor end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.") - .def("vCHomeWrap", &ScintillaWrapper::VCHomeWrap, "These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?\nexcept they behave differently when word-wrap is enabled:\nThey go first to the start / end of the display line, like (Home|LineEnd)Display\nThe difference is that, the cursor is already at the point, it goes on to the start\nor end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.") - .def("vCHomeWrapExtend", &ScintillaWrapper::VCHomeWrapExtend, "These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?\nexcept they behave differently when word-wrap is enabled:\nThey go first to the start / end of the display line, like (Home|LineEnd)Display\nThe difference is that, the cursor is already at the point, it goes on to the start\nor end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.") + .def("homeWrap", &ScintillaWrapper::HomeWrap, "Like Home but when word-wrap is enabled goes first to start of display line\nHomeDisplay, then to start of document line Home.") + .def("homeWrapExtend", &ScintillaWrapper::HomeWrapExtend, "Like HomeExtend but when word-wrap is enabled extends first to start of display line\nHomeDisplayExtend, then to start of document line HomeExtend.") + .def("lineEndWrap", &ScintillaWrapper::LineEndWrap, "Like LineEnd but when word-wrap is enabled goes first to end of display line\nLineEndDisplay, then to start of document line LineEnd.") + .def("lineEndWrapExtend", &ScintillaWrapper::LineEndWrapExtend, "Like LineEndExtend but when word-wrap is enabled extends first to end of display line\nLineEndDisplayExtend, then to start of document line LineEndExtend.") + .def("vCHomeWrap", &ScintillaWrapper::VCHomeWrap, "Like VCHome but when word-wrap is enabled goes first to start of display line\nVCHomeDisplay, then behaves like VCHome.") + .def("vCHomeWrapExtend", &ScintillaWrapper::VCHomeWrapExtend, "Like VCHomeExtend but when word-wrap is enabled extends first to start of display line\nVCHomeDisplayExtend, then behaves like VCHomeExtend.") .def("lineCopy", &ScintillaWrapper::LineCopy, "Copy the line containing the caret.") .def("moveCaretInsideView", &ScintillaWrapper::MoveCaretInsideView, "Move the caret inside current view if it's not there already.") .def("lineLength", &ScintillaWrapper::LineLength, boost::python::args("line"), "How many characters are on a line, including end of line characters?") @@ -548,8 +548,8 @@ BOOST_PYTHON_MODULE(Npp) .def("setVisiblePolicy", &ScintillaWrapper::SetVisiblePolicy, boost::python::args("visiblePolicy", "visibleSlop"), "Set the way the display area is determined when a particular line\nis to be moved to by Find, FindNext, GotoLine, etc.") .def("delLineLeft", &ScintillaWrapper::DelLineLeft, "Delete back from the current position to the start of the line.") .def("delLineRight", &ScintillaWrapper::DelLineRight, "Delete forwards from the current position to the end of the line.") - .def("setXOffset", &ScintillaWrapper::SetXOffset, boost::python::args("newOffset"), "Get and Set the xOffset (ie, horizontal scroll position).") - .def("getXOffset", &ScintillaWrapper::GetXOffset, "Get and Set the xOffset (ie, horizontal scroll position).") + .def("setXOffset", &ScintillaWrapper::SetXOffset, boost::python::args("newOffset"), "Set the xOffset (ie, horizontal scroll position).") + .def("getXOffset", &ScintillaWrapper::GetXOffset, "Get the xOffset (ie, horizontal scroll position).") .def("chooseCaretX", &ScintillaWrapper::ChooseCaretX, "Set the last x chosen value to be the caret x position.") .def("grabFocus", &ScintillaWrapper::GrabFocus, "Set the focus to this Scintilla widget.") .def("setXCaretPolicy", &ScintillaWrapper::SetXCaretPolicy, boost::python::args("caretPolicy", "caretSlop"), "Set the way the caret is kept visible when going sideways.\nThe exclusion zone is given in pixels.") @@ -564,10 +564,10 @@ BOOST_PYTHON_MODULE(Npp) .def("getHotspotActiveUnderline", &ScintillaWrapper::GetHotspotActiveUnderline, "Get whether underlining for active hotspots.") .def("setHotspotSingleLine", &ScintillaWrapper::SetHotspotSingleLine, boost::python::args("singleLine"), "Limit hotspots to single line so hotspots on two lines don't merge.") .def("getHotspotSingleLine", &ScintillaWrapper::GetHotspotSingleLine, "Get the HotspotSingleLine property") - .def("paraDown", &ScintillaWrapper::ParaDown, "Move caret between paragraphs (delimited by empty lines).") - .def("paraDownExtend", &ScintillaWrapper::ParaDownExtend, "Move caret between paragraphs (delimited by empty lines).") - .def("paraUp", &ScintillaWrapper::ParaUp, "Move caret between paragraphs (delimited by empty lines).") - .def("paraUpExtend", &ScintillaWrapper::ParaUpExtend, "Move caret between paragraphs (delimited by empty lines).") + .def("paraDown", &ScintillaWrapper::ParaDown, "Move caret down one paragraph (delimited by empty lines).") + .def("paraDownExtend", &ScintillaWrapper::ParaDownExtend, "Extend selection down one paragraph (delimited by empty lines).") + .def("paraUp", &ScintillaWrapper::ParaUp, "Move caret up one paragraph (delimited by empty lines).") + .def("paraUpExtend", &ScintillaWrapper::ParaUpExtend, "Extend selection up one paragraph (delimited by empty lines).") .def("positionBefore", &ScintillaWrapper::PositionBefore, boost::python::args("pos"), "Given a valid document position, return the previous position taking code\npage into account. Returns 0 if passed 0.") .def("positionAfter", &ScintillaWrapper::PositionAfter, boost::python::args("pos"), "Given a valid document position, return the next position taking code\npage into account. Maximum value returned is the last position in the document.") .def("positionRelative", &ScintillaWrapper::PositionRelative, boost::python::args("pos", "relative"), "Given a valid document position, return a position that differs in a number\nof characters. Returned value is always between 0 and last position in document.") @@ -604,7 +604,7 @@ BOOST_PYTHON_MODULE(Npp) .def("autoCSetCaseInsensitiveBehaviour", &ScintillaWrapper::AutoCSetCaseInsensitiveBehaviour, boost::python::args("behaviour"), "Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.") .def("autoCGetCaseInsensitiveBehaviour", &ScintillaWrapper::AutoCGetCaseInsensitiveBehaviour, "Get auto-completion case insensitive behaviour.") .def("autoCSetMulti", &ScintillaWrapper::AutoCSetMulti, boost::python::args("multi"), "Change the effect of autocompleting when there are multiple selections.") - .def("autoCGetMulti", &ScintillaWrapper::AutoCGetMulti, "Retrieve the effect of autocompleting when there are multiple selections..") + .def("autoCGetMulti", &ScintillaWrapper::AutoCGetMulti, "Retrieve the effect of autocompleting when there are multiple selections.") .def("autoCSetOrder", &ScintillaWrapper::AutoCSetOrder, boost::python::args("order"), "Set the way autocompletion lists are ordered.") .def("autoCGetOrder", &ScintillaWrapper::AutoCGetOrder, "Get the way autocompletion lists are ordered.") .def("allocate", &ScintillaWrapper::Allocate, boost::python::args("bytes"), "Enlarge the document to a particular size of text bytes.") @@ -693,28 +693,28 @@ BOOST_PYTHON_MODULE(Npp) .def("dropSelectionN", &ScintillaWrapper::DropSelectionN, boost::python::args("selection"), "Drop one selection") .def("setMainSelection", &ScintillaWrapper::SetMainSelection, boost::python::args("selection"), "Set the main selection") .def("getMainSelection", &ScintillaWrapper::GetMainSelection, "Which selection is the main selection") - .def("setSelectionNCaret", &ScintillaWrapper::SetSelectionNCaret, boost::python::args("selection", "pos"), "Which selection is the main selection") - .def("getSelectionNCaret", &ScintillaWrapper::GetSelectionNCaret, boost::python::args("selection"), "Which selection is the main selection") - .def("setSelectionNAnchor", &ScintillaWrapper::SetSelectionNAnchor, boost::python::args("selection", "posAnchor"), "Which selection is the main selection") - .def("getSelectionNAnchor", &ScintillaWrapper::GetSelectionNAnchor, boost::python::args("selection"), "Which selection is the main selection") - .def("setSelectionNCaretVirtualSpace", &ScintillaWrapper::SetSelectionNCaretVirtualSpace, boost::python::args("selection", "space"), "Which selection is the main selection") - .def("getSelectionNCaretVirtualSpace", &ScintillaWrapper::GetSelectionNCaretVirtualSpace, boost::python::args("selection"), "Which selection is the main selection") - .def("setSelectionNAnchorVirtualSpace", &ScintillaWrapper::SetSelectionNAnchorVirtualSpace, boost::python::args("selection", "space"), "Which selection is the main selection") - .def("getSelectionNAnchorVirtualSpace", &ScintillaWrapper::GetSelectionNAnchorVirtualSpace, boost::python::args("selection"), "Which selection is the main selection") + .def("setSelectionNCaret", &ScintillaWrapper::SetSelectionNCaret, boost::python::args("selection", "pos"), "Set the caret position of the nth selection.") + .def("getSelectionNCaret", &ScintillaWrapper::GetSelectionNCaret, boost::python::args("selection"), "Return the caret position of the nth selection.") + .def("setSelectionNAnchor", &ScintillaWrapper::SetSelectionNAnchor, boost::python::args("selection", "posAnchor"), "Set the anchor position of the nth selection.") + .def("getSelectionNAnchor", &ScintillaWrapper::GetSelectionNAnchor, boost::python::args("selection"), "Return the anchor position of the nth selection.") + .def("setSelectionNCaretVirtualSpace", &ScintillaWrapper::SetSelectionNCaretVirtualSpace, boost::python::args("selection", "space"), "Set the virtual space of the caret of the nth selection.") + .def("getSelectionNCaretVirtualSpace", &ScintillaWrapper::GetSelectionNCaretVirtualSpace, boost::python::args("selection"), "Return the virtual space of the caret of the nth selection.") + .def("setSelectionNAnchorVirtualSpace", &ScintillaWrapper::SetSelectionNAnchorVirtualSpace, boost::python::args("selection", "space"), "Set the virtual space of the anchor of the nth selection.") + .def("getSelectionNAnchorVirtualSpace", &ScintillaWrapper::GetSelectionNAnchorVirtualSpace, boost::python::args("selection"), "Return the virtual space of the anchor of the nth selection.") .def("setSelectionNStart", &ScintillaWrapper::SetSelectionNStart, boost::python::args("selection", "pos"), "Sets the position that starts the selection - this becomes the anchor.") .def("getSelectionNStart", &ScintillaWrapper::GetSelectionNStart, boost::python::args("selection"), "Returns the position at the start of the selection.") .def("setSelectionNEnd", &ScintillaWrapper::SetSelectionNEnd, boost::python::args("selection", "pos"), "Sets the position that ends the selection - this becomes the currentPosition.") .def("getSelectionNEnd", &ScintillaWrapper::GetSelectionNEnd, boost::python::args("selection"), "Returns the position at the end of the selection.") - .def("setRectangularSelectionCaret", &ScintillaWrapper::SetRectangularSelectionCaret, boost::python::args("pos"), "Returns the position at the end of the selection.") - .def("getRectangularSelectionCaret", &ScintillaWrapper::GetRectangularSelectionCaret, "Returns the position at the end of the selection.") - .def("setRectangularSelectionAnchor", &ScintillaWrapper::SetRectangularSelectionAnchor, boost::python::args("posAnchor"), "Returns the position at the end of the selection.") - .def("getRectangularSelectionAnchor", &ScintillaWrapper::GetRectangularSelectionAnchor, "Returns the position at the end of the selection.") - .def("setRectangularSelectionCaretVirtualSpace", &ScintillaWrapper::SetRectangularSelectionCaretVirtualSpace, boost::python::args("space"), "Returns the position at the end of the selection.") - .def("getRectangularSelectionCaretVirtualSpace", &ScintillaWrapper::GetRectangularSelectionCaretVirtualSpace, "Returns the position at the end of the selection.") - .def("setRectangularSelectionAnchorVirtualSpace", &ScintillaWrapper::SetRectangularSelectionAnchorVirtualSpace, boost::python::args("space"), "Returns the position at the end of the selection.") - .def("getRectangularSelectionAnchorVirtualSpace", &ScintillaWrapper::GetRectangularSelectionAnchorVirtualSpace, "Returns the position at the end of the selection.") - .def("setVirtualSpaceOptions", &ScintillaWrapper::SetVirtualSpaceOptions, boost::python::args("virtualSpaceOptions"), "Returns the position at the end of the selection.") - .def("getVirtualSpaceOptions", &ScintillaWrapper::GetVirtualSpaceOptions, "Returns the position at the end of the selection.") + .def("setRectangularSelectionCaret", &ScintillaWrapper::SetRectangularSelectionCaret, boost::python::args("pos"), "Set the caret position of the rectangular selection.") + .def("getRectangularSelectionCaret", &ScintillaWrapper::GetRectangularSelectionCaret, "Return the caret position of the rectangular selection.") + .def("setRectangularSelectionAnchor", &ScintillaWrapper::SetRectangularSelectionAnchor, boost::python::args("posAnchor"), "Set the anchor position of the rectangular selection.") + .def("getRectangularSelectionAnchor", &ScintillaWrapper::GetRectangularSelectionAnchor, "Return the anchor position of the rectangular selection.") + .def("setRectangularSelectionCaretVirtualSpace", &ScintillaWrapper::SetRectangularSelectionCaretVirtualSpace, boost::python::args("space"), "Set the virtual space of the caret of the rectangular selection.") + .def("getRectangularSelectionCaretVirtualSpace", &ScintillaWrapper::GetRectangularSelectionCaretVirtualSpace, "Return the virtual space of the caret of the rectangular selection.") + .def("setRectangularSelectionAnchorVirtualSpace", &ScintillaWrapper::SetRectangularSelectionAnchorVirtualSpace, boost::python::args("space"), "Set the virtual space of the anchor of the rectangular selection.") + .def("getRectangularSelectionAnchorVirtualSpace", &ScintillaWrapper::GetRectangularSelectionAnchorVirtualSpace, "Return the virtual space of the anchor of the rectangular selection.") + .def("setVirtualSpaceOptions", &ScintillaWrapper::SetVirtualSpaceOptions, boost::python::args("virtualSpaceOptions"), "Set options for virtual space behaviour.") + .def("getVirtualSpaceOptions", &ScintillaWrapper::GetVirtualSpaceOptions, "Return options for virtual space behaviour.") .def("setRectangularSelectionModifier", &ScintillaWrapper::SetRectangularSelectionModifier, boost::python::args("modifier"), "On GTK+, allow selecting the modifier key to use for mouse-based\nrectangular selection. Often the window manager requires Alt+Mouse Drag\nfor moving windows.\nValid values are SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER.") .def("getRectangularSelectionModifier", &ScintillaWrapper::GetRectangularSelectionModifier, "Get the modifier key used for rectangular selection.") .def("setAdditionalSelFore", &ScintillaWrapper::SetAdditionalSelFore, boost::python::args("fore"), "Set the foreground colour of additional selections.\nMust have previously called SetSelFore with non-zero first argument for this to have an effect.") diff --git a/PythonScript/src/ScintillaWrapper.h b/PythonScript/src/ScintillaWrapper.h index ba05289e..ad5cb092 100644 --- a/PythonScript/src/ScintillaWrapper.h +++ b/PythonScript/src/ScintillaWrapper.h @@ -357,11 +357,11 @@ class ScintillaWrapper : public PyProducerConsumer */ void SetCodePage(int codePage); - /** Is the IME displayed in a winow or inline? + /** Is the IME displayed in a window or inline? */ intptr_t GetIMEInteraction(); - /** Choose to display the the IME in a winow or inline. + /** Choose to display the the IME in a window or inline. */ void SetIMEInteraction(int imeInteraction); @@ -1539,7 +1539,7 @@ class ScintillaWrapper : public PyProducerConsumer */ void SetMultiPaste(int multiPaste); - /** Retrieve the effect of pasting when there are multiple selections.. + /** Retrieve the effect of pasting when there are multiple selections. */ intptr_t GetMultiPaste(); @@ -1561,11 +1561,11 @@ class ScintillaWrapper : public PyProducerConsumer */ void LinesSplit(int pixelWidth); - /** Set the colours used as a chequerboard pattern in the fold margin + /** Set one of the colours used as a chequerboard pattern in the fold margin */ void SetFoldMarginColour(bool useSetting, boost::python::tuple back); - /** Set the colours used as a chequerboard pattern in the fold margin + /** Set the other colour used as a chequerboard pattern in the fold margin */ void SetFoldMarginHiColour(bool useSetting, boost::python::tuple fore); @@ -1778,51 +1778,33 @@ class ScintillaWrapper : public PyProducerConsumer */ void LineEndDisplayExtend(); - /** These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? - * except they behave differently when word-wrap is enabled: - * They go first to the start / end of the display line, like (Home|LineEnd)Display - * The difference is that, the cursor is already at the point, it goes on to the start - * or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. + /** Like Home but when word-wrap is enabled goes first to start of display line + * HomeDisplay, then to start of document line Home. */ void 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)?. + /** Like HomeExtend but when word-wrap is enabled extends first to start of display line + * HomeDisplayExtend, then to start of document line HomeExtend. */ void HomeWrapExtend(); - /** 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)?. + /** Like LineEnd but when word-wrap is enabled goes first to end of display line + * LineEndDisplay, then to start of document line LineEnd. */ void LineEndWrap(); - /** 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)?. + /** Like LineEndExtend but when word-wrap is enabled extends first to end of display line + * LineEndDisplayExtend, then to start of document line LineEndExtend. */ void LineEndWrapExtend(); - /** 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)?. + /** Like VCHome but when word-wrap is enabled goes first to start of display line + * VCHomeDisplay, then behaves like VCHome. */ void VCHomeWrap(); - /** 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)?. + /** Like VCHomeExtend but when word-wrap is enabled extends first to start of display line + * VCHomeDisplayExtend, then behaves like VCHomeExtend. */ void VCHomeWrapExtend(); @@ -2029,11 +2011,11 @@ class ScintillaWrapper : public PyProducerConsumer */ void DelLineRight(); - /** Get and Set the xOffset (ie, horizontal scroll position). + /** Set the xOffset (ie, horizontal scroll position). */ void SetXOffset(int newOffset); - /** Get and Set the xOffset (ie, horizontal scroll position). + /** Get the xOffset (ie, horizontal scroll position). */ intptr_t GetXOffset(); @@ -2095,19 +2077,19 @@ class ScintillaWrapper : public PyProducerConsumer */ bool GetHotspotSingleLine(); - /** Move caret between paragraphs (delimited by empty lines). + /** Move caret down one paragraph (delimited by empty lines). */ void ParaDown(); - /** Move caret between paragraphs (delimited by empty lines). + /** Extend selection down one paragraph (delimited by empty lines). */ void ParaDownExtend(); - /** Move caret between paragraphs (delimited by empty lines). + /** Move caret up one paragraph (delimited by empty lines). */ void ParaUp(); - /** Move caret between paragraphs (delimited by empty lines). + /** Extend selection up one paragraph (delimited by empty lines). */ void ParaUpExtend(); @@ -2265,7 +2247,7 @@ class ScintillaWrapper : public PyProducerConsumer */ void AutoCSetMulti(int multi); - /** Retrieve the effect of autocompleting when there are multiple selections.. + /** Retrieve the effect of autocompleting when there are multiple selections. */ intptr_t AutoCGetMulti(); @@ -2631,35 +2613,35 @@ class ScintillaWrapper : public PyProducerConsumer */ intptr_t GetMainSelection(); - /** Which selection is the main selection + /** Set the caret position of the nth selection. */ void SetSelectionNCaret(int selection, int pos); - /** Which selection is the main selection + /** Return the caret position of the nth selection. */ intptr_t GetSelectionNCaret(int selection); - /** Which selection is the main selection + /** Set the anchor position of the nth selection. */ void SetSelectionNAnchor(int selection, int posAnchor); - /** Which selection is the main selection + /** Return the anchor position of the nth selection. */ intptr_t GetSelectionNAnchor(int selection); - /** Which selection is the main selection + /** Set the virtual space of the caret of the nth selection. */ void SetSelectionNCaretVirtualSpace(int selection, int space); - /** Which selection is the main selection + /** Return the virtual space of the caret of the nth selection. */ intptr_t GetSelectionNCaretVirtualSpace(int selection); - /** Which selection is the main selection + /** Set the virtual space of the anchor of the nth selection. */ void SetSelectionNAnchorVirtualSpace(int selection, int space); - /** Which selection is the main selection + /** Return the virtual space of the anchor of the nth selection. */ intptr_t GetSelectionNAnchorVirtualSpace(int selection); @@ -2679,43 +2661,43 @@ class ScintillaWrapper : public PyProducerConsumer */ intptr_t GetSelectionNEnd(int selection); - /** Returns the position at the end of the selection. + /** Set the caret position of the rectangular selection. */ void SetRectangularSelectionCaret(int pos); - /** Returns the position at the end of the selection. + /** Return the caret position of the rectangular selection. */ intptr_t GetRectangularSelectionCaret(); - /** Returns the position at the end of the selection. + /** Set the anchor position of the rectangular selection. */ void SetRectangularSelectionAnchor(int posAnchor); - /** Returns the position at the end of the selection. + /** Return the anchor position of the rectangular selection. */ intptr_t GetRectangularSelectionAnchor(); - /** Returns the position at the end of the selection. + /** Set the virtual space of the caret of the rectangular selection. */ void SetRectangularSelectionCaretVirtualSpace(int space); - /** Returns the position at the end of the selection. + /** Return the virtual space of the caret of the rectangular selection. */ intptr_t GetRectangularSelectionCaretVirtualSpace(); - /** Returns the position at the end of the selection. + /** Set the virtual space of the anchor of the rectangular selection. */ void SetRectangularSelectionAnchorVirtualSpace(int space); - /** Returns the position at the end of the selection. + /** Return the virtual space of the anchor of the rectangular selection. */ intptr_t GetRectangularSelectionAnchorVirtualSpace(); - /** Returns the position at the end of the selection. + /** Set options for virtual space behaviour. */ void SetVirtualSpaceOptions(int virtualSpaceOptions); - /** Returns the position at the end of the selection. + /** Return options for virtual space behaviour. */ intptr_t GetVirtualSpaceOptions(); diff --git a/PythonScript/src/ScintillaWrapperGenerated.cpp b/PythonScript/src/ScintillaWrapperGenerated.cpp index ed051c92..1e45d7f4 100644 --- a/PythonScript/src/ScintillaWrapperGenerated.cpp +++ b/PythonScript/src/ScintillaWrapperGenerated.cpp @@ -422,7 +422,7 @@ void ScintillaWrapper::SetCodePage(int codePage) callScintilla(SCI_SETCODEPAGE, codePage); } -/** Is the IME displayed in a winow or inline? +/** Is the IME displayed in a window or inline? */ intptr_t ScintillaWrapper::GetIMEInteraction() { @@ -430,7 +430,7 @@ intptr_t ScintillaWrapper::GetIMEInteraction() return callScintilla(SCI_GETIMEINTERACTION); } -/** Choose to display the the IME in a winow or inline. +/** Choose to display the the IME in a window or inline. */ void ScintillaWrapper::SetIMEInteraction(int imeInteraction) { @@ -2827,7 +2827,7 @@ void ScintillaWrapper::SetMultiPaste(int multiPaste) callScintilla(SCI_SETMULTIPASTE, multiPaste); } -/** Retrieve the effect of pasting when there are multiple selections.. +/** Retrieve the effect of pasting when there are multiple selections. */ intptr_t ScintillaWrapper::GetMultiPaste() { @@ -2871,7 +2871,7 @@ void ScintillaWrapper::LinesSplit(int pixelWidth) callScintilla(SCI_LINESSPLIT, pixelWidth); } -/** Set the colours used as a chequerboard pattern in the fold margin +/** Set one of the colours used as a chequerboard pattern in the fold margin */ void ScintillaWrapper::SetFoldMarginColour(bool useSetting, boost::python::tuple back) { @@ -2880,7 +2880,7 @@ void ScintillaWrapper::SetFoldMarginColour(bool useSetting, boost::python::tuple callScintilla(SCI_SETFOLDMARGINCOLOUR, useSetting, static_cast(rgbback)); } -/** Set the colours used as a chequerboard pattern in the fold margin +/** Set the other colour used as a chequerboard pattern in the fold margin */ void ScintillaWrapper::SetFoldMarginHiColour(bool useSetting, boost::python::tuple fore) { @@ -3302,11 +3302,8 @@ void ScintillaWrapper::LineEndDisplayExtend() callScintilla(SCI_LINEENDDISPLAYEXTEND); } -/** These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? - * except they behave differently when word-wrap is enabled: - * They go first to the start / end of the display line, like (Home|LineEnd)Display - * The difference is that, the cursor is already at the point, it goes on to the start - * or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. +/** Like Home but when word-wrap is enabled goes first to start of display line + * HomeDisplay, then to start of document line Home. */ void ScintillaWrapper::HomeWrap() { @@ -3314,11 +3311,8 @@ void ScintillaWrapper::HomeWrap() callScintilla(SCI_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)?. +/** Like HomeExtend but when word-wrap is enabled extends first to start of display line + * HomeDisplayExtend, then to start of document line HomeExtend. */ void ScintillaWrapper::HomeWrapExtend() { @@ -3326,11 +3320,8 @@ void ScintillaWrapper::HomeWrapExtend() callScintilla(SCI_HOMEWRAPEXTEND); } -/** 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)?. +/** Like LineEnd but when word-wrap is enabled goes first to end of display line + * LineEndDisplay, then to start of document line LineEnd. */ void ScintillaWrapper::LineEndWrap() { @@ -3338,11 +3329,8 @@ void ScintillaWrapper::LineEndWrap() callScintilla(SCI_LINEENDWRAP); } -/** 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)?. +/** Like LineEndExtend but when word-wrap is enabled extends first to end of display line + * LineEndDisplayExtend, then to start of document line LineEndExtend. */ void ScintillaWrapper::LineEndWrapExtend() { @@ -3350,11 +3338,8 @@ void ScintillaWrapper::LineEndWrapExtend() callScintilla(SCI_LINEENDWRAPEXTEND); } -/** 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)?. +/** Like VCHome but when word-wrap is enabled goes first to start of display line + * VCHomeDisplay, then behaves like VCHome. */ void ScintillaWrapper::VCHomeWrap() { @@ -3362,11 +3347,8 @@ void ScintillaWrapper::VCHomeWrap() callScintilla(SCI_VCHOMEWRAP); } -/** 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)?. +/** Like VCHomeExtend but when word-wrap is enabled extends first to start of display line + * VCHomeDisplayExtend, then behaves like VCHomeExtend. */ void ScintillaWrapper::VCHomeWrapExtend() { @@ -3774,7 +3756,7 @@ void ScintillaWrapper::DelLineRight() callScintilla(SCI_DELLINERIGHT); } -/** Get and Set the xOffset (ie, horizontal scroll position). +/** Set the xOffset (ie, horizontal scroll position). */ void ScintillaWrapper::SetXOffset(int newOffset) { @@ -3782,7 +3764,7 @@ void ScintillaWrapper::SetXOffset(int newOffset) callScintilla(SCI_SETXOFFSET, newOffset); } -/** Get and Set the xOffset (ie, horizontal scroll position). +/** Get the xOffset (ie, horizontal scroll position). */ intptr_t ScintillaWrapper::GetXOffset() { @@ -3908,7 +3890,7 @@ bool ScintillaWrapper::GetHotspotSingleLine() return 0 != (callScintilla(SCI_GETHOTSPOTSINGLELINE)); } -/** Move caret between paragraphs (delimited by empty lines). +/** Move caret down one paragraph (delimited by empty lines). */ void ScintillaWrapper::ParaDown() { @@ -3916,7 +3898,7 @@ void ScintillaWrapper::ParaDown() callScintilla(SCI_PARADOWN); } -/** Move caret between paragraphs (delimited by empty lines). +/** Extend selection down one paragraph (delimited by empty lines). */ void ScintillaWrapper::ParaDownExtend() { @@ -3924,7 +3906,7 @@ void ScintillaWrapper::ParaDownExtend() callScintilla(SCI_PARADOWNEXTEND); } -/** Move caret between paragraphs (delimited by empty lines). +/** Move caret up one paragraph (delimited by empty lines). */ void ScintillaWrapper::ParaUp() { @@ -3932,7 +3914,7 @@ void ScintillaWrapper::ParaUp() callScintilla(SCI_PARAUP); } -/** Move caret between paragraphs (delimited by empty lines). +/** Extend selection up one paragraph (delimited by empty lines). */ void ScintillaWrapper::ParaUpExtend() { @@ -4247,7 +4229,7 @@ void ScintillaWrapper::AutoCSetMulti(int multi) callScintilla(SCI_AUTOCSETMULTI, multi); } -/** Retrieve the effect of autocompleting when there are multiple selections.. +/** Retrieve the effect of autocompleting when there are multiple selections. */ intptr_t ScintillaWrapper::AutoCGetMulti() { @@ -5000,7 +4982,7 @@ intptr_t ScintillaWrapper::GetMainSelection() return callScintilla(SCI_GETMAINSELECTION); } -/** Which selection is the main selection +/** Set the caret position of the nth selection. */ void ScintillaWrapper::SetSelectionNCaret(int selection, int pos) { @@ -5008,7 +4990,7 @@ void ScintillaWrapper::SetSelectionNCaret(int selection, int pos) callScintilla(SCI_SETSELECTIONNCARET, selection, pos); } -/** Which selection is the main selection +/** Return the caret position of the nth selection. */ intptr_t ScintillaWrapper::GetSelectionNCaret(int selection) { @@ -5016,7 +4998,7 @@ intptr_t ScintillaWrapper::GetSelectionNCaret(int selection) return callScintilla(SCI_GETSELECTIONNCARET, selection); } -/** Which selection is the main selection +/** Set the anchor position of the nth selection. */ void ScintillaWrapper::SetSelectionNAnchor(int selection, int posAnchor) { @@ -5024,7 +5006,7 @@ void ScintillaWrapper::SetSelectionNAnchor(int selection, int posAnchor) callScintilla(SCI_SETSELECTIONNANCHOR, selection, posAnchor); } -/** Which selection is the main selection +/** Return the anchor position of the nth selection. */ intptr_t ScintillaWrapper::GetSelectionNAnchor(int selection) { @@ -5032,7 +5014,7 @@ intptr_t ScintillaWrapper::GetSelectionNAnchor(int selection) return callScintilla(SCI_GETSELECTIONNANCHOR, selection); } -/** Which selection is the main selection +/** Set the virtual space of the caret of the nth selection. */ void ScintillaWrapper::SetSelectionNCaretVirtualSpace(int selection, int space) { @@ -5040,7 +5022,7 @@ void ScintillaWrapper::SetSelectionNCaretVirtualSpace(int selection, int space) callScintilla(SCI_SETSELECTIONNCARETVIRTUALSPACE, selection, space); } -/** Which selection is the main selection +/** Return the virtual space of the caret of the nth selection. */ intptr_t ScintillaWrapper::GetSelectionNCaretVirtualSpace(int selection) { @@ -5048,7 +5030,7 @@ intptr_t ScintillaWrapper::GetSelectionNCaretVirtualSpace(int selection) return callScintilla(SCI_GETSELECTIONNCARETVIRTUALSPACE, selection); } -/** Which selection is the main selection +/** Set the virtual space of the anchor of the nth selection. */ void ScintillaWrapper::SetSelectionNAnchorVirtualSpace(int selection, int space) { @@ -5056,7 +5038,7 @@ void ScintillaWrapper::SetSelectionNAnchorVirtualSpace(int selection, int space) callScintilla(SCI_SETSELECTIONNANCHORVIRTUALSPACE, selection, space); } -/** Which selection is the main selection +/** Return the virtual space of the anchor of the nth selection. */ intptr_t ScintillaWrapper::GetSelectionNAnchorVirtualSpace(int selection) { @@ -5096,7 +5078,7 @@ intptr_t ScintillaWrapper::GetSelectionNEnd(int selection) return callScintilla(SCI_GETSELECTIONNEND, selection); } -/** Returns the position at the end of the selection. +/** Set the caret position of the rectangular selection. */ void ScintillaWrapper::SetRectangularSelectionCaret(int pos) { @@ -5104,7 +5086,7 @@ void ScintillaWrapper::SetRectangularSelectionCaret(int pos) callScintilla(SCI_SETRECTANGULARSELECTIONCARET, pos); } -/** Returns the position at the end of the selection. +/** Return the caret position of the rectangular selection. */ intptr_t ScintillaWrapper::GetRectangularSelectionCaret() { @@ -5112,7 +5094,7 @@ intptr_t ScintillaWrapper::GetRectangularSelectionCaret() return callScintilla(SCI_GETRECTANGULARSELECTIONCARET); } -/** Returns the position at the end of the selection. +/** Set the anchor position of the rectangular selection. */ void ScintillaWrapper::SetRectangularSelectionAnchor(int posAnchor) { @@ -5120,7 +5102,7 @@ void ScintillaWrapper::SetRectangularSelectionAnchor(int posAnchor) callScintilla(SCI_SETRECTANGULARSELECTIONANCHOR, posAnchor); } -/** Returns the position at the end of the selection. +/** Return the anchor position of the rectangular selection. */ intptr_t ScintillaWrapper::GetRectangularSelectionAnchor() { @@ -5128,7 +5110,7 @@ intptr_t ScintillaWrapper::GetRectangularSelectionAnchor() return callScintilla(SCI_GETRECTANGULARSELECTIONANCHOR); } -/** Returns the position at the end of the selection. +/** Set the virtual space of the caret of the rectangular selection. */ void ScintillaWrapper::SetRectangularSelectionCaretVirtualSpace(int space) { @@ -5136,7 +5118,7 @@ void ScintillaWrapper::SetRectangularSelectionCaretVirtualSpace(int space) callScintilla(SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE, space); } -/** Returns the position at the end of the selection. +/** Return the virtual space of the caret of the rectangular selection. */ intptr_t ScintillaWrapper::GetRectangularSelectionCaretVirtualSpace() { @@ -5144,7 +5126,7 @@ intptr_t ScintillaWrapper::GetRectangularSelectionCaretVirtualSpace() return callScintilla(SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE); } -/** Returns the position at the end of the selection. +/** Set the virtual space of the anchor of the rectangular selection. */ void ScintillaWrapper::SetRectangularSelectionAnchorVirtualSpace(int space) { @@ -5152,7 +5134,7 @@ void ScintillaWrapper::SetRectangularSelectionAnchorVirtualSpace(int space) callScintilla(SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE, space); } -/** Returns the position at the end of the selection. +/** Return the virtual space of the anchor of the rectangular selection. */ intptr_t ScintillaWrapper::GetRectangularSelectionAnchorVirtualSpace() { @@ -5160,7 +5142,7 @@ intptr_t ScintillaWrapper::GetRectangularSelectionAnchorVirtualSpace() return callScintilla(SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE); } -/** Returns the position at the end of the selection. +/** Set options for virtual space behaviour. */ void ScintillaWrapper::SetVirtualSpaceOptions(int virtualSpaceOptions) { @@ -5168,7 +5150,7 @@ void ScintillaWrapper::SetVirtualSpaceOptions(int virtualSpaceOptions) callScintilla(SCI_SETVIRTUALSPACEOPTIONS, virtualSpaceOptions); } -/** Returns the position at the end of the selection. +/** Return options for virtual space behaviour. */ intptr_t ScintillaWrapper::GetVirtualSpaceOptions() { diff --git a/docs/source/scintilla.rst b/docs/source/scintilla.rst index 154b48a9..9e3088eb 100644 --- a/docs/source/scintilla.rst +++ b/docs/source/scintilla.rst @@ -330,13 +330,13 @@ Scintilla Methods .. method:: editor.getIMEInteraction() -> int - Is the IME displayed in a winow or inline? + Is the IME displayed in a window or inline? See Scintilla documentation for `SCI_GETIMEINTERACTION `_ .. method:: editor.setIMEInteraction(imeInteraction) - Choose to display the the IME in a winow or inline. + Choose to display the the IME in a window or inline. See Scintilla documentation for `SCI_SETIMEINTERACTION `_ @@ -2076,7 +2076,7 @@ Scintilla Methods .. method:: editor.getMultiPaste() -> int - Retrieve the effect of pasting when there are multiple selections.. + Retrieve the effect of pasting when there are multiple selections. See Scintilla documentation for `SCI_GETMULTIPASTE `_ @@ -2108,13 +2108,13 @@ Scintilla Methods .. method:: editor.setFoldMarginColour(useSetting, back) - Set the colours used as a chequerboard pattern in the fold margin + Set one of the colours used as a chequerboard pattern in the fold margin See Scintilla documentation for `SCI_SETFOLDMARGINCOLOUR `_ .. method:: editor.setFoldMarginHiColour(useSetting, fore) - Set the colours used as a chequerboard pattern in the fold margin + Set the other colour used as a chequerboard pattern in the fold margin See Scintilla documentation for `SCI_SETFOLDMARGINHICOLOUR `_ @@ -2431,61 +2431,43 @@ Scintilla Methods .. method:: editor.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)?. + Like Home but when word-wrap is enabled goes first to start of display line + HomeDisplay, then to start of document line Home. See Scintilla documentation for `SCI_HOMEWRAP `_ .. method:: editor.homeWrapExtend() - 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)?. + Like HomeExtend but when word-wrap is enabled extends first to start of display line + HomeDisplayExtend, then to start of document line HomeExtend. See Scintilla documentation for `SCI_HOMEWRAPEXTEND `_ .. method:: editor.lineEndWrap() - 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)?. + Like LineEnd but when word-wrap is enabled goes first to end of display line + LineEndDisplay, then to start of document line LineEnd. See Scintilla documentation for `SCI_LINEENDWRAP `_ .. method:: editor.lineEndWrapExtend() - 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)?. + Like LineEndExtend but when word-wrap is enabled extends first to end of display line + LineEndDisplayExtend, then to start of document line LineEndExtend. See Scintilla documentation for `SCI_LINEENDWRAPEXTEND `_ .. method:: editor.vCHomeWrap() - 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)?. + Like VCHome but when word-wrap is enabled goes first to start of display line + VCHomeDisplay, then behaves like VCHome. See Scintilla documentation for `SCI_VCHOMEWRAP `_ .. method:: editor.vCHomeWrapExtend() - 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)?. + Like VCHomeExtend but when word-wrap is enabled extends first to start of display line + VCHomeDisplayExtend, then behaves like VCHomeExtend. See Scintilla documentation for `SCI_VCHOMEWRAPEXTEND `_ @@ -2790,13 +2772,13 @@ Scintilla Methods .. method:: editor.setXOffset(newOffset) - Get and Set the xOffset (ie, horizontal scroll position). + Set the xOffset (ie, horizontal scroll position). See Scintilla documentation for `SCI_SETXOFFSET `_ .. method:: editor.getXOffset() -> int - Get and Set the xOffset (ie, horizontal scroll position). + Get the xOffset (ie, horizontal scroll position). See Scintilla documentation for `SCI_GETXOFFSET `_ @@ -2888,25 +2870,25 @@ Scintilla Methods .. method:: editor.paraDown() - Move caret between paragraphs (delimited by empty lines). + Move caret down one paragraph (delimited by empty lines). See Scintilla documentation for `SCI_PARADOWN `_ .. method:: editor.paraDownExtend() - Move caret between paragraphs (delimited by empty lines). + Extend selection down one paragraph (delimited by empty lines). See Scintilla documentation for `SCI_PARADOWNEXTEND `_ .. method:: editor.paraUp() - Move caret between paragraphs (delimited by empty lines). + Move caret up one paragraph (delimited by empty lines). See Scintilla documentation for `SCI_PARAUP `_ .. method:: editor.paraUpExtend() - Move caret between paragraphs (delimited by empty lines). + Extend selection up one paragraph (delimited by empty lines). See Scintilla documentation for `SCI_PARAUPEXTEND `_ @@ -3138,7 +3120,7 @@ Scintilla Methods .. method:: editor.autoCGetMulti() -> int - Retrieve the effect of autocompleting when there are multiple selections.. + Retrieve the effect of autocompleting when there are multiple selections. See Scintilla documentation for `SCI_AUTOCGETMULTI `_ @@ -3682,49 +3664,49 @@ Scintilla Methods .. method:: editor.setSelectionNCaret(selection, pos) - Which selection is the main selection + Set the caret position of the nth selection. See Scintilla documentation for `SCI_SETSELECTIONNCARET `_ .. method:: editor.getSelectionNCaret(selection) -> int - Which selection is the main selection + Return the caret position of the nth selection. See Scintilla documentation for `SCI_GETSELECTIONNCARET `_ .. method:: editor.setSelectionNAnchor(selection, posAnchor) - Which selection is the main selection + Set the anchor position of the nth selection. See Scintilla documentation for `SCI_SETSELECTIONNANCHOR `_ .. method:: editor.getSelectionNAnchor(selection) -> int - Which selection is the main selection + Return the anchor position of the nth selection. See Scintilla documentation for `SCI_GETSELECTIONNANCHOR `_ .. method:: editor.setSelectionNCaretVirtualSpace(selection, space) - Which selection is the main selection + Set the virtual space of the caret of the nth selection. See Scintilla documentation for `SCI_SETSELECTIONNCARETVIRTUALSPACE `_ .. method:: editor.getSelectionNCaretVirtualSpace(selection) -> int - Which selection is the main selection + Return the virtual space of the caret of the nth selection. See Scintilla documentation for `SCI_GETSELECTIONNCARETVIRTUALSPACE `_ .. method:: editor.setSelectionNAnchorVirtualSpace(selection, space) - Which selection is the main selection + Set the virtual space of the anchor of the nth selection. See Scintilla documentation for `SCI_SETSELECTIONNANCHORVIRTUALSPACE `_ .. method:: editor.getSelectionNAnchorVirtualSpace(selection) -> int - Which selection is the main selection + Return the virtual space of the anchor of the nth selection. See Scintilla documentation for `SCI_GETSELECTIONNANCHORVIRTUALSPACE `_ @@ -3754,61 +3736,61 @@ Scintilla Methods .. method:: editor.setRectangularSelectionCaret(pos) - Returns the position at the end of the selection. + Set the caret position of the rectangular selection. See Scintilla documentation for `SCI_SETRECTANGULARSELECTIONCARET `_ .. method:: editor.getRectangularSelectionCaret() -> int - Returns the position at the end of the selection. + Return the caret position of the rectangular selection. See Scintilla documentation for `SCI_GETRECTANGULARSELECTIONCARET `_ .. method:: editor.setRectangularSelectionAnchor(posAnchor) - Returns the position at the end of the selection. + Set the anchor position of the rectangular selection. See Scintilla documentation for `SCI_SETRECTANGULARSELECTIONANCHOR `_ .. method:: editor.getRectangularSelectionAnchor() -> int - Returns the position at the end of the selection. + Return the anchor position of the rectangular selection. See Scintilla documentation for `SCI_GETRECTANGULARSELECTIONANCHOR `_ .. method:: editor.setRectangularSelectionCaretVirtualSpace(space) - Returns the position at the end of the selection. + Set the virtual space of the caret of the rectangular selection. See Scintilla documentation for `SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE `_ .. method:: editor.getRectangularSelectionCaretVirtualSpace() -> int - Returns the position at the end of the selection. + Return the virtual space of the caret of the rectangular selection. See Scintilla documentation for `SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE `_ .. method:: editor.setRectangularSelectionAnchorVirtualSpace(space) - Returns the position at the end of the selection. + Set the virtual space of the anchor of the rectangular selection. See Scintilla documentation for `SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE `_ .. method:: editor.getRectangularSelectionAnchorVirtualSpace() -> int - Returns the position at the end of the selection. + Return the virtual space of the anchor of the rectangular selection. See Scintilla documentation for `SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE `_ .. method:: editor.setVirtualSpaceOptions(virtualSpaceOptions) - Returns the position at the end of the selection. + Set options for virtual space behaviour. See Scintilla documentation for `SCI_SETVIRTUALSPACEOPTIONS `_ .. method:: editor.getVirtualSpaceOptions() -> int - Returns the position at the end of the selection. + Return options for virtual space behaviour. See Scintilla documentation for `SCI_GETVIRTUALSPACEOPTIONS `_