~chris.gagnon/+junk/qtpim-coverage

« back to all changes in this revision

Viewing changes to src/contacts/doc/src/qtcontacts.qdoc

• browse files at revision 1
• compare with another revision
• download diff
• download tarball
• view history from revision 1

Show diffs side-by-side

added

removed

src/contacts/doc/src/qtcontacts.qdoc

 

1

/****************************************************************************

 

2

**

 

3

** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).

 

4

** Contact: http://www.qt-project.org/legal

 

5

**

 

6

** This file is part of the documentation of the Qt PIM Module.

 

7

**

 

8

** $QT_BEGIN_LICENSE:FDL$

 

9

** Commercial License Usage

 

10

** Licensees holding valid commercial Qt licenses may use this file in

 

11

** accordance with the commercial license agreement provided with the

 

12

** Software or, alternatively, in accordance with the terms contained in

 

13

** a written agreement between you and Digia.  For licensing terms and

 

14

** conditions see http://qt.digia.com/licensing.  For further information

 

15

** use the contact form at http://qt.digia.com/contact-us.

 

16

**

 

17

** GNU Free Documentation License Usage

 

18

** Alternatively, this file may be used under the terms of the GNU Free

 

19

** Documentation License version 1.3 as published by the Free Software

 

20

** Foundation and appearing in the file included in the packaging of

 

21

** this file.  Please review the following information to ensure

 

22

** the GNU Free Documentation License version 1.3 requirements

 

23

** will be met: http://www.gnu.org/copyleft/fdl.html.

 

24

** $QT_END_LICENSE$

 

25

**

 

26

****************************************************************************/

 

27

 

 

28

/*!

 

29

    \module QtContacts

 

30

    \title Qt Contacts C++ Classes

 

31

    \ingroup modules

 

32

 

 

33

    \brief The QtContacts module contains classes for management.

 

34

 

 

35

    The \l{Qt Contacts} C++ classes provide contact management. A contact is the

 

36

    digital representation of a person, group, or entity that is stored in a

 

37

    platform-specific manner.

 

38

 

 

39

    To include the definitions of the module's classes, use the following

 

40

    directive:

 

41

 

 

42

    \snippet doc_src_qtcontacts.cpp include

 

43

 

 

44

    To use the C++ library in your application, add the following configuration

 

45

    option to your \c .pro file:

 

46

 

 

47

    \snippet doc_src_qtcontacts.pro contacts project modification

 

48

*/

 

49

 

 

50

/*!

 

51

    \qmlmodule QtContacts 5.0

 

52

    \title Qt Contacts QML Types

 

53

    \ingroup qmlmodules

 

54

    \brief Provides QML types for handling personal contacts and information

 

55

 

 

56

    \l{Qt Contacts}' QML API enables client to search for contacts data from

 

57

    local backends and use filters to get only the relevant results. The QML

 

58

    Contacts API delivers this capability in easy to use form. The \l{Qt

 

59

    Contacts QML API} page contains an overview of the QML types.

 

60

 

 

61

    To use the types, simply add the following to the QML file:

 

62

 

 

63

     \snippet moduleimports.qml Contacts import

 

64

 

 

65

*/

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1