Install and set up on Windows

This topic describes how to set up the following:

  • ArcGIS Runtime SDK for Qt for Windows.
  • The Qt SDK for Windows: The SDK available from The Qt Company for developing cross-platform applications. Not an Esri product.
  • The Qt SDK for Android: The SDK available from The Qt Company for developing Android applications. Not an Esri product.
  • Qt Creator: The IDE for Qt application development available from The Qt Company. Not an Esri product.

See ArcGIS Runtime SDK for Qt System Requirements for detailed software requirements.

Install Visual Studio

The Microsoft Visual Studio compiler is used to build apps with the ArcGIS Runtime SDK for Qt. It is recommended that you uninstall previous versions of Visual Studio and any previous Visual Studio redistributables before installing Visual Studio, or conflicts can occur during installation.

Install Microsoft WinDbg

To debug using Qt Creator with Visual Studio, download and install WinDbg, the stand-alone debugging tool for Windows. Be sure to download the version that matches your operating system.

Download the Qt SDK for Windows

To build an application using the ArcGIS Runtime SDK for Qt, you will need the Qt SDK designed to work with your compiler. You can install Qt SDKs for multiple target platforms on your development machine, side-by-side.

  1. Download and install the appropriate Qt SDK for Windows from The Qt Company. This download will include Qt Creator.
  2. Optionally, add Open SSL support. Open SSL allows access to secure services that need user credentials. It is not delivered with the Qt SDK. For more information, see the Qt documentation about adding SSL support to your Qt application.

Install prerequisites for Android development

If you plan to develop applications for the Android platform, you will need to install Android SDK Tools, Android NDK, Apache Ant, and the Java SE Development Kit. See Qt for Android for more information on Qt for Android. If you are not planning to develop for Android, proceed to the section of this topic titled Tell Qt Creator where to find Qt.

  1. Create a new staging folder to store all the prerequisites, such as C:\Android. This folder is referred to in these instructions as <staging folder>.
  2. Browse to Getting Started with Qt for Android.
  3. Click The Android SDK Tools.
  4. Download the Android Tools SDK Bundle, the Android NDK, Apache Ant, and the Java SE Development Kit.
  5. Extract the Android SDK to the staging folder.
  6. Extract the Android NDK to the staging folder.
  7. Extract and install Apache Ant to the staging folder.
  8. Install the Java SE Development Kit by double-clicking the .exe file and accepting all the defaults.
  9. Click Control Panel > System> Advanced System Settings > Environment variables.
  10. Create an environment variable called JAVA_HOME, and set it to the install location of the JDK folder, such as C:\Program Files\Java\jdk1.7.0_55.
  11. Create an environment variable called ANDROID_NDK_ROOT, and set it to your NDK folder <staging folder>\android-ndk-r9d.
  12. If you are developing using a Google device, download the ZIP file for Google USB Driver. For developing using other Android devices, you may need an OEM USB Driver.
  13. Extract the Android Debug Bridge Google USB Driver ZIP file to your staging folder.
  14. Verify the ADB works. Open the command prompt and type the following commands:
    cd  <staging folder>\adt-bundle-windows-x86_64-<version>\sdk\platform-tools
    adb.exe
  15. Make sure the help message displays. If it does not display, the Android SDK was not installed correctly.
  16. Launch the Android SDK Manager, and install all of the tools for Android (see ArcGIS Runtime SDK for Qt System Requirements for version information) plus the Build Tools Rev 19.
  17. Download the Qt SDK for Android (on Windows) from The Qt Company.
  18. Run the Qt for Android installer, accepting all the defaults.
  19. In Qt Creator, click Tools > Options > Android and fill in the paths. Paths will be similar to the following:
    • JDK Location: C:\Program Files\Java\jdk1.7.0_55
    • Android SDK Location: <staging folder>\adt-bundle-windows-x86_64-<date>\sdk
    • Android NDK Location: <staging folder>\android-ndk-<version>
    • Ant Location: <staging folder>\apache-ant-<version>\bin\ant.bat

Tell Qt Creator where to find Qt SDKs

It is typical to use one Qt Creator IDE with multiple Qt SDKs, such as one SDK for desktop development and another to build and deploy to a mobile device. Qt Creator needs to know where to find the Qt SDKs you want to use. It looks for Qt SDKs on your development machine but may not detect all the Qt SDKs you want to use. This can happen when you have multiple Qt SDKs on your development machine, or if you later install another Qt SDK.

Follow these steps to tell Qt Creator about additional Qt SDKs:

  1. Click Tools > Options > Build & Run > Qt Versions, and click Add.
  2. Browse to find the qmake.exe file in the installation location.
  3. Provide a suitable name for this Qt SDK.
  4. Click Apply.

After completing these steps, the Qt SDK you specified will appear under the heading Manual. You can now use these Qt SDKs to configure kits and projects.

Install ArcGIS Runtime SDK for Qt

  1. Make sure you have read/write access to your desired download location.
  2. Click the product's download link.
  3. Run the extraction wizard, which asks you to choose the extraction location.
  4. Run setup.exe from the extraction location. Installing ArcGIS Runtime SDK for Qt on Windows requires administrative privileges.
  5. After the setup program finishes, the post-installer starts. The post-installer integrates the ArcGIS Runtime SDK for Qt with your installation of the Qt SDK and Qt Creator by copying files to locations within those install locations. Choose the Qt SDK components you want to configure. Choose only components that are installed on your development machine. For each component you choose, provide a path to the component. For Qt Creator, use the path to the Qt Creator app. For Qt SDKs, use the path to qmake.exe in the SDK's install location. Please note that the post-installer needs read/write access to the User Profile's AppData folder.
  6. A patch for ArcGIS Runtime SDK 10.2.6 for Qt has been released. The patch's description, list of issues addressed, its installation instructions are available for download from the Patches and Service Packs page of the Esri support website.

Configure kits and projects

In Qt Creator, a kit defines how to build an app for a target device. A kit includes references to the compiler, the Qt SDK, and the debugger.

  1. Click Tools > Options > Build & Run > Kits.
  2. Examine the existing kits. If no existing kit has the settings you want, click Add to create a new kit.
  3. Give the kit an appropriate name.
  4. Set Device type to Desktop.
  5. Choose the appropriate compiler.
  6. Choose the CDB Engine debugger. If the debugger you want does not appear in the list of options, make sure that you have installed the WinDbg debugger, as mentioned in a previous step.
  7. Choose the Qt Version.
  8. Click OK or Apply to finish creating the kit.
  9. Repeat the previous steps to add Android kits if you installed the Qt SDK for Android.
  10. Create a project in Qt Creator for your ArcGIS Runtime SDK for Qt app. You can use a provided project template to create a new project. See Develop your first map app for more information about using a project template.
  11. When you open a Qt Creator project file for the first time, Qt Creator prompts you to configure the project. This means choosing the kits you want to use with the project. Choose the kit you created in the earlier step, and click Configure Project.
  12. You can now build your project in Qt Creator.
Related topics