htmlTextPart::embeddedObject Class Reference
Inheritance diagram for htmlTextPart::embeddedObject:
Collaboration diagram for htmlTextPart::embeddedObject:
Public Types | |
| enum | ReferenceType { REFERENCED_BY_ID, REFERENCED_BY_LOCATION } |
Public Member Functions | |
| embeddedObject (shared_ptr< contentHandler > data, const encoding &enc, const string &id, const mediaType &type, const ReferenceType refType) | |
| shared_ptr< const contentHandler > | getData () const |
| const vmime::encoding | getEncoding () const |
| const string | getId () const |
| const string | getReferenceId () const |
| const mediaType | getType () const |
| ReferenceType | getReferenceType () const |
| bool | matchesId (const string &id) const |
Additional Inherited Members | |
 Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
Embedded object (eg: image for <IMG> tag).
Member Enumeration Documentation
| enum ReferenceType |
Constructor & Destructor Documentation
| embeddedObject | ( | shared_ptr< contentHandler > | data, |
| const encoding & | enc, | ||
| const string & | id, | ||
| const mediaType & | type, | ||
| const ReferenceType | refType | ||
| ) |
Constructs an embedded object.
- Parameters
-
data content of the object enc encoding of the data id object identifier type object content type refType reference type
- Returns
- a reference to a new embedded object
Member Function Documentation
| shared_ptr< const contentHandler > getData | ( | ) | const |
Return data stored in this embedded object.
- Returns
- stored data
| const vmime::encoding getEncoding | ( | ) | const |
Return the encoding used for data in this embedded object.
- Returns
- data encoding
| const string getId | ( | ) | const |
Returns the identifier of this embedded object (either a unique ID or a location).
- Returns
- object identifier
| const string getReferenceId | ( | ) | const |
Return the identifier used to reference this embedded object in a text document (for example, you can use the result as the "src" attribute of an <img> tag).
- Returns
- object reference identifier
| htmlTextPart::embeddedObject::ReferenceType getReferenceType | ( | ) | const |
Returns the way this object is referenced.
- Returns
- reference type (see ReferenceType enum)
| const mediaType getType | ( | ) | const |
Return the content type of data stored in this embedded object.
- Returns
- data type
| bool matchesId | ( | const string & | id | ) | const |
Returns whether this object matches the specified identifier.
- Parameters
-
id identifier to test
- Returns
- true if the specified identifier references this object, or false otherwise
The documentation for this class was generated from the following files:
