ktnefwriter.h

Go to the documentation of this file.

/*
    ktnefwriter.cpp

    Copyright (C) 2002 Bo Thorsen  <bo@sonofthor.dk>

    This file is part of KTNEF, the KDE TNEF support library/program.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
 */
#ifndef KTNEFWRITER_H
#define KTNEFWRITER_H

class QString;
class QVariant;
class QIODevice;
class QDataStream;
class QDateTime;
class QStringList;

#include "ktnef_export.h"
#include <qglobal.h>

namespace KTnef {

class KTNEF_EXPORT KTNEFWriter
{
  public:
    enum MessageType {
      Appointment,     
      MeetingCancelled,
      MeetingRequest,  
      MeetingNo,       
      MeetingYes,      
      MeetingTent      
    };

    enum Method {
      PublishNew,      
      Obsolete,        
      RequestNew,      
      RequestUpdate,   
      Unknown          
    };

    enum Role {
      ReqParticipant,  
      OptParticipant,  
      NonParticipant,  
      Chair            
    };

    enum PartStat {
      NeedsAction,     
      Accepted,        
      Declined,        
      Tentative,       
      Delegated,       
      Completed,       
      InProcess        
    };

    enum Priority {
      High = 2,        
      Normal = 3,      
      Low = 1          
    };

    enum AlarmAction {
      Display          
    };

    KTNEFWriter();

    ~KTNEFWriter();

    void addProperty( int tag, int type, const QVariant &value );

    bool writeProperty( QDataStream &stream, int &bytes, int tag ) const;

    bool writeFile( QIODevice &file ) const;

    bool writeFile( QDataStream &stream ) const;

    void setSender( const QString &name, const QString &email );

    void setMessageType( MessageType methodType );

    void setMethod( Method method );

    void clearAttendees();

    void addAttendee( const QString &name, Role role, PartStat partstat,
                      bool rsvp, const QString &email );

    void setOrganizer( const QString &organizer );

    void setDtStart( const QDateTime &dtStart );

    void setDtEnd( const QDateTime &dtEnd );

    void setLocation( const QString &location );

    void setUID( const QString &uid );

    void setDtStamp( const QDateTime &dtStamp );

    void setCategories( const QStringList &categories );

    void setDescription( const QString &description );

    void setSummary( const QString &summary );

    void setPriority( Priority priority );

    void setAlarm( const QString &description, AlarmAction action,
                   const QDateTime &wakeBefore );

  private:
    //@cond PRIVATE
    class PrivateData;
    PrivateData *const d;
    //@endcond

    Q_DISABLE_COPY( KTNEFWriter )
};

}

#endif // KTNEFWRITER_H