# multilineedit class

An editor for inputting larger portions of text

Inherits
object widget
Description
This is class an editor for inputting larger portions of text. Besides that, it has unfinished docs.
Functions

`$textLine(<line>)`
Returns the string at line <line>. Note that it can be an empty string.
`$insertLine(<text>, <line>)`
Inserts <text> at line number <line>. If line is less than zero, or larger than the number of rows, the new text is put at the end. If txt contains newline characters, several lines are inserted. The <line> parameter is optional. If it is ommited, the line is put at end.
`$removeLine(<line>)`
Removes line number <line>.
`$insertAt(<txt>, <line>, <col>)`
Inserts txt at line number line, after character number col in the line. If txt contains newline characters, new lines are inserted.
`$numLines()`
Returns number of lines in the widget.
`$setCursorPosition(<line>, <col>, <mark>)`
Sets the cursor position to character number col in line number line. The parameters are adjusted to lie within the legal range. If mark is FALSE, the selection is cleared. otherwise it is extended
`$cursorPosition()`
Returns current cursor position in "<line>, <col>" format.
`$setReadOnly(<bReadOnly>)`
Sets the editor to be read-only if bReadOnly is 1 or removes the read-only status is ReadOnly is 0
`$atBeginning()`
Returns 1(TRUE) if the cursor is placed at the beginning of the text; otherwise returns 0(FALSE).
`$atEnd()`
Returns 1(TRUE) if the cursor is placed at the end of the text; otherwise returns 0(FALSE).
`$setWordWrap(<mode>)`
Sets the word wrap mode to mode. Valid Values are: - NoWrap - Do not wrap the text. - WidgetWidth - Wrap the text at the current width of the widget. - FixedPixelWidth - Wrap the text at a fixed number of pixels from the widget's left side. - FixedColumnWidth - Wrap the text at a fixed number of character columns from the widget's left side.
`$wordWrap()`
Returns the word wrap mode. NoWrap, WidgetWidth, FixedPixelWidth, FixedColumnWidth.
`$text()`
Returns the multiline edit's text.
`$length()`
Returns the number of characters in the text This function ignores newlines.
`$setMaxLines(<int a>)`
Sets the max number of the lines to <a>
`$maxLines()`
Returns the max number of the lines in the multiline edit.
`$insert(<text>)`
Inserts text at the current cursor position.
`$append()`
Appends a new paragraph with text to the end of the multiline edit.
`$copy()`
Copies any selected text from selection to the clipboard.
`$cut()`
Copies the selected text from selection to the clipboard and deletes it from the multiline edit.
`$paste()`
Pastes the text from the clipboard into the multiline edit at the current cursor position.
`$setReadOnly()`
Sets the multilineedit to read only.
`$setFamily(<fontfamily>)`
Sets the font family of the current format to fontFamily.
`$setItalic(<bool 1 or 0>)`
If the bool value is 1 sets the current format to italic; otherwise, if it's 0 sets the current format to no-italic.
`$setBold(<bool 1 or 0>)`
If the bool value is 1 sets the current format to bold; otherwise, if it's 0 sets the current format to no-bold.
`$setUnderline(<bool 1 or 0>)`
If the bool value is 1 sets the current format to underline; otherwise, if it's 0 sets the current format to no-underline.
`$italic()`
Returns 1(TRUE) if the current format is italic; otherwise returns 0(FALSE).
`$bold()`
Returns 1(TRUE) if the current format is bold; otherwise returns 0(FALSE).
`$underline()`
Returns 1(TRUE) if the current format is underline; otherwise returns 0(FALSE).
`$zoomIn(<int range>)`
Zooms in on the text by making the base font size range points larger.
`$zoomOut(<int range>)`
Zooms out on the text by making the base font size range points smaller.
`$zoomTo(<int size>)`
Zooms the text by making the base font size <size> points.
`$undo()`
Undoes the last operation.
`$redo()`
Redoes the last operation.
`$clear()`
Deletes all the text in the multiline edit.
`$setUndoRedoEnabled(<bool 1 or 0>)`
Sets whether undo/redo is enabled to the bool value.
`$setUndoDepth(<int x>)`
Sets the depth of the undo history to x.
`$isUndoRedoEnabled()`
Returns TRUE if undo/redo is enabled; otherwise returns FALSE.
`$undoDepth()`
Returns the depth of the undo history.
`$indent()`
Re-indents the current paragraph.
`$setText(<txt>)`
Sets the text edit's text to txt.
`$setPointSize(<int size))`
Sets the point size of the font.
`$setColor(<exadecimal value>)`
Sets the color of the text, to exadecimal colour values. Es: %a->$setColor(<6C6A60>)
`$setModified(<bool 1 or 0>)`
Sets whether the document has been modified by the user. Valid Values are 1(TRUE) or 0(FALSE)
`$insertParagraph(<text>,<paragraph>)`
Inserts text as a new paragraph at position <paragraph>.
`$removeParagraph(<int par>)`
Removes the paragraph <par>.
`$setLinkUnderline(<bool 1 or 0 >)`
Sets to 1 if you want that hypertext links will be underlined; otherwise sets to 0.
`$setOverwriteMode(<bool 1 or 0>)`
Sets the Multilineedit edit's overwrite mode to b (1=Enabled or 0=Disabled) .
`$setTextFormat(<textformat>)`
Sets the text format. Correct values are RichText, PlainText, LogText or AutoText.
`$textFormat()`
Returns the text format: rich text, plain text, log text or auto text.
`$setParagraphBackgroundColor(<int par>,<exadecimal color value>)`
Sets the background color of the paragraph <par> to color value specified. Es:%mymultiline->$setParagraphBackgroundColor(2,0C686F)
`$clearParagraphBackground(<int par>)`
Clear the background color of the paragraph <par>.
`$loadFile(<path>)`
Load the file specified in the <path> , also html files.
`$isUndoAvailable ()`
Returns 1(TRUE) if undo is available; otherwise returns 0(FALSE).
`$isRedoAvailable ()`
Returns 1(TRUE) if redo is available; otherwise returns 0(FALSE).
`$setAlignment(<alignment>)`
Sets the alignment of the current paragraph to <alignment>. Valid values are: - AlignAuto - Aligns according to the language. - AlignLeft - Aligns with the left edge. - AlignRight - Aligns with the right edge. - AlignCenter - Centers in both dimensions.
`$setVerticalAlignment(<Valignment>)`
Sets the vertical alignment of the current format to <Valignemnt>. Valid Values are: - AlignNormal - Normal alignment. - AlignSuperScript - Superscript. - AlignSubScript - Subscript.
`$setAutoFormatting(<afvalue>)`
Sets the enabled set of auto formatting features to afvalue. Valid values are: - AutoNone - Do not perform any automatic formatting - AutoBulletList - Only automatically format bulletted lists - AutoAll - Apply all available autoformatting
`$setWrapPolicy(<wrpl>)`

Sets the word wrap policy, at <wrpl>. Valid values are:
- AtWhiteSpace - Don't use this deprecated value (it is a synonym for AtWordBoundary which you should use instead).
- Anywhere - Break anywhere, including within words.
- AtWordBoundary - Break lines at word boundaries, e.g. spaces or newlines
- AtWordOrDocumentBoundary - Break lines at whitespace, e.g. spaces or newlines if possible. Break it anywhere otherwise.

`$paragraphs()`
Returns the number of paragraphs in the text.
`$lines()`
Returns the number of lines in the multilineedit.
`$linesOfParagraph(<int par>)`
Returns the number of lines in paragraph <par>, or -1 if there is no paragraph with index <par>.
`$lineOfChar(<int par>,<int index>)`
Returns the line number of the line in paragraph par in which the character at position index appears. If there is no such paragraph or no such character at the index position -1 is returned.
`$paragraphLenght(<int par>)`
Returns the length of the paragraph par, or -1 if there is no paragraph with index par.

Index, Object Classes

KVIrc 3.2.0 Documentation
Generated by kris at Wed Oct 25 20:15:27 2006