/usr/include/kabc/contactgroup.h is in kdepimlibs5-dev 4:4.14.10-7+b2.
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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 | /*
This file is part of libkabc.
Copyright (c) 2008 Tobias Koenig <tokoe@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 KABC_CONTACTGROUP_H
#define KABC_CONTACTGROUP_H
#include <QtCore/QList>
#include <QtCore/QSharedDataPointer>
#include <QtCore/QMetaType>
#include "kabc_export.h"
class QString;
namespace KABC {
/**
* @short This class represents a group of contacts.
*
* It can contain two types of contacts, either a reference
* or data.
* The reference entry is just an unique identifier which
* identifies the real contact in the system.
* The data entry contains a name and an email address.
*
* @author Tobias Koenig <tokoe@kde.org>
* @since 4.3
*/
class KABC_EXPORT ContactGroup
{
public:
/**
* This class represents a contact reference
*/
class KABC_EXPORT ContactReference
{
public:
/**
* A list of contact references.
*/
typedef QList<ContactReference> List;
/**
* Creates an empty contact reference.
*/
ContactReference();
/**
* Creates a contact reference from an @p other reference.
*/
ContactReference( const ContactReference &other );
/**
* Creates a contact reference for the given contact @p uid.
*/
ContactReference( const QString &uid );
/**
* Destroys the contact reference.
*/
~ContactReference();
/**
* Sets the contact uid of the contact reference.
* @param uid identifier of the contact to reference
* @note That is the Akonadi Item ID of the contact that
* is referenced here.
*/
void setUid( const QString &uid );
/**
* Returns the contact uid of the contact reference.
*
* @note That is the Akonadi Item ID of the contact that
* is referenced here.
*/
QString uid() const;
/**
* Sets the contact gid of the contact reference.
* @param gid globally unique identifier of the contact to reference
* @since 4.12
*/
void setGid( const QString &gid );
/**
* Returns the contact GID of the contact reference.
* @since 4.12
*/
QString gid() const;
/**
* Sets the preferred email address.
*/
void setPreferredEmail( const QString &email );
/**
* Returns the preferred email address, or an empty string
* if no preferred email address is set.
*/
QString preferredEmail() const;
/**
* Inserts a custom entry.
* If an entry with the same @p key already exists, it is
* overwritten.
*
* @param key The unique key.
* @param value The value.
*/
void insertCustom( const QString &key, const QString &value );
/**
* Removes the custom entry with the given @p key.
*/
void removeCustom( const QString &key );
/**
* Returns the value for the given @p key, or an empty string
* if the entry for that key does not exists.
*/
QString custom( const QString &key ) const;
/**
* @internal
*/
ContactReference &operator=( const ContactReference & );
/**
* @internal
*/
bool operator==( const ContactReference & ) const;
private:
class ContactReferencePrivate;
QSharedDataPointer<ContactReferencePrivate> d;
};
/**
* This class represents a contact group reference
*/
class KABC_EXPORT ContactGroupReference
{
public:
/**
* A list of contact group references.
*/
typedef QList<ContactGroupReference> List;
/**
* Creates an empty contact group reference.
*/
ContactGroupReference();
/**
* Creates a contact group reference from an @p other reference.
*/
ContactGroupReference( const ContactGroupReference &other );
/**
* Creates a contact group reference for the given contact group @p uid.
*/
ContactGroupReference( const QString &uid );
/**
* Destroys the contact group reference.
*/
~ContactGroupReference();
/**
* Sets the contact group uid of the contact group reference.
*/
void setUid( const QString &uid );
/**
* Returns the contact group uid of the contact group reference.
*/
QString uid() const;
/**
* Inserts a custom entry.
* If an entry with the same @p key already exists, it is
* overwritten.
*
* @param key The unique key.
* @param value The value.
*/
void insertCustom( const QString &key, const QString &value );
/**
* Removes the custom entry with the given @p key.
*/
void removeCustom( const QString &key );
/**
* Returns the value for the given @p key, or an empty string
* if the entry for that key does not exists.
*/
QString custom( const QString &key ) const;
/**
* @internal
*/
ContactGroupReference &operator=( const ContactGroupReference & );
/**
* @internal
*/
bool operator==( const ContactGroupReference & ) const;
private:
class ContactGroupReferencePrivate;
QSharedDataPointer<ContactGroupReferencePrivate> d;
};
/**
* This class represents a contact data object
*/
class KABC_EXPORT Data
{
public:
/**
* A list of contact data.
*/
typedef QList<Data> List;
/**
* Creates an empty contact data object.
*/
Data();
/**
* Creates a contact data object from an @p other data object.
*/
Data( const Data &other );
/**
* Creates a contact data object with the given @p name and @p email address.
*/
Data( const QString &name, const QString &email );
/**
* Destroys the contact data object.
*/
~Data();
/**
* Sets the @p name of the contact data object.
*/
void setName( const QString &name );
/**
* Returns the name of the contact data object.
*/
QString name() const;
/**
* Sets the @p email address of the contact data object.
*/
void setEmail( const QString &email );
/**
* Returns the email address of the contact data object.
*/
QString email() const;
/**
* Inserts a custom entry.
* If an entry with the same @p key already exists, it is
* overwritten.
*
* @param key The unique key.
* @param value The value.
*/
void insertCustom( const QString &key, const QString &value );
/**
* Removes the custom entry with the given @p key.
*/
void removeCustom( const QString &key );
/**
* Returns the value for the given @p key, or an empty string
* if the entry for that key does not exists.
*/
QString custom( const QString &key ) const;
/**
* @internal
*/
Data &operator=( const Data & );
/**
* @internal
*/
bool operator==( const Data & ) const;
private:
class DataPrivate;
QSharedDataPointer<DataPrivate> d;
};
/**
* A list of contact groups.
*/
typedef QList<ContactGroup> List;
/**
* Creates an empty contact group.
*/
ContactGroup();
/**
* Creates a contact group from an @p other group.
*/
ContactGroup( const ContactGroup &other );
/**
* Creates a contact group with the given name.
*/
ContactGroup( const QString &name );
/**
* Destroys the contact group.
*/
~ContactGroup();
/**
* Sets the unique @p id of the contact group.
*/
void setId( const QString &id );
/**
* Returns the unique id of the contact group.
*/
QString id() const;
/**
* Sets the i18n'd @p name of the contact group.
*/
void setName( const QString &name );
/**
* Returns the i18n'd name of the contact group.
*/
QString name() const;
/**
* Returns the number of contacts in this group.
* That includes the contact references and contact data.
*/
unsigned int count() const;
/**
* Returns the number of contact references in this group.
*/
unsigned int contactReferenceCount() const;
/**
* Returns the number of group references in this group.
*/
unsigned int contactGroupReferenceCount() const;
/**
* Returns the number of contact data objects in this group.
*/
unsigned int dataCount() const;
/**
* Returns the contact reference at the given @p index.
*/
ContactReference &contactReference( unsigned int index );
/**
* Returns the contact reference at the given @p index.
*/
const ContactReference &contactReference( unsigned int index ) const;
/**
* Returns the contact group reference at the given @p index.
*/
ContactGroupReference &contactGroupReference( unsigned int index );
/**
* Returns the contact group reference at the given @p index.
*/
const ContactGroupReference &contactGroupReference( unsigned int index ) const;
/**
* Returns the contact data object at the given @p index.
*/
Data &data( unsigned int index );
/**
* Returns the contact data object at the given @p index.
*/
const Data &data( unsigned int index ) const;
/**
* Appends a new contact @p reference to the contact group.
*/
void append( const ContactReference &reference );
/**
* Appends a new contact group @p reference to the contact group.
*/
void append( const ContactGroupReference &reference );
/**
* Appends a new contact @p data object to the contact group.
*/
void append( const Data &data );
/**
* Removes the given contact @p reference from the contact group.
*/
void remove( const ContactReference &reference );
/**
* Removes the given contact group @p reference from the contact group.
*/
void remove( const ContactGroupReference &reference );
/**
* Removes the given contact @p data object from the contact group.
*/
void remove( const Data &data );
/**
* Removes all contact references from the contact group.
*/
void removeAllContactReferences();
/**
* Removes all contact group references from the contact group.
*/
void removeAllContactGroupReferences();
/**
* Removes all contact data from the contact group.
*/
void removeAllContactData();
/**
* @internal
*/
ContactGroup &operator=( const ContactGroup & );
/**
* @internal
*/
bool operator==( const ContactGroup & ) const;
/**
* Returns the MIME type used for Contact Groups
*/
static QString mimeType();
private:
class Private;
QSharedDataPointer<Private> d;
};
}
#define KABC_CONTACTGROUP_METATYPE_DEFINED
Q_DECLARE_METATYPE( KABC::ContactGroup )
#endif
|