File indexing completed on 2024-04-28 05:19:25

 /*
     ktnefattach.h
 
     SPDX-FileCopyrightText: 2002 Michael Goffioul <kdeprint@swing.be>
 
     This file is part of KTNEF, the KDE TNEF support library/program.
 
     SPDX-License-Identifier: LGPL-2.0-or-later
  */
 /**
  * @file
  * This file is part of the API for handling TNEF data and
  * defines the KTNEFAttach class.
  *
  * @author Michael Goffioul
  */
 
 #pragma once
 
 #include <QString>
 
 #include "ktnef_export.h"
 #include "ktnefpropertyset.h"
 #include <memory>
 
 namespace KTnef
 {
 class KTNEFProperty;
 }
 
 namespace KTnef
 {
 /**
  * @brief
  * Represents a @acronym TNEF attachment.
  */
 class KTNEF_EXPORT KTNEFAttach : public KTNEFPropertySet
 {
 public:
     /**
      * The different attachment parsed states.
      */
     enum ParseState {
         Unparsed = 0x0000, /**< Unparsed */
         TitleParsed = 0x0001, /**< The title is parsed */
         DataParsed = 0x0002, /**< The data is parsed */
         InfoParsed = 0x0004 /**< The info is parsed */
     };
 
     /**
      * Constructs a @acronym TNEF attachment.
      */
     KTNEFAttach();
 
     /**
      * Destroys the @acronym TNEF attachment.
      */
     ~KTNEFAttach();
 
     /**
      * Sets the #TitleParsed flag for this attachment.
      */
     void setTitleParsed();
 
     /**
      * Sets the #DataParsed flag for this attachment.
      */
     void setDataParsed();
 
     /**
      * Unsets the #DataParsed flag for this attachment.
      */
     void unsetDataParser();
 
     /**
      * Sets the #InfoParsed flag for this attachment.
      */
     void setInfoParsed();
 
     /**
      * Returns true if the #TitleParsed flag is set; else returns false.
      */
     [[nodiscard]] bool titleParsed() const;
 
     /**
      * Returns true if the ParseState::DataParsed flag is set; else returns false.
      */
     [[nodiscard]] bool dataParsed() const;
 
     /**
      * Returns true if the #InfoParsed flag is set; else returns false.
      */
     [[nodiscard]] bool infoParsed() const;
 
     /**
      * Sets/Unsets the attachment state according to the @p state flag
      * must be a #ParseState type.
      *
      * @param state a #ParseState type.
      * @return true if the state is turned-on; else returns false.
      */
     [[nodiscard]] bool checkState(int state) const;
 
     /**
      * Sets the offset value of this attachment to @p offset.
      *
      * @param offset is the attachment offset to set.
      */
     void setOffset(int offset);
 
     /**
      * Returns the offset value of the attachment.
      */
     [[nodiscard]] int offset() const;
 
     /**
      * Sets the size of the attachment to @p size.
      *
      * @param size is the attachment size to set.
      */
     void setSize(int size);
 
     /**
      * Returns the size of the attachment.
      */
     [[nodiscard]] int size() const;
 
     /**
      * Sets the display size of the attachment to @p size.
      *
      * @param size is the attachment display size to set.
      */
     void setDisplaySize(int size);
 
     /**
      * Returns the display size of the attachment.
      */
     [[nodiscard]] int displaySize() const;
 
     /**
      * Sets the name of this attachment to @p str.
      *
      * @param str is attachment name to set.
      */
     void setName(const QString &str);
 
     /**
      * Returns the name of the attachment.
      */
     [[nodiscard]] QString name() const;
 
     /**
      * Sets the index of this attachment to @p indx.
      *
      * @param indx is the attachment index to set.
      */
     void setIndex(int indx);
 
     /**
      * Returns the index of the attachment.
      */
     [[nodiscard]] int index() const;
 
     /**
      * Sets the filename of this attachment to @p str.
      *
      * @param str is the attachment filename to set.
      */
     void setFileName(const QString &str);
 
     /**
      * Returns the filename of the attachment.
      */
     [[nodiscard]] QString fileName() const;
 
     /**
      * Sets the display name of this attachment to @p str.
      *
      * @param str is the attachment display name to set.
      */
     void setDisplayName(const QString &str);
 
     /**
      * Returns the display name of the attachment.
      */
     [[nodiscard]] QString displayName() const;
 
     /**
      * Sets the @acronym MIME tag of this attachment to @p str.
      *
      * @param str is the attachment @acronym MIME tag to set.
      */
     void setMimeTag(const QString &str);
 
     /**
      * Returns the @acronym MIME tag of the attachment.
      */
     [[nodiscard]] QString mimeTag() const;
 
     /**
      * Sets the filename extension of this attachment to @p str.
      *
      * @param str is the attachment filename extension to set.
      */
     void setExtension(const QString &str);
 
     /**
      * Returns the filename extension of the attachment.
      */
     [[nodiscard]] QString extension() const;
 
 private:
     //@cond PRIVATE
     class AttachPrivate;
     std::unique_ptr<AttachPrivate> const d;
     //@endcond
 
     Q_DISABLE_COPY(KTNEFAttach)
 };
 
 }