KTnef::KTNEFWriter
#include <ktnefwriter.h>
Public Types | |
enum | AlarmAction { Display } |
enum | MessageType { Appointment , MeetingCancelled , MeetingRequest , MeetingNo , MeetingYes , MeetingTent } |
enum | Method { PublishNew , Obsolete , RequestNew , RequestUpdate , Unknown } |
enum | PartStat { NeedsAction , Accepted , Declined , Tentative , Delegated , Completed , InProcess } |
enum | Priority { High = 2 , Normal = 3 , Low = 1 } |
enum | Role { ReqParticipant , OptParticipant , NonParticipant , Chair } |
Public Member Functions | |
KTNEFWriter () | |
~KTNEFWriter () | |
void | addAttendee (const QString &name, Role role, PartStat partstat, bool rsvp, const QString &email) |
void | addProperty (int tag, int type, const QVariant &value) |
void | clearAttendees () |
void | setAlarm (const QString &description, AlarmAction action, const QDateTime &wakeBefore) |
void | setCategories (const QStringList &categories) |
void | setDescription (const QString &description) |
void | setDtEnd (const QDateTime &dtEnd) |
void | setDtStamp (const QDateTime &dtStamp) |
void | setDtStart (const QDateTime &dtStart) |
void | setLocation (const QString &location) |
void | setMessageType (MessageType methodType) |
void | setMethod (Method method) |
void | setOrganizer (const QString &organizer) |
void | setPriority (Priority priority) |
void | setSender (const QString &name, const QString &email) |
void | setSummary (const QString &summary) |
void | setUID (const QString &uid) |
bool | writeFile (QDataStream &stream) const |
bool | writeFile (QIODevice &file) const |
bool | writeProperty (QDataStream &stream, int &bytes, int tag) const |
Detailed Description
Manages the writing of TNEF attachments.
Definition at line 38 of file ktnefwriter.h.
Member Enumeration Documentation
◆ AlarmAction
The different alarm actions.
Enumerator | |
---|---|
Display | Display the alarm. |
Definition at line 99 of file ktnefwriter.h.
◆ MessageType
The different types of messages.
Definition at line 44 of file ktnefwriter.h.
◆ Method
The different types of message statuses.
Enumerator | |
---|---|
PublishNew | Publish new. |
Obsolete | Replace the message. |
RequestNew | Request a new message. |
RequestUpdate | Request an update. |
Unknown | Unknown. |
Definition at line 56 of file ktnefwriter.h.
◆ PartStat
The different types of participant statuses.
Definition at line 77 of file ktnefwriter.h.
◆ Priority
The different priorities.
Enumerator | |
---|---|
High | High priority task. |
Normal | Normal priority task. |
Low | Low priority task. |
Definition at line 90 of file ktnefwriter.h.
◆ Role
The different types of meeting roles.
Enumerator | |
---|---|
ReqParticipant | Required participant. |
OptParticipant | Optional participant. |
NonParticipant | Non-participant. |
Chair | Meeting chairperson. |
Definition at line 67 of file ktnefwriter.h.
Constructor & Destructor Documentation
◆ KTNEFWriter()
KTNEFWriter::KTNEFWriter | ( | ) |
Constructs a TNEF writer object.
KTNEFWriterPrivate class that helps to provide binary compatibility between releases.
Definition at line 55 of file ktnefwriter.cpp.
◆ ~KTNEFWriter()
|
default |
Destroys the TNEF writer object.
Member Function Documentation
◆ addAttendee()
void KTNEFWriter::addAttendee | ( | const QString & | name, |
Role | role, | ||
PartStat | partstat, | ||
bool | rsvp, | ||
const QString & | email ) |
Adds a meeting participant (attendee).
- Parameters
-
name is the name of the attendee role is the Role of the attendee partstat is the status PartStat of the attendee rsvp is true if the attendee will attend the meeting; else false email is the email address of the attendee
Definition at line 421 of file ktnefwriter.cpp.
◆ addProperty()
void KTNEFWriter::addProperty | ( | int | tag, |
int | type, | ||
const QVariant & | value ) |
Adds a TNEF property.
- Parameters
-
tag is the TNEF tag type is the property type value is the property value
Definition at line 75 of file ktnefwriter.cpp.
◆ clearAttendees()
void KTNEFWriter::clearAttendees | ( | ) |
Clears the attendees list.
Definition at line 417 of file ktnefwriter.cpp.
◆ setAlarm()
void KTNEFWriter::setAlarm | ( | const QString & | description, |
AlarmAction | action, | ||
const QDateTime & | wakeBefore ) |
Sets the alarm.
- Parameters
-
description is the alarm description action is the alaram AlarmAction wakeBefore is the alarm Date/Time
Definition at line 502 of file ktnefwriter.cpp.
◆ setCategories()
void KTNEFWriter::setCategories | ( | const QStringList & | categories | ) |
Sets the category list to categories
.
- Parameters
-
categories is the list categories.
Definition at line 477 of file ktnefwriter.cpp.
◆ setDescription()
void KTNEFWriter::setDescription | ( | const QString & | description | ) |
Sets the description to description
.
- Parameters
-
description is the description.
Definition at line 482 of file ktnefwriter.cpp.
◆ setDtEnd()
void KTNEFWriter::setDtEnd | ( | const QDateTime & | dtEnd | ) |
Sets the Ending Date and Time to dtEnd
.
- Parameters
-
dtEnd is the ending date/time.
Definition at line 454 of file ktnefwriter.cpp.
◆ setDtStamp()
void KTNEFWriter::setDtStamp | ( | const QDateTime & | dtStamp | ) |
Sets the timestamp to dtStamp
.
- Parameters
-
dtStamp is the timestamp.
Definition at line 471 of file ktnefwriter.cpp.
◆ setDtStart()
void KTNEFWriter::setDtStart | ( | const QDateTime & | dtStart | ) |
Sets the Starting Date and Time to dtStart
.
- Parameters
-
dtStart is the starting date/time.
Definition at line 448 of file ktnefwriter.cpp.
◆ setLocation()
void KTNEFWriter::setLocation | ( | const QString & | location | ) |
Sets the Location to location
.
- Parameters
-
location is the location.
Definition at line 460 of file ktnefwriter.cpp.
◆ setMessageType()
void KTNEFWriter::setMessageType | ( | MessageType | methodType | ) |
Sets the MessageType to methodType
.
- Parameters
-
methodType is the MessageType.
Definition at line 374 of file ktnefwriter.cpp.
◆ setMethod()
void KTNEFWriter::setMethod | ( | Method | method | ) |
Sets the Method to method
.
- Parameters
-
method is the Method.
Definition at line 413 of file ktnefwriter.cpp.
◆ setOrganizer()
void KTNEFWriter::setOrganizer | ( | const QString & | organizer | ) |
Sets the name of the organizer to organizer
.
The organizer is any string identifier; it could be the name of a person, or the application that sent the invitation, for example.
- Parameters
-
organizer is the organizer identifier.
Definition at line 432 of file ktnefwriter.cpp.
◆ setPriority()
void KTNEFWriter::setPriority | ( | Priority | priority | ) |
Sets the priority to priority
.
- Parameters
-
priority is the Priority.
Definition at line 496 of file ktnefwriter.cpp.
◆ setSender()
Sets the sender's name
and email
address.
- Parameters
-
name is the sender's name. email is the sender's email address.
Definition at line 361 of file ktnefwriter.cpp.
◆ setSummary()
void KTNEFWriter::setSummary | ( | const QString & | summary | ) |
Sets the summary to summary
.
- Parameters
-
summary is the summary.
Definition at line 488 of file ktnefwriter.cpp.
◆ setUID()
void KTNEFWriter::setUID | ( | const QString & | uid | ) |
◆ writeFile() [1/2]
|
nodiscard |
Writes the attachment to the QDataStream specified by stream
.
- Parameters
-
stream is the QDataStream to write.
- Returns
- true if the write was successful; otherwise false.
Definition at line 330 of file ktnefwriter.cpp.
◆ writeFile() [2/2]
|
nodiscard |
Writes the attachment to the QIODevice specified by file
.
- Parameters
-
file is the QIODevice to write.
- Returns
- true if the write was successful; otherwise false.
Definition at line 320 of file ktnefwriter.cpp.
◆ writeProperty()
|
nodiscard |
Writes a TNEF property to the QDataStream specified by stream
.
A TNEF property has a 1 byte type (LVL_MESSAGE or LVL_ATTACHMENT), a 4 byte type/tag, a 4 byte length, the data and finally the checksum.
The checksum is a 16 byte int with all bytes in the data added.
- Parameters
-
stream is the QDataStream to write bytes is a pointer to an int type that will contain the number of bytes written to the stream
tag is the TNEF tag
- Returns
- false if an invalid TNEF tag was specified by
tag
or if there are no properties to write; else true.
Definition at line 116 of file ktnefwriter.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Sep 27 2024 11:54:35 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.