File indexing completed on 2024-06-23 05:15:12

 /*
     SPDX-FileCopyrightText: 2009 Constantin Berzan <exit3219@gmail.com>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "mailtransport_export.h"
 #include "transport.h"
 
 #include <QString>
 
 namespace MailTransport
 {
 class AddTransportDialog;
 class TransportManager;
 class TransportTypePrivate;
 
 /**
   @short A representation of a transport type.
 
   Represents an available transport type.  SMTP is available
 
   All available transport types can be retrieved via TransportManager::types().
 
   @author Constantin Berzan <exit3219@gmail.com>
   @since 4.4
 */
 class MAILTRANSPORT_EXPORT TransportType
 {
     Q_GADGET
 
     /// This property holds whether the transport type is valid.
     Q_PROPERTY(bool isValid READ isValid CONSTANT)
 
     /// This property holds the i18n'ed name of the transport type.
     Q_PROPERTY(QString name READ name CONSTANT)
 
     /// This property holds the transport type.
     Q_PROPERTY(QString description READ description CONSTANT)
 
     /// This property holds the plugin identifier.
     Q_PROPERTY(QString identifier READ identifier CONSTANT)
 
     /// This property holds whether this transport is an akonadi resource.
     Q_PROPERTY(bool isAkonadiResource READ isAkonadiResource CONSTANT)
 
     friend class AddTransportDialog;
     friend class Transport;
     friend class TransportManager;
     friend class TransportManagerPrivate;
 
 public:
     /**
       Describes a list of transport types.
     */
     using List = QList<TransportType>;
 
     /**
       Constructs a new TransportType.
     */
     TransportType();
 
     /**
       Creates a copy of the @p other TransportType.
     */
     TransportType(const TransportType &other);
 
     /**
       Destroys the TransportType.
     */
     ~TransportType();
 
     /**
      * Replaces the transport type by the @p other.
      */
     TransportType &operator=(const TransportType &other);
 
     /**
      * Compares the transport type with the @p other.
      */
     [[nodiscard]] bool operator==(const TransportType &other) const;
 
     /**
       Returns whether the transport type is valid.
     */
     [[nodiscard]] bool isValid() const;
 
     /**
       Returns the i18n'ed name of the transport type.
     */
     [[nodiscard]] QString name() const;
 
     /**
       Returns a description of the transport type.
     */
     [[nodiscard]] QString description() const;
 
     /**
      * Returns a plugin identifier
      */
     [[nodiscard]] QString identifier() const;
 
     /// Returns whether this transport is an akonadi resource.
     [[nodiscard]] bool isAkonadiResource() const;
 
 private:
     //@cond PRIVATE
     QSharedDataPointer<TransportTypePrivate> d;
     //@endcond
 };
 } // namespace MailTransport
 
 Q_DECLARE_TYPEINFO(MailTransport::TransportType, Q_RELOCATABLE_TYPE);