_stc_gendocs.i

Wxpython Implemented on Windows CE, Source code

Default is space but can be changed if items contain space.", "");

DocStr(wxStyledTextCtrl::AutoCompGetSeparator,
"Retrieve the auto-completion list separator character.", "");

DocStr(wxStyledTextCtrl::AutoCompSelect,
"Select the item in the auto-completion list that starts with a string.", "");

DocStr(wxStyledTextCtrl::AutoCompSetCancelAtStart,
"Should the auto-completion list be cancelled if the user backspaces to a
position before where the box was created.", "");

DocStr(wxStyledTextCtrl::AutoCompGetCancelAtStart,
"Retrieve whether auto-completion cancelled by backspacing before start.", "");

DocStr(wxStyledTextCtrl::AutoCompSetFillUps,
"Define a set of characters that when typed will cause the autocompletion to
choose the selected item.", "");

DocStr(wxStyledTextCtrl::AutoCompSetChooseSingle,
"Should a single item auto-completion list automatically choose the item.", "");

DocStr(wxStyledTextCtrl::AutoCompGetChooseSingle,
"Retrieve whether a single item auto-completion list automatically choose the item.", "");

DocStr(wxStyledTextCtrl::AutoCompSetIgnoreCase,
"Set whether case is significant when performing auto-completion searches.", "");

DocStr(wxStyledTextCtrl::AutoCompGetIgnoreCase,
"Retrieve state of ignore case flag.", "");

DocStr(wxStyledTextCtrl::UserListShow,
"Display a list of strings and send notification when user chooses one.", "");

DocStr(wxStyledTextCtrl::AutoCompSetAutoHide,
"Set whether or not autocompletion is hidden automatically when nothing matches.", "");

DocStr(wxStyledTextCtrl::AutoCompGetAutoHide,
"Retrieve whether or not autocompletion is hidden automatically when nothing matches.", "");

DocStr(wxStyledTextCtrl::AutoCompSetDropRestOfWord,
"Set whether or not autocompletion deletes any word characters
after the inserted text upon completion.", "");

DocStr(wxStyledTextCtrl::AutoCompGetDropRestOfWord,
"Retrieve whether or not autocompletion deletes any word characters
after the inserted text upon completion.", "");

DocStr(wxStyledTextCtrl::RegisterImage,
"Register an image for use in autocompletion lists.", "");

DocStr(wxStyledTextCtrl::ClearRegisteredImages,
"Clear all the registered images.", "");

DocStr(wxStyledTextCtrl::AutoCompGetTypeSeparator,
"Retrieve the auto-completion list type-separator character.", "");

DocStr(wxStyledTextCtrl::AutoCompSetTypeSeparator,
"Change the type-separator character in the string setting up an auto-completion list.
Default is '?' but can be changed if items contain '?'.", "");

DocStr(wxStyledTextCtrl::AutoCompSetMaxWidth,
"Set the maximum width, in characters, of auto-completion and user lists.
Set to 0 to autosize to fit longest item, which is the default.", "");

DocStr(wxStyledTextCtrl::AutoCompGetMaxWidth,
"Get the maximum width, in characters, of auto-completion and user lists.", "");

DocStr(wxStyledTextCtrl::AutoCompSetMaxHeight,
"Set the maximum height, in rows, of auto-completion and user lists.
The default is 5 rows.", "");

DocStr(wxStyledTextCtrl::AutoCompGetMaxHeight,
"Set the maximum height, in rows, of auto-completion and user lists.", "");

DocStr(wxStyledTextCtrl::SetIndent,
"Set the number of spaces used for one level of indentation.", "");

DocStr(wxStyledTextCtrl::GetIndent,
"Retrieve indentation size.", "");

DocStr(wxStyledTextCtrl::SetUseTabs,
"Indentation will only use space characters if useTabs is false, otherwise
it will use a combination of tabs and spaces.", "");

DocStr(wxStyledTextCtrl::GetUseTabs,
"Retrieve whether tabs will be used in indentation.", "");

DocStr(wxStyledTextCtrl::SetLineIndentation,
"Change the indentation of a line to a number of columns.", "");

DocStr(wxStyledTextCtrl::GetLineIndentation,
"Retrieve the number of columns that a line is indented.", "");

DocStr(wxStyledTextCtrl::GetLineIndentPosition,
"Retrieve the position before the first non indentation character on a line.", "");

DocStr(wxStyledTextCtrl::GetColumn,
"Retrieve the column number of a position, taking tab width into account.", "");

DocStr(wxStyledTextCtrl::SetUseHorizontalScrollBar,
"Show or hide the horizontal scroll bar.", "");

DocStr(wxStyledTextCtrl::GetUseHorizontalScrollBar,
"Is the horizontal scroll bar visible?", "");

DocStr(wxStyledTextCtrl::SetIndentationGuides,
"Show or hide indentation guides.", "");

DocStr(wxStyledTextCtrl::GetIndentationGuides,
"Are the indentation guides visible?", "");

DocStr(wxStyledTextCtrl::SetHighlightGuide,
"Set the highlighted indentation guide column.
0 = no highlighted guide.", "");

DocStr(wxStyledTextCtrl::GetHighlightGuide,
"Get the highlighted indentation guide column.", "");

DocStr(wxStyledTextCtrl::GetLineEndPosition,
"Get the position after the last visible characters on a line.", "");

DocStr(wxStyledTextCtrl::GetCodePage,
"Get the code page used to interpret the bytes of the document as characters.", "");

DocStr(wxStyledTextCtrl::GetCaretForeground,
"Get the foreground colour of the caret.", "");

DocStr(wxStyledTextCtrl::GetReadOnly,
"In read-only mode?", "");

DocStr(wxStyledTextCtrl::SetCurrentPos,
"Sets the position of the caret.", "");

DocStr(wxStyledTextCtrl::SetSelectionStart,
"Sets the position that starts the selection - this becomes the anchor.", "");

DocStr(wxStyledTextCtrl::GetSelectionStart,
"Returns the position at the start of the selection.", "");

DocStr(wxStyledTextCtrl::SetSelectionEnd,
"Sets the position that ends the selection - this becomes the currentPosition.", "");

DocStr(wxStyledTextCtrl::GetSelectionEnd,
"Returns the position at the end of the selection.", "");

DocStr(wxStyledTextCtrl::SetPrintMagnification,
"Sets the print magnification added to the point size of each style for printing.", "");

DocStr(wxStyledTextCtrl::GetPrintMagnification,
"Returns the print magnification.", "");

DocStr(wxStyledTextCtrl::SetPrintColourMode,
"Modify colours when printing for clearer printed text.", "");

DocStr(wxStyledTextCtrl::GetPrintColourMode,
"Returns the print colour mode.", "");

DocStr(wxStyledTextCtrl::FindText,
"Find some text in the document.", "");

DocStr(wxStyledTextCtrl::FormatRange,
"On Windows, will draw the document into a display context such as a printer.", "");

DocStr(wxStyledTextCtrl::GetFirstVisibleLine,
"Retrieve the display line at the top of the display.", "");

DocStr(wxStyledTextCtrl::GetLine,
"Retrieve the contents of a line.", "");

DocStr(wxStyledTextCtrl::GetLineCount,
"Returns the number of lines in the document. There is always at least one.", "");

DocStr(wxStyledTextCtrl::SetMarginLeft,
"Sets the size in pixels of the left margin.", "");

DocStr(wxStyledTextCtrl::GetMarginLeft,
"Returns the size in pixels of the left margin.", "");

DocStr(wxStyledTextCtrl::SetMarginRight,
"Sets the size in pixels of the right margin.", "");

DocStr(wxStyledTextCtrl::GetMarginRight,
"Returns the size in pixels of the right margin.", "");

DocStr(wxStyledTextCtrl::GetModify,
"Is the document different from when it was last saved?", "");

DocStr(wxStyledTextCtrl::SetSelection,
"Select a range of text.", "");

DocStr(wxStyledTextCtrl::GetSelectedText,
"Retrieve the selected text.", "");

DocStr(wxStyledTextCtrl::GetTextRange,
"Retrieve a range of text.", "");

DocStr(wxStyledTextCtrl::HideSelection,
"Draw the selection in normal style or with selection highlighted.", "");

DocStr(wxStyledTextCtrl::LineFromPosition,
"Retrieve the line containing a position.", "");

DocStr(wxStyledTextCtrl::PositionFromLine,
"Retrieve the position at the start of a line.", "");

DocStr(wxStyledTextCtrl::LineScroll,
"Scroll horizontally and vertically.", "");

DocStr(wxStyledTextCtrl::EnsureCaretVisible,
"Ensure the caret is visible.", "");

DocStr(wxStyledTextCtrl::ReplaceSelection,
"Replace the selected text with the argument text.", "");

DocStr(wxStyledTextCtrl::SetReadOnly,
"Set to read only or read write.", "");

DocStr(wxStyledTextCtrl::CanPaste,
"Will a paste succeed?", "");

DocStr(wxStyledTextCtrl::CanUndo,
"Are there any undoable actions in the undo history?", "");

DocStr(wxStyledTextCtrl::EmptyUndoBuffer,
"Delete the undo history.", "");

DocStr(wxStyledTextCtrl::Undo,
"Undo one action in the undo history.", "");

DocStr(wxStyledTextCtrl::Cut,
"Cut the selection to the clipboard.", "");

DocStr(wxStyledTextCtrl::Copy,
"Copy the selection to the clipboard.", "");

DocStr(wxStyledTextCtrl::Paste,
"Paste the contents of the clipboard into the document replacing the selection.", "");

DocStr(wxStyledTextCtrl::Clear,
"Clear the selection.", "");

DocStr(wxStyledTextCtrl::SetText,
"Replace the contents of the document with the argument text.", "");

DocStr(wxStyledTextCtrl::GetText,
"Retrieve all the text in the document.", "");

DocStr(wxStyledTextCtrl::GetTextLength,
"Retrieve the number of characters in the document.", "");

DocStr(wxStyledTextCtrl::SetOvertype,
"Set to overtype (true) or insert mode.", "");

DocStr(wxStyledTextCtrl::GetOvertype,
"Returns true if overtype mode is active otherwise false is returned.", "");

DocStr(wxStyledTextCtrl::SetCaretWidth,
"Set the width of the insert mode caret.", "");

DocStr(wxStyledTextCtrl::GetCaretWidth,
"Returns the width of the insert mode caret.", "");

DocStr(wxStyledTextCtrl::SetTargetStart,
"Sets the position that starts the target which is used for updating the
document without affecting the scroll position.", "");

DocStr(wxStyledTextCtrl::GetTargetStart,
"Get the position that starts the target.", "");

DocStr(wxStyledTextCtrl::SetTargetEnd,
"Sets the position that ends the target which is used for updating the
document without affecting the scroll position.", "");

DocStr(wxStyledTextCtrl::GetTargetEnd,
"Get the position that ends the target.", "");

DocStr(wxStyledTextCtrl::ReplaceTarget,
"Replace the target text with the argument text.
Text is counted so it can contain NULs.
Returns the length of the replacement text.", "");

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

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

DocStr(wxStyledTextCtrl::SetSearchFlags,
"Set the search flags used by SearchInTarget.", "");

DocStr(wxStyledTextCtrl::GetSearchFlags,
"Get the search flags used by SearchInTarget.", "");

DocStr(wxStyledTextCtrl::CallTipShow,
"Show a call tip containing a definition near position pos.", "");

DocStr(wxStyledTextCtrl::CallTipCancel,
"Remove the call tip from the screen.", "");

DocStr(wxStyledTextCtrl::CallTipActive,
"Is there an active call tip?", "");

DocStr(wxStyledTextCtrl::CallTipPosAtStart,
"Retrieve the position where the caret was before displaying the call tip.", "");

DocStr(wxStyledTextCtrl::CallTipSetHighlight,
"Highlight a segment of the definition.", "");

DocStr(wxStyledTextCtrl::CallTipSetBackground,
"Set the background colour for the call tip.", "");

DocStr(wxStyledTextCtrl::CallTipSetForeground,
"Set the foreground colour for the call tip.", "");

DocStr(wxStyledTextCtrl::CallTipSetForegroundHighlight,
"Set the foreground colour for the highlighted part of the call tip.", "");

DocStr(wxStyledTextCtrl::CallTipUseStyle,
"Enable use of STYLE_CALLTIP and set call tip tab size in pixels.", "");

DocStr(wxStyledTextCtrl::VisibleFromDocLine,
"Find the display line of a document line taking hidden lines into account.", "");

DocStr(wxStyledTextCtrl::DocLineFromVisible,
"Find the document line of a display line taking hidden lines into account.", "");

DocStr(wxStyledTextCtrl::WrapCount,
"The number of display lines needed to wrap a document line", "");

DocStr(wxStyledTextCtrl::SetFoldLevel,
"Set the fold level of a line.
This encodes an integer level along with flags indicating whether the