diff options
author | Willian Padovani Germano <wpgermano@gmail.com> | 2003-06-26 06:03:51 +0400 |
---|---|---|
committer | Willian Padovani Germano <wpgermano@gmail.com> | 2003-06-26 06:03:51 +0400 |
commit | 72f0cdace4cd4e83b8175f255a0d7733bfa2f0d1 (patch) | |
tree | f9d8f3d9d36933bc50785bdc773baf7f1ac5ddc9 /source/blender/python/api2_2x/doc/Text.py | |
parent | dd8f2166916844eb8b8013fa78931b3f671fe9f5 (diff) |
* Added function Blender.Draw.GetStringWidth().
* Added doc and small test for Blender.Test
* trying changes to make Blender.Test.unlink() safer.
Diffstat (limited to 'source/blender/python/api2_2x/doc/Text.py')
-rw-r--r-- | source/blender/python/api2_2x/doc/Text.py | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/source/blender/python/api2_2x/doc/Text.py b/source/blender/python/api2_2x/doc/Text.py new file mode 100644 index 00000000000..54694b722c4 --- /dev/null +++ b/source/blender/python/api2_2x/doc/Text.py @@ -0,0 +1,124 @@ +# Blender.Text module and the Text PyType object + +""" +The Blender.Text submodule + +This module provides access to B{Text} objects in Blender. + +Example:: + import Blender + from Blender import Text + # + txt = Text.New("MyText") # create a new Text object + print Text.Get() # current list of Texts in Blender + txt.write("Appending some ") # appending text + txt.write("text to my\\n") # '\\n' inserts new-line markers + txt.write("text buffer.") + print txt.asLines() # retrieving the buffer as a list of lines + Text.unlink(txt) # removing a Text object +""" + +def New (name = None, follow_cursor = 0): + """ + Create a new Text object. + @type name: string + @param name: The Text name. + @type follow_cursor: int + @param follow_cursor: The text follow flag: if 1, the text display always + follows the cursor. + @rtype: Blender Text + @return: The created Text Data object. + """ + +def Get (name = None): + """ + Get the Text object(s) from Blender. + @type name: string + @param name: The name of the Text object. + @rtype: Blender Text or a list of Blender Texts + @return: It depends on the 'name' parameter: + - (name): The Text object with the given name; + - (): A list with all Text objects in the current scene. + """ + +def Load (filename): + """ + Load a file into a Blender Text object. + @type filename: string + @param filename: The name of the file to load. + @rtype: Blender Text + @return: A Text object with the contents of the loaded file. + """ + +def unlink(textobj): + """ + Unlink (remove) the given Text object from Blender. + @type textobj: Blender Text + @param textobj: The Text object to be deleted. + """ + +class Text: + """ + The Text object + =============== + This object gives access to Texts in Blender. + @cvar name: The Text name. + @cvar filename: The filename of the file loaded into this Text. + @cvar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'. + @cvar nlines: The number of lines in this Text. + """ + + def getName(): + """ + Get the name of this Text object. + @rtype: string + """ + + def setName(name): + """ + Set the name of this Text object. + @type name: string + @param name: The new name. + """ + + def getFilename(): + """ + Get the filename of the file loaded into this Text object. + @rtype: string + """ + + def getNLines(): + """ + Get the number of lines in this Text buffer. + @rtype: int + """ + + def clear(): + """ + Clear this Text object: its buffer becomes empty. + """ + + def set(attribute, value): + """ + Set this Text's attributes. + @type attribute: string + @param 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 value: int + @param value: The new attribute value. + """ + + def write(data): + """ + Append a string to this Text buffer. + @type data: string + @param data: The string to append to the text buffer. + """ + + def asLines(): + """ + Retrieve the contents of this Text buffer as a list of strings. + @rtype: list + @return: A list of strings. + """ |