/usr/include/kpimidentities/identitymanager.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | /*
Copyright (c) 2002 Marc Mutz <mutz@kde.org>
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 KPIMIDENTITIES_IDENTITYMANAGER_H
#define KPIMIDENTITIES_IDENTITYMANAGER_H
#include <kpimidentities/kpimidentities_export.h>
#include <kconfiggroup.h>
#include <QtCore/QObject>
class KConfigBase;
class KConfig;
class QStringList;
namespace KPIMIdentities
{
class Identity;
/**
* @short Manages the list of identities.
* @author Marc Mutz <mutz@kde.org>
**/
class KPIMIDENTITIES_EXPORT IdentityManager : public QObject
{
Q_OBJECT
public:
/**
* Create an identity manager, which loads the emailidentities file
* to create identities.
* @param readonly if true, no changes can be made to the identity manager
* This means in particular that if there is no identity configured,
* the default identity created here will not be saved.
* It is assumed that a minimum of one identity is always present.
*/
explicit IdentityManager( bool readonly = false, QObject *parent=0,
const char *name=0 );
virtual ~IdentityManager();
public:
typedef QList<Identity>::Iterator Iterator;
typedef QList<Identity>::ConstIterator ConstIterator;
/**
* Typedef for STL style iterator
*/
typedef Iterator iterator;
/**
* Typedef for STL style iterator
*/
typedef ConstIterator const_iterator;
/** @return a unique name for a new identity based on @p name */
QString makeUnique( const QString &name ) const;
/** @return whether the @p name is unique */
bool isUnique( const QString &name ) const;
/** Commit changes to disk and emit changed() if necessary. */
void commit();
/** Re-read the config from disk and forget changes. */
void rollback();
/** Check whether there are any unsaved changes. */
bool hasPendingChanges() const;
/** @return the list of identities */
QStringList identities() const;
/** Convenience method.
@return the list of (shadow) identities, ie. the ones currently
under configuration.
*/
QStringList shadowIdentities() const;
/** Sort the identities by name (the default is always first). This
operates on the @em shadow list, so you need to @ref commit for
the changes to take effect.
**/
void sort();
/** @return an identity whose address matches any in @p addresses
or @ref Identity::null if no such identity exists.
**/
const Identity &identityForAddress( const QString &addresses ) const;
/** @return true if @p addressList contains any of our addresses,
false otherwise.
@see #identityForAddress
**/
bool thatIsMe( const QString &addressList ) const;
/** @return the identity with Unique Object Identifier (UOID) @p
uoid or @ref Identity::null if not found.
**/
const Identity &identityForUoid( uint uoid ) const;
/** Convenience menthod.
@return the identity with Unique Object Identifier (UOID) @p
uoid or the default identity if not found.
**/
const Identity &identityForUoidOrDefault( uint uoid ) const;
/** @return the default identity */
const Identity &defaultIdentity() const;
/** Sets the identity with Unique Object Identifier (UOID) @p uoid
to be new the default identity. As usual, use @ref commit to
make this permanent.
@return false if an identity with UOID @p uoid was not found
**/
bool setAsDefault( uint uoid );
/** @return the identity named @p identityName. This method returns a
reference to the identity that can be modified. To let others
see this change, use @ref commit.
**/
Identity &modifyIdentityForName( const QString &identityName );
/** @return the identity with Unique Object Identifier (UOID) @p uoid.
This method returns a reference to the identity that can
be modified. To let others see this change, use @ref commit.
**/
Identity &modifyIdentityForUoid( uint uoid );
/** Removes the identity with name @p identityName
Will return false if the identity is not found,
or when one tries to remove the last identity.
**/
bool removeIdentity( const QString &identityName );
/**
* Removes the identity with name @p identityName
* Will return @c false if the identity is not found, @c true otherwise.
*
* @note In opposite to removeIdentity, this method allows to remove the
* last remaining identity.
*
* @since 4.6
*/
bool removeIdentityForced( const QString &identityName );
ConstIterator begin() const;
ConstIterator end() const;
/// Iterator used by the configuration dialog, which works on a separate list
/// of identities, for modification. Changes are made effective by commit().
Iterator modifyBegin();
Iterator modifyEnd();
Identity &newFromScratch( const QString &name );
Identity &newFromControlCenter( const QString &name );
Identity &newFromExisting( const Identity &other,
const QString &name=QString() );
/** Returns the list of all email addresses (only name@host) from all
identities */
QStringList allEmails() const;
Q_SIGNALS:
/** Emitted whenever a commit changes any configure option */
void changed();
/** Emitted whenever the identity with Unique Object Identifier
(UOID) @p uoid changed. Useful for more fine-grained change
notifications than what is possible with the standard @ref
changed() signal. */
void changed( uint uoid );
/** Emitted whenever the identity @p ident changed. Useful for more
fine-grained change notifications than what is possible with the
standard @ref changed() signal. */
void changed( const KPIMIdentities::Identity &ident );
/** Emitted on @ref commit() for each deleted identity. At the time
this signal is emitted, the identity does still exist and can be
retrieved by @ref identityForUoid() if needed */
void deleted( uint uoid );
/** Emitted on @ref commit() for each new identity */
void added( const KPIMIdentities::Identity &ident );
protected:
/**
* This is called when no identity has been defined, so we need to
* create a default one. The parameters are filled with some default
* values from KUser, but reimplementations of this method can give
* them another value.
*/
virtual void createDefaultIdentity( QString&/*fullName*/,
QString&/*emailAddress*/ ) {}
protected Q_SLOTS:
void slotRollback();
protected:
/** The list that will be seen by everyone */
QList<Identity> mIdentities;
/** The list that will be seen by the config dialog */
QList<Identity> mShadowIdentities;
Q_SIGNALS:
void identitiesChanged( const QString &id );
private Q_SLOTS:
// Connected to the DBus signal
void slotIdentitiesChanged( const QString &id );
private:
void writeConfig() const;
void readConfig( KConfig *config );
QStringList groupList( KConfig *config ) const;
void createDefaultIdentity();
// returns a new Unique Object Identifier
int newUoid();
private:
KConfig *mConfig;
bool mReadOnly;
};
} // namespace
#endif // _KMAIL_IDENTITYMANAGER_H_
|