Source: addresseedialog.h

# Source: addresseedialog.h |
Annotated List
Files
Globals
Hierarchy
Index

    /*
        This file is part of libkabc.
        Copyright (c) 2001 Cornelius Schumacher

        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., 59 Temple Place - Suite 330,
        Boston, MA 02111-1307, USA.
    */

    #ifndef KABC_ADDRESSEEDIALOG_H
    #define KABC_ADDRESSEEDIALOG_H

    #include

    #include
    #include
    #include

    #include "addressbook.h"

    namespace KABC {

    /**
      @short Special ListViewItem, that is used by the @ref AddresseeDialog.
    */
    class AddresseeItem : public QListViewItem
    {
      public:

        /**
          Type of column
          @li @p Name -  Name in Addressee
          @li @p Email - Email in Addressee
        */
        enum columns { Name = 0, Email = 1 };

        /**
          Constructor.

          @param parent    The parent listview.
          @param addressee The associated addressee.
        */
        AddresseeItem( QListView *parent, const Addressee &addressee );

        /**
          Returns the addressee.
        */
        Addressee addressee() const { return mAddressee; }

        /**
          Method used by QListView to sort the items.
        */
        virtual QString key( int column, bool ascending ) const;

      private:
        Addressee mAddressee;
    };

    /**
      @short Dialog for selecting address book entries.

      This class provides a dialog for selecting entries from the standard KDE
      address book. Use the @ref getAddressee() function to open a modal dialog,
      returning an address book entry.

      In the dialog you can select an entry from the list with the mouse or type in
      the first letters of the name or email address you are searching for. The
      entry matching best is automatically selected. Use double click, pressing
      return or pressing the ok button to return the selected addressee to the
      application.
    */
    class AddresseeDialog : public KDialogBase
    {
        Q_OBJECT

      public:
        /**
          Construct addressbook entry select dialog.

          @param parent parent widget
        */
        AddresseeDialog( QWidget *parent=0, bool multiple=false );

        /**
          Destructor.
        */
        virtual ~AddresseeDialog();

        /**
          Return the address chosen.

          If it is a multiple select, this will return only the first address chosen
        */
        Addressee addressee();

        /**
          Return the list of addresses chosen
        */
        Addressee::List addressees();

        /**
          Select a single address book entry.

          Open addressee select dialog and return the entry selected by the user.
          If the user doesn't select an entry or presses cancel, the returned
          addressee is empty.
        */
        static Addressee getAddressee( QWidget *parent );

        /**
          Select multiple adress book entries.

          Open addressee select dialog and return the entries selected by the user.
          If the user doesn't select an entry or presses cancel, the returned
          addressee list is empty.
        */
        static Addressee::List getAddressees( QWidget *parent );

      private slots:
        void selectItem( const QString & );
        void updateEdit( QListViewItem *item );
        void addSelected( QListViewItem *item );
        void removeSelected();

      protected slots:
        void addressBookChanged();

      private:
        void loadAddressBook();
        void addCompletionItem( const QString &str, QListViewItem *item );

        bool mMultiple;

        KListView *mAddresseeList;
        KLineEdit *mAddresseeEdit;

        KListView *mSelectedList;

        AddressBook *mAddressBook;

        QDict mItemDict;
        QDict mSelectedDict;

        class AddresseeDialogPrivate;
        AddresseeDialogPrivate *d;
    };

    }
    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:38:02 2003, using kdoc 2.0a54.