idllib

Personal IDL library for M. Galloy

single page | use frames     summary     class     fields     routine details     file attributes

textmarkup/

mgtmtext__define.pro


A MGtmText object is a MGtmNode that contains text.

Class description for mgtmtext

Inheritance

Properties

_extra init
_ref_extra get

properties of MGtmNode

text get init

text stored in node

Routines

mgtmtext::_print [, indent=string]

Helper routine for debugging.

result = mgtmtext::isBlank()

Indicates whether this is a blank line.

mgtmtext::getProperty, text=text, _ref_extra=_ref_extra

Get properties of the text node.

result = mgtmtext::_clone()

Implement cloning.

mgtmtext::cleanup

Free resources of the text node.

result = mgtmtext::init( [text=string/strarr] [, _extra=keywords])

Creates a text node.

mgtmtext__define

Defines MGtmText which is a MGtmNode that contains text.

Routine details

top source mgtmtext::_print

mgtmtext::_print [, indent=string]

Helper routine for debugging.

Keywords

indent in optional type=string

prefix to print before each line, usually set to several spaces

top source mgtmtext::isBlank

result = mgtmtext::isBlank()

Indicates whether this is a blank line.

Return value

1 if line is blank, 0 if not

top source mgtmtext::getProperty

mgtmtext::getProperty, text=text, _ref_extra=_ref_extra

Get properties of the text node.

Keywords

text

text stored in node

_ref_extra

properties of MGtmNode

top source mgtmtext::_clone

result = mgtmtext::_clone()

Implement cloning.

Return value

MGtmNode object

top source mgtmtext::cleanup

mgtmtext::cleanup

Free resources of the text node.

top source mgtmtext::init

result = mgtmtext::init( [text=string/strarr] [, _extra=keywords])

Creates a text node.

Return value

1 for success, 0 for failure

Keywords

text in optional type=string/strarr

text to store

_extra in optional type=keywords

keywords to MGtmNode::init

top source mgtmtext__define

mgtmtext__define

Defines MGtmText which is a MGtmNode that contains text.

File attributes

Modification date: Mon Jul 18 12:29:20 2011
Lines: 116
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.