author | zautrix <zautrix> | 2005-08-22 15:42:41 (UTC) |
---|---|---|
committer | zautrix <zautrix> | 2005-08-22 15:42:41 (UTC) |
commit | 1d82d044bbdedd407f6d08305522187ffd256552 (patch) (unidiff) | |
tree | 08f5651d72548b643ed012e5f6ad938b36d1ae3f /kabc/addressee.h | |
parent | f516a558e6d18982a54152b28ca3da78fe76e3fc (diff) | |
download | kdepimpi-1d82d044bbdedd407f6d08305522187ffd256552.zip kdepimpi-1d82d044bbdedd407f6d08305522187ffd256552.tar.gz kdepimpi-1d82d044bbdedd407f6d08305522187ffd256552.tar.bz2 |
kapi search fix
-rw-r--r-- | kabc/addressee.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/kabc/addressee.h b/kabc/addressee.h index a2fbcf5..d1c07cb 100644 --- a/kabc/addressee.h +++ b/kabc/addressee.h | |||
@@ -1,129 +1,130 @@ | |||
1 | /*** Warning! This file has been generated by the script makeaddressee ***/ | 1 | /*** Warning! This file has been generated by the script makeaddressee ***/ |
2 | /* | 2 | /* |
3 | This file is part of libkabc. | 3 | This file is part of libkabc. |
4 | Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> | 4 | Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> |
5 | 5 | ||
6 | This library is free software; you can redistribute it and/or | 6 | This library is free software; you can redistribute it and/or |
7 | modify it under the terms of the GNU Library General Public | 7 | modify it under the terms of the GNU Library General Public |
8 | License as published by the Free Software Foundation; either | 8 | License as published by the Free Software Foundation; either |
9 | version 2 of the License, or (at your option) any later version. | 9 | version 2 of the License, or (at your option) any later version. |
10 | 10 | ||
11 | This library is distributed in the hope that it will be useful, | 11 | This library is distributed in the hope that it will be useful, |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
14 | Library General Public License for more details. | 14 | Library General Public License for more details. |
15 | 15 | ||
16 | You should have received a copy of the GNU Library General Public License | 16 | You should have received a copy of the GNU Library General Public License |
17 | along with this library; see the file COPYING.LIB. If not, write to | 17 | along with this library; see the file COPYING.LIB. If not, write to |
18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | 18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. | 19 | Boston, MA 02111-1307, USA. |
20 | */ | 20 | */ |
21 | 21 | ||
22 | /* | 22 | /* |
23 | Enhanced Version of the file for platform independent KDE tools. | 23 | Enhanced Version of the file for platform independent KDE tools. |
24 | Copyright (c) 2004 Ulf Schenk | 24 | Copyright (c) 2004 Ulf Schenk |
25 | 25 | ||
26 | $Id$ | 26 | $Id$ |
27 | */ | 27 | */ |
28 | 28 | ||
29 | #ifndef KABC_ADDRESSEE_H | 29 | #ifndef KABC_ADDRESSEE_H |
30 | #define KABC_ADDRESSEE_H | 30 | #define KABC_ADDRESSEE_H |
31 | 31 | ||
32 | #include <qdatetime.h> | 32 | #include <qdatetime.h> |
33 | #include <qstring.h> | 33 | #include <qstring.h> |
34 | #include <qregexp.h> | ||
34 | #include <qstringlist.h> | 35 | #include <qstringlist.h> |
35 | #include <qvaluelist.h> | 36 | #include <qvaluelist.h> |
36 | 37 | ||
37 | #include <ksharedptr.h> | 38 | #include <ksharedptr.h> |
38 | #include <kurl.h> | 39 | #include <kurl.h> |
39 | 40 | ||
40 | #include "address.h" | 41 | #include "address.h" |
41 | #include "agent.h" | 42 | #include "agent.h" |
42 | #include "geo.h" | 43 | #include "geo.h" |
43 | #include "key.h" | 44 | #include "key.h" |
44 | #include "phonenumber.h" | 45 | #include "phonenumber.h" |
45 | #include "picture.h" | 46 | #include "picture.h" |
46 | #include "secrecy.h" | 47 | #include "secrecy.h" |
47 | #include "sound.h" | 48 | #include "sound.h" |
48 | #include "timezone.h" | 49 | #include "timezone.h" |
49 | 50 | ||
50 | namespace KABC { | 51 | namespace KABC { |
51 | 52 | ||
52 | class Resource; | 53 | class Resource; |
53 | 54 | ||
54 | /** | 55 | /** |
55 | @short address book entry | 56 | @short address book entry |
56 | 57 | ||
57 | This class represents an entry in the address book. | 58 | This class represents an entry in the address book. |
58 | 59 | ||
59 | The data of this class is implicitly shared. You can pass this class by value. | 60 | The data of this class is implicitly shared. You can pass this class by value. |
60 | 61 | ||
61 | If you need the name of a field for presenting it to the user you should use | 62 | If you need the name of a field for presenting it to the user you should use |
62 | the functions ending in Label(). They return a translated string which can be | 63 | the functions ending in Label(). They return a translated string which can be |
63 | used as label for the corresponding field. | 64 | used as label for the corresponding field. |
64 | 65 | ||
65 | About the name fields: | 66 | About the name fields: |
66 | 67 | ||
67 | givenName() is the first name and familyName() the last name. In some | 68 | givenName() is the first name and familyName() the last name. In some |
68 | countries the family name comes first, that's the reason for the | 69 | countries the family name comes first, that's the reason for the |
69 | naming. formattedName() is the full name with the correct formatting. | 70 | naming. formattedName() is the full name with the correct formatting. |
70 | It is used as an override, when the correct formatting can't be generated | 71 | It is used as an override, when the correct formatting can't be generated |
71 | from the other name fields automatically. | 72 | from the other name fields automatically. |
72 | 73 | ||
73 | realName() returns a fully formatted name(). It uses formattedName, if set, | 74 | realName() returns a fully formatted name(). It uses formattedName, if set, |
74 | otherwise it constucts the name from the name fields. As fallback, if | 75 | otherwise it constucts the name from the name fields. As fallback, if |
75 | nothing else is set it uses name(). | 76 | nothing else is set it uses name(). |
76 | 77 | ||
77 | name() is the NAME type of RFC2426. It can be used as internal name for the | 78 | name() is the NAME type of RFC2426. It can be used as internal name for the |
78 | data enty, but shouldn't be used for displaying the data to the user. | 79 | data enty, but shouldn't be used for displaying the data to the user. |
79 | */ | 80 | */ |
80 | class Addressee | 81 | class Addressee |
81 | { | 82 | { |
82 | friend QDataStream &operator<<( QDataStream &, const Addressee & ); | 83 | friend QDataStream &operator<<( QDataStream &, const Addressee & ); |
83 | friend QDataStream &operator>>( QDataStream &, Addressee & ); | 84 | friend QDataStream &operator>>( QDataStream &, Addressee & ); |
84 | 85 | ||
85 | public: | 86 | public: |
86 | typedef QValueList<Addressee> List; | 87 | typedef QValueList<Addressee> List; |
87 | 88 | ||
88 | /** | 89 | /** |
89 | Construct an empty address book entry. | 90 | Construct an empty address book entry. |
90 | */ | 91 | */ |
91 | Addressee(); | 92 | Addressee(); |
92 | ~Addressee(); | 93 | ~Addressee(); |
93 | 94 | ||
94 | Addressee( const Addressee & ); | 95 | Addressee( const Addressee & ); |
95 | Addressee &operator=( const Addressee & ); | 96 | Addressee &operator=( const Addressee & ); |
96 | 97 | ||
97 | bool operator==( const Addressee & ) const; | 98 | bool operator==( const Addressee & ) const; |
98 | bool operator!=( const Addressee & ) const; | 99 | bool operator!=( const Addressee & ) const; |
99 | // sync stuff | 100 | // sync stuff |
100 | void setTempSyncStat(int id); | 101 | void setTempSyncStat(int id); |
101 | int tempSyncStat() const; | 102 | int tempSyncStat() const; |
102 | void setIDStr( const QString & ); | 103 | void setIDStr( const QString & ); |
103 | const QString IDStr() const; | 104 | const QString IDStr() const; |
104 | void setID( const QString &, const QString & ); | 105 | void setID( const QString &, const QString & ); |
105 | const QString getID( const QString & ) const; | 106 | const QString getID( const QString & ) const; |
106 | void setCsum( const QString &, const QString & ); | 107 | void setCsum( const QString &, const QString & ); |
107 | const QString getCsum( const QString & ) const ; | 108 | const QString getCsum( const QString & ) const ; |
108 | void removeID(const QString &); | 109 | void removeID(const QString &); |
109 | void computeCsum(const QString &dev); | 110 | void computeCsum(const QString &dev); |
110 | ulong getCsum4List( const QStringList & attList); | 111 | ulong getCsum4List( const QStringList & attList); |
111 | /** | 112 | /** |
112 | Return, if the address book entry is empty. | 113 | Return, if the address book entry is empty. |
113 | */ | 114 | */ |
114 | bool isEmpty() const; | 115 | bool isEmpty() const; |
115 | void setExternalUID( const QString &id ); | 116 | void setExternalUID( const QString &id ); |
116 | const QString externalUID() const; | 117 | const QString externalUID() const; |
117 | void setOriginalExternalUID( const QString &id ); | 118 | void setOriginalExternalUID( const QString &id ); |
118 | QString originalExternalUID() const; | 119 | QString originalExternalUID() const; |
119 | void mergeContact( const Addressee& ad, bool isSubSet ); | 120 | void mergeContact( const Addressee& ad, bool isSubSet ); |
120 | void simplifyEmails(); | 121 | void simplifyEmails(); |
121 | void simplifyAddresses(); | 122 | void simplifyAddresses(); |
122 | void simplifyPhoneNumbers(); | 123 | void simplifyPhoneNumbers(); |
123 | void simplifyPhoneNumberTypes(); | 124 | void simplifyPhoneNumberTypes(); |
124 | bool removeVoice(); | 125 | bool removeVoice(); |
125 | bool containsAdr(const Addressee& addr ); | 126 | bool containsAdr(const Addressee& addr ); |
126 | 127 | ||
127 | /** | 128 | /** |
128 | Set unique identifier. | 129 | Set unique identifier. |
129 | */ | 130 | */ |
@@ -557,192 +558,195 @@ class Addressee | |||
557 | */ | 558 | */ |
558 | Sound sound() const; | 559 | Sound sound() const; |
559 | /** | 560 | /** |
560 | Return translated label for sound field. | 561 | Return translated label for sound field. |
561 | */ | 562 | */ |
562 | static QString soundLabel(); | 563 | static QString soundLabel(); |
563 | 564 | ||
564 | /** | 565 | /** |
565 | Set agent. | 566 | Set agent. |
566 | */ | 567 | */ |
567 | void setAgent( const Agent &agent ); | 568 | void setAgent( const Agent &agent ); |
568 | /** | 569 | /** |
569 | Return agent. | 570 | Return agent. |
570 | */ | 571 | */ |
571 | Agent agent() const; | 572 | Agent agent() const; |
572 | /** | 573 | /** |
573 | Return translated label for agent field. | 574 | Return translated label for agent field. |
574 | */ | 575 | */ |
575 | static QString agentLabel(); | 576 | static QString agentLabel(); |
576 | 577 | ||
577 | /** | 578 | /** |
578 | Set name fields by parsing the given string and trying to associate the | 579 | Set name fields by parsing the given string and trying to associate the |
579 | parts of the string with according fields. This function should probably | 580 | parts of the string with according fields. This function should probably |
580 | be a bit more clever. | 581 | be a bit more clever. |
581 | */ | 582 | */ |
582 | void setNameFromString( const QString & ); | 583 | void setNameFromString( const QString & ); |
583 | 584 | ||
584 | /** | 585 | /** |
585 | Return the name of the addressee. This is calculated from all the name | 586 | Return the name of the addressee. This is calculated from all the name |
586 | fields. | 587 | fields. |
587 | */ | 588 | */ |
588 | QString realName() const; | 589 | QString realName() const; |
589 | 590 | ||
590 | /** | 591 | /** |
591 | Return the name that consists of all name parts. | 592 | Return the name that consists of all name parts. |
592 | */ | 593 | */ |
593 | QString assembledName() const; | 594 | QString assembledName() const; |
594 | 595 | ||
595 | /** | 596 | /** |
596 | Return email address including real name. | 597 | Return email address including real name. |
597 | 598 | ||
598 | @param email Email address to be used to construct the full email string. | 599 | @param email Email address to be used to construct the full email string. |
599 | If this is QString::null the preferred email address is used. | 600 | If this is QString::null the preferred email address is used. |
600 | */ | 601 | */ |
601 | QString fullEmail( const QString &email=QString::null ) const; | 602 | QString fullEmail( const QString &email=QString::null ) const; |
602 | 603 | ||
603 | /** | 604 | /** |
604 | Insert an email address. If the email address already exists in this | 605 | Insert an email address. If the email address already exists in this |
605 | addressee it is not duplicated. | 606 | addressee it is not duplicated. |
606 | 607 | ||
607 | @param email Email address | 608 | @param email Email address |
608 | @param preferred Set to true, if this is the preferred email address of | 609 | @param preferred Set to true, if this is the preferred email address of |
609 | the addressee. | 610 | the addressee. |
610 | */ | 611 | */ |
611 | void insertEmail( const QString &email, bool preferred=false ); | 612 | void insertEmail( const QString &email, bool preferred=false ); |
612 | 613 | ||
613 | /** | 614 | /** |
614 | Remove email address. If the email address doesn't exist, nothing happens. | 615 | Remove email address. If the email address doesn't exist, nothing happens. |
615 | */ | 616 | */ |
616 | void removeEmail( const QString &email ); | 617 | void removeEmail( const QString &email ); |
617 | 618 | ||
618 | /** | 619 | /** |
619 | Return preferred email address. This is the first email address or the | 620 | Return preferred email address. This is the first email address or the |
620 | last one added with @ref insertEmail() with a set preferred parameter. | 621 | last one added with @ref insertEmail() with a set preferred parameter. |
621 | */ | 622 | */ |
622 | QString preferredEmail() const; | 623 | QString preferredEmail() const; |
623 | 624 | ||
624 | /** | 625 | /** |
625 | Return list of all email addresses. | 626 | Return list of all email addresses. |
626 | */ | 627 | */ |
627 | QStringList emails() const; | 628 | QStringList emails() const; |
628 | 629 | ||
629 | /** | 630 | /** |
630 | Set the emails to @param. | 631 | Set the emails to @param. |
631 | The first email address gets the preferred one! | 632 | The first email address gets the preferred one! |
632 | @param list The list of email addresses. | 633 | @param list The list of email addresses. |
633 | */ | 634 | */ |
634 | void setEmails( const QStringList& list); | 635 | void setEmails( const QStringList& list); |
635 | 636 | ||
636 | /** | 637 | /** |
637 | Insert a phone number. If a phone number with the same id already exists | 638 | Insert a phone number. If a phone number with the same id already exists |
638 | in this addressee it is not duplicated. | 639 | in this addressee it is not duplicated. |
639 | */ | 640 | */ |
640 | void insertPhoneNumber( const PhoneNumber &phoneNumber ); | 641 | void insertPhoneNumber( const PhoneNumber &phoneNumber ); |
641 | 642 | ||
642 | /** | 643 | /** |
643 | Remove phone number. If no phone number with the given id exists for this | 644 | Remove phone number. If no phone number with the given id exists for this |
644 | addresse nothing happens. | 645 | addresse nothing happens. |
645 | */ | 646 | */ |
646 | void removePhoneNumber( const PhoneNumber &phoneNumber ); | 647 | void removePhoneNumber( const PhoneNumber &phoneNumber ); |
647 | 648 | ||
648 | /** | 649 | /** |
649 | Return phone number, which matches the given type. | 650 | Return phone number, which matches the given type. |
650 | */ | 651 | */ |
651 | PhoneNumber phoneNumber( int type ) const; | 652 | PhoneNumber phoneNumber( int type ) const; |
652 | 653 | ||
654 | bool matchPhoneNumber( QRegExp* searchExp ) const; | ||
655 | bool matchAddress( QRegExp* searchExp ) const; | ||
656 | |||
653 | /** | 657 | /** |
654 | Return list of all phone numbers. | 658 | Return list of all phone numbers. |
655 | */ | 659 | */ |
656 | PhoneNumber::List phoneNumbers() const; | 660 | PhoneNumber::List phoneNumbers() const; |
657 | 661 | ||
658 | /** | 662 | /** |
659 | Return list of phone numbers with a special type. | 663 | Return list of phone numbers with a special type. |
660 | */ | 664 | */ |
661 | PhoneNumber::List phoneNumbers( int type ) const; | 665 | PhoneNumber::List phoneNumbers( int type ) const; |
662 | 666 | ||
663 | /** | 667 | /** |
664 | Return phone number with the given id. | 668 | Return phone number with the given id. |
665 | */ | 669 | */ |
666 | PhoneNumber findPhoneNumber( const QString &id ) const; | 670 | PhoneNumber findPhoneNumber( const QString &id ) const; |
667 | 671 | ||
668 | /** | 672 | /** |
669 | Insert a key. If a key with the same id already exists | 673 | Insert a key. If a key with the same id already exists |
670 | in this addressee it is not duplicated. | 674 | in this addressee it is not duplicated. |
671 | */ | 675 | */ |
672 | void insertKey( const Key &key ); | 676 | void insertKey( const Key &key ); |
673 | 677 | ||
674 | /** | 678 | /** |
675 | Remove a key. If no key with the given id exists for this | 679 | Remove a key. If no key with the given id exists for this |
676 | addresse nothing happens. | 680 | addresse nothing happens. |
677 | */ | 681 | */ |
678 | void removeKey( const Key &key ); | 682 | void removeKey( const Key &key ); |
679 | 683 | ||
680 | /** | 684 | /** |
681 | Return key, which matches the given type. | 685 | Return key, which matches the given type. |
682 | If @p type == Key::Custom you can specify a string | 686 | If @p type == Key::Custom you can specify a string |
683 | that should match. If you leave the string empty, the first | 687 | that should match. If you leave the string empty, the first |
684 | key with a custom value is returned. | 688 | key with a custom value is returned. |
685 | */ | 689 | */ |
686 | Key key( int type, QString customTypeString = QString::null ) const; | 690 | Key key( int type, QString customTypeString = QString::null ) const; |
687 | 691 | ||
688 | /** | 692 | /** |
689 | Return list of all keys. | 693 | Return list of all keys. |
690 | */ | 694 | */ |
691 | Key::List keys() const; | 695 | Key::List keys() const; |
692 | 696 | ||
693 | /** | 697 | /** |
694 | Set the list of keys | 698 | Set the list of keys |
695 | @param keys The keys to be set. | 699 | @param keys The keys to be set. |
696 | */ | 700 | */ |
697 | void setKeys( const Key::List& keys); | 701 | void setKeys( const Key::List& keys); |
698 | 702 | ||
699 | /** | 703 | /** |
700 | Return list of keys with a special type. | 704 | Return list of keys with a special type. |
701 | If @p type == Key::Custom you can specify a string | 705 | If @p type == Key::Custom you can specify a string |
702 | that should match. If you leave the string empty, all custom | 706 | that should match. If you leave the string empty, all custom |
703 | keys will be returned. | 707 | keys will be returned. |
704 | */ | 708 | */ |
705 | Key::List keys( int type, QString customTypeString = QString::null ) const; | 709 | Key::List keys( int type, QString customTypeString = QString::null ) const; |
706 | 710 | ||
707 | /** | 711 | /** |
708 | Return key with the given id. | 712 | Return key with the given id. |
709 | */ | 713 | */ |
710 | Key findKey( const QString &id ) const; | 714 | Key findKey( const QString &id ) const; |
711 | 715 | ||
712 | /** | 716 | /** |
713 | Insert an address. If an address with the same id already exists | 717 | Insert an address. If an address with the same id already exists |
714 | in this addressee it is not duplicated. | 718 | in this addressee it is not duplicated. |
715 | */ | 719 | */ |
716 | void insertAddress( const Address &address ); | 720 | void insertAddress( const Address &address ); |
717 | 721 | ||
718 | /** | 722 | /** |
719 | Remove address. If no address with the given id exists for this | 723 | Remove address. If no address with the given id exists for this |
720 | addresse nothing happens. | 724 | addresse nothing happens. |
721 | */ | 725 | */ |
722 | void removeAddress( const Address &address ); | 726 | void removeAddress( const Address &address ); |
723 | 727 | ||
724 | /** | 728 | /** |
725 | Return address, which matches the given type. | 729 | Return address, which matches the given type. |
726 | */ | 730 | */ |
727 | Address address( int type ) const; | 731 | Address address( int type ) const; |
728 | 732 | ||
729 | /** | 733 | /** |
730 | Return list of all addresses. | 734 | Return list of all addresses. |
731 | */ | 735 | */ |
732 | Address::List addresses() const; | 736 | Address::List addresses() const; |
733 | 737 | ||
734 | /** | 738 | /** |
735 | Return list of addresses with a special type. | 739 | Return list of addresses with a special type. |
736 | */ | 740 | */ |
737 | Address::List addresses( int type ) const; | 741 | Address::List addresses( int type ) const; |
738 | 742 | ||
739 | /** | 743 | /** |
740 | Return address with the given id. | 744 | Return address with the given id. |
741 | */ | 745 | */ |
742 | Address findAddress( const QString &id ) const; | 746 | Address findAddress( const QString &id ) const; |
743 | 747 | ||
744 | /** | 748 | /** |
745 | Insert category. If the category already exists it is not duplicated. | 749 | Insert category. If the category already exists it is not duplicated. |
746 | */ | 750 | */ |
747 | void insertCategory( const QString & ); | 751 | void insertCategory( const QString & ); |
748 | 752 | ||