diff --git a/src/libkdepim/addressline/addresslineedit/addresseelineeditutil.h b/src/libkdepim/addressline/addresslineedit/addresseelineeditutil.h index da1f5a0..286c0b7 100644 --- a/src/libkdepim/addressline/addresslineedit/addresseelineeditutil.h +++ b/src/libkdepim/addressline/addresslineedit/addresseelineeditutil.h @@ -1,34 +1,38 @@ /* Copyright (C) 2016-2019 Laurent Montel 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 ADDRESSEELINEEDITUTIL_H #define ADDRESSEELINEEDITUTIL_H #include #include "kdepim_export.h" namespace KPIM { +/** + * @brief The AddresseeLineEditUtil class + * @author Laurent Montel + */ class KDEPIM_EXPORT AddresseeLineEditUtil { public: static QString adaptPasteMails(const QString &str); }; } #endif // ADDRESSEELINEEDITUTIL_H diff --git a/src/libkdepim/addressline/recentaddress/recentaddresswidget.h b/src/libkdepim/addressline/recentaddress/recentaddresswidget.h index f124f91..b146688 100644 --- a/src/libkdepim/addressline/recentaddress/recentaddresswidget.h +++ b/src/libkdepim/addressline/recentaddress/recentaddresswidget.h @@ -1,59 +1,63 @@ /* Copyright (c) 2015-2019 Montel Laurent 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 RECENTADDRESSWIDGET_H #define RECENTADDRESSWIDGET_H #include "kdepim_export.h" #include #include class KConfig; class QListWidget; class KLineEdit; class QToolButton; namespace KPIM { +/** + * @brief The RecentAddressWidget class + * @author Laurent Montel + */ class KDEPIM_EXPORT RecentAddressWidget : public QWidget { Q_OBJECT public: explicit RecentAddressWidget(QWidget *parent = nullptr); ~RecentAddressWidget() override; void setAddresses(const QStringList &addrs); void storeAddresses(KConfig *config); Q_REQUIRED_RESULT bool wasChanged() const; protected: void updateButtonState(); bool eventFilter(QObject *o, QEvent *e) override; private: void slotAddItem(); void slotRemoveItem(); void slotUpdateAddButton(const QString &str); QToolButton *mNewButton = nullptr; QToolButton *mRemoveButton = nullptr; QListWidget *mListView = nullptr; KLineEdit *mLineEdit = nullptr; bool mDirty = false; }; } #endif // RECENTADDRESSWIDGET_H diff --git a/src/libkdepim/ldap/addhostdialog.h b/src/libkdepim/ldap/addhostdialog.h index dc2a38c..4cd7de5 100644 --- a/src/libkdepim/ldap/addhostdialog.h +++ b/src/libkdepim/ldap/addhostdialog.h @@ -1,51 +1,55 @@ /* This file is part of libkldap. Copyright (c) 2002-2010 Tobias Koenig 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 ADDHOSTDIALOG_H #define ADDHOSTDIALOG_H #include "kdepim_export.h" #include namespace KLDAP { class LdapServer; class AddHostDialogPrivate; +/** + * @brief The AddHostDialog class + * @author Laurent Montel + */ class KDEPIM_EXPORT AddHostDialog : public QDialog { Q_OBJECT public: explicit AddHostDialog(KLDAP::LdapServer *server, QWidget *parent = nullptr); ~AddHostDialog(); Q_SIGNALS: void changed(bool); private Q_SLOTS: void slotHostEditChanged(const QString &); void slotOk(); private: AddHostDialogPrivate *const d; }; } #endif // ADDHOSTDIALOG_H diff --git a/src/libkdepim/ldap/ldapclientsearchconfig.h b/src/libkdepim/ldap/ldapclientsearchconfig.h index e4f65fc..42fef2c 100644 --- a/src/libkdepim/ldap/ldapclientsearchconfig.h +++ b/src/libkdepim/ldap/ldapclientsearchconfig.h @@ -1,77 +1,81 @@ /* * Copyright (C) 2013-2019 Laurent Montel * * 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 LDAPCLIENTSEARCHCONFIG_H #define LDAPCLIENTSEARCHCONFIG_H #include "kdepim_export.h" #include class KConfigGroup; class KConfig; namespace KLDAP { class LdapServer; class LdapClient; +/** + * @brief The LdapClientSearchConfig class + * @author Laurent Montel + */ class KDEPIM_EXPORT LdapClientSearchConfig : public QObject { Q_OBJECT public: explicit LdapClientSearchConfig(QObject *parent = nullptr); ~LdapClientSearchConfig(); /** * Returns the global config object, which stores the LdapClient configurations. */ static KConfig *config(); /** * Reads the LDAP @p server settings from the given config @p group for the * given LDAP @p clientNumber. * * @param active Defines whether the active settings shall be read. */ void readConfig(KLDAP::LdapServer &server, KConfigGroup &group, int clientNumber, bool active); /** * Writes the LDAP @p server settings to the given config @p group for the * given LDAP @p clientNumber. * * @param active Defines whether the active settings shall be written. */ void writeConfig(const KLDAP::LdapServer &server, KConfigGroup &group, int clientNumber, bool active); /** * Should LdapClientSearchConfig ask, if it should use the KWallet to store passwords */ void askForWallet(bool askForWallet); void clearWalletPassword(); private Q_SLOTS: void slotWalletClosed(); private: //@cond PRIVATE class Private; Private *const d; }; } #endif // LDAPCLIENTSEARCHCONFIG_H diff --git a/src/libkdepim/ldap/ldapconfigurewidget.h b/src/libkdepim/ldap/ldapconfigurewidget.h index c35daac..56df922 100644 --- a/src/libkdepim/ldap/ldapconfigurewidget.h +++ b/src/libkdepim/ldap/ldapconfigurewidget.h @@ -1,73 +1,76 @@ /* * Copyright (C) 2019 Laurent Montel * * 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 LDAPCONFIGUREWIDGET_H #define LDAPCONFIGUREWIDGET_H #include "kdepim_export.h" #include class QListWidget; class QPushButton; class QToolButton; class QListWidgetItem; namespace KLDAP { class LdapClientSearchConfig; - +/** + * @brief The LdapConfigureWidget class + * @author Laurent Montel + */ class KDEPIM_EXPORT LdapConfigureWidget : public QWidget { Q_OBJECT public: explicit LdapConfigureWidget(QWidget *parent = nullptr); ~LdapConfigureWidget(); void load(); void save(); private Q_SLOTS: void slotAddHost(); void slotEditHost(); void slotRemoveHost(); void slotSelectionChanged(QListWidgetItem *); void slotItemClicked(QListWidgetItem *); void slotMoveUp(); void slotMoveDown(); Q_SIGNALS: void changed(bool); private: void initGUI(); QListWidget *mHostListView = nullptr; QPushButton *mAddButton = nullptr; QPushButton *mEditButton = nullptr; QPushButton *mRemoveButton = nullptr; QToolButton *mUpButton = nullptr; QToolButton *mDownButton = nullptr; KLDAP::LdapClientSearchConfig *mClientSearchConfig = nullptr; }; } #endif // LDAPCONFIGUREWIDGET_H diff --git a/src/libkdepim/progresswidget/progressmanager.h b/src/libkdepim/progresswidget/progressmanager.h index a033900..7fffe04 100644 --- a/src/libkdepim/progresswidget/progressmanager.h +++ b/src/libkdepim/progresswidget/progressmanager.h @@ -1,425 +1,427 @@ /* progressmanager.h This file is part of libkdepim. Copyright (C) 2004 Till Adam 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 KDEPIM_PROGRESSMANAGER_H #define KDEPIM_PROGRESSMANAGER_H #include "kdepim_export.h" #include #include #include #include #include namespace KPIM { class ProgressItem; class ProgressManager; typedef QMap ProgressItemMap; - +/** + * @brief The ProgressItem class + */ class KDEPIM_EXPORT ProgressItem : public QObject { Q_OBJECT friend class ProgressManager; public: enum CryptoStatus { Encrypted, Unencrypted, Unknown }; /** * @return The id string which uniquely identifies the operation * represented by this item. */ Q_REQUIRED_RESULT const QString &id() const; /** * @return The parent item of this one, if there is one. */ Q_REQUIRED_RESULT ProgressItem *parent() const; /** * @return The user visible string to be used to represent this item. */ Q_REQUIRED_RESULT const QString &label() const; /** * @param v Set the user visible string identifying this item. */ void setLabel(const QString &v); /** * @return The string to be used for showing this item's current status. */ Q_REQUIRED_RESULT const QString &status() const; /** * Set the string to be used for showing this item's current status. * @param v The status string. */ void setStatus(const QString &v); /** * @return Whether this item can be canceled. */ Q_REQUIRED_RESULT bool canBeCanceled() const; /** * @param b Set if can be canceled */ void setCanBeCanceled(bool b); /** * @return Whether this item uses secure communication * (Account uses ssl, for example.). */ Q_REQUIRED_RESULT CryptoStatus cryptoStatus() const; /** * Set whether this item uses crypted communication, so listeners * can display a nice crypto icon. * @param v The value. */ void setCryptoStatus(ProgressItem::CryptoStatus v); /** * @return whether this item uses a busy indicator instead of real progress display */ Q_REQUIRED_RESULT bool usesBusyIndicator() const; /** * Sets whether this item uses a busy indicator instead of real progress for its progress bar. * If it uses a busy indicator, you are still responsible for calling setProgress() from time to * time to update the busy indicator. */ void setUsesBusyIndicator(bool useBusyIndicator); /** * @return The current progress value of this item in percent. */ Q_REQUIRED_RESULT unsigned int progress() const; /** * Set the progress (percentage of completion) value of this item. * @param v The percentage value. */ void setProgress(unsigned int v); /** * Tell the item it has finished. This will Q_EMIT progressItemCompleted() * result in the destruction of the item after all slots connected to this * signal have executed. This is the only way to get rid of an item and * needs to be called even if the item is canceled. Don't use the item * after this has been called on it. */ void setComplete(); /** * Reset the progress value of this item to 0 and the status string to * the empty string. */ void reset(); void cancel(); // Often needed values for calculating progress. void setTotalItems(unsigned int v); Q_REQUIRED_RESULT unsigned int totalItems() const; void setCompletedItems(unsigned int v); void incCompletedItems(unsigned int v = 1); Q_REQUIRED_RESULT unsigned int completedItems() const; /** * Recalculate progress according to total/completed items and update. */ void updateProgress(); void addChild(ProgressItem *kiddo); void removeChild(ProgressItem *kiddo); bool canceled() const; unsigned int typeProgressItem() const; void setTypeProgressItem(unsigned int); Q_SIGNALS: /** * Emitted when a new ProgressItem is added. * @param The ProgressItem that was added. */ void progressItemAdded(KPIM::ProgressItem *); /** * Emitted when the progress value of an item changes. * @param The item which got a new value. * @param The value, for convenience. */ void progressItemProgress(KPIM::ProgressItem *, unsigned int); /** * Emitted when a progress item was completed. The item will be * deleted afterwards, so slots connected to this are the last * chance to work with this item. * @param The completed item. */ void progressItemCompleted(KPIM::ProgressItem *); /** * Emitted when an item was canceled. It will _not_ go away immediately, * only when the owner sets it complete, which will usually happen. Can be * used to visually indicate the canceled status of an item. Should be used * by the owner of the item to make sure it is set completed even if it is * canceled. There is a ProgressManager::slotStandardCancelHandler which * simply sets the item completed and can be used if no other work needs to * be done on cancel. * @param The canceled item; */ void progressItemCanceled(KPIM::ProgressItem *); /** * Emitted when the status message of an item changed. Should be used by * progress dialogs to update the status message for an item. * @param The updated item. * @param The new message. */ void progressItemStatus(KPIM::ProgressItem *, const QString &); /** * Emitted when the label of an item changed. Should be used by * progress dialogs to update the label of an item. * @param The updated item. * @param The new label. */ void progressItemLabel(KPIM::ProgressItem *, const QString &); /** * Emitted when the crypto status of an item changed. Should be used by * progress dialogs to update the crypto indicator of an item. * @param The updated item. * @param The new state. */ void progressItemCryptoStatus(KPIM::ProgressItem *, KPIM::ProgressItem::CryptoStatus); /** * Emitted when the busy indicator state of an item changes. Should be used * by progress dialogs so that they can adjust the display of the progress bar * to the new mode. * @param item The updated item * @param value True if the item uses a busy indicator now, false otherwise */ void progressItemUsesBusyIndicator(KPIM::ProgressItem *item, bool value); protected: /* Only to be used by our good friend the ProgressManager */ ProgressItem(ProgressItem *parent, const QString &id, const QString &label, const QString &status, bool isCancellable, CryptoStatus cryptoStatus); ~ProgressItem() override; private: QString mId; QString mLabel; QString mStatus; QPointer mParent; bool mCanBeCanceled = false; unsigned int mProgress = 0; ProgressItemMap mChildren; unsigned int mTotal = 0; unsigned int mCompleted = 0; CryptoStatus mCryptoStatus; unsigned int mType = 0; bool mWaitingForKids = false; bool mCanceled = false; bool mUsesBusyIndicator = false; bool mCompletedCalled = false; }; struct ProgressManagerPrivate; /** * The ProgressManager singleton keeps track of all ongoing transactions * and notifies observers (progress dialogs) when their progress percent value * changes, when they are completed (by their owner), and when they are canceled. * Each ProgressItem emits those signals individually and the singleton * broadcasts them. Use the ::createProgressItem() statics to acquire an item * and then call ->setProgress( int percent ) on it every time you want to * update the item and ->setComplete() when the operation is done. This will * delete the item. Connect to the item's progressItemCanceled() signal to be * notified when the user cancels the transaction using one of the observing * progress dialogs or by calling item->cancel() in some other way. The owner * is responsible for calling setComplete() on the item, even if it is canceled. * Use the standardCancelHandler() slot if that is all you want to do on cancel. * * Note that if you request an item with a certain id and there is already * one with that id, there will not be a new one created but the existing * one will be returned. This is convenient for accessing items that are * needed regularly without the to store a pointer to them or to add child * items to parents by id. */ class KDEPIM_EXPORT ProgressManager : public QObject { Q_OBJECT friend struct ProgressManagerPrivate; public: ~ProgressManager() override; /** * @return The singleton instance of this class. */ static ProgressManager *instance(); /** * Use this to acquire a unique id number which can be used to discern * an operation from all others going on at the same time. Use that * number as the id string for your progressItem to ensure it is unique. * @return */ static QString getUniqueID(); /** * Creates a ProgressItem with a unique id and the given label. * This is the simplest way to acquire a progress item. It will not * have a parent and will be set to be cancellable and not using crypto. */ static ProgressItem *createProgressItem(unsigned int progressType, const QString &label); /** * Creates a ProgressItem with a unique id and the given label. * This is the simplest way to acquire a progress item. It will not * have a parent and will be set to be cancellable and not using crypto. */ static ProgressItem *createProgressItem(const QString &label); /** * Creates a new progressItem with the given parent, id, label and initial * status. * * @param parent Specify an already existing item as the parent of this one. * @param id Used to identify this operation for cancel and progress info. * @param label The text to be displayed by progress handlers * @param status Additional text to be displayed for the item. * @param canBeCanceled can the user cancel this operation? * @param usesCrypto does the operation use secure transports (SSL) * Cancelling the parent will cancel the children as well (if they can be * canceled) and ongoing children prevent parents from finishing. * @return The ProgressItem representing the operation. */ static ProgressItem *createProgressItem(ProgressItem *parent, const QString &id, const QString &label, const QString &status = QString(), bool canBeCanceled = true, KPIM::ProgressItem::CryptoStatus cryptoStatus = KPIM::ProgressItem::Unencrypted); /** * Use this version if you have the id string of the parent and want to * add a subjob to it. */ static ProgressItem *createProgressItem(const QString &parent, const QString &id, const QString &label, const QString &status = QString(), bool canBeCanceled = true, KPIM::ProgressItem::CryptoStatus cryptoStatus = KPIM::ProgressItem::Unencrypted); /** * Version without a parent. */ static ProgressItem *createProgressItem(const QString &id, const QString &label, const QString &status = QString(), bool canBeCanceled = true, KPIM::ProgressItem::CryptoStatus cryptoStatus = KPIM::ProgressItem::Unencrypted); /** * @return true when there are no more progress items. */ bool isEmpty() const; /** * @return the only top level progressitem when there's only one. * Returns 0 if there is no item, or more than one top level item. * Since this is used to calculate the overall progress, it will also return * 0 if there is an item which uses a busy indicator, since that will invalidate * the overall progress. */ ProgressItem *singleItem() const; /** * Ask all listeners to show the progress dialog, because there is * something that wants to be shown. */ static void emitShowProgressDialog(); ProgressItem *progressItem(const QString &id) const; Q_SIGNALS: /** @see ProgressItem::progressItemAdded() */ void progressItemAdded(KPIM::ProgressItem *); /** @see ProgressItem::progressItemProgress() */ void progressItemProgress(KPIM::ProgressItem *, unsigned int); /** @see ProgressItem::progressItemCompleted() */ void progressItemCompleted(KPIM::ProgressItem *); /** @see ProgressItem::progressItemCanceled() */ void progressItemCanceled(KPIM::ProgressItem *); /** @see ProgressItem::progressItemStatus() */ void progressItemStatus(KPIM::ProgressItem *, const QString &); /** @see ProgressItem::progressItemLabel() */ void progressItemLabel(KPIM::ProgressItem *, const QString &); /** @see ProgressItem::progressItemCryptoStatus() */ void progressItemCryptoStatus(KPIM::ProgressItem *, KPIM::ProgressItem::CryptoStatus); /** @see ProgressItem::progressItemUsesBusyIndicator */ void progressItemUsesBusyIndicator(KPIM::ProgressItem *, bool); /** * Emitted when an operation requests the listeners to be shown. * Use emitShowProgressDialog() to trigger it. */ void showProgressDialog(); public Q_SLOTS: /** * Calls setCompleted() on the item, to make sure it goes away. * Provided for convenience. * @param item the canceled item. */ void slotStandardCancelHandler(KPIM::ProgressItem *item); /** * Aborts all running jobs. Bound to "Esc" */ void slotAbortAll(); private Q_SLOTS: void slotTransactionCompleted(KPIM::ProgressItem *item); private: ProgressManager(); // prevent unsolicited copies ProgressManager(const ProgressManager &); ProgressItem *createProgressItemImpl(ProgressItem *parent, const QString &id, const QString &label, const QString &status, bool cancellable, ProgressItem::CryptoStatus cryptoStatus, unsigned int progressType = 0); ProgressItem *createProgressItemImpl(const QString &parent, const QString &id, const QString &label, const QString &status, bool cancellable, ProgressItem::CryptoStatus cryptoStatus, unsigned int progressType = 0); void emitShowProgressDialogImpl(); QHash< QString, ProgressItem * > mTransactions; static unsigned int uID; }; } #endif // __KPIM_PROGRESSMANAGER_H__ diff --git a/src/libkdepim/progresswidget/progressstatusbarwidget.h b/src/libkdepim/progresswidget/progressstatusbarwidget.h index 6f4143d..93918dc 100644 --- a/src/libkdepim/progresswidget/progressstatusbarwidget.h +++ b/src/libkdepim/progresswidget/progressstatusbarwidget.h @@ -1,42 +1,46 @@ /* Copyright (C) 2014-2019 Laurent Montel 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 PROGRESSSTATUSBARWIDGET_H #define PROGRESSSTATUSBARWIDGET_H #include #include "kdepim_export.h" namespace KPIM { class StatusbarProgressWidget; class ProgressStatusBarWidgetPrivate; +/** + * @brief The ProgressStatusBarWidget class + * @author Laurent Montel + */ class KDEPIM_EXPORT ProgressStatusBarWidget : public QObject { Q_OBJECT public: explicit ProgressStatusBarWidget(QWidget *alignWidget, QWidget *parent = nullptr, unsigned int showTypeProgressItem = 0); ~ProgressStatusBarWidget(); Q_REQUIRED_RESULT KPIM::StatusbarProgressWidget *littleProgress() const; private: ProgressStatusBarWidgetPrivate *const d; }; } #endif // PROGRESSSTATUSBARWIDGET_H diff --git a/src/libkdepim/widgets/progressindicatorlabel.h b/src/libkdepim/widgets/progressindicatorlabel.h index 79d4bc6..e6b30e3 100644 --- a/src/libkdepim/widgets/progressindicatorlabel.h +++ b/src/libkdepim/widgets/progressindicatorlabel.h @@ -1,51 +1,55 @@ /* Copyright (c) 2013-2019 Montel Laurent 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 PROGRESSINDICATORLABEL_H #define PROGRESSINDICATORLABEL_H #include "kdepim_export.h" #include namespace KPIM { class ProgressIndicatorLabelPrivate; +/** + * @brief The ProgressIndicatorLabel class + * @author Laurent Montel + */ class KDEPIM_EXPORT ProgressIndicatorLabel : public QWidget { Q_OBJECT public: /** * @since 4.12 */ explicit ProgressIndicatorLabel(const QString &labelStr, QWidget *parent = nullptr); explicit ProgressIndicatorLabel(QWidget *parent = nullptr); ~ProgressIndicatorLabel(); void setActiveLabel(const QString &label); public Q_SLOTS: void start(); void stop(); private: friend class ProgressIndicatorLabelPrivate; ProgressIndicatorLabelPrivate *const d; }; } #endif // PROGRESSINDICATORLABEL_H diff --git a/src/libkdepimakonadi/addressline/addresslineedit/addresseelineeditakonadi.h b/src/libkdepimakonadi/addressline/addresslineedit/addresseelineeditakonadi.h index bbec4f8..2af0332 100644 --- a/src/libkdepimakonadi/addressline/addresslineedit/addresseelineeditakonadi.h +++ b/src/libkdepimakonadi/addressline/addresslineedit/addresseelineeditakonadi.h @@ -1,43 +1,47 @@ /* Copyright (C) 2017-2019 Laurent Montel 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 ADDRESSEELINEEDITAKONADI_H #define ADDRESSEELINEEDITAKONADI_H namespace Akonadi { class Session; } namespace KPIM { class AddresseeLineEditManager; +/** + * @brief The AddresseeLineEditAkonadi class + * @author Laurent Montel + */ class AddresseeLineEditAkonadi { public: explicit AddresseeLineEditAkonadi(AddresseeLineEditManager *addressLineStatic); ~AddresseeLineEditAkonadi(); Akonadi::Session *akonadiSession() const; private: mutable Akonadi::Session *m_akonadiSession = nullptr; AddresseeLineEditManager *mAddressLineStatic = nullptr; }; } #endif // ADDRESSEELINEEDITAKONADI_H diff --git a/src/libkdepimakonadi/addressline/completionconfiguredialog/completionconfiguredialog.h b/src/libkdepimakonadi/addressline/completionconfiguredialog/completionconfiguredialog.h index 7eee2f0..6282fd7 100644 --- a/src/libkdepimakonadi/addressline/completionconfiguredialog/completionconfiguredialog.h +++ b/src/libkdepimakonadi/addressline/completionconfiguredialog/completionconfiguredialog.h @@ -1,55 +1,59 @@ /* Copyright (c) 2015-2019 Montel Laurent 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 COMPLETIONCONFIGUREDIALOG_H #define COMPLETIONCONFIGUREDIALOG_H #include "kdepimakonadi_export.h" #include class KConfig; namespace KLDAP { class LdapClientSearch; } namespace KPIM { class CompletionConfigureDialogPrivate; +/** + * @brief The CompletionConfigureDialog class + * @author Laurent Montel + */ class KDEPIMAKONADI_EXPORT CompletionConfigureDialog : public QDialog { Q_OBJECT public: explicit CompletionConfigureDialog(QWidget *parent = nullptr); ~CompletionConfigureDialog(); void load(); void setEmailBlackList(const QStringList &lst); void setLdapClientSearch(KLDAP::LdapClientSearch *ldapSearch); void setRecentAddresses(const QStringList &lst); Q_REQUIRED_RESULT bool recentAddressWasChanged() const; void storeAddresses(KConfig *config); private: void slotSave(); void readConfig(); void writeConfig(); CompletionConfigureDialogPrivate *const d; }; } #endif // COMPLETIONCONFIGUREDIALOG_H diff --git a/src/libkdepimakonadi/addressline/completionorder/completionordereditor.h b/src/libkdepimakonadi/addressline/completionorder/completionordereditor.h index f565643..3a71bac 100644 --- a/src/libkdepimakonadi/addressline/completionorder/completionordereditor.h +++ b/src/libkdepimakonadi/addressline/completionorder/completionordereditor.h @@ -1,62 +1,65 @@ /* -*- c++ -*- * completionordereditor.h * * Copyright (c) 2004 David Faure * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * In addition, as a special exception, the copyright holders give * permission to link the code of this program with any edition of * the Qt library by Trolltech AS, Norway (or with modified versions * of Qt that use the same license as Qt), and distribute linked * combinations including the two. You must obey the GNU General * Public License in all respects for all of the code used other than * Qt. If you modify this file, you may extend this exception to * your version of the file, but you are not obligated to do so. If * you do not wish to do so, delete this exception statement from * your version. */ #ifndef KDEPIM_COMPLETIONORDEREDITOR_H #define KDEPIM_COMPLETIONORDEREDITOR_H #include "kdepimakonadi_export.h" #include namespace KLDAP { class LdapClientSearch; } namespace KPIM { class CompletionOrderEditorPrivate; +/** + * @brief The CompletionOrderEditor class + */ class KDEPIMAKONADI_EXPORT CompletionOrderEditor : public QDialog { Q_OBJECT public: CompletionOrderEditor(KLDAP::LdapClientSearch *ldapSearch, QWidget *parent = nullptr); ~CompletionOrderEditor(); private Q_SLOTS: void slotOk(); private: void readConfig(); void writeConfig(); CompletionOrderEditorPrivate *const d; }; } // namespace #endif /* COMPLETIONORDEREDITOR_H */ diff --git a/src/libkdepimakonadi/addressline/plugins/addressesslineeditabstractplugin.h b/src/libkdepimakonadi/addressline/plugins/addressesslineeditabstractplugin.h index 98727f4..7dcbd7b 100644 --- a/src/libkdepimakonadi/addressline/plugins/addressesslineeditabstractplugin.h +++ b/src/libkdepimakonadi/addressline/plugins/addressesslineeditabstractplugin.h @@ -1,58 +1,66 @@ /* Copyright (C) 2017-2019 Laurent Montel 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 ADDRESSESSLINEEDITABSTRACTPLUGIN_H #define ADDRESSESSLINEEDITABSTRACTPLUGIN_H #include #include "kdepimakonadi_export.h" namespace KPIM { class AddresseeLineEdit; +/** + * @brief The AddressessLineEditAbstractPluginInfo struct + * @author Laurent Montel + */ struct KDEPIMAKONADI_EXPORT AddressessLineEditAbstractPluginInfo { QString name; QString identifier; QString description; }; +/** + * @brief The AddressessLineEditAbstractPlugin class + * @author Laurent Montel + */ class KDEPIMAKONADI_EXPORT AddressessLineEditAbstractPlugin : public QObject { Q_OBJECT public: explicit AddressessLineEditAbstractPlugin(QObject *parent = nullptr); ~AddressessLineEditAbstractPlugin(); void setLineEdit(KPIM::AddresseeLineEdit *linedit); virtual QVector names() const = 0; virtual void start() = 0; virtual void cancel() = 0; virtual void stop() = 0; Q_SIGNALS: void wasUpdated(); private: KPIM::AddresseeLineEdit *mLinedit = nullptr; bool mEnabled = true; }; } #endif // ADDRESSESSLINEEDITABSTRACTPLUGIN_H diff --git a/src/libkdepimakonadi/addressline/plugins/addressesslineeditpluginmanager.h b/src/libkdepimakonadi/addressline/plugins/addressesslineeditpluginmanager.h index 0ddbe5e..83a709e 100644 --- a/src/libkdepimakonadi/addressline/plugins/addressesslineeditpluginmanager.h +++ b/src/libkdepimakonadi/addressline/plugins/addressesslineeditpluginmanager.h @@ -1,46 +1,50 @@ /* Copyright (C) 2017-2019 Laurent Montel 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 ADDRESSESSLINEEDITPLUGINMANAGER_H #define ADDRESSESSLINEEDITPLUGINMANAGER_H #include #include "kdepimakonadi_export.h" namespace KPIM { class AddressessLineEditAbstractPlugin; class AddressessLineEditPluginManagerPrivate; +/** + * @brief The AddressessLineEditPluginManager class + * @author Laurent Montel + */ class KDEPIMAKONADI_EXPORT AddressessLineEditPluginManager : public QObject { Q_OBJECT public: explicit AddressessLineEditPluginManager(QObject *parent = nullptr); ~AddressessLineEditPluginManager(); static AddressessLineEditPluginManager *self(); KPIM::AddressessLineEditAbstractPlugin *plugin(const QString &identifier); QVector pluginsList() const; private: AddressessLineEditPluginManagerPrivate *const d; }; } #endif // ADDRESSESSLINEEDITPLUGINMANAGER_H diff --git a/src/libkdepimakonadi/job/addemaildisplayjob.h b/src/libkdepimakonadi/job/addemaildisplayjob.h index a19de62..f585836 100644 --- a/src/libkdepimakonadi/job/addemaildisplayjob.h +++ b/src/libkdepimakonadi/job/addemaildisplayjob.h @@ -1,58 +1,62 @@ /* Copyright 2013-2019 Laurent Montel 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 ADDEMAILDISPLAYJOB_H #define ADDEMAILDISPLAYJOB_H #include "kdepimakonadi_export.h" #include #include namespace Akonadi { class Item; } namespace KPIM { +/** + * @brief The AddEmailDiplayJob class + * @author Laurent Montel + */ class KDEPIMAKONADI_EXPORT AddEmailDiplayJob : public KJob { Q_OBJECT public: explicit AddEmailDiplayJob(const QString &email, QWidget *parentWidget, QObject *parent = nullptr); ~AddEmailDiplayJob() override; void setShowAsHTML(bool html); void setRemoteContent(bool b); void setContact(const Akonadi::Item &contact); void setMessageId(Akonadi::Item::Id id); void start() override; Q_SIGNALS: void contactUpdated(const Akonadi::Item &contact, Akonadi::Item::Id id); private: //@cond PRIVATE class Private; Private *const d; //@endcond }; } #endif diff --git a/src/libkdepimakonadi/widgets/tagselectioncombo.h b/src/libkdepimakonadi/widgets/tagselectioncombo.h index 5899851..abc7ba1 100644 --- a/src/libkdepimakonadi/widgets/tagselectioncombo.h +++ b/src/libkdepimakonadi/widgets/tagselectioncombo.h @@ -1,42 +1,48 @@ /* Copyright (c) 2014 Christian Mollekopf This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program 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 General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef TAGSELECTIONCOMBO_H #define TAGSELECTIONCOMBO_H #include "kdepimakonadi_export.h" #include #include namespace KPIM { +/** + * @brief The TagSelectionCombo class + */ class KDEPIMAKONADI_EXPORT TagSelectionCombo : public KPIM::KCheckComboBox { Q_OBJECT public: explicit TagSelectionCombo(QWidget *parent = nullptr); }; +/** + * @brief The TagCombo class + */ class KDEPIMAKONADI_EXPORT TagCombo : public KComboBox { Q_OBJECT public: explicit TagCombo(QWidget *parent = nullptr); }; } #endif // TAGSELECTIONCOMBO_H