FXText

Multiline text widget

FXText(p, tgt=None, sel=0, opts=0, x=0, y=0, w=0, h=0)

Construct multi-line text widget.

Argument	Type	Default	Description
p	FXComposite
tgt	FXObject	None
sel	Int	0
opts	Int	0
x	Int	0
y	Int	0
w	Int	0
h	Int	0

appendText(text, n, notify=False)

Append n characters of text at the end of the buffer.

Argument	Type	Default	Description
text	String
n	Int
notify	Bool	False

canFocus()

Returns True because a text widget can receive focus.

Reimplemented from FXWindow.

create()

Create server-side resources.

Reimplemented from FXComposite.

detach()

Detach server-side resources.

Reimplemented from FXComposite.

disable()

Disable the text widget.

Reimplemented from FXWindow.

enable()

Enable the text widget.

Reimplemented from FXWindow.

extractText(text, pos, n)

Extract n characters of text from position pos.

Argument	Type	Default	Description
text	String
pos	Int
n	Int

getBarColor()

Return bar color.

getBarColumns()

Return number of columns used for line numbers.

getChar(pos)

Get character at position in text buffer.

Argument	Type	Default	Description
pos	Int

getContentHeight()

Get default height.

Reimplemented from FXScrollArea.

getContentWidth()

Get default width.

Reimplemented from FXScrollArea.

getCursorCol()

Return cursor row, i.e. indent position.

getCursorColor()

Return cursor color.

getCursorPos()

Return the cursor position.

getCursorRow()

Return cursor row.

getDefaultHeight()

Return default height.

Reimplemented from FXScrollArea.

getDefaultWidth()

Return default width.

Reimplemented from FXScrollArea.

getFont()

Return text font.

getLength()

Return length of buffer.

getMarginBottom()

Return bottom margin.

getMarginLeft()

Return left margin.

getMarginRight()

Return right margin.

getMarginTop()

Return top margin.

getNumberColor()

Return line number color.

getPosAt(x, y)

Return text position at given visible x,y coordinate.

Argument	Type	Default	Description
x	Int
y	Int

getSelBackColor()

Return selected background color.

getSelEndPos()

Return selendpos.

getSelStartPos()

Return selstartpos.

getSelTextColor()

Return selected text color.

getText()

Return text in the widget.

getText(text, n)

Retrieve text into buffer.

Argument	Type	Default	Description
text	String
n	Int

getTextColor()

Return text color.

getTopLine()

Return position of top line.

getVisCols()

Return number of visible columns.

getVisRows()

Return number of visible rows.

insertText(pos, text, n, notify=False)

Insert n characters of text at position pos into the buffer.

Argument	Type	Default	Description
pos	Int
text	String
n	Int
notify	Bool	False

isEditable()

Return True if text is editable.

isModified()

Return True if text was modified.

isPosSelected(pos)

Return True if position pos is selected.

Argument	Type	Default	Description
pos	Int

killSelection(notify=False)

Unselect the text.

Argument	Type	Default	Description
notify	Bool	False

lineEnd(pos)

Return position of end of line containing position pos.

Argument	Type	Default	Description
pos	Int

lineStart(pos)

Return position of begin of line containing position pos.

Argument	Type	Default	Description
pos	Int

makePositionVisible(pos)

Scroll text to make the given position visible.

Argument	Type	Default	Description
pos	Int

moveContents(x, y)

Scroll the contents.

Reimplemented from FXScrollArea.

Argument	Type	Default	Description
x	Int
y	Int

nextLine(pos, nl=1)

Return start of next line.

Argument	Type	Default	Description
pos	Int
nl	Int	1

nextRow(pos, nr=1)

Return start of next row.

Argument	Type	Default	Description
pos	Int
nr	Int	1

position(x, y, w, h)

Move and resize this window in the parent's coordinates.

Reimplemented from FXWindow.

Argument	Type	Default	Description
x	Int
y	Int
w	Int
h	Int

prevLine(pos, nl=1)

Return start of previous line.

Argument	Type	Default	Description
pos	Int
nl	Int	1

