Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Public Member Functions
Xfc::Atk::Attribute Class Reference

A AtkAttribute C++ wrapper class. More...

#include <xfc/atk/text.hh>

List of all members.

Public Member Functions

Constructors

Detailed Description

A AtkAttribute C++ wrapper class.

Attribute is a string name/value pair representing a text attribute.


Constructor & Destructor Documentation

Xfc::Atk::Attribute::Attribute ( TextAttribute  attr,
int  index 
)

Construct an new attribute from a TextAttribute and a value index.

Parameters:
attrThe TextAttribute whose name will be used.
indexThe index of the string value required.

This is a convenience constructor that calls text_attribute_get_name() and text_attribute_get_value() for you. The index is the index of the required value for those values which are strings.

Xfc::Atk::Attribute::Attribute ( TextAttribute  attr,
const String value 
)

Construct an new attribute from a TextAttribute and a value string.

Parameters:
attrThe TextAttribute whose name will be used.
valueA string representation of the value.

This is a convenience constructor that calls text_attribute_get_name() for you. Call text_attribute_get_value() for those values which are strings. For values which are numbers, the string representation of the number should be in value.

Xfc::Atk::Attribute::Attribute ( const String name,
const String value 
)

Construct an new attribute from an attribute name and a value string.

Parameters:
nameThe attribute name (call text_attribute_get_name()).
valueThe value of the attribute, represented as a string.

Call text_attribute_get_value() for those values which are strings. For values which are numbers, the string representation of the number should be in value.

Xfc::Atk::Attribute::Attribute ( const AtkAttribute &  attrib)

Construct an new attribute from an existing AtkAttribute.

Parameters:
attribAn AtkAttribute.

Copy constructor.

Parameters:
srcThe source attribute.

Member Function Documentation

Returns the TextAttribute enumerated type corresponding to the attibute name, or TEXT_ATTR_INVALID if no matching text attribute is found.

Attribute& Xfc::Atk::Attribute::operator= ( const Attribute src)

Assignment operator.

Parameters:
srcThe source attribute.
void Xfc::Atk::Attribute::set ( const String name,
const String value 
)

Sets the name and value for the attribute.

Parameters:
nameThe attribute name (call text_attribute_get_name()).
valueThe value of the attribute, represented as a string.

Call text_attribute_get_value() for those values which are strings. For values which are numbers, the string representation of the number should be in value.


The documentation for this class was generated from the following file:
Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC