source: trunk/doc/src/development/qmsdev.qdoc@ 564

/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation ([email protected])
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at [email protected].
** $QT_END_LICENSE$
**
****************************************************************************/

/* NOT DOCUMENTED ! 
  \page qmsdev.html

  \title The QMsDev Plugin

  The Visual Studio Integration Plugin is currently available only to users of
  Visual Studio 6. It offers simple ways of doing common tasks when writing a
  Qt application. 

  \tableofcontents

  \section1 How to install the Visual Studio Integration Plugin
   
  When you install Qt, the integration plugin should be installed for you,
  however, sometimes this does  not happen, so to install the integration
  plugin manually just carry out the following steps.

  \list
  \i Start up Visual Studio.
  \i Select Tools|Customize|Add-ins and Macro Files.
  \i Ensure that there is a tick next to QMsDev Developer Studio Add-In.
  \i Click Close.
  \endlist

  Now the integration plugin should be installed. If this doesn't
  work, then contact Qt technical support giving details of
  what went wrong.
  
  \section1 How to uninstall the Visual Studio Integration Plugin

  When you want to uninstall the integration plugin, just carry out the
  following steps.

  \list
  \i Close down any instances of Visual Studio.
  \i Delete the file '%MSDevDir%\\addins\\qmsdev.dll'
  \endlist

  \section1 What can the Visual Studio Integration Plugin do?
  
  The integration plugin adds the following options to Visual Studio:

  \list
  \i New Qt Project
  \i New Qt Dialog
  \i Qt Designer
  \i Open Qt Project
  \i Write Qt Project
  \i Use Qt In Current Project
  \i Add MOC
  \endlist

  \section2 Using the 'New Qt Project' button
  
  The 'New Qt Project' button allows you to create a simple Qt project
  ready for development. Simply fill in the form and if you select
  'Dialog' or 'Main Window' without MDI support then it will
  automatically start up \e{Qt Designer}. When you have finished with
  the form in \e{Qt Designer} just save it and it will appear in a
  ready made Qt project.

  If you select 'Main Window' with 'MDI Support' then it will simply
  give you a code skeleton in a project ready for you to populate with
  your own code.

  \section2 Using the 'New Qt Dialog' button

  The 'New Qt Dialog' button works in two ways: You can use it to create a new
  dialog for your project; or you can  use it to insert an existing
  dialog into your project.

  If you want to create a new dialog then all you need to do is specify where
  the dialog file should be saved and give it a name. This will start up
  \e{Qt Designer} to allow you to design your new dialog, and will add it to
  the existing  project.

  If you want to add an existing dialog to your project, then just select the
  relevant UI file. This will then add it to your existing project and add
  the relevant steps to create the generated code.

  \section2 Using the 'Qt Designer' button

  The 'Qt Designer' button simply starts up \e{Qt Designer}, it has no ties to
  your existing project so whatever you do with it will not affect your
  existing projects. It can also be started up by using the Ctrl+Shift+D key
  combination in Visual Studio.

  \section2 Using the 'Open Qt Project' button

  The 'Open Qt Project' button allows you to convert an existing \c
  qmake project file into a \c .dsp file which you can insert into
  your existing workspace. When you click the 'Open Qt Project'
  button, just select an existing \c qmake project file (a \c .pro
  file) and then click OK. You will get a message box at the end
  which asks you to insert the newly created \c .dsp file into your
  existing workspace.

  \section2 Using the 'Write Qt Project' button

  The 'Write Qt Project' button creates a \c qmake project (\c .pro)
  file for your current project so that you can easily copy the files
  onto another platform and be able to use \c qmake to create a Makefile
  on that other platform. All you need to do is make the project you
  want to create a \c .pro file for, and click on the button. Just
  name your \c qmake project file and click Save.

  \section2 Using the 'Use Qt In Current Project' button

  The 'Use Qt In Current Project' button simply adds in the necessary
  information for the current project so that it links against Qt and
  sets any other settings needed to use Qt in that project.

  \section2 Using the 'Add MOC' button

  The 'Add MOC' button will add in the custom build step for the selected file
  so that it creates any needed MOC files and it will add these generated
  files to the project. All you need to do to use it is click on a file that
  has Q_OBJECT and click the button. 

  You only need to use this button if you added a file that has
  Q_OBJECT in it by hand, you don't need to use this if you used any
  of the previously mentioned buttons. It can also be invoked by using
  the \key{Ctrl+Shift+M} key combination in Visual Studio.

*/