doc/src/classes.qdoc
branchRCL_3
changeset 8 3f74d0d4af4c
equal deleted inserted replaced
6:dee5afe5301f 8:3f74d0d4af4c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the documentation of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 /*!
       
    43     \group classlists
       
    44     \title Class and Function Documentation
       
    45     \brief Lists and Indexes of classes, functions, and types.
       
    46 
       
    47     Links to indexes and lists for finding class and function
       
    48     reference documentation.
       
    49 
       
    50     \section2 Class Lists
       
    51 
       
    52     \annotatedlist classlists
       
    53 
       
    54     \section2 Function Lists
       
    55 
       
    56     \annotatedlist funclists
       
    57 
       
    58 */
       
    59 
       
    60 /*!
       
    61     \page classes.html
       
    62     \title All Qt Classes (main index)
       
    63     \ingroup classlists
       
    64 
       
    65     \brief If you know the name of the class you want, find it here.
       
    66 
       
    67     This is a list of all Qt classes. For a list of the classes
       
    68     provided for compatibility with Qt3, see \l{Qt3 Support
       
    69     Classes}. For classes that have been deprecated, see the
       
    70     \l{Obsolete Classes} list.
       
    71 
       
    72     \generatelist classes
       
    73 
       
    74     \sa {Qt3 Support Classes}, {All Qt Modules}, {Obsolete Classes}
       
    75 */
       
    76 
       
    77 /*!
       
    78     \page annotated.html
       
    79     \title Annotated Class List
       
    80     \ingroup classlists
       
    81 
       
    82     \brief If you don't know the name of the class you want, but you
       
    83     know what the class should do, you might try looking here.
       
    84 
       
    85     Qt classes with brief descriptions:
       
    86 
       
    87     \generatelist annotatedclasses
       
    88 */
       
    89 
       
    90 /*!
       
    91     \group groups
       
    92     \title Groups Of Related Classes
       
    93     \ingroup classlists
       
    94 
       
    95     \brief If you know what kind of class you want (GUI, painting,
       
    96     I.O, etc), look here.
       
    97 
       
    98     This is a list of functional groups of Qt classes. A class can
       
    99     appear in more than one functional group.
       
   100 
       
   101     \generatelist{related}
       
   102 
       
   103 */
       
   104 
       
   105 /*!
       
   106     \page hierarchy.html
       
   107 
       
   108     \title Inheritance Hierarchy
       
   109     \ingroup classlists
       
   110 
       
   111     \brief The C++ class inheritance hierarchy for all classes in the
       
   112     Qt API.
       
   113 
       
   114     \generatelist classhierarchy
       
   115 */
       
   116 
       
   117 /*!
       
   118     \page obsoleteclasses.html
       
   119     \title Obsolete Classes
       
   120     \ingroup classlists
       
   121     
       
   122     \brief These classes are obsolete and should not be used in new code. 
       
   123 
       
   124     This is a list of Qt classes that are obsolete (deprecated). These
       
   125     classes are provided to keep old source code working but they are
       
   126     no longer maintained. We strongly advise against using these
       
   127     classes in new code.
       
   128 
       
   129     \generatelist obsoleteclasses
       
   130 
       
   131 */
       
   132 
       
   133 /*!
       
   134     \page compatclasses.html
       
   135     \title Qt3 Support Classes
       
   136     \ingroup classlists
       
   137 
       
   138     \brief These classes ease the porting of code from Qt 3 to Qt 4.
       
   139 
       
   140     These are the classes that Qt provides for compatibility with Qt
       
   141     3. Most of these are provided by the Qt3Support module.
       
   142 
       
   143     \generatelist compatclasses
       
   144 
       
   145 */
       
   146 
       
   147 /*!
       
   148     \page functions.html
       
   149     \title All Functions (main index)
       
   150     \ingroup funclists
       
   151 
       
   152     \brief All documented Qt functions listed alphabetically with a
       
   153     link to where each one is declared.
       
   154 
       
   155     This is the list of all documented member functions and global
       
   156     functions in the Qt API.  Each function has a link to the class or
       
   157     header file where it is declared and documented.
       
   158 
       
   159     \generatelist functionindex
       
   160 */
       
   161 
       
   162 
       
   163 /*!
       
   164     \page namespaces.html
       
   165     \title All Qt Namespaces
       
   166     \ingroup classlists
       
   167 
       
   168     \brief A Qt namespace contains enum types, functions, and sometimes classes.
       
   169 
       
   170     This is a list of the main namespaces in Qt. 
       
   171 
       
   172     \generatelist{namespaces}
       
   173 */