doc/src/development/qmsdev.qdoc
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 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 /* NOT DOCUMENTED ! 
       
    43   \page qmsdev.html
       
    44 
       
    45   \title The QMsDev Plugin
       
    46 
       
    47   The Visual Studio Integration Plugin is currently available only to users of
       
    48   Visual Studio 6. It offers simple ways of doing common tasks when writing a
       
    49   Qt application. 
       
    50 
       
    51   \tableofcontents
       
    52 
       
    53   \section1 How to install the Visual Studio Integration Plugin
       
    54    
       
    55   When you install Qt, the integration plugin should be installed for you,
       
    56   however, sometimes this does  not happen, so to install the integration
       
    57   plugin manually just carry out the following steps.
       
    58 
       
    59   \list
       
    60   \i Start up Visual Studio.
       
    61   \i Select Tools|Customize|Add-ins and Macro Files.
       
    62   \i Ensure that there is a tick next to QMsDev Developer Studio Add-In.
       
    63   \i Click Close.
       
    64   \endlist
       
    65 
       
    66   Now the integration plugin should be installed. If this doesn't
       
    67   work, then contact Qt technical support giving details of
       
    68   what went wrong.
       
    69   
       
    70   \section1 How to uninstall the Visual Studio Integration Plugin
       
    71 
       
    72   When you want to uninstall the integration plugin, just carry out the
       
    73   following steps.
       
    74 
       
    75   \list
       
    76   \i Close down any instances of Visual Studio.
       
    77   \i Delete the file '%MSDevDir%\\addins\\qmsdev.dll'
       
    78   \endlist
       
    79 
       
    80   \section1 What can the Visual Studio Integration Plugin do?
       
    81   
       
    82   The integration plugin adds the following options to Visual Studio:
       
    83 
       
    84   \list
       
    85   \i New Qt Project
       
    86   \i New Qt Dialog
       
    87   \i Qt Designer
       
    88   \i Open Qt Project
       
    89   \i Write Qt Project
       
    90   \i Use Qt In Current Project
       
    91   \i Add MOC
       
    92   \endlist
       
    93 
       
    94   \section2 Using the 'New Qt Project' button
       
    95   
       
    96   The 'New Qt Project' button allows you to create a simple Qt project
       
    97   ready for development. Simply fill in the form and if you select
       
    98   'Dialog' or 'Main Window' without MDI support then it will
       
    99   automatically start up \e{Qt Designer}. When you have finished with
       
   100   the form in \e{Qt Designer} just save it and it will appear in a
       
   101   ready made Qt project.
       
   102 
       
   103   If you select 'Main Window' with 'MDI Support' then it will simply
       
   104   give you a code skeleton in a project ready for you to populate with
       
   105   your own code.
       
   106 
       
   107   \section2 Using the 'New Qt Dialog' button
       
   108 
       
   109   The 'New Qt Dialog' button works in two ways: You can use it to create a new
       
   110   dialog for your project; or you can  use it to insert an existing
       
   111   dialog into your project.
       
   112 
       
   113   If you want to create a new dialog then all you need to do is specify where
       
   114   the dialog file should be saved and give it a name. This will start up
       
   115   \e{Qt Designer} to allow you to design your new dialog, and will add it to
       
   116   the existing  project.
       
   117 
       
   118   If you want to add an existing dialog to your project, then just select the
       
   119   relevant UI file. This will then add it to your existing project and add
       
   120   the relevant steps to create the generated code.
       
   121 
       
   122   \section2 Using the 'Qt Designer' button
       
   123 
       
   124   The 'Qt Designer' button simply starts up \e{Qt Designer}, it has no ties to
       
   125   your existing project so whatever you do with it will not affect your
       
   126   existing projects. It can also be started up by using the Ctrl+Shift+D key
       
   127   combination in Visual Studio.
       
   128 
       
   129   \section2 Using the 'Open Qt Project' button
       
   130 
       
   131   The 'Open Qt Project' button allows you to convert an existing \c
       
   132   qmake project file into a \c .dsp file which you can insert into
       
   133   your existing workspace. When you click the 'Open Qt Project'
       
   134   button, just select an existing \c qmake project file (a \c .pro
       
   135   file) and then click OK. You will get a message box at the end
       
   136   which asks you to insert the newly created \c .dsp file into your
       
   137   existing workspace.
       
   138 
       
   139   \section2 Using the 'Write Qt Project' button
       
   140 
       
   141   The 'Write Qt Project' button creates a \c qmake project (\c .pro)
       
   142   file for your current project so that you can easily copy the files
       
   143   onto another platform and be able to use \c qmake to create a Makefile
       
   144   on that other platform. All you need to do is make the project you
       
   145   want to create a \c .pro file for, and click on the button. Just
       
   146   name your \c qmake project file and click Save.
       
   147 
       
   148   \section2 Using the 'Use Qt In Current Project' button
       
   149 
       
   150   The 'Use Qt In Current Project' button simply adds in the necessary
       
   151   information for the current project so that it links against Qt and
       
   152   sets any other settings needed to use Qt in that project.
       
   153 
       
   154   \section2 Using the 'Add MOC' button
       
   155 
       
   156   The 'Add MOC' button will add in the custom build step for the selected file
       
   157   so that it creates any needed MOC files and it will add these generated
       
   158   files to the project. All you need to do to use it is click on a file that
       
   159   has Q_OBJECT and click the button. 
       
   160 
       
   161   You only need to use this button if you added a file that has
       
   162   Q_OBJECT in it by hand, you don't need to use this if you used any
       
   163   of the previously mentioned buttons. It can also be invoked by using
       
   164   the \key{Ctrl+Shift+M} key combination in Visual Studio.
       
   165 
       
   166 */