author | zautrix <zautrix> | 2004-10-29 23:13:22 (UTC) |
---|---|---|
committer | zautrix <zautrix> | 2004-10-29 23:13:22 (UTC) |
commit | da80b510e4643fa3f78cf3f97af108e87097583d (patch) (unidiff) | |
tree | 01c328362a6bf1898853ba26fd5d48eb5cff1e27 /kabc/addressee.h | |
parent | aafa695508796e86e9f267633ea5e6965d876031 (diff) | |
download | kdepimpi-da80b510e4643fa3f78cf3f97af108e87097583d.zip kdepimpi-da80b510e4643fa3f78cf3f97af108e87097583d.tar.gz kdepimpi-da80b510e4643fa3f78cf3f97af108e87097583d.tar.bz2 |
added better category handling to kapi
-rw-r--r-- | kabc/addressee.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/kabc/addressee.h b/kabc/addressee.h index 2c81c1a..08d2f56 100644 --- a/kabc/addressee.h +++ b/kabc/addressee.h | |||
@@ -570,284 +570,284 @@ class Addressee | |||
570 | /** | 570 | /** |
571 | Return translated label for agent field. | 571 | Return translated label for agent field. |
572 | */ | 572 | */ |
573 | static QString agentLabel(); | 573 | static QString agentLabel(); |
574 | 574 | ||
575 | /** | 575 | /** |
576 | Set name fields by parsing the given string and trying to associate the | 576 | Set name fields by parsing the given string and trying to associate the |
577 | parts of the string with according fields. This function should probably | 577 | parts of the string with according fields. This function should probably |
578 | be a bit more clever. | 578 | be a bit more clever. |
579 | */ | 579 | */ |
580 | void setNameFromString( const QString & ); | 580 | void setNameFromString( const QString & ); |
581 | 581 | ||
582 | /** | 582 | /** |
583 | Return the name of the addressee. This is calculated from all the name | 583 | Return the name of the addressee. This is calculated from all the name |
584 | fields. | 584 | fields. |
585 | */ | 585 | */ |
586 | QString realName() const; | 586 | QString realName() const; |
587 | 587 | ||
588 | /** | 588 | /** |
589 | Return the name that consists of all name parts. | 589 | Return the name that consists of all name parts. |
590 | */ | 590 | */ |
591 | QString assembledName() const; | 591 | QString assembledName() const; |
592 | 592 | ||
593 | /** | 593 | /** |
594 | Return email address including real name. | 594 | Return email address including real name. |
595 | 595 | ||
596 | @param email Email address to be used to construct the full email string. | 596 | @param email Email address to be used to construct the full email string. |
597 | If this is QString::null the preferred email address is used. | 597 | If this is QString::null the preferred email address is used. |
598 | */ | 598 | */ |
599 | QString fullEmail( const QString &email=QString::null ) const; | 599 | QString fullEmail( const QString &email=QString::null ) const; |
600 | 600 | ||
601 | /** | 601 | /** |
602 | Insert an email address. If the email address already exists in this | 602 | Insert an email address. If the email address already exists in this |
603 | addressee it is not duplicated. | 603 | addressee it is not duplicated. |
604 | 604 | ||
605 | @param email Email address | 605 | @param email Email address |
606 | @param preferred Set to true, if this is the preferred email address of | 606 | @param preferred Set to true, if this is the preferred email address of |
607 | the addressee. | 607 | the addressee. |
608 | */ | 608 | */ |
609 | void insertEmail( const QString &email, bool preferred=false ); | 609 | void insertEmail( const QString &email, bool preferred=false ); |
610 | 610 | ||
611 | /** | 611 | /** |
612 | Remove email address. If the email address doesn't exist, nothing happens. | 612 | Remove email address. If the email address doesn't exist, nothing happens. |
613 | */ | 613 | */ |
614 | void removeEmail( const QString &email ); | 614 | void removeEmail( const QString &email ); |
615 | 615 | ||
616 | /** | 616 | /** |
617 | Return preferred email address. This is the first email address or the | 617 | Return preferred email address. This is the first email address or the |
618 | last one added with @ref insertEmail() with a set preferred parameter. | 618 | last one added with @ref insertEmail() with a set preferred parameter. |
619 | */ | 619 | */ |
620 | QString preferredEmail() const; | 620 | QString preferredEmail() const; |
621 | 621 | ||
622 | /** | 622 | /** |
623 | Return list of all email addresses. | 623 | Return list of all email addresses. |
624 | */ | 624 | */ |
625 | QStringList emails() const; | 625 | QStringList emails() const; |
626 | 626 | ||
627 | /** | 627 | /** |
628 | Set the emails to @param. | 628 | Set the emails to @param. |
629 | The first email address gets the preferred one! | 629 | The first email address gets the preferred one! |
630 | @param list The list of email addresses. | 630 | @param list The list of email addresses. |
631 | */ | 631 | */ |
632 | void setEmails( const QStringList& list); | 632 | void setEmails( const QStringList& list); |
633 | 633 | ||
634 | /** | 634 | /** |
635 | Insert a phone number. If a phone number with the same id already exists | 635 | Insert a phone number. If a phone number with the same id already exists |
636 | in this addressee it is not duplicated. | 636 | in this addressee it is not duplicated. |
637 | */ | 637 | */ |
638 | void insertPhoneNumber( const PhoneNumber &phoneNumber ); | 638 | void insertPhoneNumber( const PhoneNumber &phoneNumber ); |
639 | 639 | ||
640 | /** | 640 | /** |
641 | Remove phone number. If no phone number with the given id exists for this | 641 | Remove phone number. If no phone number with the given id exists for this |
642 | addresse nothing happens. | 642 | addresse nothing happens. |
643 | */ | 643 | */ |
644 | void removePhoneNumber( const PhoneNumber &phoneNumber ); | 644 | void removePhoneNumber( const PhoneNumber &phoneNumber ); |
645 | 645 | ||
646 | /** | 646 | /** |
647 | Return phone number, which matches the given type. | 647 | Return phone number, which matches the given type. |
648 | */ | 648 | */ |
649 | PhoneNumber phoneNumber( int type ) const; | 649 | PhoneNumber phoneNumber( int type ) const; |
650 | 650 | ||
651 | /** | 651 | /** |
652 | Return list of all phone numbers. | 652 | Return list of all phone numbers. |
653 | */ | 653 | */ |
654 | PhoneNumber::List phoneNumbers() const; | 654 | PhoneNumber::List phoneNumbers() const; |
655 | 655 | ||
656 | /** | 656 | /** |
657 | Return list of phone numbers with a special type. | 657 | Return list of phone numbers with a special type. |
658 | */ | 658 | */ |
659 | PhoneNumber::List phoneNumbers( int type ) const; | 659 | PhoneNumber::List phoneNumbers( int type ) const; |
660 | 660 | ||
661 | /** | 661 | /** |
662 | Return phone number with the given id. | 662 | Return phone number with the given id. |
663 | */ | 663 | */ |
664 | PhoneNumber findPhoneNumber( const QString &id ) const; | 664 | PhoneNumber findPhoneNumber( const QString &id ) const; |
665 | 665 | ||
666 | /** | 666 | /** |
667 | Insert a key. If a key with the same id already exists | 667 | Insert a key. If a key with the same id already exists |
668 | in this addressee it is not duplicated. | 668 | in this addressee it is not duplicated. |
669 | */ | 669 | */ |
670 | void insertKey( const Key &key ); | 670 | void insertKey( const Key &key ); |
671 | 671 | ||
672 | /** | 672 | /** |
673 | Remove a key. If no key with the given id exists for this | 673 | Remove a key. If no key with the given id exists for this |
674 | addresse nothing happens. | 674 | addresse nothing happens. |
675 | */ | 675 | */ |
676 | void removeKey( const Key &key ); | 676 | void removeKey( const Key &key ); |
677 | 677 | ||
678 | /** | 678 | /** |
679 | Return key, which matches the given type. | 679 | Return key, which matches the given type. |
680 | If @p type == Key::Custom you can specify a string | 680 | If @p type == Key::Custom you can specify a string |
681 | that should match. If you leave the string empty, the first | 681 | that should match. If you leave the string empty, the first |
682 | key with a custom value is returned. | 682 | key with a custom value is returned. |
683 | */ | 683 | */ |
684 | Key key( int type, QString customTypeString = QString::null ) const; | 684 | Key key( int type, QString customTypeString = QString::null ) const; |
685 | 685 | ||
686 | /** | 686 | /** |
687 | Return list of all keys. | 687 | Return list of all keys. |
688 | */ | 688 | */ |
689 | Key::List keys() const; | 689 | Key::List keys() const; |
690 | 690 | ||
691 | /** | 691 | /** |
692 | Set the list of keys | 692 | Set the list of keys |
693 | @param keys The keys to be set. | 693 | @param keys The keys to be set. |
694 | */ | 694 | */ |
695 | void setKeys( const Key::List& keys); | 695 | void setKeys( const Key::List& keys); |
696 | 696 | ||
697 | /** | 697 | /** |
698 | Return list of keys with a special type. | 698 | Return list of keys with a special type. |
699 | If @p type == Key::Custom you can specify a string | 699 | If @p type == Key::Custom you can specify a string |
700 | that should match. If you leave the string empty, all custom | 700 | that should match. If you leave the string empty, all custom |
701 | keys will be returned. | 701 | keys will be returned. |
702 | */ | 702 | */ |
703 | Key::List keys( int type, QString customTypeString = QString::null ) const; | 703 | Key::List keys( int type, QString customTypeString = QString::null ) const; |
704 | 704 | ||
705 | /** | 705 | /** |
706 | Return key with the given id. | 706 | Return key with the given id. |
707 | */ | 707 | */ |
708 | Key findKey( const QString &id ) const; | 708 | Key findKey( const QString &id ) const; |
709 | 709 | ||
710 | /** | 710 | /** |
711 | Insert an address. If an address with the same id already exists | 711 | Insert an address. If an address with the same id already exists |
712 | in this addressee it is not duplicated. | 712 | in this addressee it is not duplicated. |
713 | */ | 713 | */ |
714 | void insertAddress( const Address &address ); | 714 | void insertAddress( const Address &address ); |
715 | 715 | ||
716 | /** | 716 | /** |
717 | Remove address. If no address with the given id exists for this | 717 | Remove address. If no address with the given id exists for this |
718 | addresse nothing happens. | 718 | addresse nothing happens. |
719 | */ | 719 | */ |
720 | void removeAddress( const Address &address ); | 720 | void removeAddress( const Address &address ); |
721 | 721 | ||
722 | /** | 722 | /** |
723 | Return address, which matches the given type. | 723 | Return address, which matches the given type. |
724 | */ | 724 | */ |
725 | Address address( int type ) const; | 725 | Address address( int type ) const; |
726 | 726 | ||
727 | /** | 727 | /** |
728 | Return list of all addresses. | 728 | Return list of all addresses. |
729 | */ | 729 | */ |
730 | Address::List addresses() const; | 730 | Address::List addresses() const; |
731 | 731 | ||
732 | /** | 732 | /** |
733 | Return list of addresses with a special type. | 733 | Return list of addresses with a special type. |
734 | */ | 734 | */ |
735 | Address::List addresses( int type ) const; | 735 | Address::List addresses( int type ) const; |
736 | 736 | ||
737 | /** | 737 | /** |
738 | Return address with the given id. | 738 | Return address with the given id. |
739 | */ | 739 | */ |
740 | Address findAddress( const QString &id ) const; | 740 | Address findAddress( const QString &id ) const; |
741 | 741 | ||
742 | /** | 742 | /** |
743 | Insert category. If the category already exists it is not duplicated. | 743 | Insert category. If the category already exists it is not duplicated. |
744 | */ | 744 | */ |
745 | void insertCategory( const QString & ); | 745 | void insertCategory( const QString & ); |
746 | 746 | ||
747 | /** | 747 | /** |
748 | Remove category. | 748 | Remove category. |
749 | */ | 749 | */ |
750 | void removeCategory( const QString & ); | 750 | void removeCategory( const QString & ); |
751 | 751 | ||
752 | /** | 752 | /** |
753 | Return, if addressee has the given category. | 753 | Return, if addressee has the given category. |
754 | */ | 754 | */ |
755 | bool hasCategory( const QString & ) const; | 755 | bool hasCategory( const QString & ) const; |
756 | 756 | ||
757 | /** | 757 | /** |
758 | Set categories to given value. | 758 | Set categories to given value. |
759 | */ | 759 | */ |
760 | void setCategories( const QStringList & ); | 760 | void setCategories( const QStringList & ); |
761 | 761 | ||
762 | /** | 762 | /** |
763 | Return list of all set categories. | 763 | Return list of all set categories. |
764 | */ | 764 | */ |
765 | QStringList categories() const; | 765 | QStringList categories() const; |
766 | 766 | ||
767 | /** | 767 | /** |
768 | Insert custom entry. The entry is identified by the name of the inserting | 768 | Insert custom entry. The entry is identified by the name of the inserting |
769 | application and a unique name. If an entry with the given app and name | 769 | application and a unique name. If an entry with the given app and name |
770 | already exists its value is replaced with the new given value. | 770 | already exists its value is replaced with the new given value. |
771 | */ | 771 | */ |
772 | void insertCustom( const QString &app, const QString &name, | 772 | void insertCustom( const QString &app, const QString &name, |
773 | const QString &value ); | 773 | const QString &value ); |
774 | 774 | ||
775 | /** | 775 | /** |
776 | Remove custom entry. | 776 | Remove custom entry. |
777 | */ | 777 | */ |
778 | void removeCustom( const QString &app, const QString &name ); | 778 | void removeCustom( const QString &app, const QString &name ); |
779 | 779 | ||
780 | /** | 780 | /** |
781 | Return value of custom entry, identified by app and entry name. | 781 | Return value of custom entry, identified by app and entry name. |
782 | */ | 782 | */ |
783 | QString custom( const QString &app, const QString &name ) const; | 783 | QString custom( const QString &app, const QString &name ) const; |
784 | 784 | ||
785 | /** | 785 | /** |
786 | Set all custom entries. | 786 | Set all custom entries. |
787 | */ | 787 | */ |
788 | void setCustoms( const QStringList & ); | 788 | void setCustoms( const QStringList & ); |
789 | 789 | ||
790 | /** | 790 | /** |
791 | Return list of all custom entries. | 791 | Return list of all custom entries. |
792 | */ | 792 | */ |
793 | QStringList customs() const; | 793 | QStringList customs() const; |
794 | 794 | ||
795 | /** | 795 | /** |
796 | Parse full email address. The result is given back in fullName and email. | 796 | Parse full email address. The result is given back in fullName and email. |
797 | */ | 797 | */ |
798 | static void parseEmailAddress( const QString &rawEmail, QString &fullName, | 798 | static void parseEmailAddress( const QString &rawEmail, QString &fullName, |
799 | QString &email ); | 799 | QString &email ); |
800 | 800 | ||
801 | /** | 801 | /** |
802 | Debug output. | 802 | Debug output. |
803 | */ | 803 | */ |
804 | void dump() const; | 804 | void dump() const; |
805 | 805 | ||
806 | /** | 806 | /** |
807 | Returns string representation of the addressee. | 807 | Returns string representation of the addressee. |
808 | */ | 808 | */ |
809 | QString asString() const; | 809 | QString asString() const; |
810 | 810 | ||
811 | /** | 811 | /** |
812 | Set resource where the addressee is from. | 812 | Set resource where the addressee is from. |
813 | */ | 813 | */ |
814 | void setResource( Resource *resource ); | 814 | void setResource( Resource *resource ); |
815 | 815 | ||
816 | /** | 816 | /** |
817 | Return pointer to resource. | 817 | Return pointer to resource. |
818 | */ | 818 | */ |
819 | Resource *resource() const; | 819 | Resource *resource() const; |
820 | 820 | ||
821 | /** | 821 | /** |
822 | Return resourcelabel. | 822 | Return resourcelabel. |
823 | */ | 823 | */ |
824 | //US | 824 | //US |
825 | static QString resourceLabel(); | 825 | static QString resourceLabel(); |
826 | 826 | static QString categoryLabel(); | |
827 | /** | 827 | /** |
828 | Mark addressee as changed. | 828 | Mark addressee as changed. |
829 | */ | 829 | */ |
830 | void setChanged( bool value ); | 830 | void setChanged( bool value ); |
831 | 831 | ||
832 | /** | 832 | /** |
833 | Return whether the addressee is changed. | 833 | Return whether the addressee is changed. |
834 | */ | 834 | */ |
835 | bool changed() const; | 835 | bool changed() const; |
836 | 836 | ||
837 | void setTagged( bool value ); | 837 | void setTagged( bool value ); |
838 | bool tagged() const; | 838 | bool tagged() const; |
839 | 839 | ||
840 | private: | 840 | private: |
841 | Addressee copy(); | 841 | Addressee copy(); |
842 | void detach(); | 842 | void detach(); |
843 | 843 | ||
844 | struct AddresseeData; | 844 | struct AddresseeData; |
845 | mutable KSharedPtr<AddresseeData> mData; | 845 | mutable KSharedPtr<AddresseeData> mData; |
846 | }; | 846 | }; |
847 | 847 | ||
848 | QDataStream &operator<<( QDataStream &, const Addressee & ); | 848 | QDataStream &operator<<( QDataStream &, const Addressee & ); |
849 | QDataStream &operator>>( QDataStream &, Addressee & ); | 849 | QDataStream &operator>>( QDataStream &, Addressee & ); |
850 | 850 | ||
851 | } | 851 | } |
852 | 852 | ||
853 | #endif | 853 | #endif |