Outlook 范例 (ActiveQt)

The Qutlook example demonstrates the use of ActiveQt to automate Outlook. The example makes use of the dumpcpp tool to generate a C++ namespace for the type library describing the Outlook Object Model.

范例工程文件看起来像这样：

TEMPLATE = app
TARGET   = qutlook
QT += widgets axcontainer
TYPELIBS = $$system(dumpcpp -getfile {00062FFF-0000-0000-C000-000000000046})
isEmpty(TYPELIBS) {
    message("Microsoft Outlook type library not found!")
    REQUIRES += Outlook
} else {
    HEADERS  = addressview.h
    SOURCES  = addressview.cpp main.cpp
}
					

工程文件使用 dumpcpp 工具将 MS Outlook 类型库添加到工程。若这失败，那么生成的 makefile 将仅仅打印错误消息，否则构建步骤现在将运行 dumpcpp 工具在类型库，并生成头和 cpp 文件 (在这种情况下， msoutl.h and msoutl.cpp ) 声明并实现易于使用的 Outlook 对象 API。

class AddressView : public QWidget
{
    Q_OBJECT
public:
    explicit AddressView(QWidget *parent = nullptr);
protected slots:
    void addEntry();
    void changeEntry();
    void itemSelected(const QModelIndex &index);
    void updateOutlook();
protected:
    AddressBookModel *model;
    QTreeView *m_treeView;
    QPushButton *m_addButton;
    QPushButton *m_changeButton;
    QLineEdit *m_firstName;
    QLineEdit *m_lastName;
    QLineEdit *m_address;
    QLineEdit *m_email;
};
					

AddressView 类是 QWidget 子类对于用户界面。 QTreeView 小部件将显示 Outlook 联络文件夹的内容如提供通过 model .

#include "addressview.h"
#include "msoutl.h"
#include <QtWidgets>
class AddressBookModel : public QAbstractListModel
{
public:
    explicit AddressBookModel(AddressView *parent);
    virtual ~AddressBookModel();
    int rowCount(const QModelIndex &parent = QModelIndex()) const;
    int columnCount(const QModelIndex &parent) const;
    QVariant headerData(int section, Qt::Orientation orientation, int role) const;
    QVariant data(const QModelIndex &index, int role) const;
    void changeItem(const QModelIndex &index, const QString &firstName, const QString &lastName, const QString &address, const QString &email);
    void addItem(const QString &firstName, const QString &lastName, const QString &address, const QString &email);
    void update();
private:
    Outlook::Application outlook;
    Outlook::Items *folderItems = nullptr;
    mutable QHash<QModelIndex, QStringList> cache;
};
					

AddressBookModel 类是 QAbstractListModel 子类直接与 Outlook 通信，使用 QHash 为缓存。

AddressBookModel::AddressBookModel(AddressView *parent)
: QAbstractListModel(parent)
{
    if (!outlook.isNull()) {
        Outlook::NameSpace session(outlook.Session());
        session.Logon();
        Outlook::MAPIFolder *folder = session.GetDefaultFolder(Outlook::olFolderContacts);
        folderItems = new Outlook::Items(folder->Items());
        connect(folderItems, SIGNAL(ItemAdd(IDispatch*)), parent, SLOT(updateOutlook()));
        connect(folderItems, SIGNAL(ItemChange(IDispatch*)), parent, SLOT(updateOutlook()));
        connect(folderItems, SIGNAL(ItemRemove()), parent, SLOT(updateOutlook()));
        delete folder;
    }
}
					

构造函数初始化 Outlook。连接 Outlook 提供的内容即将改变的各种通知信号到 updateOutlook() 槽。

AddressBookModel::~AddressBookModel()
{
    delete folderItems;
    if (!outlook.isNull())
        Outlook::NameSpace(outlook.Session()).Logoff();
}
					

析构函数注销会话。

int AddressBookModel::rowCount(const QModelIndex &) const
{
    return folderItems ? folderItems->Count() : 0;
}
int AddressBookModel::columnCount(const QModelIndex & /*parent*/) const
{
    return 4;
}
					

The rowCount() 实现返回由 Outlook 报告的条目数。 columnCount and headerData 被实现为在树视图中展示 4 列。

QVariant AddressBookModel::headerData(int section, Qt::Orientation /*orientation*/, int role) const
{
    if (role != Qt::DisplayRole)
        return QVariant();
    switch (section) {
    case 0:
        return tr("First Name");
    case 1:
        return tr("Last Name");
    case 2:
        return tr("Address");
    case 3:
        return tr("Email");
    default:
        break;
    }
    return QVariant();
}
					

The headerData() 实现返回硬编码字符串。

QVariant AddressBookModel::data(const QModelIndex &index, int role) const
{
    if (!index.isValid() || role != Qt::DisplayRole)
        return QVariant();
    QStringList data;
    if (cache.contains(index)) {
        data = cache.value(index);
    } else {
        Outlook::ContactItem contact(folderItems->Item(index.row() + 1));
        if (contact.Class() == Outlook::OlObjectClass::olContact)
            data << contact.FirstName() << contact.LastName() << contact.HomeAddress() << contact.Email1Address();
        cache.insert(index, data);
    }
    if (index.column() < data.size())
        return data.at(index.column());
    return QVariant();
}
					

The data() 实现是模型核心。若请求数据在缓存中，使用缓存值，否则从 Outlook 获取数据。

void AddressBookModel::changeItem(const QModelIndex &index, const QString &firstName, const QString &lastName, const QString &address, const QString &email)
{
    Outlook::ContactItem item(folderItems->Item(index.row() + 1));
    if (item.Class() != Outlook::OlObjectClass::olContact)
        return; // Not a contact
    item.SetFirstName(firstName);
    item.SetLastName(lastName);
    item.SetHomeAddress(address);
    item.SetEmail1Address(email);
    item.Save();
    cache.take(index);
}
					

