Home	Xport Overview	Xport Download	XportPro Overview	Buy XportPro Now!

Xport Interface: `element::attribute`

Sets or retrieves an attribute value for the called element.

virtual std::string element::attribute(1st Variety
  xhtml_attribute attrib
);

virtual bool element::attribute(2nd Variety
  xhtml_attribute attrib,
  const std::string& value
);

Parameters

attrib

An xhtml_attribute enumerator. For a list of xhtml_attribute enumerators, see Xport Usage: Enumerations.

value

A string value which represents the value of the accompanied attribute.

Returns

In the first variety, returns the string value of the specified attribute if the attribute is present within the called element, or an empty string otherwise. In the second variety, returns true if the attribute is set successfully, false otherwise.

Remarks

This operation is used to set or retrieve an attribute value in the called element. When setting an element's attribute, Xport will only allow attributes to be set which are valid attributes for the called element. The attribute values are represented by strings. All attribute values will be properly delimeted by single or double quotes when writing the element or document, so there is no need to include the single or double quotes when specifying the attributes value. When retrieving attributes in the second variety obove, a string value is returned without the single/double quote delimiters.

The first variety above allows the retrieval of a single attribute value. If you wish to determine which attributes are present for a particular element, use the elment::attributes() operation, which returns a map of all attibutes present in the called element.

Complexity

Constant

Example

1st Variety

#include "xhtml_doc.h"
#include <iostream>

int main(int argc, char* argv[])
{
  using namespace Xport;

  // create an xhtml strict root document
  document doc(root_doc);

  // set the body's title attribute
  doc.body()->attribute(attribute::title, "content container");

  // add a ul element, setting it's id attribute in the constructor
  markup::iterator it = doc.body()->insert(element(ul, "list1"));
  // set the class name attributes of the list item in the element's constructor
  *it << (element(li, "", "litem") << "List item 1");
  *it << (element(li, "", "litem") << "List item 2");
  *it << (element(li, "", "litem") << "List item 3");

  // write the document to cout
  formatter fmtr(std::cout);
  fmtr << doc;
  std::cout << "\n\n";

  // retrieve the body's title attribute
  std::cout << "The title attribute of body is '" << doc.body()->attribute(attribute::title) << "'\n";

  // retrieve the unordered list's id attribute
  std::cout << "The id attribute for the unordered list is '" << it->attribute(id) << "'\n";

  // retrieve the class attributes for the list items
  markup::iterator lit = it->begin();
  for (int i = 1; lit != it->end(); ++lit, ++i) {
    std::cout << "The class attribute of list item " << i << " is '" << lit->attribute( 
    class_attribute) << "'\n";
  }

  return 0;
}

2nd Variety

#include "xhtml_doc.h"
#include <iostream>

int main(int argc, char* argv[])
{
  using namespace Xport;

  // create an xhtml transitional root document
  tdocument doc(root_doc);

  // set the body's title attribute
  doc.body()->attribute(attribute::title, "content container");

  // add a ul element, setting it's id attribute in the constructor
  tmarkup::iterator it = doc.body()->insert(telement(ul, "list1"));
  // set the class name attributes of the list item in the element's constructor
  tmarkup::iterator lit = it->insert(telement(li, "", "litem") << "List item 1");
  lit->attribute(attribute::type, "square");
  *it << (telement(li, "", "litem") << "List item 2");
  lit->attribute(type, "circle");
  *it << (telement(li, "", "litem") << "List item 3");
  lit->attribute(type, "disc");

  // write the document to cout
  tformatter fmtr(std::cout);
  fmtr << doc;
  std::cout << "\n\n";


  return 0;
}

Datasoft Solutions is proud to present their landmark product, Work Time Studio. Utilizing the tree container library, Work Time Studio provides unparalleled features in personal time, project and task management software. If you're looking for a way to increase your productivity, visit Work Time Studio's product website, and start being more productive today.

XHTML Parsing &Objective Reporting Toolkit

Xport Interface: element::attribute