Module Text :: Class Text

Class Text

The Text object

This object gives access to Texts in Blender.

Method Summary
list of strings	`asLines()` Retrieve the contents of this Text buffer as a list of strings.
	`clear()` Clear this Text object: its buffer becomes empty.
string	`getFilename()` Get the filename of the file loaded into this Text object.
string	`getName()` Get the name of this Text object.
int	`getNLines()` Get the number of lines in this Text buffer.
	`set(attribute, value)` Set this Text's attributes.
	`setName(name)` Set the name of this Text object.
	`write(data)` Append a string to this Text buffer.

Class Variable Summary
	`filename`: The filename of the file loaded into this Text.
	`mode`: The follow_mode flag: if 1 it is 'on'; if 0, 'off'.
	`name`: The Text name.
	`nlines`: The number of lines in this Text.

Method Details

Retrieve the contents of this Text buffer as a list of strings.

Returns:: A list of strings, one for each line in the buffer
(type=list of strings)

Clear this Text object: its buffer becomes empty.

Get the filename of the file loaded into this Text object.

Get the name of this Text object.

Get the number of lines in this Text buffer.

Set this Text's attributes.

Parameters:: attribute - The attribute to change: currently, 'follow_cursor' is the only one available. It can be turned 'on' with value = 1 and 'off' with value = 0.
(type=string); value - The new attribute value.
(type=int)

Set the name of this Text object.

Append a string to this Text buffer.

Parameters:: data - The string to append to the text buffer.
(type=string)

Class Variable Details

The filename of the file loaded into this Text.

The follow_mode flag: if 1 it is 'on'; if 0, 'off'.

The Text name.

The number of lines in this Text.

Generated by Epydoc 2.1 on Mon Jun 13 15:31:22 2005