prevRow(pos, nr=1)

Return start of previous row.

Argument	Type	Default	Description
pos	Int
nr	Int	1

recalc()

Need to recalculate size.

Reimplemented from FXWindow.

removeText(pos, n, notify=False)

Remove n characters of text at position pos from the buffer.

Argument	Type	Default	Description
pos	Int
n	Int
notify	Bool	False

replaceText(pos, m, text, n, notify=False)

Replace m characters at pos by n characters.

Argument	Type	Default	Description
pos	Int
m	Int
text	String
n	Int
notify	Bool	False

resize(w, h)

Resize this window to the specified width and height.

Reimplemented from FXWindow.

Argument	Type	Default	Description
w	Int
h	Int

rowEnd(pos)

Return row end.

Argument	Type	Default	Description
pos	Int

rowStart(pos)

Return row start.

Argument	Type	Default	Description
pos	Int

setBarColor(clr)

Change bar color.

Argument	Type	Default	Description
clr	FXColor

setBarColumns(cols)

Change number of columns used for line numbers.

Argument	Type	Default	Description
cols	Int

setBottomLine(pos)

Make line containing pos the bottom line.

Argument	Type	Default	Description
pos	Int

setCursorCol(col, notify=False)

Set cursor column.

Argument	Type	Default	Description
col	Int
notify	Bool	False

setCursorColor(clr)

Change cursor color.

Argument	Type	Default	Description
clr	FXColor

setCursorPos(pos, notify=False)

Set the cursor position.

Argument	Type	Default	Description
pos	Int
notify	Bool	False

setCursorRow(row, notify=False)

Set cursor row.

Argument	Type	Default	Description
row	Int
notify	Bool	False

setEditable(edit=True)

Set editable flag.

Argument	Type	Default	Description
edit	Bool	True

setFont(fnt)

Change text font.

Argument	Type	Default	Description
fnt	FXFont

setMarginBottom(pb)

Change bottom margin.

Argument	Type	Default	Description
pb	Int

setMarginLeft(pl)

Change left margin.

Argument	Type	Default	Description
pl	Int

setMarginRight(pr)

Change right margin.

Argument	Type	Default	Description
pr	Int

setMarginTop(pt)

Change top margin.

Argument	Type	Default	Description
pt	Int

setModified(mod=True)

Set modified flag.

Argument	Type	Default	Description
mod	Bool	True

setNumberColor(clr)

Change line number color.

Argument	Type	Default	Description
clr	FXColor

setSelBackColor(clr)

Change selected background color.

Argument	Type	Default	Description
clr	FXColor

setSelection(pos, len, notify=False)

Select len characters starting at given position pos.

Argument	Type	Default	Description
pos	Int
len	Int
notify	Bool	False

setSelTextColor(clr)

Change selected text color.

Argument	Type	Default	Description
clr	FXColor

setText(text, notify=False)

Change the text.

Argument	Type	Default	Description
text	String
notify	Bool	False

setText(text, n, notify=False)

Change the text in the buffer to new text.

Argument	Type	Default	Description
text	String
n	Int
notify	Bool	False

setTextColor(clr)

Change text color.

Argument	Type	Default	Description
clr	FXColor

setTopLine(pos)

Make line containing pos the top line.

Argument	Type	Default	Description
pos	Int

setVisCols(cols)

Change number of visible columns.

Argument	Type	Default	Description
cols	Int

setVisRows(rows)

Change number of visible rows.

Argument	Type	Default	Description
rows	Int

Global flags

Text widget options

TEXT_READONLY	Text is NOT editable.
TEXT_WORDWRAP	Wrap at word breaks.
TEXT_OVERSTRIKE	Overstrike mode.
TEXT_FIXEDWRAP	Fixed wrap columns.
TEXT_NO_TABS	Insert spaces for tabs.
TEXT_AUTOINDENT	Autoindent.
TEXT_SHOWACTIVE	Show active line.

Selection modes

SELECT_CHARS	Select characters.
SELECT_WORDS	Select words.
SELECT_LINES	Select lines.