ECLAPI.ECLEntry Class Reference

Public Member Functions
def	__init__ (self, category, tags=[], formname='default', text='', preformatted=False, private=False, textile=False, related=None)
def	setValue (self, name, value)
def	setAuthor (self, name)
def	addAttachment (self, name, filename, data=None)
def	addImage (self, name, filename, image=None)
def	addSubject (self, text)
def	xshow (self)

Private Attributes
	_category
	_tags
	_formname
	_text
	_entry
	_form

Detailed Description

Definition at line 166 of file ECLAPI.py.

Constructor & Destructor Documentation

def ECLAPI.ECLEntry.__init__	(		self,
			category,
			tags = [],
			formname = 'default',
			text = '',
			preformatted = False,
			private = False,
			textile = False,
			related = None
	)

Definition at line 169 of file ECLAPI.py.

                private=False, textile=False, related=None):
        self._category = category
        self._tags = tags
        self._formname = formname
        self._text = text
        # Create the top level element
        self._entry = etree.Element('entry', category=category)
        if not preformatted:
            self._entry.attrib['formatted']='yes'
        if textile:
            self._entry.attrib['html_safe']='no'
        if private:
            self._entry.attrib['private'] = 'yes'
        if related:
            self._entry.attrib['related'] = '%s' % (related,)
        # Create the form
        self._form = etree.SubElement(self._entry, 'form', name=formname)
        if text:
            # Create the text field
            textfield = etree.SubElement(self._form, 'field', name='text')
            # Store the text
            textfield.text = text
        for tag in tags:
            etree.SubElement(self._entry, 'tag', name=tag)

Member Function Documentation

def ECLAPI.ECLEntry.addAttachment	(		self,
			name,
			filename,
			data = None
	)

Definition at line 203 of file ECLAPI.py.

    def addAttachment(self, name, filename, data=None):
        # Create the field
        field = etree.SubElement(self._entry, 'attachment', type='file', name=name, filename=os.path.basename(filename))
        if data:
            # Store the text 
            field.text = base64.b64encode(data)
        else:
            f = open(filename,'r')
            b = f.read()
            field.text = base64.b64encode(b)
            f.close()

def ECLAPI.ECLEntry.addImage	(		self,
			name,
			filename,
			image = None
	)

Definition at line 215 of file ECLAPI.py.

    def addImage(self, name, filename, image=None):
        # Create the field
        field = etree.SubElement(self._entry, 'attachment', type='image', name=name, filename=os.path.basename(filename))
        # Store the text 
        if image:
            # Store the text 
            field.text = base64.b64encode(image)
        else:
            f = open(filename,'r')
            b = f.read()
            field.text = base64.b64encode(b)
            f.close()

def ECLAPI.ECLEntry.addSubject	(		self,
			text
	)

Definition at line 228 of file ECLAPI.py.

    def addSubject(self, text):
        self._entry.attrib['subject'] = text

def ECLAPI.ECLEntry.setAuthor	(		self,
			name
	)

Definition at line 200 of file ECLAPI.py.

    def setAuthor(self, name):
        self._entry.attrib['author'] = name

def ECLAPI.ECLEntry.setValue	(		self,
			name,
			value
	)

Definition at line 194 of file ECLAPI.py.

    def setValue(self, name, value):
        # Create the field
        field = etree.SubElement(self._form, 'field', name=name)
        # Store the text 
        field.text = value

def ECLAPI.ECLEntry.xshow

(

self

)

Definition at line 231 of file ECLAPI.py.

    def xshow(self):
        return etree.tostring(self._entry)

Member Data Documentation

ECLAPI.ECLEntry._category

private

Definition at line 170 of file ECLAPI.py.

ECLAPI.ECLEntry._entry

private

Definition at line 175 of file ECLAPI.py.

ECLAPI.ECLEntry._form

private

Definition at line 185 of file ECLAPI.py.

ECLAPI.ECLEntry._formname

private

Definition at line 172 of file ECLAPI.py.

ECLAPI.ECLEntry._tags

private

Definition at line 171 of file ECLAPI.py.

ECLAPI.ECLEntry._text

private

Definition at line 173 of file ECLAPI.py.

---

The documentation for this class was generated from the following file:

• duneutil/scripts/ECLAPI.py