The changeItem() 槽被调用当用户使用用户界面改变当前条目时。Outlook 项的访问是使用 Outlook API，而修改是使用特性 setter。最后，项被保存到 Outlook，并从缓存移除它。注意，模型将不发射数据视图改变信号，因为 Outlook 自己会发射信号。

void AddressBookModel::addItem(const QString &firstName, const QString &lastName, const QString &address, const QString &email)
{
    Outlook::ContactItem item(outlook.CreateItem(Outlook::olContactItem));
    if (!item.isNull()) {
        item.SetFirstName(firstName);
        item.SetLastName(lastName);
        item.SetHomeAddress(address);
        item.SetEmail1Address(email);
        item.Save();
    }
}
					

The addItem() 槽调用 Outlook 的 CreateItem 方法创建新的联络项，并将新项的特性设为用户输入值再保存项。

void AddressBookModel::update()
{
    beginResetModel();
    cache.clear();
    endResetModel();
}
					

The update() slot clears the cache, and emits the reset() signal to notify the view about the data change requiring a redraw of the contents.

AddressView::AddressView(QWidget *parent)
: QWidget(parent)
{
    QGridLayout *mainGrid = new QGridLayout(this);
    QLabel *firstNameLabel = new QLabel(tr("First &Name"), this);
    firstNameLabel->resize(firstNameLabel->sizeHint());
    mainGrid->addWidget(firstNameLabel, 0, 0);
    QLabel *lastNameLabel = new QLabel(tr("&Last Name"), this);
    lastNameLabel->resize(lastNameLabel->sizeHint());
    mainGrid->addWidget(lastNameLabel, 0, 1);
    QLabel *addressLabel = new QLabel(tr("Add&ress"), this);
    addressLabel->resize(addressLabel->sizeHint());
    mainGrid->addWidget(addressLabel, 0, 2);
    QLabel *emailLabel = new QLabel(tr("&E-Mail"), this);
    emailLabel->resize(emailLabel->sizeHint());
    mainGrid->addWidget(emailLabel, 0, 3);
    m_addButton = new QPushButton(tr("A&dd"), this);
    m_addButton->resize(m_addButton->sizeHint());
    mainGrid->addWidget(m_addButton, 0, 4);
    connect(m_addButton, &QPushButton::clicked, this, &AddressView::addEntry);
    m_firstName = new QLineEdit(this);
    m_firstName->resize(m_firstName->sizeHint());
    mainGrid->addWidget(m_firstName, 1, 0);
    firstNameLabel->setBuddy(m_firstName);
    m_lastName = new QLineEdit(this);
    m_lastName->resize(m_lastName->sizeHint());
    mainGrid->addWidget(m_lastName, 1, 1);
    lastNameLabel->setBuddy(m_lastName);
    m_address = new QLineEdit(this);
    m_address->resize(m_address->sizeHint());
    mainGrid->addWidget(m_address, 1, 2);
    addressLabel->setBuddy(m_address);
    m_email = new QLineEdit(this);
    m_email->resize(m_email->sizeHint());
    mainGrid->addWidget(m_email, 1, 3);
    emailLabel->setBuddy(m_email);
    m_changeButton = new QPushButton(tr("&Change"), this);
    m_changeButton->resize(m_changeButton->sizeHint());
    mainGrid->addWidget(m_changeButton, 1, 4);
    connect(m_changeButton, &QPushButton::clicked, this, &AddressView::changeEntry);
    m_treeView = new QTreeView(this);
    m_treeView->setSelectionMode(QTreeView::SingleSelection);
    m_treeView->setRootIsDecorated(false);
    model = new AddressBookModel(this);
    m_treeView->setModel(model);
    connect(m_treeView->selectionModel(), &QItemSelectionModel::currentChanged, this, &AddressView::itemSelected);
    mainGrid->addWidget(m_treeView, 2, 0, 1, 5);
}
void AddressView::updateOutlook()
{
    model->update();
}
void AddressView::addEntry()
{
    if (!m_firstName->text().isEmpty() || !m_lastName->text().isEmpty() ||
         !m_address->text().isEmpty() || !m_email->text().isEmpty()) {
        model->addItem(m_firstName->text(), m_lastName->text(), m_address->text(), m_email->text());
    }
    m_firstName->clear();
    m_lastName->clear();
    m_address->clear();
    m_email->clear();
}
void AddressView::changeEntry()
{
    QModelIndex current = m_treeView->currentIndex();
    if (current.isValid())
        model->changeItem(current, m_firstName->text(), m_lastName->text(), m_address->text(), m_email->text());
}
void AddressView::itemSelected(const QModelIndex &index)
{
    if (!index.isValid())
        return;
    QAbstractItemModel *model = m_treeView->model();
    m_firstName->setText(model->data(model->index(index.row(), 0)).toString());
    m_lastName->setText(model->data(model->index(index.row(), 1)).toString());
    m_address->setText(model->data(model->index(index.row(), 2)).toString());
    m_email->setText(model->data(model->index(index.row(), 3)).toString());
}
					

文件的其余部分仅使用 Qt API 实现用户界面，即：不直接与 Outlook 进行通信。

#include "addressview.h"
#include <QApplication>
int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
    AddressView view;
    view.setWindowTitle(QObject::tr("Qt Example - Looking at Outlook"));
    view.show();
    return a.exec();
}
					

The main() 入口点函数最后实例化用户界面并进入事件循环。

要构建范例必须先构建 QAxContainer 库。然后运行 make 工具在 examples/activeqt/qutlook 和运行结果 qutlook.exe .

范例工程 @ code.qt.io