_stc_gendocs.i

Wxpython Implemented on Windows CE, Source code

DocStr(wxStyledTextCtrl::BraceMatch,
"Find the position of a matching brace or INVALID_POSITION if no match.", "");

DocStr(wxStyledTextCtrl::GetViewEOL,
"Are the end of line characters visible?", "");

DocStr(wxStyledTextCtrl::SetViewEOL,
"Make the end of line characters visible or invisible.", "");

DocStr(wxStyledTextCtrl::GetDocPointer,
"Retrieve a pointer to the document object.", "");

DocStr(wxStyledTextCtrl::SetDocPointer,
"Change the document object used.", "");

DocStr(wxStyledTextCtrl::SetModEventMask,
"Set which document modification events are sent to the container.", "");

DocStr(wxStyledTextCtrl::GetEdgeColumn,
"Retrieve the column number which text should be kept within.", "");

DocStr(wxStyledTextCtrl::SetEdgeColumn,
"Set the column number of the edge.
If text goes past the edge then it is highlighted.", "");

DocStr(wxStyledTextCtrl::GetEdgeMode,
"Retrieve the edge highlight mode.", "");

DocStr(wxStyledTextCtrl::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).", "");

DocStr(wxStyledTextCtrl::GetEdgeColour,
"Retrieve the colour used in edge indication.", "");

DocStr(wxStyledTextCtrl::SetEdgeColour,
"Change the colour used in edge indication.", "");

DocStr(wxStyledTextCtrl::SearchAnchor,
"Sets the current caret position to be the search anchor.", "");

DocStr(wxStyledTextCtrl::SearchNext,
"Find some text starting at the search anchor.
Does not ensure the selection is visible.", "");

DocStr(wxStyledTextCtrl::SearchPrev,
"Find some text starting at the search anchor and moving backwards.
Does not ensure the selection is visible.", "");

DocStr(wxStyledTextCtrl::LinesOnScreen,
"Retrieves the number of lines completely visible.", "");

DocStr(wxStyledTextCtrl::UsePopUp,
"Set whether a pop up menu is displayed automatically when the user presses
the wrong mouse button.", "");

DocStr(wxStyledTextCtrl::SelectionIsRectangle,
"Is the selection rectangular? The alternative is the more common stream selection.", "");

DocStr(wxStyledTextCtrl::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.", "");

DocStr(wxStyledTextCtrl::GetZoom,
"Retrieve the zoom level.", "");

DocStr(wxStyledTextCtrl::CreateDocument,
"Create a new document object.
Starts with reference count of 1 and not selected into editor.", "");

DocStr(wxStyledTextCtrl::AddRefDocument,
"Extend life of document.", "");

DocStr(wxStyledTextCtrl::ReleaseDocument,
"Release a reference to the document, deleting document if it fades to black.", "");

DocStr(wxStyledTextCtrl::GetModEventMask,
"Get which document modification events are sent to the container.", "");

DocStr(wxStyledTextCtrl::SetSTCFocus,
"Change internal focus flag.", "");

DocStr(wxStyledTextCtrl::GetSTCFocus,
"Get internal focus flag.", "");

DocStr(wxStyledTextCtrl::SetStatus,
"Change error status - 0 = OK.", "");

DocStr(wxStyledTextCtrl::GetStatus,
"Get error status.", "");

DocStr(wxStyledTextCtrl::SetMouseDownCaptures,
"Set whether the mouse is captured when its button is pressed.", "");

DocStr(wxStyledTextCtrl::GetMouseDownCaptures,
"Get whether mouse gets captured.", "");

DocStr(wxStyledTextCtrl::SetSTCCursor,
"Sets the cursor to one of the SC_CURSOR* values.", "");

DocStr(wxStyledTextCtrl::GetSTCCursor,
"Get cursor type.", "");

DocStr(wxStyledTextCtrl::SetControlCharSymbol,
"Change the way control characters are displayed:
If symbol is < 32, keep the drawn way, else, use the given character.", "");

DocStr(wxStyledTextCtrl::GetControlCharSymbol,
"Get the way control characters are displayed.", "");

DocStr(wxStyledTextCtrl::WordPartLeft,
"Move to the previous change in capitalisation.", "");

DocStr(wxStyledTextCtrl::WordPartLeftExtend,
"Move to the previous change in capitalisation extending selection
to new caret position.", "");

DocStr(wxStyledTextCtrl::WordPartRight,
"Move to the change next in capitalisation.", "");

DocStr(wxStyledTextCtrl::WordPartRightExtend,
"Move to the next change in capitalisation extending selection
to new caret position.", "");

DocStr(wxStyledTextCtrl::SetVisiblePolicy,
"Set the way the display area is determined when a particular line
is to be moved to by Find, FindNext, GotoLine, etc.", "");

DocStr(wxStyledTextCtrl::DelLineLeft,
"Delete back from the current position to the start of the line.", "");

DocStr(wxStyledTextCtrl::DelLineRight,
"Delete forwards from the current position to the end of the line.", "");

DocStr(wxStyledTextCtrl::SetXOffset,
"Get and Set the xOffset (ie, horizonal scroll position).", "");

DocStr(wxStyledTextCtrl::GetXOffset,
"", "");

DocStr(wxStyledTextCtrl::ChooseCaretX,
"Set the last x chosen value to be the caret x position.", "");

DocStr(wxStyledTextCtrl::SetXCaretPolicy,
"Set the way the caret is kept visible when going sideway.
The exclusion zone is given in pixels.", "");

DocStr(wxStyledTextCtrl::SetYCaretPolicy,
"Set the way the line the caret is on is kept visible.
The exclusion zone is given in lines.", "");

DocStr(wxStyledTextCtrl::SetPrintWrapMode,
"Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).", "");

DocStr(wxStyledTextCtrl::GetPrintWrapMode,
"Is printing line wrapped?", "");

DocStr(wxStyledTextCtrl::SetHotspotActiveForeground,
"Set a fore colour for active hotspots.", "");

DocStr(wxStyledTextCtrl::SetHotspotActiveBackground,
"Set a back colour for active hotspots.", "");

DocStr(wxStyledTextCtrl::SetHotspotActiveUnderline,
"Enable / Disable underlining active hotspots.", "");

DocStr(wxStyledTextCtrl::SetHotspotSingleLine,
"Limit hotspots to single line so hotspots on two lines don't merge.", "");

DocStr(wxStyledTextCtrl::ParaDown,
"Move caret between paragraphs (delimited by empty lines).", "");

DocStr(wxStyledTextCtrl::ParaDownExtend,
"", "");

DocStr(wxStyledTextCtrl::ParaUp,
"", "");

DocStr(wxStyledTextCtrl::ParaUpExtend,
"", "");

DocStr(wxStyledTextCtrl::PositionBefore,
"Given a valid document position, return the previous position taking code
page into account. Returns 0 if passed 0.", "");

DocStr(wxStyledTextCtrl::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.", "");

DocStr(wxStyledTextCtrl::CopyRange,
"Copy a range of text to the clipboard. Positions are clipped into the document.", "");

DocStr(wxStyledTextCtrl::CopyText,
"Copy argument text to the clipboard.", "");

DocStr(wxStyledTextCtrl::SetSelectionMode,
"Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE) or
by lines (SC_SEL_LINES).", "");

DocStr(wxStyledTextCtrl::GetSelectionMode,
"Get the mode of the current selection.", "");

DocStr(wxStyledTextCtrl::GetLineSelStartPosition,
"Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).", "");

DocStr(wxStyledTextCtrl::GetLineSelEndPosition,
"Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).", "");

DocStr(wxStyledTextCtrl::LineDownRectExtend,
"Move caret down one line, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::LineUpRectExtend,
"Move caret up one line, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::CharLeftRectExtend,
"Move caret left one character, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::CharRightRectExtend,
"Move caret right one character, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::HomeRectExtend,
"Move caret to first position on line, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::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.", "");

DocStr(wxStyledTextCtrl::LineEndRectExtend,
"Move caret to last position on line, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::PageUpRectExtend,
"Move caret one page up, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::PageDownRectExtend,
"Move caret one page down, extending rectangular selection to new caret position.", "");

DocStr(wxStyledTextCtrl::StutteredPageUp,
"Move caret to top of page, or one page up if already at top of page.", "");

DocStr(wxStyledTextCtrl::StutteredPageUpExtend,
"Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.", "");

DocStr(wxStyledTextCtrl::StutteredPageDown,
"Move caret to bottom of page, or one page down if already at bottom of page.", "");

DocStr(wxStyledTextCtrl::StutteredPageDownExtend,
"Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.", "");

DocStr(wxStyledTextCtrl::WordLeftEnd,
"Move caret left one word, position cursor at end of word.", "");

DocStr(wxStyledTextCtrl::WordLeftEndExtend,
"Move caret left one word, position cursor at end of word, extending selection to new caret position.", "");

DocStr(wxStyledTextCtrl::WordRightEnd,
"Move caret right one word, position cursor at end of word.", "");

DocStr(wxStyledTextCtrl::WordRightEndExtend,
"Move caret right one word, position cursor at end of word, extending selection to new caret position.", "");

DocStr(wxStyledTextCtrl::SetWhitespaceChars,
"Set the set of characters making up whitespace for when moving or selecting by word.
Should be called after SetWordChars.", "");

DocStr(wxStyledTextCtrl::SetCharsDefault,
"Reset the set of characters for whitespace and word characters to the defaults.", "");

DocStr(wxStyledTextCtrl::AutoCompGetCurrent,
"Get currently selected item position in the auto-completion list", "");

DocStr(wxStyledTextCtrl::Allocate,
"Enlarge the document to a particular size of text bytes.", "");

DocStr(wxStyledTextCtrl::FindColumn,
"Find the position of a column on a line taking into account tabs and
multi-byte characters. If beyond end of line, return line end position.", "");

DocStr(wxStyledTextCtrl::GetCaretSticky,
"Can the caret preferred x position only be changed by explicit movement commands?", "");

DocStr(wxStyledTextCtrl::SetCaretSticky,
"Stop the caret preferred x position changing when the user types.", "");

DocStr(wxStyledTextCtrl::ToggleCaretSticky,
"Switch between sticky and non-sticky: meant to be bound to a key.", "");

DocStr(wxStyledTextCtrl::SetPasteConvertEndings,
"Enable/Disable convert-on-paste for line endings", "");

DocStr(wxStyledTextCtrl::GetPasteConvertEndings,
"Get convert-on-paste setting", "");

DocStr(wxStyledTextCtrl::SelectionDuplicate,
"Duplicate the selection. If selection empty duplicate the line containing the caret.", "");

DocStr(wxStyledTextCtrl::SetCaretLineBackAlpha,
"Set background alpha of the caret line.", "");

DocStr(wxStyledTextCtrl::GetCaretLineBackAlpha,
"Get the background alpha of the caret line.", "");

DocStr(wxStyledTextCtrl::StartRecord,
"Start notifying the container of all key presses and commands.", "");

DocStr(wxStyledTextCtrl::StopRecord,
"Stop notifying the container of all key presses and commands.", "");

DocStr(wxStyledTextCtrl::SetLexer,
"Set the lexing language of the document.", "");

DocStr(wxStyledTextCtrl::GetLexer,
"Retrieve the lexing language of the document.", "");

DocStr(wxStyledTextCtrl::Colourise,
"Colourise a segment of the document using the current lexing language.", "");

DocStr(wxStyledTextCtrl::SetProperty,
"Set up a value that may be used by a lexer for some optional feature.", "");

DocStr(wxStyledTextCtrl::SetKeyWords,
"Set up the key words used by the lexer.", "");

DocStr(wxStyledTextCtrl::SetLexerLanguage,
"Set the lexing language of the document based on string name.", "");

DocStr(wxStyledTextCtrl::GetProperty,
"Retrieve a 'property' value previously set with SetProperty.", "");

DocStr(wxStyledTextCtrl::GetPropertyExpanded,
"Retrieve a 'property' value previously set with SetProperty,
with '$()' variable replacement on returned buffer.", "");

DocStr(wxStyledTextCtrl::GetPropertyInt,
"Retrieve a 'property' value previously set with SetProperty,
interpreted as an int AFTER any '$()' variable replacement.", "");

DocStr(wxStyledTextCtrl::GetStyleBitsNeeded,
"Retrieve the number of bits the current lexer needs for styling.", "");